Get the hatch test command working

Author: Archmonger

.github/workflows/test-python.yml

@@ -28,4 +28,4 @@ jobs:
             - name: Install Python Dependencies
               run: pip install --upgrade pip hatch uv
             - name: Run Tests
-              run: hatch run test:python --python ${{ matrix.python-version }}
+              run: hatch test --python ${{ matrix.python-version }}

pyproject.toml

@@ -78,28 +78,68 @@ commands = [
 artifacts = []
 
 # >>> Hatch Test Suite <<<
-[tool.hatch.envs.test]
-detached = true
+[tool.hatch.envs.hatch-test]
 extra-dependencies = [
+  "pytest-sugar",
+  "pytest-django",
   "playwright",
-  "twisted",
   "channels[daphne]>=4.0.0",
+  "twisted",
   "tblib",
-  "whitenoise",              # TODO: Switch to ServeStatic
+  "servestatic",
 ]
+matrix-name-format = "{variable}-{value}"
+
+# Django 4.2
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.9", "3.10", "3.11", "3.12"]
+django = ["4.2"]
+
+# Django 5.0
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.10", "3.11", "3.12"]
+django = ["5.0"]
+
+# Django 5.1
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.10", "3.11", "3.12", "3.13"]
+django = ["5.1"]
+
+[tool.hatch.envs.hatch-test.overrides]
+matrix.django.dependencies = [
+  { if = [
+    "4.2",
+  ], value = "django~=4.2" },
+  { if = [
+    "5.0",
+  ], value = "django~=5.0" },
+  { if = [
+    "5.1",
+  ], value = "django~=5.1" },
+]
+
+[tool.pytest.ini_options]
+addopts = """\
+    --strict-config
+    --strict-markers
+    --reuse-db
+    """
+django_find_project = false
+DJANGO_SETTINGS_MODULE = "test_app.settings_single_db"
+pythonpath = [".", "tests/"]
 
-[tool.hatch.envs.test.scripts]
-python = [
-  "pip install -e . -U",
-  "playwright install chromium",
-  "cd tests && python manage.py test --noinput --settings='test_app.settings_single_db'",
-  "cd tests && python manage.py test --noinput --settings='test_app.settings_multi_db'",
+
+# >>> Hatch Django Scripts <<<
+[tool.hatch.envs.django]
+extra-dependencies = ["channels[daphne]>=4.0.0", "twisted", "servestatic"]
+
+[tool.hatch.envs.django.scripts]
+runserver = [
+  "cd tests && python manage.py migrate --noinput && python manage.py runserver",
 ]
-runserver = ["cd tests && python manage.py runserver"]
 
 
 # >>> Hatch Documentation Scripts <<<
-
 [tool.hatch.envs.docs]
 template = "docs"
 detached = true
@@ -138,7 +178,6 @@ detached = true
 check = ["cd src/js && bun install && bun run check"]
 
 # >>> Generic Tools <<<
-
 [tool.ruff]
 extend-exclude = ["*/migrations/*", ".venv/*", ".eggs/*", ".nox/*", "build/*"]
 line-length = 120
@@ -156,9 +195,3 @@ lint.extend-ignore = [
 ]
 lint.preview = true
 lint.isort.known-first-party = ["src", "tests"]
-
-[tool.pytest.ini_options]
-addopts = """\
-    --strict-config
-    --strict-markers
-    """

tests/test_app/prerender/components.py

@@ -1,14 +1,19 @@
 from time import sleep
 
-import reactpy_django
 from reactpy import component, html
 
+import reactpy_django
+
+SLEEP_TIME = 0.25
+
 
 @component
 def prerender_string():
     scope = reactpy_django.hooks.use_scope()
 
-    sleep(0.5)
+    if scope.get("type") != "http":
+        sleep(SLEEP_TIME)
+
     return (
         "prerender_string: Fully Rendered"
         if scope.get("type") == "websocket"

tests/test_app/settings_multi_db.py

@@ -12,9 +12,9 @@
 SECRET_KEY = "django-insecure-n!bd1#+7ufw5#9ipayu9k(lyu@za$c2ajbro7es(v8_7w1$=&c"
 
 # Run in production mode when using a real web server
-DEBUG = all(
-    not sys.argv[0].endswith(webserver_name)
-    for webserver_name in {"hypercorn", "uvicorn", "daphne"}
+DEBUG = not any(
+    sys.argv[0].endswith(webserver_name)
+    for webserver_name in ["hypercorn", "uvicorn", "daphne"]
 )
 ALLOWED_HOSTS = ["*"]
 
@@ -66,39 +66,26 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        # Changing NAME is needed due to a bug related to `manage.py test`
-        "NAME": os.path.join(
-            BASE_DIR,
-            f"test_{DB_NAME}.sqlite3" if "test" in sys.argv else f"{DB_NAME}.sqlite3",
-        ),
+        "NAME": os.path.join(BASE_DIR, f"{DB_NAME}.sqlite3"),
         "TEST": {
-            "NAME": os.path.join(BASE_DIR, f"test_{DB_NAME}.sqlite3"),
+            "NAME": os.path.join(BASE_DIR, f"{DB_NAME}.sqlite3"),
             "OPTIONS": {"timeout": 20},
             "DEPENDENCIES": [],
         },
         "OPTIONS": {"timeout": 20},
     },
-}
-if "test" in sys.argv:
-    DATABASES["reactpy"] = {
+    "reactpy": {
         "ENGINE": "django.db.backends.sqlite3",
-        # Changing NAME is needed due to a bug related to `manage.py test`
-        "NAME": os.path.join(
-            BASE_DIR,
-            (
-                f"test_{DB_NAME}_2.sqlite3"
-                if "test" in sys.argv
-                else f"{DB_NAME}_2.sqlite3"
-            ),
-        ),
+        "NAME": os.path.join(BASE_DIR, f"{DB_NAME}_2.sqlite3"),
         "TEST": {
-            "NAME": os.path.join(BASE_DIR, f"test_{DB_NAME}_2.sqlite3"),
+            "NAME": os.path.join(BASE_DIR, f"{DB_NAME}_2.sqlite3"),
             "OPTIONS": {"timeout": 20},
             "DEPENDENCIES": [],
         },
         "OPTIONS": {"timeout": 20},
-    }
-    REACTPY_DATABASE = "reactpy"
+    },
+}
+REACTPY_DATABASE = "reactpy"
 DATABASE_ROUTERS = ["reactpy_django.database.Router"]
 
 # Cache
@@ -161,4 +148,6 @@
 CHANNEL_LAYERS = {"default": {"BACKEND": "channels.layers.InMemoryChannelLayer"}}
 
 # ReactPy-Django Settings
-REACTPY_BACKHAUL_THREAD = "test" not in sys.argv and "runserver" not in sys.argv
+REACTPY_BACKHAUL_THREAD = any(
+    sys.argv[0].endswith(webserver_name) for webserver_name in ["hypercorn", "uvicorn"]
+)

tests/test_app/settings_single_db.py

@@ -12,9 +12,9 @@
 SECRET_KEY = "django-insecure-n!bd1#+7ufw5#9ipayu9k(lyu@za$c2ajbro7es(v8_7w1$=&c"
 
 # Run in production mode when using a real web server
-DEBUG = all(
-    not sys.argv[0].endswith(webserver_name)
-    for webserver_name in {"hypercorn", "uvicorn", "daphne"}
+DEBUG = not any(
+    sys.argv[0].endswith(webserver_name)
+    for webserver_name in ["hypercorn", "uvicorn", "daphne"]
 )
 ALLOWED_HOSTS = ["*"]
 
@@ -66,13 +66,9 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        # Changing NAME is needed due to a bug related to `manage.py test`
-        "NAME": os.path.join(
-            BASE_DIR,
-            f"test_{DB_NAME}.sqlite3" if "test" in sys.argv else f"{DB_NAME}.sqlite3",
-        ),
+        "NAME": os.path.join(BASE_DIR, f"{DB_NAME}.sqlite3"),
         "TEST": {
-            "NAME": os.path.join(BASE_DIR, f"test_{DB_NAME}.sqlite3"),
+            "NAME": os.path.join(BASE_DIR, f"{DB_NAME}.sqlite3"),
             "OPTIONS": {"timeout": 20},
             "DEPENDENCIES": [],
         },
@@ -140,4 +136,6 @@
 CHANNEL_LAYERS = {"default": {"BACKEND": "channels.layers.InMemoryChannelLayer"}}
 
 # ReactPy-Django Settings
-REACTPY_BACKHAUL_THREAD = "test" not in sys.argv and "runserver" not in sys.argv
+REACTPY_BACKHAUL_THREAD = any(
+    sys.argv[0].endswith(webserver_name) for webserver_name in ["hypercorn", "uvicorn"]
+)

tests/test_app/tests/__init__.py

@@ -1 +0,0 @@
-from . import *  # noqa: F401, F403

tests/test_app/tests/conftest.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+import pytest
+
+os.chdir(Path(__file__).parent.parent.parent)
+
+
+@pytest.fixture(autouse=True)
+def enable_db_access_for_all_tests(db):
+    pass

tests/test_app/tests/test_components.py

@@ -21,7 +21,6 @@
 
 
 class ComponentTests(ChannelsLiveServerTestCase):
-    from django.db import DEFAULT_DB_ALIAS
 
     from reactpy_django import config
 
@@ -71,6 +70,8 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
+        from django.db import DEFAULT_DB_ALIAS
+
         from reactpy_django import config
 
         # Close the Playwright browser
@@ -86,7 +87,7 @@ def tearDownClass(cls):
 
         # Repurposed from ChannelsLiveServerTestCase._post_teardown
         cls._live_server_modified_settings.disable()
-        for db_name in {"default", config.REACTPY_DATABASE}:
+        for db_name in [DEFAULT_DB_ALIAS, config.REACTPY_DATABASE]:
             call_command(
                 "flush",
                 verbosity=0,
@@ -369,13 +370,12 @@ def test_prerender(self):
             use_user_http = new_page.locator("#use-user-http[data-success=True]")
             use_user_ws = new_page.locator("#use-user-ws[data-success=true]")
 
+            # Check if the prerender occurred properly
             string.wait_for()
             vdom.wait_for()
             component.wait_for()
             use_root_id_http.wait_for()
             use_user_http.wait_for()
-
-            # Check if the prerender occurred
             self.assertEqual(
                 string.all_inner_texts(), ["prerender_string: Prerendered"]
             )
@@ -387,7 +387,7 @@ def test_prerender(self):
             self.assertEqual(len(root_id_value), 36)
 
             # Check if the full render occurred
-            sleep(1)
+            sleep(2)
             self.assertEqual(
                 string.all_inner_texts(), ["prerender_string: Fully Rendered"]
             )

tests/test_app/tests/test_database.py

@@ -4,6 +4,7 @@
 
 import dill as pickle
 from django.test import TransactionTestCase
+
 from reactpy_django import clean
 from reactpy_django.models import ComponentSession, UserDataModel
 from reactpy_django.types import ComponentParams

tests/test_app/tests/test_regex.py

@@ -1,6 +1,7 @@
 import re
 
 from django.test import TestCase
+
 from reactpy_django.utils import COMMENT_REGEX, COMPONENT_REGEX
 
 
@@ -21,10 +22,10 @@ def test_component_regex(self):
         )
         self.assertRegex(
             r"""{%
-            component   
-            "my.component"  
-            class="my_thing"  
-            attr="attribute"  
+            component
+            "my.component"
+            class="my_thing"
+            attr="attribute"
 
         %}""",  # noqa: W291
             COMPONENT_REGEX,
@@ -84,10 +85,10 @@ def test_comment_regex(self):
             COMMENT_REGEX,
         )
         self.assertRegex(
-            r"""<!-- 
+            r"""<!--
         a comment
         another comments
-        drink some cement 
+        drink some cement
         -->""",  # noqa: W291
             COMMENT_REGEX,
         )
@@ -138,8 +139,8 @@ def test_comment_regex(self):
             COMMENT_REGEX.sub(
                 "",
                 r"""<!--
-            {% component "my.component" %} 
-            {% component "my.component" %} 
+            {% component "my.component" %}
+            {% component "my.component" %}
             -->""",  # noqa: W291
             ),
             "",