Started adding Mozilla semantic classes

Author: jtc42

examples/simple_thing.py

@@ -13,11 +13,8 @@
 import atexit
 
 from labthings.server.quick import create_app
-from labthings.server.decorators import (
-    PropertySchema,
-    use_args,
-    marshal_with,
-)
+from labthings.server.decorators import PropertySchema, use_args, marshal_with, Doc
+from labthings.server import semantics
 from labthings.server.view import ActionView, PropertyView
 from labthings.server.find import find_component
 from labthings.server import fields
@@ -77,15 +74,8 @@ def average_data(self, n: int):
 
 
 # Define the data we're going to output (get), and what to expect in (post)
-@PropertySchema(
-    fields.Integer(
-        required=True,
-        example=200,
-        minimum=100,
-        maximum=500,
-        description="Value of magic_denoise",
-    )
-)
+@semantics.moz.LevelProperty(100, 500, example=200)
+@Doc(description="Value of magic_denoise",)
 class DenoiseProperty(PropertyView):
 
     # Main function to handle GET requests (read)

src/labthings/server/semantics/__init__.py

@@ -0,0 +1 @@
+from . import moz

src/labthings/server/semantics/moz.py

@@ -0,0 +1,47 @@
+from .. import decorators
+from .. import fields
+
+# BASIC PROPERTIES
+class Property:
+    def __init__(self, schema):
+        self.schema = schema
+
+    def __call__(self, viewcls):
+        # Use the class name as the semantic type
+        viewcls = decorators.Semtype(self.__class__.__name__)(viewcls)
+        viewcls = decorators.PropertySchema(self.schema)(viewcls)
+        return viewcls
+
+
+class BooleanProperty(Property):
+    """https://iot.mozilla.org/schemas/#BooleanProperty"""
+
+    def __init__(self, **kwargs):
+        schema = fields.Bool(required=True, **kwargs)
+        Property.__init__(self, schema)
+
+
+class LevelProperty(Property):
+    """https://iot.mozilla.org/schemas/#LevelProperty"""
+
+    def __init__(self, minimum, maximum, **kwargs):
+        schema = fields.Int(required=True, minimum=minimum, maximum=maximum, **kwargs,)
+
+        Property.__init__(self, schema)
+
+
+# INHERITED PROPERTIES
+
+
+class BrightnessProperty(LevelProperty):
+    """https://iot.mozilla.org/schemas/#BrightnessProperty"""
+
+    def __init__(self, **kwargs):
+        LevelProperty.__init__(self, 0, 100, unit="percent", **kwargs)
+
+
+class OnOffProperty(BooleanProperty):
+    """https://iot.mozilla.org/schemas/#OnOffProperty"""
+
+    def __init__(self, **kwargs):
+        BooleanProperty.__init__(self, **kwargs)

tests/conftest.py

@@ -1,5 +1,7 @@
 import pytest
 import os
+import json
+import jsonschema
 from flask import Flask
 from flask.views import MethodView
 from apispec import APISpec
@@ -11,6 +13,24 @@
 from flask.testing import FlaskClient
 
 
+class Helpers:
+    @staticmethod
+    def validate_thing_description(thing_description, app_ctx, schemas_path):
+        schema = json.load(open(os.path.join(schemas_path, "td_schema.json"), "r"))
+        jsonschema.Draft7Validator.check_schema(schema)
+
+        with app_ctx.test_request_context():
+            td_json = thing_description.to_dict()
+            assert td_json
+
+        jsonschema.validate(instance=td_json, schema=schema)
+
+
+@pytest.fixture
+def helpers():
+    return Helpers
+
+
 class FakeWebsocket:
     def __init__(self, message: str, recieve_once=True):
         self.message = message

tests/schemas/td_schema.json

@@ -170,7 +170,7 @@
                     }
                 },
                 "required": {
-                    "type": "array",
+                    "type": ["array", "boolean"],
                     "items": {
                         "type": "string"
                     }
@@ -486,7 +486,7 @@
                     }
                 },
                 "required": {
-                    "type": "array",
+                    "type": ["array", "boolean"],
                     "items": {
                         "type": "string"
                     }

tests/test_server_semantics.py

@@ -0,0 +1,93 @@
+import pytest
+
+from labthings.server.view import View
+from labthings.server import semantics
+
+
+@pytest.fixture
+def thing_description(thing):
+    return thing.thing_description
+
+
+def test_moz_BooleanProperty(helpers, app, thing_description, app_ctx, schemas_path):
+    @semantics.moz.BooleanProperty()
+    class Index(View):
+        def get(self):
+            return "GET"
+
+    app.add_url_rule("/", view_func=Index.as_view("index"))
+    rules = app.url_map._rules_by_endpoint["index"]
+
+    thing_description.property(rules, Index)
+
+    with app_ctx.test_request_context():
+        assert (
+            thing_description.to_dict()["properties"]["index"]["@type"]
+            == "BooleanProperty"
+        )
+        assert thing_description.to_dict()["properties"]["index"]["type"] == "boolean"
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
+
+
+def test_moz_LevelProperty(helpers, app, thing_description, app_ctx, schemas_path):
+    @semantics.moz.LevelProperty(0, 100)
+    class Index(View):
+        def get(self):
+            return "GET"
+
+    app.add_url_rule("/", view_func=Index.as_view("index"))
+    rules = app.url_map._rules_by_endpoint["index"]
+
+    thing_description.property(rules, Index)
+
+    with app_ctx.test_request_context():
+        assert (
+            thing_description.to_dict()["properties"]["index"]["@type"]
+            == "LevelProperty"
+        )
+        assert thing_description.to_dict()["properties"]["index"]["type"] == "integer"
+        assert thing_description.to_dict()["properties"]["index"]["minimum"] == 0
+        assert thing_description.to_dict()["properties"]["index"]["maximum"] == 100
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
+
+
+def test_moz_BrightnessProperty(helpers, app, thing_description, app_ctx, schemas_path):
+    @semantics.moz.BrightnessProperty()
+    class Index(View):
+        def get(self):
+            return "GET"
+
+    app.add_url_rule("/", view_func=Index.as_view("index"))
+    rules = app.url_map._rules_by_endpoint["index"]
+
+    thing_description.property(rules, Index)
+
+    with app_ctx.test_request_context():
+        assert (
+            thing_description.to_dict()["properties"]["index"]["@type"]
+            == "BrightnessProperty"
+        )
+        assert thing_description.to_dict()["properties"]["index"]["type"] == "integer"
+        assert thing_description.to_dict()["properties"]["index"]["minimum"] == 0
+        assert thing_description.to_dict()["properties"]["index"]["maximum"] == 100
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
+
+
+def test_moz_OnOffProperty(helpers, app, thing_description, app_ctx, schemas_path):
+    @semantics.moz.OnOffProperty()
+    class Index(View):
+        def get(self):
+            return "GET"
+
+    app.add_url_rule("/", view_func=Index.as_view("index"))
+    rules = app.url_map._rules_by_endpoint["index"]
+
+    thing_description.property(rules, Index)
+
+    with app_ctx.test_request_context():
+        assert (
+            thing_description.to_dict()["properties"]["index"]["@type"]
+            == "OnOffProperty"
+        )
+        assert thing_description.to_dict()["properties"]["index"]["type"] == "boolean"
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)

tests/test_server_spec_td.py

@@ -1,8 +1,5 @@
 import pytest
 
-import os
-import json
-import jsonschema
 from labthings.server import fields
 from labthings.server.view import View
 from labthings.server.spec import td
@@ -13,17 +10,6 @@ def thing_description(thing):
     return thing.thing_description
 
 
-def validate_thing_description(thing_description, app_ctx, schemas_path):
-    schema = json.load(open(os.path.join(schemas_path, "td_schema.json"), "r"))
-    jsonschema.Draft7Validator.check_schema(schema)
-
-    with app_ctx.test_request_context():
-        td_json = thing_description.to_dict()
-        assert td_json
-
-    jsonschema.validate(instance=td_json, schema=schema)
-
-
 def test_find_schema_for_view_readonly():
     class ViewClass:
         def get(self):
@@ -58,13 +44,13 @@ class ViewClass:
     assert td.find_schema_for_view(ViewClass) == {}
 
 
-def test_td_init(thing_description, app_ctx, schemas_path):
+def test_td_init(helpers, thing_description, app_ctx, schemas_path):
     assert thing_description
 
