Finished extensions coverage

Author: Joel Collins

labthings/server/extensions.py

@@ -65,7 +65,7 @@ def views(self):
     def add_view(self, view_class, rule, view_id=None, **kwargs):
         # Remove all leading slashes from view route
         cleaned_rule = rule
-        while cleaned_rule[0] == "/":
+        while cleaned_rule and cleaned_rule[0] == "/":
             cleaned_rule = cleaned_rule[1:]
 
         # Expand the rule to include extension name
@@ -141,7 +141,7 @@ def add_method(self, method, method_name):
         if not hasattr(self, method_name):
             setattr(self, method_name, method)
         else:
-            logging.warning(
+            raise NameError(
                 "Unable to bind method to extension. Method name already exists."
             )
 

tests/conftest.py

@@ -104,3 +104,8 @@ def static_path(app):
 @pytest.fixture
 def schemas_path(app):
     return os.path.join(os.path.dirname(__file__), "schemas")
+
+
+@pytest.fixture
+def extensions_path(app):
+    return os.path.join(os.path.dirname(__file__), "extensions")

tests/extensions/extension_package/__init__.py

@@ -0,0 +1,3 @@
+from labthings.server.extensions import BaseExtension
+
+test_extension = BaseExtension("org.labthings.tests.extension_package")

tests/extensions/test_extension.py

@@ -0,0 +1,3 @@
+from labthings.server.extensions import BaseExtension
+
+test_extension = BaseExtension("org.labthings.tests.extension")

tests/extensions/test_extension_exception.py

@@ -0,0 +1 @@
+raise Exception

tests/extensions/test_extension_explicit_list.py

@@ -0,0 +1,6 @@
+from labthings.server.extensions import BaseExtension
+
+test_extension = BaseExtension("org.labthings.tests.extension")
+test_extension_excluded = BaseExtension("org.labthings.tests.extension_excluded")
+
+__extensions__ = ["test_extension"]

tests/test_server_extensions.py

@@ -0,0 +1,168 @@
+from labthings.server import extensions
+import os
+
+import pytest
+
+
+@pytest.fixture
+def lt_extension():
+    return extensions.BaseExtension("org.labthings.tests.extension")
+
+
+def test_extension_init(lt_extension):
+    assert lt_extension
+    assert lt_extension.name
+
+
+def test_add_view(lt_extension, app, view_cls):
+    lt_extension.add_view(view_cls, "/index")
+
+    assert "index" in lt_extension.views
+    assert lt_extension.views.get("index") == {
+        "rule": "/org.labthings.tests.extension/index",
+        "view": view_cls,
+        "kwargs": {},
+    }
+
+
+def test_on_register(lt_extension):
+    def f(arg, kwarg=1):
+        pass
+
+    lt_extension.on_register(f, args=(1,), kwargs={"kwarg": 0})
+    assert {
+        "function": f,
+        "args": (1,),
+        "kwargs": {"kwarg": 0},
+    } in lt_extension._on_registers
+
+
+def test_on_register_non_callable(lt_extension):
+    with pytest.raises(TypeError):
+        lt_extension.on_register(object())
+
+
+def test_on_component(lt_extension):
+    def f():
+        pass
+
+    lt_extension.on_component("org.labthings.tests.component", f)
+    assert {
+        "component": "org.labthings.tests.component",
+        "function": f,
+        "args": (),
+        "kwargs": {},
+    } in lt_extension._on_components
+
+
+def test_on_component_non_callable(lt_extension):
+    with pytest.raises(TypeError):
+        lt_extension.on_component("org.labthings.tests.component", object())
+
+
+def test_meta_simple(lt_extension):
+    lt_extension.add_meta("key", "value")
+    assert lt_extension.meta.get("key") == "value"
+
+
+def test_meta_callable(lt_extension):
+    def f():
+        return "callable value"
+
+    lt_extension.add_meta("key", f)
+    assert lt_extension.meta.get("key") == "callable value"
+
+
+def test_add_method(lt_extension):
+    def f():
+        pass
+
+    lt_extension.add_method(
+        f, "method_name",
+    )
+    assert lt_extension.method_name == f
+
+
+def test_add_method_name_clash(lt_extension):
+    def f():
+        pass
+
+    lt_extension.add_method(
+        f, "method_name",
+    )
+    assert lt_extension.method_name == f
+
+    with pytest.raises(NameError):
+        lt_extension.add_method(
+            f, "method_name",
+        )
+
+
+def test_static_file_url(lt_extension, app, app_ctx):
+    endpoint = "extensionstatic"
+    static_view = lt_extension.views.get("static").get("view")
+    static_view.endpoint = endpoint
+    static_rule = lt_extension.views.get("static").get("rule")
+
+    assert static_view
+    assert static_rule
+
+    app.add_url_rule(static_rule, view_func=static_view.as_view(endpoint))
+
+    with app_ctx.test_request_context():
+        assert (
+            "org.labthings.tests.extension/static/filename"
+            in lt_extension.static_file_url("filename")
+        )
+
+
+def test_static_file_url_no_endpoint(lt_extension, app, app_ctx):
+    static_view = lt_extension.views.get("static").get("view")
+    static_rule = lt_extension.views.get("static").get("rule")
+
+    assert static_view
+    assert static_rule
+
+    app.add_url_rule(static_rule, view_func=static_view.as_view("index"))
+
+    with app_ctx.test_request_context():
+        assert lt_extension.static_file_url("filename") is None
+
+
+def test_find_instances_in_module(lt_extension):
+    mod = type(
+        "mod",
+        (object,),
+        {"extension_instance": lt_extension, "another_object": object()},
+    )
+    assert extensions.find_instances_in_module(mod, extensions.BaseExtension) == [
+        lt_extension
+    ]
+
+
+def test_find_extensions_in_file(extensions_path):
+    test_file = os.path.join(extensions_path, "test_extension.py")
+
+    found_extensions = extensions.find_extensions_in_file(test_file)
+    assert len(found_extensions) == 1
+    assert found_extensions[0].name == "org.labthings.tests.extension"
+
+
+def test_find_extensions_in_file_explicit_list(extensions_path):
+    test_file = os.path.join(extensions_path, "test_extension_explicit_list.py")
+
+    found_extensions = extensions.find_extensions_in_file(test_file)
+    assert len(found_extensions) == 1
+    assert found_extensions[0].name == "org.labthings.tests.extension"
+
+
+def test_find_extensions_in_file_exception(extensions_path):
+    test_file = os.path.join(extensions_path, "test_extension_exception.py")
+
+    found_extensions = extensions.find_extensions_in_file(test_file)
+    assert found_extensions == []
+
+
+def test_find_extensions(extensions_path):
+    found_extensions = extensions.find_extensions(extensions_path)
+    assert len(found_extensions) == 3