Started spec utilities tests

Author: Joel Collins

tests/test_server_spec_utilities.py

@@ -0,0 +1,195 @@
+from labthings.server.spec import utilities
+import json
+from apispec import APISpec
+from apispec.ext.marshmallow import MarshmallowPlugin
+from marshmallow import fields
+import pytest
+
+
+@pytest.fixture
+def view_class():
+    class ViewClass:
+        def get(self):
+            pass
+
+        def post(self):
+            pass
+
+        def put(self):
+            pass
+
+        def delete(self):
+            pass
+
+    return ViewClass
+
+
+@pytest.fixture
+def spec():
+    return APISpec(
+        title="Python-LabThings PyTest",
+        version="1.0.0",
+        openapi_version="3.0.2",
+        plugins=[MarshmallowPlugin()],
+    )
+
+
+def test_initial_update_spec(view_class):
+    initial_spec = {"key": "value"}
+    utilities.update_spec(view_class, initial_spec)
+
+    assert view_class.__apispec__ == initial_spec
+
+
+def test_update_spec(view_class):
+    initial_spec = {"key": {"subkey": "value"}}
+    utilities.update_spec(view_class, initial_spec)
+
+    new_spec = {"key": {"new_subkey": "new_value"}}
+    utilities.update_spec(view_class, new_spec)
+
+    assert view_class.__apispec__ == {
+        "key": {"subkey": "value", "new_subkey": "new_value"}
+    }
+
+
+def test_get_spec(view_class):
+    assert utilities.get_spec(None) == {}
+    assert utilities.get_spec(view_class) == {}
+
+    initial_spec = {"key": {"subkey": "value"}}
+    view_class.__apispec__ = initial_spec
+
+    assert utilities.get_spec(view_class) == initial_spec
+
+
+def test_get_topmost_spec_attr(view_class):
+    assert not utilities.get_topmost_spec_attr(view_class, "key")
+
+    # Root value missing, fall back to GET
+    view_class.get.__apispec__ = {"key": "get_value"}
+    assert utilities.get_topmost_spec_attr(view_class, "key") == "get_value"
+
+    # Root value present, return root value
+    view_class.__apispec__ = {"key": "class_value"}
+    assert utilities.get_topmost_spec_attr(view_class, "key") == "class_value"
+
+
+def test_convert_schema_none(spec):
+    assert not utilities.convert_schema(None, spec)
+
+
+def test_convert_schema_schema(spec):
+    from marshmallow import Schema
+
+    schema = Schema()
+    assert utilities.convert_schema(schema, spec) is schema
+
+
+def test_convert_schema_map(spec):
+    schema = {"integer": fields.Int()}
+    assert utilities.convert_schema(schema, spec) == {
+        "type": "object",
+        "properties": {"integer": {"type": "integer", "format": "int32"}},
+    }
+
+
+def test_convert_schema_field(spec):
+    schema = fields.Int()
+    assert utilities.convert_schema(schema, spec) == {
+        "type": "integer",
+        "format": "int32",
+    }
+
+
+def test_convert_schema_invalid(spec):
+    schema = object()
+
+    with pytest.raises(TypeError):
+        utilities.convert_schema(schema, spec)
+
+
+def test_map_to_schema_nested(spec):
+    schema = {"submap": {"integer": fields.Int()}}
+
+    assert utilities.map_to_properties(schema, spec) == {
+        "type": "object",
+        "properties": {
+            "submap": {
+                "type": "object",
+                "properties": {"integer": {"type": "integer", "format": "int32"}},
+            }
+        },
+    }
+
+
+def test_map_to_schema_json(spec):
+    schema = {"key": "value"}
+
+    assert utilities.map_to_properties(schema, spec) == {
+        "type": "object",
+        "properties": {"key": "value"},
+    }
+
+
+def test_schema_to_json(spec):
+    from marshmallow import Schema
+
+    UserSchema = Schema.from_dict({"name": fields.Str(), "email": fields.Email()})
+
+    assert utilities.schema_to_json(UserSchema(), spec) == {
+        "type": "object",
+        "properties": {
+            "name": {"type": "string"},
+            "email": {"type": "string", "format": "email"},
+        },
+    }
+
+
+def test_schema_to_json_json_in(spec):
+    from marshmallow import Schema
+
+    input_dict = {
+        "type": "object",
+        "properties": {
+            "name": {"type": "string"},
+            "email": {"type": "string", "format": "email"},
+        },
+    }
+
+    assert utilities.schema_to_json(input_dict, spec) == input_dict
+
+
+def test_recursive_expand_refs(spec):
+    from marshmallow import Schema
+
+    UserSchema = Schema.from_dict({"name": fields.Str(), "email": fields.Email()})
+    TestParentSchema = Schema.from_dict({"author": fields.Nested(UserSchema)})
+
+    assert utilities.schema_to_json(TestParentSchema(), spec) == {
+        "type": "object",
+        "properties": {
+            "author": {
+                "type": "object",
+                "properties": {
+                    "email": {"type": "string", "format": "email"},
+                    "name": {"type": "string"},
+                },
+            }
+        },
+    }
+
+
+def test_recursive_expand_refs_schema_in(spec):
+    from marshmallow import Schema
+
+    UserSchema = Schema.from_dict({"name": fields.Str(), "email": fields.Email()})
+
+    user_schema_instance = UserSchema()
+    assert (
+        utilities.recursive_expand_refs(user_schema_instance, spec)
+        == user_schema_instance
+    )
+
+
+### TODO: Test expand_refs