implement test_module

Author: rmorshea

re.txt

@@ -5,7 +5,8 @@ display\((.*?)\)
 page = await display.show($1)
 
 driver\.find_element\("id", "(.*?)"\)
-await display.wait_for_selector("#$1")
+await page.wait_for_selector("#$1")
+await page.wait_for_selector("#$1", state="attached")
 
 driver_wait\.until\(lambda .*: (\w*)\.get_attribute\("(.*?)"\) == (.*)\)
 assert (await $1.evaluate("node => node['$2']")) == $3

requirements/test-env.txt

@@ -7,3 +7,4 @@ pytest-rerunfailures
 pytest-timeout
 responses
 playwright
+pytest-playwright

src/idom/testing.py

@@ -113,6 +113,10 @@ def until(
         self.until: Callable[[Callable[[_R], bool]], Any] = until
         """Check that the coroutines result meets a condition within the timeout"""
 
+    def until_is(self, right: Any, timeout: float = _DEFAULT_TIMEOUT) -> Any:
+        """Wait until the result is identical to the given value"""
+        return self.until(lambda left: left is right, timeout)
+
     def until_equals(self, right: Any, timeout: float = _DEFAULT_TIMEOUT) -> Any:
         """Wait until the result is equal to the given value"""
         return self.until(lambda left: left == right, timeout)
@@ -197,13 +201,22 @@ def __init__(
         self,
         host: str = "127.0.0.1",
         port: Optional[int] = None,
+        app: Any | None = None,
         implementation: ServerImplementation[Any] = default_server,
     ) -> None:
         self.server_implementation = implementation
         self.host = host
         self.port = port or find_available_port(host, allow_reuse_waiting_ports=False)
         self.mount, self._root_component = hotswap()
 
+        if app is not None:
+            if implementation is None:
+                raise ValueError(
+                    "If an application instance its corresponding "
+                    "server implementation must be provided too."
+                )
+        self._app = app
+
     @property
     def log_records(self) -> List[logging.LogRecord]:
         """A list of captured log records"""
@@ -259,7 +272,7 @@ def list_logged_exceptions(
     async def __aenter__(self: _Self) -> _Self:
         self._log_handler = _LogRecordCaptor()
         logging.getLogger().addHandler(self._log_handler)
-        app = self.server_implementation.create_development_app()
+        app = self._app or self.server_implementation.create_development_app()
         self.server_implementation.configure(app, self._root_component)
 
         started = asyncio.Event()

tests/conftest.py

@@ -5,15 +5,14 @@
 from _pytest.config.argparsing import Parser
 from playwright.async_api import async_playwright
 
-from idom.server.utils import all_implementations
 from idom.testing import DisplayFixture, ServerFixture, clear_idom_web_modules_dir
 from tests.tooling.loop import open_event_loop
 
 
 def pytest_addoption(parser: Parser) -> None:
     parser.addoption(
-        "--open-browser",
-        dest="open_browser",
+        "--headed",
+        dest="headed",
         action="store_true",
         help="Open a browser window when runnging web-based tests",
     )
@@ -34,6 +33,7 @@ async def server():
 @pytest.fixture(scope="session")
 async def page(browser):
     pg = await browser.new_page()
+    pg.set_default_timeout(5000)
     try:
         yield pg
     finally:
@@ -43,9 +43,7 @@ async def page(browser):
 @pytest.fixture(scope="session")
 async def browser(pytestconfig: Config):
     async with async_playwright() as pw:
-        yield await pw.chromium.launch(
-            headless=not bool(pytestconfig.option.open_browser)
-        )
+        yield await pw.chromium.launch(headless=not bool(pytestconfig.option.headed))
 
 
 @pytest.fixture(scope="session")

tests/test_web/test_module.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from sys import implementation
 
 import pytest
 from sanic import Sanic
@@ -7,15 +8,21 @@
 from selenium.webdriver.support.ui import WebDriverWait
 
 import idom
-from idom.server.sanic import PerClientStateServer
-from idom.testing import ServerFixture, assert_idom_did_not_log, assert_idom_logged
+from idom.server import sanic as sanic_implementation
+from idom.testing import (
+    DisplayFixture,
+    ServerFixture,
+    assert_idom_did_not_log,
+    assert_idom_logged,
+    poll,
+)
 from idom.web.module import NAME_SOURCE, WebModule
 
 
 JS_FIXTURES_DIR = Path(__file__).parent / "js_fixtures"
 
 
-def test_that_js_module_unmount_is_called(driver, display):
+async def test_that_js_module_unmount_is_called(display: DisplayFixture):
     SomeComponent = idom.web.export(
         idom.web.module_from_file(
             "set-flag-when-unmount-is-called",
@@ -33,23 +40,23 @@ def ShowCurrentComponent():
         )
         return current_component
 
-    display(ShowCurrentComponent)
+    page = await display.show(ShowCurrentComponent)
 
-    driver.find_element("id", "some-component")
+    await page.wait_for_selector("#some-component", state="attached")
 
     set_current_component.current(
         idom.html.h1({"id": "some-other-component"}, "some other component")
     )
 
     # the new component has been displayed
-    driver.find_element("id", "some-other-component")
+    await page.wait_for_selector("#some-other-component", state="attached")
 
     # the unmount callback for the old component was called
-    driver.find_element("id", "unmount-flag")
+    await page.wait_for_selector("#unmount-flag", state="attached")
 
 
-def test_module_from_url(driver):
-    app = Sanic(__name__)
+async def test_module_from_url(browser):
+    app = Sanic("test_module_from_url")
 
     # instead of directing the URL to a CDN, we just point it to this static file
     app.static(
@@ -67,30 +74,25 @@ def test_module_from_url(driver):
     def ShowSimpleButton():
         return SimpleButton({"id": "my-button"})
 
-    with ServerFixture(PerClientStateServer, app=app) as mount_point:
-        mount_point.mount(ShowSimpleButton)
-        driver.get(mount_point.url())
-        driver.find_element("id", "my-button")
+    async with ServerFixture(app=app, implementation=sanic_implementation) as server:
+        async with DisplayFixture(server, browser) as display:
+            page = await display.show(ShowSimpleButton)
+            await page.wait_for_selector("#my-button")
 
 
 def test_module_from_template_where_template_does_not_exist():
     with pytest.raises(ValueError, match="No template for 'does-not-exist.js'"):
         idom.web.module_from_template("does-not-exist", "something.js")
 
 
-def test_module_from_template(driver, display):
+async def test_module_from_template(display: DisplayFixture):
     victory = idom.web.module_from_template("react", "[email protected]")
     VictoryBar = idom.web.export(victory, "VictoryBar")
-    display(VictoryBar)
-    wait = WebDriverWait(driver, 10)
-    wait.until(
-        expected_conditions.visibility_of_element_located(
-            (By.CLASS_NAME, "VictoryContainer")
-        )
-    )
+    page = await display.show(VictoryBar)
+    await page.wait_for_selector(".VictoryContainer")
 
 
-def test_module_from_file(driver, driver_wait, display):
+async def test_module_from_file(display: DisplayFixture):
     SimpleButton = idom.web.export(
         idom.web.module_from_file(
             "simple-button", JS_FIXTURES_DIR / "simple-button.js"
@@ -106,11 +108,11 @@ def ShowSimpleButton():
             {"id": "my-button", "onClick": lambda event: is_clicked.set_current(True)}
         )
 
-    display(ShowSimpleButton)
+    page = await display.show(ShowSimpleButton)
 
-    button = driver.find_element("id", "my-button")
-    button.click()
-    driver_wait.until(lambda d: is_clicked.current)
+    button = await page.wait_for_selector("#my-button")
+    await button.click()
+    poll(lambda: is_clicked.current).until_is(True)
 
 
 def test_module_from_file_source_conflict(tmp_path):
@@ -188,44 +190,44 @@ def test_module_missing_exports():
         idom.web.export(module, ["x", "y"])
 
 
-def test_module_exports_multiple_components(driver, display):
+async def test_module_exports_multiple_components(display: DisplayFixture):
     Header1, Header2 = idom.web.export(
         idom.web.module_from_file(
             "exports-two-components", JS_FIXTURES_DIR / "exports-two-components.js"
         ),
         ["Header1", "Header2"],
     )
 
-    display(lambda: Header1({"id": "my-h1"}, "My Header 1"))
+    page = await display.show(lambda: Header1({"id": "my-h1"}, "My Header 1"))
 
-    driver.find_element("id", "my-h1")
+    await page.wait_for_selector("#my-h1", state="attached")
 
-    display(lambda: Header2({"id": "my-h2"}, "My Header 2"))
+    page = await display.show(lambda: Header2({"id": "my-h2"}, "My Header 2"))
 
-    driver.find_element("id", "my-h2")
+    await page.wait_for_selector("#my-h2", state="attached")
 
 
-def test_imported_components_can_render_children(driver, display):
+async def test_imported_components_can_render_children(display: DisplayFixture):
     module = idom.web.module_from_file(
         "component-can-have-child", JS_FIXTURES_DIR / "component-can-have-child.js"
     )
     Parent, Child = idom.web.export(module, ["Parent", "Child"])
 
-    display(
+    page = await display.show(
         lambda: Parent(
             Child({"index": 1}),
             Child({"index": 2}),
             Child({"index": 3}),
         )
     )
 
-    parent = driver.find_element("id", "the-parent")
-    children = parent.find_elements("tag name", "li")
+    parent = await page.wait_for_selector("#the-parent", state="attached")
+    children = await parent.query_selector_all("li")
 
     assert len(children) == 3
 
     for index, child in enumerate(children):
-        assert child.get_attribute("id") == f"child-{index + 1}"
+        assert (await child.get_attribute("id")) == f"child-{index + 1}"
 
 
 def test_module_from_string():