add public test tooling

Author: rmorshea

Diff for: idom/client/app/package.json

@@ -5,15 +5,17 @@
   "author": "Ryan Morshead",
   "license": "MIT",
   "repository": {
+    "type": "git",
     "url": "https://github.com/rmorshea/idom"
   },
   "main": "src/layout.js",
   "files": [
-    "src/*.js"
+    "src/**/*.js"
   ],
   "scripts": {
-    "build": "npx snowpack && npx snowpack build",
-    "format": "npx prettier --write ./src"
+    "build": "snowpack && snowpack build",
+    "format": "prettier --write ./src",
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "devDependencies": {
     "prettier": "2.1.1",

Diff for: idom/testing.py

@@ -0,0 +1,156 @@
+from contextlib import contextmanager, AbstractContextManager
+from typing import Callable, Tuple, Iterator, Type, Optional, Union, Any
+
+from sanic import Sanic
+from selenium.webdriver.remote.webdriver import WebDriver
+from selenium.webdriver import Chrome
+from selenium.webdriver.chrome.options import Options
+
+import idom
+from idom.core.element import AbstractElement, ElementConstructor
+from idom.server.sanic import SanicRenderServer, PerClientStateServer
+from idom.server.prefab import hotswap_server
+from idom.server.utils import find_available_port
+from idom.utils import Ref
+
+
+DisplayFunction = Callable[[Union[ElementConstructor, AbstractElement], str], None]
+
+
+def create_selenium_display_context(
+    headless: bool, driver_timeout: float = 3.0
+) -> Iterator[DisplayFunction]:
+    host = "127.0.0.1"
+    port = find_available_port(host)
+    server_url = f"http://{host}:{port}"
+
+    with open_selenium_chrome_driver(
+        headless=headless,
+        page_load_timeout=driver_timeout,
+        implicit_wait_timeout=driver_timeout,
+    ) as driver:
+        with open_sanic_mount_and_server(
+            server_type=PerClientStateServer, host=host, port=port
+        ) as (mount, server):
+            return create_selenium_page_get_and_display_context(
+                driver, server, server_url, mount
+            )[1]
+
+
+def create_selenium_page_get_and_display_context(
+    driver: WebDriver,
+    server: "_RenderServerSavesLastError",
+    server_url: str,
+    element_mount_function: Callable[..., None],
+) -> Tuple[Callable[[str], None], "AbstractContextManager[DisplayFunction]"]:
+    display_id = Ref(0)
+
+    def get_page(query: str = "") -> None:
+        """Navigate the driver to an IDOM server at the given host and port.
+
+        The ``query`` parameter is typically used to specify a ``view_id`` when a
+        ``multiview()`` elemement has been mounted to the layout.
+        """
+        driver.get(f"{server_url}/client/index.html?{query}")
+
+    def display_function(
+        element: Union[Callable[[], Any], AbstractElement],
+        query: str = "",
+        check_mount: bool = True,
+    ) -> None:
+        d_id = display_id.current
+        display_id.current += 1
+        display_attrs = {"id": f"display-{d_id}"}
+        element_constructor = element if callable(element) else lambda: element
+        element_mount_function(
+            lambda: idom.html.div(display_attrs, element_constructor())
+        )
+
+        get_page(query)
+        if check_mount:
+            # Ensure element was actually mounted.
+            driver.find_element_by_id(f"display-{d_id}")
+
+        return None
+
+    @contextmanager
+    def display_context():
+        server.last_server_error_for_idom_testing.current = None
+        try:
+            yield display_function
+        finally:
+            if server.last_server_error_for_idom_testing.current is not None:
+                raise server.last_server_error_for_idom_testing.current
+
+    return get_page, display_context
+
+
+@contextmanager
+def open_sanic_mount_and_server(
+    server_type: Type[SanicRenderServer],
+    host: str,
+    port: int,
+    app: Optional[Sanic] = None,
+) -> Iterator[Tuple[Callable[..., None], SanicRenderServer]]:
+    try:
+        yield hotswap_server(
+            (
+                server_type
+                if issubclass(server_type, _RenderServerSavesLastError)
+                else create_sanic_server_type_for_testing(server_type)
+            ),
+            host,
+            port,
+            server_options={"cors": True},
+            run_options={},
+            sync_views=False,
+            app=app,
+        )
+    finally:
+        if server_type.last_server_error_for_idom_testing.current is not None:
+            raise server_type.last_server_error_for_idom_testing.current
+
+
+def create_sanic_server_type_for_testing(
+    server_type: Type[SanicRenderServer],
+) -> Type["_RenderServerSavesLastError"]:
+    return type(
+        server_type.__name__,
+        (_RenderServerSavesLastError, server_type),
+        {"last_server_error_for_idom_testing": Ref(None)},
+    )
+
+
+@contextmanager
+def open_selenium_chrome_driver(
+    headless: bool,
+    implicit_wait_timeout: float = 3.0,
+    page_load_timeout: float = 3.0,
+    window_size: Tuple[int, int] = (1080, 800),
+) -> Iterator[Chrome]:
+    options = Options()
+    options.headless = headless
+
+    driver = Chrome(options=options)
+
+    driver.set_window_size(*window_size)
+    driver.set_page_load_timeout(page_load_timeout)
+    driver.implicitly_wait(implicit_wait_timeout)
+
+    try:
+        yield driver
+    finally:
+        driver.quit()
+
+
+class _RenderServerSavesLastError(SanicRenderServer):
+    """A server that updates the ``last_server_error`` fixture"""
+
+    last_server_error_for_idom_testing: Ref[Optional[Exception]]
+
+    async def _run_dispatcher(self, *args: Any, **kwargs: Any) -> None:
+        self.last_server_error_for_idom_testing.current = None
+        try:
+            await super()._run_dispatcher(*args, **kwargs)
+        except Exception as e:
+            self.last_server_error_for_idom_testing.current = e

Diff for: pyproject.toml

@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools >= 40.9.0", "wheel"]
+requires = ["setuptools >= 40.9.0", "wheel", "setuptools_scm"]
 build-backend = "setuptools.build_meta"

Diff for: setup.py

@@ -33,9 +33,9 @@
     "keywords": ["interactive", "widgets", "DOM", "React"],
     "include_package_data": True,
     "zip_safe": False,
-    "setup_requires": ["setuptools_scm"],
     "use_scm_version": True,
     "classifiers": [
+        "Framework :: IDOM",
         "Intended Audience :: Developers",
         "Intended Audience :: Science/Research",
         "Topic :: Multimedia :: Graphics",