v6.12.0

Author: GitRon

CHANGES.md

@@ -1,5 +1,11 @@
 # Changelog
 
+* **6.12.0** (2023-03-16)
+  * Added `validate_test_structure` management command for validating project test structure
+  * Fixed syntax error in docs
+  * Fixed typo in docstring of `concat` method
+  * Improved code in test app
+
 * **6.11.0** (2023-02-19)
   * Added `HtmxResponseMixin` for Django views
   * Added missing `object` class attribute to `ToggleView`

ai_django_core/__init__.py

@@ -1,3 +1,3 @@
 """Ambient toolbox - Lots of helper functions and useful widgets"""
 
-__version__ = '6.11.0'
+__version__ = '6.12.0'

ai_django_core/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class AmbientToolboxConfig(AppConfig):
+    name = 'ai_django_core'
+    verbose_name = _('Ambient Toolbox')

ai_django_core/management/__init__.py

@@ -0,0 +1,9 @@
+from django.core.management.base import BaseCommand
+
+from ai_django_core.tests.structure_validator.test_structure_validator import TestStructureValidator
+
+
+class Command(BaseCommand):
+    def handle(self, *args, **options):
+        service = TestStructureValidator()
+        service.process()

ai_django_core/management/commands/__init__.py

@@ -17,7 +17,7 @@ def get_first_char(value):
 @register.filter(name='concat')
 def concat(obj, str):
     """
-    Concats the the two given strings
+    Concats the two given strings
 
     :param obj:
     :param str:

ai_django_core/management/commands/validate_test_structure.py

@@ -0,0 +1,11 @@
+from django.conf import settings
+
+# Test validator
+TEST_STRUCTURE_VALIDATOR_FILE_WHITELIST = []
+try:
+    TEST_STRUCTURE_VALIDATOR_BASE_DIR = settings.BASE_DIR
+except AttributeError:
+    TEST_STRUCTURE_VALIDATOR_BASE_DIR = ''
+TEST_STRUCTURE_VALIDATOR_BASE_APP_NAME = 'apps'
+TEST_STRUCTURE_VALIDATOR_APP_LIST = settings.INSTALLED_APPS
+TEST_STRUCTURE_VALIDATOR_IGNORED_DIRECTORY_LIST = []

ai_django_core/templatetags/ai_string_tags.py

@@ -0,0 +1,124 @@
+import os
+import sys
+from pathlib import Path
+from typing import Union
+
+from django.conf import settings
+
+from ai_django_core.tests.structure_validator import settings as toolbox_settings
+
+
+class TestStructureValidator:
+    file_whitelist: list
+    issue_list: list
+
+    def __init__(self):
+        self.file_whitelist = self._get_file_whitelist()
+        self.issue_list = []
+
+    @staticmethod
+    def _get_file_whitelist() -> list:
+        default_whitelist = ['__init__']
+        try:
+            return default_whitelist + settings.TEST_STRUCTURE_VALIDATOR_FILE_WHITELIST
+        except AttributeError:
+            return default_whitelist + toolbox_settings.TEST_STRUCTURE_VALIDATOR_FILE_WHITELIST
+
+    @staticmethod
+    def _get_base_dir() -> Union[Path, str]:
+        try:
+            return settings.TEST_STRUCTURE_VALIDATOR_BASE_DIR
+        except AttributeError:
+            return toolbox_settings.TEST_STRUCTURE_VALIDATOR_BASE_DIR
+
+    @staticmethod
+    def _get_base_app_name() -> str:
+        try:
+            return settings.TEST_STRUCTURE_VALIDATOR_BASE_APP_NAME
+        except AttributeError:
+            return toolbox_settings.TEST_STRUCTURE_VALIDATOR_BASE_APP_NAME
+
+    @staticmethod
+    def _get_ignored_directory_list() -> list:
+        default_dir_list = ['__pycache__']
+        try:
+            return default_dir_list + settings.TEST_STRUCTURE_VALIDATOR_IGNORED_DIRECTORY_LIST
+        except AttributeError:
+            return default_dir_list + toolbox_settings.TEST_STRUCTURE_VALIDATOR_IGNORED_DIRECTORY_LIST
+
+    @staticmethod
+    def _get_app_list() -> Union[list, tuple]:
+        try:
+            return settings.TEST_STRUCTURE_VALIDATOR_APP_LIST
+        except AttributeError:
+            return toolbox_settings.TEST_STRUCTURE_VALIDATOR_APP_LIST
+
+    def _check_missing_test_prefix(self, *, root: str, file: str, filename: str, extension: str) -> bool:
+        if extension == '.py' and not filename[0:5] == "test_" and filename not in self.file_whitelist:
+            file_path = f"{root}\\{file}".replace('\\', '/')
+            self.issue_list.append(f'Python file without "test_" prefix found: {file_path!r}.')
+            return False
+        return True
+
+    def _check_missing_init(self, *, root: str, init_found: bool, number_of_py_files: int) -> bool:
+        if not init_found and number_of_py_files > 0:
+            path = root.replace('\\', '/')
+            self.issue_list.append(f"__init__.py missing in {path!r}.")
+            return False
+        return True
+
+    def _build_path_to_test_package(self, app: str) -> Path:
+        return self._get_base_dir() / Path(app.replace('.', '/')) / 'tests'
+
+    def process(self) -> None:
+        backend_package = self._get_base_app_name()
+        app_list = self._get_app_list()
+
+        for app in app_list:
+            if not app.startswith(backend_package):
+                continue
+            app_path = self._build_path_to_test_package(app=app)
+            for root, dirs, files in os.walk(app_path):
+                cleaned_root = root.replace('\\', '/')
+                print(f"Inspecting {cleaned_root!r}...")
+                init_found = False
+                number_of_py_files = 0
+
+                for excluded_dir in self._get_ignored_directory_list():
+                    try:
+                        dirs.remove(excluded_dir)
+                    except ValueError:
+                        pass
+
+                for file in files:
+                    filename = file[:-3]
+                    extension = file[-3:]
+
+                    if filename == "__init__":
+                        init_found = True
+
+                    if extension == ".py":
+                        number_of_py_files += 1
+
+                    # Check for missing test prefix
+                    self._check_missing_test_prefix(root=root, file=file, filename=filename, extension=extension)
+
+                # Check for missing init file
+                self._check_missing_init(root=root, init_found=init_found, number_of_py_files=number_of_py_files)
+
+        number_of_issues = len(self.issue_list)
+
+        if number_of_issues:
+            print("=======================")
+            print("Errors found:")
+
+            for issue in self.issue_list:
+                print(f"- {issue}")
+
+        print("=======================")
+
+        if number_of_issues:
+            print(f'Checking test structure failed with {number_of_issues} issue(s).')
+            sys.exit(1)
+        else:
+            print("0 issues detected. Yeah!")

ai_django_core/tests/structure_validator/__init__.py

@@ -37,7 +37,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'ai-django-core'
-copyright = '2022, Ambient Innovation: GmbH'
+copyright = '2022, Ambient Innovation: GmbH'  # noqa
 author = 'Ambient Innovation: GmbH <[email protected]>'
 version = __version__
 release = __version__

ai_django_core/tests/structure_validator/settings.py

@@ -234,11 +234,37 @@ class MyViewTest(DjangoMessagingFrameworkTestMixin, TestCase):
         # The view creates a message: "It's sunny on Sundays."
         view = function_to_instantiate_your_view()
         self.assert_full_message_in_request(
-            view.request, 'It's sunny on Sundays.')
+            view.request, "It's sunny on Sundays.")
 
     def test_my_message_partial_case(self):
         # The view creates a message: "I have added *n* new records" with "n" being a variable
         view = function_to_instantiate_your_view()
         self.assert_partial_message_in_request(
             view.request, 'I have added')
 ````
+
+## Test structure validator
+
+### Motivation
+
+When working in a Django project, it can happen very easily that you create unit-tests in a way that they won't be
+auto-discovered. The mean thing about this is that you can still run those tests - so it's hard to find those issues.
+
+The most common mistakes are forgetting the `__init__.py` in the directory or not prefixing your python files
+with `test_`. To tackle this problem, we created a handy management command you can run manually or integrate in your
+CI pipeline.
+
+    python manage.py validate_test_structure
+
+
+### Configuration
+
+You can define all of those settings variables in your main Django settings file.
+
+| Variable                                        | Type | Default                 | Explanation                                                         |
+|-------------------------------------------------|------|-------------------------|---------------------------------------------------------------------|
+| TEST_STRUCTURE_VALIDATOR_FILE_WHITELIST         | list | []                      | Filenames which will be ignored, will always ignore `__init__`      |
+| TEST_STRUCTURE_VALIDATOR_BASE_DIR               | Path | settings.BASE_DIR       | Root path to your application (BASE_DIR in a vanilla Django setup)   |
+| TEST_STRUCTURE_VALIDATOR_BASE_APP_NAME          | str  | "apps"                  | Directory where all your Django apps live in, can be set to "".     |
+| TEST_STRUCTURE_VALIDATOR_APP_LIST               | list | settings.INSTALLED_APPS | List of all your Django apps you want to validate                   |
+| TEST_STRUCTURE_VALIDATOR_IGNORED_DIRECTORY_LIST | list | []                      | Directories which will be ignored, will always ignore `__pycache__` |

ai_django_core/tests/structure_validator/test_structure_validator.py

@@ -6,4 +6,4 @@
 class CommonInfoBasedModelTestForm(forms.ModelForm):
     class Meta:
         model = CommonInfoBasedModel
-        exclude = ()
+        fields = ('value',)

docs/conf.py

@@ -16,6 +16,9 @@ class MySingleSignalModel(models.Model):
 
     objects = GloballyVisibleQuerySet.as_manager()
 
+    def __str__(self):
+        return str(self.value)
+
 
 class ForeignKeyRelatedModel(models.Model):
     single_signal = models.ForeignKey(
@@ -24,6 +27,9 @@ class ForeignKeyRelatedModel(models.Model):
 
     objects = GloballyVisibleQuerySet.as_manager()
 
+    def __str__(self):
+        return str(self.id)
+
 
 @receiver(pre_save, sender=MySingleSignalModel)
 def increase_value_no_dispatch_uid(sender, instance, **kwargs):
@@ -33,6 +39,9 @@ def increase_value_no_dispatch_uid(sender, instance, **kwargs):
 class MyMultipleSignalModel(models.Model):
     value = models.PositiveIntegerField(default=0)
 
+    def __str__(self):
+        return str(self.value)
+
 
 @receiver(pre_save, sender=MyMultipleSignalModel, dispatch_uid='test.mysinglesignalmodel.increase_value_with_uuid')
 def increase_value_with_dispatch_uid(sender, instance, **kwargs):
@@ -50,34 +59,55 @@ def send_email(sender, instance, **kwargs):
 class CommonInfoBasedModel(CommonInfo):
     value = models.PositiveIntegerField(default=0)
 
+    def __str__(self):
+        return str(self.value)
+
 
 class ModelWithSelector(models.Model):
     value = models.PositiveIntegerField(default=0)
 
     objects = ModelWithSelectorQuerySet.as_manager()
     selectors = ModelWithSelectorGloballyVisibleSelector()
 
+    def __str__(self):
+        return str(self.value)
+
 
 class ModelWithFkToSelf(models.Model):
     parent = models.ForeignKey('self', blank=True, null=True, related_name='children', on_delete=models.CASCADE)
 
+    def __str__(self):
+        return str(self.id)
+
 
 class ModelWithOneToOneToSelf(models.Model):
     peer = models.OneToOneField('self', blank=True, null=True, related_name='related_peer', on_delete=models.CASCADE)
 
+    def __str__(self):
+        return str(self.id)
+
 
 class ModelWithCleanMixin(CleanOnSaveMixin, models.Model):
     def clean(self):
         return True
 
+    def __str__(self):
+        return str(self.id)
+
 
 class MyPermissionModelMixin(PermissionModelMixin, models.Model):
     pass
 
+    def __str__(self):
+        return str(self.id)
+
 
 class ModelWithSaveWithoutSignalsMixin(SaveWithoutSignalsMixin, models.Model):
     value = models.PositiveIntegerField(default=0)
 
+    def __str__(self):
+        return str(self.value)
+
 
 @receiver(pre_save, sender=ModelWithSaveWithoutSignalsMixin)
 def increase_value_on_pre_save(sender, instance, **kwargs):

docs/features/tests.md

@@ -13,7 +13,7 @@
 class CommonInfoBasedModelForm(forms.ModelForm):
     class Meta:
         model = CommonInfoBasedModel
-        exclude = ()
+        fields = ('value',)
 
 
 class TestCommonInfoAdminMixinAdmin(CommonInfoAdminMixin, admin.ModelAdmin):