Merge pull request #1330 from maykinmedia/disable-django-admin-index-fixture-loading-during-testing

Disable loading of admin-index fixture in testing

Author: swrichards

src/open_inwoner/accounts/apps.py

@@ -1,3 +1,4 @@
+import logging
 from io import StringIO
 
 from django.apps import AppConfig, apps
@@ -6,10 +7,18 @@
 from django.core.management import call_command
 from django.db.models.signals import post_migrate
 
+logger = logging.getLogger(__name__)
+
 
 def update_admin_index(sender=None, **kwargs) -> bool:
     if "django_admin_index" not in settings.INSTALLED_APPS:
-        print("django_admin_index not installed, skipping update_admin_index()")
+        logger.info("django_admin_index not installed, skipping update_admin_index()")
+        return False
+
+    if getattr(settings, "SKIP_ADMIN_INDEX_FIXTURE", False):
+        logger.info(
+            "SKIP_ADMIN_INDEX_FIXTURE is set to True, skipping update_admin_index()"
+        )
         return False
 
     from django_admin_index.models import AppGroup
@@ -32,18 +41,21 @@ def update_admin_index(sender=None, **kwargs) -> bool:
     try:
         call_command("loaddata", "django-admin-index", verbosity=0, stdout=StringIO())
     except Exception as exc:
-        print(f"Error: Unable to load django-admin-index fixture ({exc})")
+        error_message = f"Error: Unable to load django-admin-index fixture ({exc})"
+
         if ct_create_exceptions:
             ct_exc = ExceptionGroup(
                 "Unable to create contenttypes", *ct_create_exceptions
             )
-            print(
+            error_message += (
                 "NOTE: this may be a consequence of being unable to create the following "
                 f"contenttypes: {ct_exc}"
             )
+
+        logger.error(error_message)
         return False
     else:
-        print("Successfully loaded django-admin-index fixture")
+        logger.info("Successfully loaded django-admin-index fixture")
         return True
 
 

src/open_inwoner/accounts/tests/test_admin_index_fixture.py

@@ -73,3 +73,7 @@
 PASSWORD_HASHERS = [
     "django.contrib.auth.hashers.MD5PasswordHasher",
 ]
+
+# Sip the auto-loading of the django-admin-index fixture on startup.
+# It doesn't add anything in CI, and just adds time to the run.
+SKIP_ADMIN_INDEX_FIXTURE = True

src/open_inwoner/conf/ci.py

@@ -1,12 +1,13 @@
 from django.core.management import call_command
-from django.test import TestCase
+from django.db.models.signals import post_migrate
+from django.test import TestCase, override_settings
 
 from open_inwoner.accounts.apps import update_admin_index
 
 
 class FixtureTests(TestCase):
     def test_admin_index(self):
-        self.assertTrue(update_admin_index())
+        call_command("loaddata", "django-admin-index")
 
     def test_cms_pages(self):
         # pass if this doesn't raise anything
@@ -23,3 +24,20 @@ def test_mail_editor(self):
     def test_profile_apphook_config(self):
         # pass if this doesn't raise anything
         call_command("loaddata", "profile_apphook_config")
+
+
+class AutoLoadDjangoAdminIndexFixtureTests(TestCase):
+    def test_update_admin_index_hook_is_not_registered_if_skip_flag_is_unset(self):
+        self.assertTrue(update_admin_index())
+
+    @override_settings(SKIP_ADMIN_INDEX_FIXTURE=False)
+    def test_update_admin_index_hook_is_not_registered_if_skip_flag_is_false(self):
+        self.assertTrue(update_admin_index())
+
+    @override_settings(SKIP_ADMIN_INDEX_FIXTURE=True)
+    def test_update_admin_index_hook_is_registered_if_skip_flag_is_true(self):
+        self.assertFalse(update_admin_index())
+
+    def test_update_admin_index_hook_is_registered(self):
+        connected_functions = [receiver[1]() for receiver in post_migrate.receivers]
+        self.assertIn(update_admin_index, connected_functions)