config error if urls loaded too early

wq · Jun 14, 2023 · b04f8f9 · b04f8f9
1 parent 031b082
commit b04f8f9
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 9 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,7 +15,7 @@ jobs:
         django-version: [4.2.2]
         drf-version: [3.14.0]
         variant: ['']
-        backend: [threading, immediate, celery]
+        backend: [threading, immediate, celery, broken]
         include:
 
         # Alternate configurations
@@ -108,7 +108,14 @@ jobs:
         python -c "import tests"
         celery -A tests worker &
     - name: Test with unittest
+      if: ${{ matrix.variant != 'broken' }}
       run: python -m unittest discover -s tests -t . -v
+    - name: Test broken URL message
+      if: ${{ matrix.variant == 'broken' }}
+      run: |
+        set +e
+        python -m unittest discover -s tests -t . -v
+        test $? -eq 1
     - name: Test build
       run: python -m build
   npm:

diff --git a/data_wizard/urls.py b/data_wizard/urls.py
@@ -1,5 +1,14 @@
 from rest_framework import routers
+from django.core.exceptions import ImproperlyConfigured
 from .views import RunViewSet
+from . import discovered
+
+
+if not discovered:
+    raise ImproperlyConfigured(
+        "data_wizard.urls imported before data_wizard.autodiscover(). "
+        "Try moving data_wizard to an earlier position in INSTALLED_APPS."
+    )
 
 
 router = routers.SimpleRouter()

diff --git a/tests/settings.py b/tests/settings.py
@@ -47,6 +47,25 @@
     REVERSION_APPS = tuple()
 
 
+if TEST_VARIANT == "broken":
+    APP_ORDER = (
+        "tests.data_app",
+        "tests.naturalkey_app",
+        "tests.eav_app",
+        "tests.source_app",
+        "data_wizard",
+        "data_wizard.sources",
+    )
+else:
+    APP_ORDER = (
+        "tests.data_app",
+        "tests.naturalkey_app",
+        "tests.eav_app",
+        "data_wizard",
+        "data_wizard.sources",
+        "tests.source_app",
+    )
+
 INSTALLED_APPS = (
     (
         "django.contrib.contenttypes",
@@ -57,14 +76,7 @@
     )
     + WQ_APPS
     + REVERSION_APPS
-    + (
-        "data_wizard",
-        "data_wizard.sources",
-        "tests.data_app",
-        "tests.naturalkey_app",
-        "tests.eav_app",
-        "tests.source_app",
-    )
+    + APP_ORDER
 )
 
 

diff --git a/tests/source_app/apps.py b/tests/source_app/apps.py
@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+
+
+class CustomURLConfig(AppConfig):
+    name = "tests.source_app"
+
+    def ready(self):
+        import tests.urls