introduce make_mock_extension_app fixture to inject the template_paths

Author: echarles

jupyter_server/pytest_plugin.py

@@ -52,6 +52,7 @@ def mkdir(tmp_path, *parts):
 config_dir = pytest.fixture(lambda tmp_path: mkdir(tmp_path, "config"))
 runtime_dir = pytest.fixture(lambda tmp_path: mkdir(tmp_path, "runtime"))
 root_dir = pytest.fixture(lambda tmp_path: mkdir(tmp_path, "root_dir"))
+template_dir = pytest.fixture(lambda tmp_path: mkdir(tmp_path, "template_dir"))
 system_jupyter_path = pytest.fixture(
     lambda tmp_path: mkdir(tmp_path, "share", "jupyter")
 )

tests/extension/conftest.py

@@ -33,6 +33,14 @@ def _jupyter_server_extension_paths():
             'module': '_mockdestination/index'
         }]
 
+@pytest.fixture
+def make_mock_extension_app(template_dir):
+    def _make_mock_extension_app(**kwargs):
+        kwargs.setdefault('template_paths', [str(template_dir)])
+        return MockExtensionApp(**kwargs)
+
+    return _make_mock_extension_app
+
 
 @pytest.fixture
 def config_file(config_dir):
@@ -43,21 +51,21 @@ def config_file(config_dir):
 
 
 @pytest.fixture
-def extended_serverapp(serverapp):
+def extended_serverapp(serverapp, make_mock_extension_app):
     """"""
-    m = MockExtensionApp()
+    m = make_mock_extension_app()
     m.initialize(serverapp)
     return m
 
 
 @pytest.fixture
-def inject_mock_extension(environ, extension_environ):
+def inject_mock_extension(environ, extension_environ, make_mock_extension_app):
     """Fixture that can be used to inject a mock Jupyter Server extension into the tests namespace.
 
         Usage: inject_mock_extension({'extension_name': ExtensionClass})
     """
     def ext(modulename="mockextension"):
-        sys.modules[modulename] = e = MockExtensionApp()
+        sys.modules[modulename] = e = make_mock_extension_app()
         return e
 
     return ext

tests/extension/test_app.py

@@ -3,19 +3,17 @@
 from jupyter_server.serverapp import ServerApp
 from jupyter_server.extension.application import ExtensionApp
 
-from .conftest import MockExtensionApp
 
-
-def test_instance_creation():
-    mock_extension = MockExtensionApp()
+def test_instance_creation(make_mock_extension_app, template_dir):
+    mock_extension = make_mock_extension_app()
     assert mock_extension.static_paths == []
-    assert mock_extension.template_paths == []
+    assert mock_extension.template_paths == [str(template_dir)]
     assert mock_extension.settings == {}
-    assert mock_extension.handlers == [] 
+    assert mock_extension.handlers == []
 
 
-def test_initialize(serverapp):
-    mock_extension = MockExtensionApp()
+def test_initialize(serverapp, make_mock_extension_app):
+    mock_extension = make_mock_extension_app()
     mock_extension.initialize(serverapp)
     # Check that settings and handlers were added to the mock extension.
     assert isinstance(mock_extension.serverapp, ServerApp)
@@ -35,24 +33,24 @@ def test_initialize(serverapp):
     'trait_name,trait_value',
     traits
 )
-def test_instance_creation_with_instance_args(trait_name, trait_value):
+def test_instance_creation_with_instance_args(trait_name, trait_value, make_mock_extension_app):
     kwarg = {}
     kwarg.setdefault(trait_name, trait_value)
-    mock_extension = MockExtensionApp(**kwarg)
+    mock_extension = make_mock_extension_app(**kwarg)
     assert getattr(mock_extension, trait_name) == trait_value
 
 
 @pytest.mark.parametrize(
     'trait_name,trait_value',
     traits
 )
-def test_instance_creation_with_argv(serverapp, trait_name, trait_value):
+def test_instance_creation_with_argv(serverapp, trait_name, trait_value, make_mock_extension_app):
     kwarg = {}
     kwarg.setdefault(trait_name, trait_value)
     argv = [
         '--MockExtensionApp.{name}={value}'.format(name=trait_name, value=trait_value)
     ]
-    mock_extension = MockExtensionApp()
+    mock_extension = make_mock_extension_app()
     mock_extension.initialize(serverapp, argv=argv)
     assert getattr(mock_extension, trait_name) == trait_value
 

tests/extension/test_entrypoint.py

@@ -3,8 +3,6 @@
 from jupyter_core import paths
 from jupyter_server.extension import serverextension
 
-from .conftest import MockExtensionApp
-
 # All test coroutines will be treated as marked.
 pytestmark = pytest.mark.script_launch_mode('subprocess')
 

tests/extension/test_handler.py

@@ -1,7 +1,6 @@
 import pytest
 
 from jupyter_server.serverapp import ServerApp
-from .conftest import MockExtensionApp
 
 # ------------------ Start tests -------------------
 
@@ -14,9 +13,9 @@ async def test_handler(fetch, extended_serverapp):
     assert r.body.decode() == 'mock trait'
 
 
-async def test_handler_setting(fetch, serverapp):
+async def test_handler_setting(fetch, serverapp, make_mock_extension_app):
     # Configure trait in Mock Extension.
-    m = MockExtensionApp(mock_trait='test mock trait')
+    m = make_mock_extension_app(mock_trait='test mock trait')
     m.initialize(serverapp)
 
     # Test that the extension trait was picked up by the webapp.
@@ -28,9 +27,9 @@ async def test_handler_setting(fetch, serverapp):
     assert r.body.decode() == 'test mock trait'
 
 
-async def test_handler_argv(fetch, serverapp):
+async def test_handler_argv(fetch, serverapp, make_mock_extension_app):
     # Configure trait in Mock Extension.
-    m = MockExtensionApp()
+    m = make_mock_extension_app()
     argv = ['--MockExtensionApp.mock_trait="test mock trait"']
     m.initialize(serverapp, argv=argv)