Move test dep configuration out of Pytest and into Hatch

Author: Archmonger

pyproject.toml

@@ -88,6 +88,13 @@ artifacts = []
 #############################
 # >>> Hatch Test Runner <<< #
 #############################
+[tool.hatch.envs.hatch-test.scripts]
+run = [
+  "hatch --env default build -t wheel",
+  "playwright install chromium",
+  "playwright install-deps",
+  "pytest{env:HATCH_TEST_ARGS:} {args}",
+]
 
 [tool.hatch.envs.hatch-test]
 extra-dependencies = [
@@ -98,7 +105,6 @@ extra-dependencies = [
   "exceptiongroup",
   "jsonpointer",
   "starlette",
-  "filelock",
 ]
 features = ["all"]
 

src/build_scripts/clean_js_dir.py

@@ -11,6 +11,8 @@
 import pathlib
 import shutil
 
+print("Cleaning JS source directory...")  # noqa: T201
+
 # Get the path to the JS source directory
 js_src_dir = pathlib.Path(__file__).parent.parent / "js"
 static_output_dir = pathlib.Path(__file__).parent.parent / "reactpy" / "static"

src/reactpy/testing/__init__.py

@@ -1,10 +1,5 @@
 from reactpy.testing.backend import BackendFixture
-from reactpy.testing.common import (
-    HookCatcher,
-    StaticEventHandler,
-    clear_reactpy_web_modules_dir,
-    poll,
-)
+from reactpy.testing.common import HookCatcher, StaticEventHandler, poll
 from reactpy.testing.display import DisplayFixture
 from reactpy.testing.logs import (
     LogAssertionError,
@@ -22,6 +17,5 @@
     "assert_reactpy_did_log",
     "assert_reactpy_did_not_log",
     "capture_reactpy_logs",
-    "clear_reactpy_web_modules_dir",
     "poll",
 ]

src/reactpy/testing/common.py

@@ -3,26 +3,18 @@
 import asyncio
 import inspect
 import os
-import shutil
 import time
 from collections.abc import Awaitable, Callable, Coroutine
 from functools import wraps
 from typing import Any, Generic, ParamSpec, TypeVar, cast
 from uuid import uuid4
 from weakref import ref
 
-from reactpy.config import REACTPY_TESTS_DEFAULT_TIMEOUT, REACTPY_WEB_MODULES_DIR
+from reactpy.config import REACTPY_TESTS_DEFAULT_TIMEOUT
 from reactpy.core._life_cycle_hook import HOOK_STACK, LifeCycleHook
 from reactpy.core.events import EventHandler, to_event_handler_function
 from reactpy.utils import str_to_bool
 
-
-def clear_reactpy_web_modules_dir() -> None:
-    """Clear the directory where ReactPy stores registered web modules"""
-    for path in REACTPY_WEB_MODULES_DIR.current.iterdir():
-        shutil.rmtree(path) if path.is_dir() else path.unlink()
-
-
 _P = ParamSpec("_P")
 _R = TypeVar("_R")
 

tests/conftest.py

@@ -1,12 +1,9 @@
 from __future__ import annotations
 
-import contextlib
 import os
-import subprocess
 
 import pytest
 from _pytest.config.argparsing import Parser
-from filelock import FileLock
 
 from reactpy.config import (
     REACTPY_ASYNC_RENDERING,
@@ -16,7 +13,6 @@
     BackendFixture,
     DisplayFixture,
     capture_reactpy_logs,
-    clear_reactpy_web_modules_dir,
 )
 from reactpy.testing.common import GITHUB_ACTIONS
 
@@ -33,59 +29,6 @@ def pytest_addoption(parser: Parser) -> None:
     )
 
 
-def headless_environ(pytestconfig: pytest.Config):
-    if (
-        pytestconfig.getoption("headless")
-        or os.environ.get("PLAYWRIGHT_HEADLESS") == "1"
-        or GITHUB_ACTIONS
-    ):
-        os.environ["PLAYWRIGHT_HEADLESS"] = "1"
-        return True
-    return False
-
-
-def get_lock_dir(tmp_path_factory, worker_id):
-    if worker_id == "master":
-        return tmp_path_factory.getbasetemp()
-    return tmp_path_factory.getbasetemp().parent
-
-
-@pytest.fixture(autouse=True, scope="session")
-def install_playwright(tmp_path_factory, worker_id):
-    root_tmp_dir = get_lock_dir(tmp_path_factory, worker_id)
-    fn = root_tmp_dir / "playwright_install.lock"
-    flag = root_tmp_dir / "playwright_install.done"
-
-    with FileLock(str(fn)):
-        if not flag.exists():
-            subprocess.run(["playwright", "install", "chromium"], check=True)  # noqa: S607
-            # Try to install system deps, but don't fail if already installed or no root access
-            with contextlib.suppress(subprocess.CalledProcessError):
-                subprocess.run(["playwright", "install-deps"], check=True)  # noqa: S607
-            flag.touch()
-
-
-@pytest.fixture(autouse=True, scope="session")
-def rebuild(tmp_path_factory, worker_id):
-    # When running inside `hatch test`, the `HATCH_ENV_ACTIVE` environment variable
-    # is set. If we try to run `hatch build` with this variable set, Hatch will
-    # complain that the current environment is not a builder environment.
-    # To fix this, we remove `HATCH_ENV_ACTIVE` from the environment variables
-    # passed to the subprocess.
-    env = os.environ.copy()
-    env.pop("HATCH_ENV_ACTIVE", None)
-
-    root_tmp_dir = get_lock_dir(tmp_path_factory, worker_id)
-    fn = root_tmp_dir / "build.lock"
-    flag = root_tmp_dir / "build.done"
-
-    # Whoever gets the lock first performs the build.
-    with FileLock(str(fn)):
-        if not flag.exists():
-            subprocess.run(["hatch", "build", "-t", "wheel"], check=True, env=env)  # noqa: S607
-            flag.touch()
-
-
 @pytest.fixture(scope="session")
 async def display(server, browser):
     async with DisplayFixture(backend=server, browser=browser) as display:
@@ -103,12 +46,7 @@ async def browser(pytestconfig: pytest.Config):
     from playwright.async_api import async_playwright
 
     async with async_playwright() as pw:
-        yield await pw.chromium.launch(headless=headless_environ(pytestconfig))
-
-
-@pytest.fixture(autouse=True)
-def clear_web_modules_dir_after_test():
-    clear_reactpy_web_modules_dir()
+        yield await pw.chromium.launch(headless=_headless_environ(pytestconfig))
 
 
 @pytest.fixture(autouse=True)
@@ -121,3 +59,14 @@ def assert_no_logged_exceptions():
                     raise r.exc_info[1]
         finally:
             records.clear()
+
+
+def _headless_environ(pytestconfig: pytest.Config):
+    if (
+        pytestconfig.getoption("headless")
+        or os.environ.get("PLAYWRIGHT_HEADLESS") == "1"
+        or GITHUB_ACTIONS
+    ):
+        os.environ["PLAYWRIGHT_HEADLESS"] = "1"
+        return True
+    return False