Merge pull request #56 from GitRon/feature/scrubber-validation-whitel…

…ist-added

Added SCRUBBER_VALIDATION_WHITELIST and excluded Django core test model

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 
 - Added support for `Django` version `5.1`
+- Added `SCRUBBER_VALIDATION_WHITELIST` and excluded Django core test model
 -->
 
 ## [2.0.0] - 2024-06-27

README.md

@@ -322,6 +322,13 @@ SCRUBBER_MAPPING = {
 
 (default: {})
 
+### `SCRUBBER_VALIDATION_WHITELIST`:
+
+Whitelist models you want to exclude from the `scrub_validation` checker command for scrubber-wise undeclared models.
+By default, it contains only a test model from Django core which doesn't have to be anonymised. 
+
+(default: ['db.TestModel',])
+
 ## Logging
 
 Scrubber uses the default django logger. The logger name is ``django_scrubber.scrubbers``.

django_scrubber/__init__.py

@@ -29,6 +29,9 @@
         'sites.Site',
         'django_scrubber.FakeData',
     ],
+    'SCRUBBER_VALIDATION_WHITELIST': [
+        'db.TestModel',  # Test model from Django core
+    ],
 }
 
 

django_scrubber/management/commands/scrub_validation.py

@@ -2,6 +2,7 @@
 
 from django.core.management.base import BaseCommand
 
+from django_scrubber import settings_with_fallback
 from django_scrubber.services.validator import ScrubberValidatorService
 
 
@@ -13,8 +14,17 @@ def handle(self, *args, **options):
 
         found_models = 0
         found_fields = 0
+
+        whitelisted_models = settings_with_fallback('SCRUBBER_VALIDATION_WHITELIST')
+
         if len(non_scrubbed_field_list):
             for model_path, affected_field_list in non_scrubbed_field_list.items():
+
+                if model_path in whitelisted_models:
+                    print(f'Model {model_path!r} was excluded via \'SCRUBBER_VALIDATION_WHITELIST\' and will '
+                          'not be validated.')
+                    continue
+
                 print(f'Model {model_path!r}:')
                 found_models += 1
                 for field in affected_field_list: