Use pytest-playwright

.github/workflows/test.yml

@@ -92,7 +92,7 @@ jobs:
 
       - name: Run the tests
         if: ${{ ! startsWith(runner.os, 'Linux') }}
-        run: BETTY_TEST_SKIP_SHELLCHECK=true BETTY_TEST_SKIP_RUFF=true BETTY_TEST_SKIP_MYPY=true BETTY_TEST_SKIP_STYLELINT=true BETTY_TEST_SKIP_ESLINT=true BETTY_TEST_SKIP_PLAYWRIGHT=true ./bin/test
+        run: BETTY_TEST_SKIP_SHELLCHECK=true BETTY_TEST_SKIP_RUFF=true BETTY_TEST_SKIP_MYPY=true BETTY_TEST_SKIP_STYLELINT=true BETTY_TEST_SKIP_ESLINT=true ./bin/test
         shell: bash
 
       - name: Upload code coverage

betty/test_utils/conftest.py

@@ -16,6 +16,7 @@
 from typing import TYPE_CHECKING
 
 import pytest
+from playwright.async_api import async_playwright, Playwright
 
 from betty.app import App
 from betty.cache.file import BinaryFileCache
@@ -40,3 +41,10 @@ async def new_temporary_app() -> AsyncIterator[App]:
     """
     async with App.new_temporary() as app, app:
         yield app
+
+
+@pytest.fixture(scope="session")
+async def playwright() -> AsyncIterator[Playwright]:
+    pw = await async_playwright().start()
+    yield pw
+    await pw.stop()

betty/tests/project/extension/cotton_candy/test_search.py

@@ -378,4 +378,4 @@ async def test_build_private_file(self, new_temporary_app: App) -> None:
                     DEFAULT_LOCALIZER,
                 ).build()
 
-                assert actual == []
+                assert actual == []

betty/tests/project/extension/cotton_candy/test_search_ui.py

@@ -0,0 +1,35 @@
+import pytest
+from playwright.async_api import expect, Page
+
+from betty import serve
+from betty.ancestry.person import Person
+from betty.ancestry.person_name import PersonName
+from betty.project import Project
+from betty.project.extension.cotton_candy import CottonCandy
+
+
+class TestSearch:
+    @pytest.mark.asyncio(loop_scope="session")
+    async def test(self, page: Page) -> None:
+        # @todo Finish this
+        raise AssertionError
+        person_id = "I0001"
+        person = Person(id=person_id)
+        person_individual_name = "Janet"
+        PersonName(individual=person_individual_name, person=person)
+        async with Project.new_temporary(new_temporary_app) as project:
+            await project.configuration.extensions.enable(CottonCandy)
+            project.ancestry[Person].add(person)
+            async with (
+                project,
+                await serve.BuiltinProjectServer.new_for_project(project) as server,
+            ):
+                page.goto(server.public_url)
+                search_query = page.locator("#search-query")
+                search_query.fill(person_individual_name)
+                search_query.press("ArrowDown")
+                expect(page.locator("#search-results")).to_be_visible()
+                page.keyboard.press("ArrowDown")
+                page.locator(":focus").press("Enter")
+                assert page.url == f"{server.public_url}/person/{person.id}/index.html"
+                page.close()

bin/build-ci

@@ -10,4 +10,3 @@ pip install '.[ci]'
 # Install JavaScript dependencies.
 npm install
 npm install --no-save "@types/node@$(node -e 'console.log(process.versions.node.split(".")[0])')"
-npx playwright install --with-deps

bin/build-dev-npm

@@ -7,6 +7,3 @@ cd "$(dirname "$0")/.."
 # Install JavaScript dependencies.
 npm install
 npm install --no-save "@types/node@$(node -e 'console.log(process.versions.node.split(".")[0])')"
-# Install Playwright browser dependencies, but allow those
-# to fail as Playwright runs on very few systems only.
-npx playwright install --with-deps || true

bin/build-dev-pip

@@ -6,3 +6,6 @@ cd "$(dirname "$0")/.."
 
 # Install Python dependencies.
 pip install -e '.[development]'
+# Install Playwright browser dependencies, but allow those
+# to fail as Playwright runs on very few systems only.
+playwright install --with-deps || true

bin/fix

@@ -12,4 +12,4 @@ ruff format .
 ./node_modules/.bin/stylelint --fix "./betty/**/*.css" "./betty/**/*.scss"
 
 # Fix JS code style violations.
-./node_modules/.bin/eslint --fix -c ./eslint.config.js ./betty ./playwright
+./node_modules/.bin/eslint --fix -c ./eslint.config.js ./betty

bin/test

@@ -22,7 +22,4 @@ if [ -z "${BETTY_TEST_SKIP_ESLINT-}" ]; then
   ./bin/test-eslint
 fi
 ./bin/test-pytest
-if [ -z "${BETTY_TEST_SKIP_PLAYWRIGHT-}" ]; then
-  ./bin/test-playwright
-fi
 ./bin/test-build-setuptools

bin/test-eslint

@@ -6,4 +6,4 @@ cd "$(dirname "$0")/.."
 
 echo 'Running ESLint...'
 
-./node_modules/.bin/eslint -c ./eslint.config.js ./betty ./playwright "$@"
+./node_modules/.bin/eslint -c ./eslint.config.js ./betty "$@"

documentation/development/betty/commands.rst

@@ -24,8 +24,6 @@ Helpful commands
     Run `ESLint <https://eslint.org/>`_ tests.
 ``./bin/test-mypy``
     Run `mypy <https://www.mypy-lang.org/>`_ tests.
-``./bin/test-playwright``
-    Run `Playwright <https://playwright.dev>`_ tests.
 ``./bin/test-pytest``
     Run `pytest <https://docs.pytest.org/en/stable/>`_ tests.
 ``./bin/test-ruff``

documentation/development/betty/test.rst

@@ -13,7 +13,6 @@ These impact the ``./bin/test`` command:
 * ``BETTY_TEST_SKIP_MYPY=true``: Skip mypy tests.
 * ``BETTY_TEST_SKIP_STYLELINT=true``: Skip Stylelint tests.
 * ``BETTY_TEST_SKIP_ESLINT=true``: Skip ESLint tests.
-* ``BETTY_TEST_SKIP_PLAYWRIGHT=true``: Skip Playwright tests.
 
 Fixing problems automatically
 -----------------------------

eslint.config.js

@@ -3,7 +3,6 @@
 import eslint from '@eslint/js'
 import stylistic from '@stylistic/eslint-plugin'
 import globals from 'globals'
-import playwright from 'eslint-plugin-playwright'
 import tseslint from 'typescript-eslint'
 
 const typescriptFiles = [
@@ -39,15 +38,6 @@ export default [
         },
     },
 
-    // Playwright tests.
-    {
-        files: [
-            'playwright/tests/**',
-        ],
-        ...playwright.configs['flat/recommended'],
-
-    },
-
     // Generic EcmaScript.
   {
     plugins: {

package.json

@@ -3,7 +3,6 @@
     "node": ">= 20"
   },
   "devDependencies": {
-    "@playwright/test": "^1.49.0",
     "@stylistic/eslint-plugin": "^2.10.1",
     "@types/node": "*",
     "@types/webpack": "^5.28.5",
@@ -15,7 +14,6 @@
     "eslint": "^9.15.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-n": "^17.13.2",
-    "eslint-plugin-playwright": "^2.1.0",
     "eslint-plugin-promise": "^7.1.0",
     "stylelint": "^16.10.0",
     "stylelint-config-standard": "^36.0.1",

pyproject.toml

@@ -212,6 +212,7 @@ test = [
     'pytest-aioresponses ~= 0.2',
     'pytest-asyncio ~= 0.24',
     'pytest-mock ~= 3.14',
+    'pytest-playwright-asyncio ~= 9.9.9',
     'requests ~= 2.32',
     'ruff ~= 0.7',
     'types-aiofiles ~= 24.1',