refactor some tests

this should make it easier to check basic functionality in
future server implementations

Author: rmorshea

idom/server/__init__.py

@@ -1,4 +1,11 @@
 from .base import AbstractRenderServer
 from .prefab import run, multiview_server, hotswap_server
+from . import default
 
-__all__ = ["run", "multiview_server", "hotswap_server", "AbstractRenderServer"]
+__all__ = [
+    "default",
+    "run",
+    "multiview_server",
+    "hotswap_server",
+    "AbstractRenderServer",
+]

idom/server/base.py

@@ -45,9 +45,9 @@ def run(self, *args: Any, **kwargs: Any) -> None:
         if self._app is None:
             app = self._default_application(self._config)
             self.register(app)
-        else:
+        else:  # pragma: no cover
             app = self._app
-        if not self._daemonized:
+        if not self._daemonized:  # pragma: no cover
             return self._run_application(app, self._config, args, kwargs)
         else:
             return self._run_application_in_thread(app, self._config, args, kwargs)
@@ -70,14 +70,12 @@ def register(self: _Self, app: Optional[_App]) -> _Self:
         self._app = app
         return self
 
-    def server_started(self) -> bool:
-        """Whether the underlying application has started"""
-        return self._server_did_start.set()
-
     def wait_until_server_start(self, timeout: float = 3.0):
         """Block until the underlying application has started"""
         if not self._server_did_start.wait(timeout=timeout):
-            raise RuntimeError(f"Server did not start within {timeout} seconds")
+            raise RuntimeError(  # pragma: no cover
+                f"Server did not start within {timeout} seconds"
+            )
 
     @abc.abstractmethod
     def _create_config(self, config: Optional[_Config]) -> _Config:

idom/server/default.py

@@ -0,0 +1,4 @@
+from .sanic import Config, PerClientStateServer, SharedClientStateServer
+
+
+__all__ = ["Config", "PerClientStateServer", "SharedClientStateServer"]

idom/server/flask.py

@@ -57,7 +57,7 @@ def _setup_application(self, app: Flask, config: Config) -> None:
         self._setup_blueprint_routes(bp, config)
 
         cors_config = config["cors"]
-        if cors_config:
+        if cors_config:  # pragma: no cover
             cors_params = cors_config if isinstance(cors_config, dict) else {}
             CORS(bp, **cors_params)
 
@@ -124,7 +124,7 @@ def _generic_run_application(
         **kwargs
     ):
         if debug:
-            logging.basicConfig(level=logging.DEBUG)
+            logging.basicConfig(level=logging.DEBUG)  # pragma: no cover
         logging.debug("Starting server...")
         _StartCallbackWSGIServer(
             self._server_did_start.set,

idom/server/prefab.py

@@ -66,7 +66,7 @@ def run(
 
     server = server_type(element, server_config)
 
-    if app is not None:
+    if app is not None:  # pragma: no cover
         server.register(app)
 
     run_server = server.run if not daemon else server.daemon

idom/testing.py

@@ -15,8 +15,8 @@
 from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver import Chrome
 
+from idom import server
 from idom.server.base import AbstractRenderServer
-from idom.server.sanic import PerClientStateServer
 from idom.server.prefab import hotswap_server
 from idom.server.utils import find_available_port
 from idom.utils import Ref
@@ -58,7 +58,7 @@ class ServerMountPoint(Generic[_Mount, _Server]):
 
     def __init__(
         self,
-        server_type: Type[_Server] = PerClientStateServer,
+        server_type: Type[_Server] = server.default.PerClientStateServer,
         host: str = "127.0.0.1",
         port: Optional[int] = None,
         server_config: Optional[Any] = None,

tests/conftest.py

@@ -70,7 +70,7 @@ def last_server_error(server_mount_point):
     return server_mount_point.server.last_server_error_for_idom_testing
 
 
-@pytest.fixture(scope="module")
+@pytest.fixture
 def server_mount_point():
     """An IDOM layout mount function and server as a tuple
 

tests/test_server/test_base.py

@@ -1,26 +1,15 @@
 import pytest
-from sanic import Sanic
 
 import idom
-from idom.server.sanic import PerClientStateServer
-from idom.testing import ServerMountPoint
-
-
-@pytest.fixture(scope="module")
-def server_mount_point():
-    return ServerMountPoint(
-        PerClientStateServer,
-        # test that we can use a custom app instance
-        app=Sanic(),
-    )
+from idom.server.default import PerClientStateServer
 
 
 def test_no_application_until_running():
     @idom.element
     def AnyElement():
         pass
 
-    server = idom.server.sanic.PerClientStateServer(AnyElement)
+    server = PerClientStateServer(AnyElement)
 
     with pytest.raises(RuntimeError, match="No application"):
         server.application

tests/test_server/test_flask/__init__.py renamed to tests/test_server/test_common/__init__.py

@@ -1,17 +1,20 @@
 import pytest
 
 import idom
-from idom.server.flask import PerClientStateServer
 from idom.testing import ServerMountPoint
-
-
-@pytest.fixture(scope="module")
-def server_mount_point():
-    """An IDOM layout mount function and server as a tuple
-
-    The ``mount`` and ``server`` fixtures use this.
-    """
-    return ServerMountPoint(PerClientStateServer, server_config={"cors": True})
+from idom.server import flask as idom_flask, sanic as idom_sanic
+
+
+@pytest.fixture(
+    params=[
+        # add new PerClientStateServer implementations here to
+        # run a suite of tests which check basic functionality
+        idom_sanic.PerClientStateServer,
+        idom_flask.PerClientStateServer,
+    ],
+)
+def server_mount_point(request):
+    return ServerMountPoint(request.param)
 
 
 def test_display_simple_hello_world(driver, display):

tests/test_server/test_flask/test_per_client_state.py renamed to tests/test_server/test_common/test_per_client_state.py

@@ -5,17 +5,19 @@
 import pytest
 
 import idom
-from idom.server.sanic import SharedClientStateServer
+from idom.server import sanic as idom_sanic
 from idom.testing import ServerMountPoint
 
 
-@pytest.fixture(scope="module")
-def server_mount_point():
-    """An IDOM layout mount function and server as a tuple
-
-    The ``mount`` and ``server`` fixtures use this.
-    """
-    return ServerMountPoint(SharedClientStateServer, sync_views=True)
+@pytest.fixture(
+    params=[
+        # add new SharedClientStateServer implementations here to
+        # run a suite of tests which check basic functionality
+        idom_sanic.SharedClientStateServer,
+    ]
+)
+def server_mount_point(request):
+    return ServerMountPoint(request.param, sync_views=True)
 
 
 def test_shared_client_state(create_driver, mount, server_mount_point):
@@ -76,7 +78,7 @@ def test_shared_client_state_server_does_not_support_per_client_parameters(
 
     assert error is not None
 
-    with pytest.raises(ValueError, match="does not support per-client view parameters"):
-        raise error
+    assert isinstance(error, ValueError)
+    assert "does not support per-client view parameters" in str(error)
 
     last_server_error.current = None

tests/test_server/test_sanic/test_shared_state_client.py renamed to tests/test_server/test_common/test_shared_state_client.py

@@ -1,14 +1,14 @@
 import pytest
 
 import idom
-from idom.server.sanic import PerClientStateServer
+from idom.server.default import PerClientStateServer
 from idom.server.prefab import multiview_server
 from idom.testing import ServerMountPoint
 
 from tests.driver_utils import no_such_element
 
 
-@pytest.fixture(scope="module")
+@pytest.fixture
 def server_mount_point():
     return ServerMountPoint(
         PerClientStateServer, mount_and_server_constructor=multiview_server