start to switch test suite to playwright

Author: rmorshea

.github/workflows/test.yml

@@ -15,7 +15,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: nanasess/setup-chromedriver@master
       - uses: actions/setup-node@v2
         with:
           node-version: "14.x"
@@ -38,7 +37,6 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
       - uses: actions/checkout@v2
-      - uses: nanasess/setup-chromedriver@master
       - uses: actions/setup-node@v2
         with:
           node-version: "14.x"

noxfile.py

@@ -179,7 +179,7 @@ def test_python_suite(session: Session) -> None:
     """Run the Python-based test suite"""
     session.env["IDOM_DEBUG_MODE"] = "1"
     install_requirements_file(session, "test-env")
-
+    session.run("playwright install")
     posargs = session.posargs
     posargs += ["--reruns", "3", "--reruns-delay", "1"]
 

requirements/pkg-extras.txt

@@ -1,13 +1,13 @@
 # extra=stable,sanic
-sanic <19.12.0
+sanic
 sanic-cors
 
 # extra=fastapi
 fastapi >=0.63.0
 uvicorn[standard] >=0.13.4
 
 # extra=starlette
-fastapi >=0.16.0
+starlette >=0.13.6
 uvicorn[standard] >=0.13.4
 
 # extra=flask

requirements/test-env.txt

@@ -1,9 +1,9 @@
 ipython
 pytest
-pytest-asyncio
+pytest-asyncio>=0.17
 pytest-cov
 pytest-mock
 pytest-rerunfailures
 pytest-timeout
 responses
-selenium
+playwright

setup.cfg

@@ -24,7 +24,8 @@ testpaths = tests
 xfail_strict = True
 markers =
     slow: marks tests as slow (deselect with '-m "not slow"')
-python_files = assert_*.py test_*.py
+python_files = *asserts.py test_*.py
+asyncio_mode = auto
 
 [coverage:report]
 fail_under = 100

src/idom/sample.py

@@ -11,7 +11,7 @@
 
 @component
 def App() -> VdomDict:
-    return html._(
+    return html.div(
         {"style": {"padding": "15px"}},
         html.h1("Sample Application"),
         html.p(

tests/__init__.py

@@ -0,0 +1 @@
+from .utils.browser import Display

tests/conftest.py

@@ -1,27 +1,21 @@
 from __future__ import annotations
 
-import inspect
 import os
-from typing import Any, List
+from dataclasses import dataclass
+from typing import Awaitable, Callable, List
 
 import pytest
 from _pytest.config import Config
 from _pytest.config.argparsing import Parser
-from selenium.webdriver import Chrome, ChromeOptions
-from selenium.webdriver.support.ui import WebDriverWait
 
 import idom
-from idom.testing import (
-    ServerMountPoint,
-    clear_idom_web_modules_dir,
-    create_simple_selenium_web_driver,
-)
+from idom.testing import ServerMountPoint, clear_idom_web_modules_dir
+from tests.utils.browser import launch_browser, open_display
 
 
 def pytest_collection_modifyitems(
-    session: pytest.Session, config: pytest.config.Config, items: List[pytest.Item]
+    session: pytest.Session, config: Config, items: List[pytest.Item]
 ) -> None:
-    _mark_coros_as_async_tests(items)
     _skip_web_driver_tests_on_windows(items)
 
 
@@ -32,92 +26,25 @@ def pytest_addoption(parser: Parser) -> None:
         action="store_true",
         help="Whether to run browser tests in headless mode.",
     )
-    parser.addoption(
-        "--no-restore",
-        dest="restore_client",
-        action="store_false",
-        help="Whether to restore the client build before testing.",
-    )
 
 
 @pytest.fixture
-def display(driver, server_mount_point):
-    display_id = idom.Ref(0)
-
-    def mount_and_display(component_constructor, query=None, check_mount=True):
-        component_id = f"display-{display_id.set_current(display_id.current + 1)}"
-        server_mount_point.mount(
-            lambda: idom.html.div({"id": component_id}, component_constructor())
-        )
-        driver.get(server_mount_point.url(query=query))
-        if check_mount:
-            driver.find_element("id", component_id)
-        return component_id
-
-    yield mount_and_display
+async def display(browser):
+    async with open_display(browser, idom.server.any) as display:
+        yield display
 
 
 @pytest.fixture
-def driver_get(driver, server_mount_point):
-    return lambda query=None: driver.get(server_mount_point.url(query=query))
-
-
-@pytest.fixture
-async def server_mount_point():
-    """An IDOM layout mount function and server as a tuple
-
-    The ``mount`` and ``server`` fixtures use this.
-    """
-    async with ServerMountPoint() as mount_point:
-        yield mount_point
-
-
-@pytest.fixture(scope="module")
-def driver_wait(driver):
-    return WebDriverWait(driver, 3)
-
-
-@pytest.fixture(scope="module")
-def driver(create_driver) -> Chrome:
-    """A Selenium web driver"""
-    return create_driver()
-
-
-@pytest.fixture(scope="module")
-def create_driver(driver_is_headless):
-    """A Selenium web driver"""
-    drivers = []
-
-    def create(**kwargs: Any):
-        options = ChromeOptions()
-        options.headless = driver_is_headless
-        driver = create_simple_selenium_web_driver(driver_options=options, **kwargs)
-        drivers.append(driver)
-        return driver
-
-    yield create
-
-    for d in drivers:
-        d.quit()
-
-
-@pytest.fixture(scope="session")
-def driver_is_headless(pytestconfig: Config):
-    return bool(pytestconfig.option.headless)
+async def browser(pytestconfig: Config):
+    async with launch_browser(headless=bool(pytestconfig.option.headless)) as browser:
+        yield browser
 
 
 @pytest.fixture(autouse=True)
 def _clear_web_modules_dir_after_test():
     clear_idom_web_modules_dir()
 
 
-def _mark_coros_as_async_tests(items: List[pytest.Item]) -> None:
-    for item in items:
-        if isinstance(item, pytest.Function):
-            if inspect.iscoroutinefunction(item.function):
-                item.add_marker(pytest.mark.asyncio)
-
-
 def _skip_web_driver_tests_on_windows(items: List[pytest.Item]) -> None:
     if os.name == "nt":
         for item in items:

tests/driver_utils.py

@@ -4,7 +4,7 @@
 
 import idom
 from idom.testing import ServerMountPoint
-from tests.driver_utils import send_keys
+from tests.utils.browser import send_keys
 
 
 JS_DIR = Path(__file__).parent / "js"

tests/test_client.py

@@ -10,7 +10,7 @@
 from idom.core.serve import render_json_patch
 from idom.testing import HookCatcher, assert_idom_logged
 from idom.utils import Ref
-from tests.assert_utils import assert_same_items
+from tests.utils.asserts import assert_same_items
 
 
 async def test_must_be_rendering_in_layout_to_use_hooks():

tests/test_core/test_hooks.py

@@ -21,7 +21,7 @@
     capture_idom_logs,
 )
 from idom.utils import Ref
-from tests.assert_utils import assert_same_items
+from tests.utils.asserts import assert_same_items
 
 
 @pytest.fixture(autouse=True)

tests/test_core/test_layout.py

@@ -1,15 +1,7 @@
-from idom.sample import run_sample_app
+from idom.sample import App, run_sample_app
 from idom.server.utils import find_available_port
+from tests import Display
 
 
-def test_sample_app(driver):
-    host = "127.0.0.1"
-    port = find_available_port(host, allow_reuse_waiting_ports=False)
-
-    run_sample_app(host=host, port=port, run_in_thread=True)
-
-    driver.get(f"http://{host}:{port}")
-
-    h1 = driver.find_element("tag name", "h1")
-
-    assert h1.get_attribute("innerHTML") == "Sample Application"
+async def test_sample_app(display: Display):
+    await display.show(App)

tests/test_sample.py

@@ -7,7 +7,7 @@
 from idom.server import sanic as idom_sanic
 from idom.server import starlette as idom_starlette
 from idom.testing import ServerMountPoint
-from tests.driver_utils import no_such_element
+from tests.utils.browser import no_such_element
 
 
 @pytest.fixture(

tests/test_server/test_common/test_multiview.py

@@ -4,7 +4,7 @@
 from selenium.webdriver.common.keys import Keys
 
 import idom
-from tests.driver_utils import send_keys
+from tests.utils.browser import send_keys
 
 
 HERE = Path(__file__).parent

tests/test_widgets.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from contextlib import asynccontextmanager
+from typing import Any
+
+from playwright.async_api import Browser, Page, async_playwright
+
+from idom import html
+from idom.server import any as any_server
+from idom.server.types import ServerImplementation
+from idom.testing import ServerMountPoint
+from idom.types import RootComponentConstructor
+
+
+@asynccontextmanager
+async def launch_browser(headless: bool) -> Browser:
+    async with async_playwright() as p:
+        yield await p.chromium.launch(headless=headless)
+
+
+@asynccontextmanager
+async def open_display(
+    browser: Browser, implementation: ServerImplementation[Any] = any_server
+) -> Display:
+    async with ServerMountPoint(implementation) as mount:
+        page = await browser.new_page()
+        try:
+            yield Display(page, mount)
+        finally:
+            await page.close()
+
+
+class Display:
+    def __init__(self, page: Page, mount: ServerMountPoint) -> None:
+        self.page = page
+        self.mount = mount
+        self._next_id = 0
+
+    async def show(
+        self, component: RootComponentConstructor, query: dict[str, Any] | None = None
+    ) -> str:
+        self._next_id += 1
+        component_id = f"display-{self._next_id}"
+        self.mount.mount(lambda: html.div({"id": component_id}, component()))
+        await self.page.goto(self.mount.url(query=query))
+        await self.page.wait_for_selector(f"#{component_id}")
+        return component_id