Added some more tests of thing description

After the changes I made to action schemas, I wanted to ensure
I'd not broken the Thing Description.
I am no longer worried - the TD serialises
schemas in place and doesn't rely on names.  The
thing that mostly went wrong was naming the schemas,
which doesn't apply to the TD.

Also, I've tested all the cases I can think of, and the
TD still validates.

Author: rwb27

src/labthings/schema.py

@@ -156,16 +156,21 @@ def build_action_schema(
     name: Optional[str] = None,
     base_class: type = ActionSchema,
 ):
-    """Builds a complete schema for a given ActionView. That is, it reads any input and output
-    schemas attached to the POST method, and nests them within the input/output fields of
-    the generic ActionSchema.
+    """Builds a complete schema for a given ActionView.
+
+    This method combines input and output schemas for a particular
+    Action with the generic ActionSchema to give a specific ActionSchema
+    subclass for that Action.
+
+    This is used in the Thing Description (where it is serialised to
+    JSON in-place) but not in the OpenAPI description (where the input,
+    output, and ActionSchema schemas are combined using `allOf`.)
 
     :param output_schema: Schema:
     :param input_schema: Schema:
     :param name: str:  (Default value = None)
 
     """
-    # FIXME: this seems to lose the schemas.  I suspect this is down to `nest_if_needed`.
     # Create a name for the generated schema
     if not name:
         name = str(id(output_schema))

tests/conftest.py

@@ -8,8 +8,9 @@
 from flask import Flask
 from flask.testing import FlaskClient
 from flask.views import MethodView
+from marshmallow import validate
 
-from labthings import LabThing
+from labthings import LabThing, fields
 from labthings.actions import Pool
 from labthings.json import encode_json
 from labthings.views import ActionView, PropertyView, View
@@ -179,6 +180,41 @@ def thing_ctx(thing):
         yield thing.app
 
 
+@pytest.fixture
+def thing_with_some_views(thing):
+    class TestAction(ActionView):
+        args = {"n": fields.Integer()}
+
+        def post(self):
+            return "POST"
+
+    thing.add_view(TestAction, "TestAction")
+
+    class TestProperty(PropertyView):
+        schema = {"count": fields.Integer()}
+
+        def get(self):
+            return 1
+
+        def post(self, args):
+            pass
+
+    thing.add_view(TestProperty, "TestProperty")
+
+    class TestFieldProperty(PropertyView):
+        schema = fields.String(validate=validate.OneOf(["one", "two"]))
+
+        def get(self):
+            return "one"
+
+        def post(self, args):
+            pass
+
+    thing.add_view(TestFieldProperty, "TestFieldProperty")
+
+    return thing
+
+
 @pytest.fixture()
 def debug_app(request):
 

tests/test_openapi.py

@@ -10,7 +10,6 @@
 import yaml
 from apispec.ext.marshmallow import MarshmallowPlugin
 from apispec.utils import validate_spec
-from marshmallow import validate
 
 from labthings import fields, schema
 from labthings.actions.thread import ActionThread
@@ -21,41 +20,6 @@
 from labthings.utilities import get_by_path
 
 
-@pytest.fixture
-def thing_with_some_views(thing):
-    class TestAction(ActionView):
-        args = {"n": fields.Integer()}
-
-        def post(self):
-            return "POST"
-
-    thing.add_view(TestAction, "TestAction")
-
-    class TestProperty(PropertyView):
-        schema = {"count": fields.Integer()}
-
-        def get(self):
-            return 1
-
-        def post(self, args):
-            pass
-
-    thing.add_view(TestProperty, "TestProperty")
-
-    class TestFieldProperty(PropertyView):
-        schema = fields.String(validate=validate.OneOf(["one", "two"]))
-
-        def get(self):
-            return "one"
-
-        def post(self, args):
-            pass
-
-    thing.add_view(TestFieldProperty, "TestFieldProperty")
-
-    return thing
-
-
 def test_openapi(thing_with_some_views):
     """Make an example Thing and check its openapi description validates"""
 
@@ -74,7 +38,12 @@ class TestAction(ActionView):
         def post(self):
             return "POST"
 
-    t.add_view(TestAction, "TestActionM", endpoint="TestActionM")
+    with pytest.warns(UserWarning):
+        t.add_view(TestAction, "TestActionM", endpoint="TestActionM")
+
+    for v in t._action_views.values():
+        # We should have two actions with the same name
+        assert v.__name__ == "TestAction"
 
     api = t.spec.to_dict()
     original_input_schema = get_by_path(api, ["paths", "/TestAction", "post"])

tests/test_td.py

@@ -16,6 +16,16 @@ def test_td_init(helpers, thing, thing_description, app_ctx, schemas_path):
     validate_spec(thing.spec)
 
 
+def test_interesting_td(helpers, thing_with_some_views, app_ctx, schemas_path):
+    td = thing_with_some_views.thing_description
+    helpers.validate_thing_description(td, app_ctx, schemas_path)
+    validate_spec(thing_with_some_views.spec)
+    # Check the arguments were preserved OK for TestAction
+    assert td.actions["TestAction"]["input"]["properties"] == {
+        "n": {"type": "number", "format": "integer"}
+    }
+
+
 def test_td_add_link(
     helpers, thing, thing_description, view_cls, app_ctx, schemas_path
 ):