Add strict validation via pydantic for all events (#361)

Author: raman325

.github/workflows/test.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Upload coverage data
         uses: "actions/[email protected]"
         with:
-          name: coverage-data
+          name: coverage-${{ matrix.python-version }}
           path: "coverage.xml"
 
   coverage:
@@ -47,9 +47,7 @@ jobs:
         uses: actions/[email protected]
         with:
           fetch-depth: 2
-      - name: Download coverage data
+      - name: Download all coverage data
         uses: actions/[email protected]
-        with:
-          name: coverage-data
       - name: Upload coverage report
         uses: codecov/[email protected]

pylintrc

@@ -4,6 +4,7 @@ ignore=tests
 # any too bad. Override on command line as appropriate.
 jobs=2
 persistent=no
+extension-pkg-whitelist=pydantic
 
 [BASIC]
 good-names=id,i,j,k,ex,Run,_,fp

requirements.txt

@@ -1 +1,2 @@
 aiohttp==3.8.1
+pydantic==1.9.0

setup.cfg

@@ -22,6 +22,7 @@ use_parentheses = True
 line_length = 88
 
 [mypy]
+plugins = pydantic.mypy
 follow_imports = skip
 ignore_missing_imports = true
 check_untyped_defs = true

setup.py

@@ -20,7 +20,7 @@
     long_description_content_type="text/markdown",
     packages=find_packages(exclude=["test.*", "test"]),
     python_requires=">=3.8",
-    install_requires=["aiohttp>3"],
+    install_requires=["aiohttp>3", "pydantic>=1.9.0"],
     entry_points={
         "console_scripts": ["zwave-js-server-python = zwave_js_server.__main__:main"]
     },

test/fixtures/multisensor_6_state.json

@@ -10,7 +10,7 @@
     "generic": { "key": 2, "label": "Multilevel Sensor" },
     "specific": { "key": 3, "label": "Routing Multilevel Sensor" },
     "mandatorySupportedCCs": [],
-    "mandatoryControlCCs": []
+    "mandatoryControlledCCs": []
   },
   "isListening": true,
   "isFrequentListening": false,

test/model/test_controller.py

@@ -1358,3 +1358,43 @@ async def test_nvm_events(controller):
     )
     controller.receive_event(event)
     assert event.data["nvm_restore_progress"] == controller_pkg.NVMProgress(5, 6)
+
+
+async def test_node_added(controller, multisensor_6_state):
+    """Test node added event."""
+    event = Event(
+        "node added",
+        {
+            "source": "controller",
+            "event": "node added",
+            "node": multisensor_6_state,
+            "result": "",
+        },
+    )
+    controller.receive_event(event)
+    assert event.data["node"].node_id == 52
+
+
+async def test_node_removed(client, multisensor_6, multisensor_6_state):
+    """Test node removed event."""
+    event = Event(
+        "node removed",
+        {
+            "source": "controller",
+            "event": "node removed",
+            "node": multisensor_6_state,
+            "replaced": False,
+        },
+    )
+    client.driver.controller.receive_event(event)
+    assert event.data["node"].node_id == 52
+    assert event.data["node"].client is None
+    assert 52 not in client.driver.controller.nodes
+
+
+async def test_unknown_event(controller):
+    """Test that an unknown event type causes an exception."""
+    with pytest.raises(KeyError):
+        assert controller.receive_event(
+            Event("unknown_event", {"source": "controller"})
+        )

test/model/test_driver.py

@@ -1,6 +1,8 @@
 """Test the driver model."""
 import json
 
+import pytest
+
 from zwave_js_server.const import LogLevel
 from zwave_js_server.event import Event
 from zwave_js_server.model import driver as driver_pkg
@@ -315,3 +317,9 @@ async def test_set_preferred_scales(driver, uuid4, mock_command):
         "scales": {1: 1},
         "messageId": uuid4,
     }
+
+
+async def test_unknown_event(driver):
+    """Test that an unknown event type causes an exception."""
+    with pytest.raises(KeyError):
+        assert driver.receive_event(Event("unknown_event", {"source": "driver"}))

test/model/test_node.py

@@ -438,7 +438,7 @@ async def test_abort_firmware_update(multisensor_6, uuid4, mock_command):
     }
 
 
-def test_node_inclusion():
+def test_node_inclusion(multisensor_6_state):
     """Emulate a node being added."""
     # when a node node is added, it has minimal info first
     node = node_pkg.Node(
@@ -451,8 +451,16 @@ def test_node_inclusion():
     assert node.device_config.manufacturer is None
 
     # the ready event contains a full (and complete) dump of the node, including values
-    state = json.loads(load_fixture("multisensor_6_state.json"))
-    event = Event("ready", {"nodeState": state})
+    event = Event(
+        "ready",
+        {
+            "event": "ready",
+            "source": "node",
+            "nodeId": node.node_id,
+            "nodeState": multisensor_6_state,
+            "result": [],
+        },
+    )
     node.receive_event(event)
 
     assert node.device_config.manufacturer == "AEON Labs"
@@ -1102,6 +1110,7 @@ async def test_statistics_updated(wallmote_central_scene: node_pkg.Node):
         {
             "source": "node",
             "event": "statistics updated",
+            "nodeId": node.node_id,
             "statistics": {
                 "commandsTX": 1,
                 "commandsRX": 1,
@@ -1441,3 +1450,9 @@ async def test_set_keep_awake(multisensor_6: node_pkg.Node, uuid4, mock_command)
         "keepAwake": False,
         "messageId": uuid4,
     }
+
+
+async def test_unknown_event(multisensor_6: node_pkg.Node):
+    """Test that an unknown event type causes an exception."""
+    with pytest.raises(KeyError):
+        assert multisensor_6.receive_event(Event("unknown_event", {"source": "node"}))

test/test_event.py

@@ -1,5 +1,4 @@
 """Test event helpers."""
-
 from zwave_js_server import event