-    validate_thing_description(thing_description, app_ctx, schemas_path)
+    helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
-def test_td_add_link(thing_description, view_cls, app_ctx, schemas_path):
+def test_td_add_link(helpers, thing_description, view_cls, app_ctx, schemas_path):
     thing_description.add_link(view_cls, "rel")
     assert {
         "rel": "rel",
@@ -73,7 +59,7 @@ def test_td_add_link(thing_description, view_cls, app_ctx, schemas_path):
         "kwargs": {},
     } in thing_description._links
 
-    validate_thing_description(thing_description, app_ctx, schemas_path)
+    helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
 def test_td_add_link_options(thing_description, view_cls):
@@ -99,18 +85,20 @@ def test_td_links(thing_description, app_ctx, view_cls):
         )
 
 
-def test_td_action(app, thing_description, view_cls, app_ctx, schemas_path):
+def test_td_action(helpers, app, thing_description, view_cls, app_ctx, schemas_path):
     app.add_url_rule("/", view_func=view_cls.as_view("index"))
     rules = app.url_map._rules_by_endpoint["index"]
 
     thing_description.action(rules, view_cls)
 
     with app_ctx.test_request_context():
         assert "index" in thing_description.to_dict().get("actions")
-        validate_thing_description(thing_description, app_ctx, schemas_path)
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
-def test_td_action_with_schema(app, thing_description, view_cls, app_ctx, schemas_path):
+def test_td_action_with_schema(
+    helpers, app, thing_description, view_cls, app_ctx, schemas_path
+):
     view_cls.post.__apispec__ = {
         "_params": {"integer": fields.Int()},
         "@type": "ToggleAction",
@@ -128,10 +116,10 @@ def test_td_action_with_schema(app, thing_description, view_cls, app_ctx, schema
             "properties": {"integer": {"type": "integer", "format": "int32"}},
             "@type": "ToggleAction",
         }
-        validate_thing_description(thing_description, app_ctx, schemas_path)
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
-def test_td_property(app, thing_description, app_ctx, schemas_path):
+def test_td_property(helpers, app, thing_description, app_ctx, schemas_path):
     class Index(View):
         def get(self):
             return "GET"
@@ -143,17 +131,18 @@ def get(self):
 
     with app_ctx.test_request_context():
         assert "index" in thing_description.to_dict().get("properties")
-        validate_thing_description(thing_description, app_ctx, schemas_path)
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
-def test_td_property_with_schema(app, thing_description, app_ctx, schemas_path):
+def test_td_property_with_schema(
+    helpers, app, thing_description, app_ctx, schemas_path
+):
     class Index(View):
         def get(self):
             return "GET"
 
     Index.__apispec__ = {
-        "_propertySchema": {"integer": fields.Int()},
-        "@type": "OnOffProperty",
+        "_propertySchema": fields.Int(required=True),
     }
 
     app.add_url_rule("/", view_func=Index.as_view("index"))
@@ -163,11 +152,12 @@ def get(self):
 
     with app_ctx.test_request_context():
         assert "index" in thing_description.to_dict().get("properties")
-        assert "@type" in thing_description.to_dict().get("properties").get("index", {})
-        validate_thing_description(thing_description, app_ctx, schemas_path)
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
-def test_td_property_with_url_param(app, thing_description, app_ctx, schemas_path):
+def test_td_property_with_url_param(
+    helpers, app, thing_description, app_ctx, schemas_path
+):
     class Index(View):
         def get(self):
             return "GET"
@@ -179,10 +169,10 @@ def get(self):
 
     with app_ctx.test_request_context():
         assert "index" in thing_description.to_dict().get("properties")
-        validate_thing_description(thing_description, app_ctx, schemas_path)
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)
 
 
-def test_td_property_write_only(app, thing_description, app_ctx, schemas_path):
+def test_td_property_write_only(helpers, app, thing_description, app_ctx, schemas_path):
     class Index(View):
         def post(self):
             return "POST"
@@ -196,4 +186,4 @@ def post(self):
 
     with app_ctx.test_request_context():
         assert "index" in thing_description.to_dict().get("properties")
-        validate_thing_description(thing_description, app_ctx, schemas_path)
+        helpers.validate_thing_description(thing_description, app_ctx, schemas_path)