Turn navigate_to_page into a decorator

Author: Archmonger

pyproject.toml

@@ -95,6 +95,8 @@ extra-dependencies = [
   "tblib",
   "servestatic",
   "django-bootstrap5",
+  "decorator",
+
 ]
 matrix-name-format = "{variable}-{value}"
 # TODO: Remove the `retries` value once we fix flakiness of `test_sync_form_events`

tests/test_app/tests/test_components.py

@@ -585,9 +585,8 @@ def test_offline_components(self):
 
 
 class FormTests(PlaywrightTestCase):
+    @navigate_to_page("/form/")
     def test_basic_form(self):
-        navigate_to_page(self, "/form/")
-
         try:
             from test_app.models import TodoItem
 
@@ -682,9 +681,8 @@ def test_basic_form(self):
         # Make sure no errors remain
         assert len(self.page.query_selector_all(".errorlist")) == 0
 
+    @navigate_to_page("/form/bootstrap/")
     def test_bootstrap_form(self):
-        navigate_to_page(self, "/form/bootstrap/")
-
         try:
             from test_app.models import TodoItem
 
@@ -780,9 +778,8 @@ def test_bootstrap_form(self):
         # Make sure no errors remain
         assert len(self.page.query_selector_all(".invalid-feedback")) == 0
 
+    @navigate_to_page("/form/model/")
     def test_model_form(self):
-        navigate_to_page(self, "/form/model/")
-
         uuid = uuid4().hex
         self.page.wait_for_selector("form")
 
@@ -816,8 +813,8 @@ def test_model_form(self):
         finally:
             os.environ.pop("DJANGO_ALLOW_ASYNC_UNSAFE")
 
+    @navigate_to_page("/form/sync_event/")
     def test_sync_form_events(self):
-        navigate_to_page(self, "/form/sync_event/")
         self.page.wait_for_selector("form")
 
         # Check initial state
@@ -846,8 +843,8 @@ def test_sync_form_events(self):
         self.page.wait_for_selector("#receive_data[data-value='true']")
         self.page.wait_for_selector("#change[data-value='true']")
 
+    @navigate_to_page("/form/async_event/")
     def test_async_form_events(self):
-        navigate_to_page(self, "/form/async_event/")
         self.page.wait_for_selector("form")
 
         # Check initial state

tests/test_app/tests/utils.py

@@ -3,7 +3,9 @@
 import os
 import sys
 from functools import partial
+from typing import Callable
 
+import decorator
 from channels.testing import ChannelsLiveServerTestCase
 from channels.testing.live import make_application
 from django.core.exceptions import ImproperlyConfigured
@@ -89,7 +91,14 @@ def _post_teardown(self):
         occurring due to a bug within `ChannelsLiveServerTestCase`."""
 
 
-def navigate_to_page(self: PlaywrightTestCase, path: str):
-    """Redirect the page's URL to the given link, if the page is not already there."""
-    if self.page.url != path:
-        self.page.goto(f"http://{self.host}:{self._port}/{path.lstrip('/')}")
+def navigate_to_page(path: str):
+    def _decorator(func: Callable):
+        @decorator.decorator
+        def _wrapper(func: Callable, self: PlaywrightTestCase, *args, **kwargs):
+            if self.page.url != path:
+                self.page.goto(f"http://{self.host}:{self._port}/{path.lstrip('/')}")
+            return func(self, *args, **kwargs)
+
+        return _wrapper(func)
+
+    return _decorator