fix: Fixed the test for the example ready to test on hardware

Author: Aiky30

standalone_modules/rpi/device.py

@@ -16,14 +16,14 @@ class RPIDevice:
     def __init__(
         self,
         submission_service: ReadingSubmissionService,
-        device_module_id: int,
-        cpu_module_id: int,
+        device_module_id: str,
+        cpu_module_id: str,
     ) -> None:
         self.device_module_id = device_module_id
         self.cpu_module_id = cpu_module_id
         self.submission_service = submission_service
 
-    def get_cpu_temp(self):
+    def get_cpu_temp(self) -> float:
         cpu_temp = os.popen("vcgencmd measure_temp").readline()
 
         # Convert the temp read from the OS to a clean float
@@ -36,12 +36,10 @@ def submit_reading(self) -> requests.Response:
         :return:
         """
         cpu_temp = self.get_cpu_temp()
-
-        # FIXME: Should this be a float or a string? Broke the test
         data = {"temperature": str(cpu_temp)}
 
         response = self.submission_service.submit(
-            device_module_id=self.device_module_id, data=data
+            device_module_id=self.cpu_module_id, data=data
         )
 
         return response

standalone_modules/shed_pi_example_device_installation/config.ini

@@ -0,0 +1,11 @@
+[server]
+url = http://localhost:8000
+
+[device]
+module_id = 0
+
+[external_temp]
+module_id = 0
+
+[cpu_temp]
+module_id = 0

standalone_modules/shed_pi_example_device_installation/device_protocol.py

@@ -1,5 +1,5 @@
+import configparser
 import time
-from typing import Optional
 
 import requests
 from shed_pi_module_utils.base_protocol import BaseProtocol
@@ -18,23 +18,32 @@ class DeviceProtocol(BaseProtocol):
     def __init__(
         self,
         submission_service: ReadingSubmissionService,
-        temp_probe_device_id: Optional[int] = None,
     ):
+        config = self.get_config()
+        device_module_id: str = config["device"]["module_id"]
+        ext_temp_module_id: str = config["external_temp"]["module_id"]
+        cpu_temp_module_id: str = config["cpu_temp"]["module_id"]
+
         # Installed modules
         self.temp_probe = TempProbe()
         self.rpi_device = RPIDevice(
             submission_service=submission_service,
-            device_module_id=None,
-            cpu_module_id=None,
+            device_module_id=device_module_id,
+            cpu_module_id=cpu_temp_module_id,
         )
         self.submission_delay = TIME_TO_SLEEP
 
-        # FIXME: Part of the migration of submission service out of the probe driver
         self.submission_service = submission_service
-        self.temp_probe_device_id = temp_probe_device_id
+        self.temp_probe_device_id = ext_temp_module_id
+
+    def get_config(self) -> dict:
+        config = configparser.ConfigParser()
+        config.read("config.ini")
+        return config
 
     def stop(self):
-        # FIXKE: This should be a threading event, to break when the execution is terminated, prevents leaving threads behind
+        # FIXME: This should be a threading event, to break when the execution is terminated,
+        #       prevents leaving threads behind
         return False
 
     def startup(self):
@@ -51,7 +60,7 @@ def run(self):
     def shutdown(self):
         self.rpi_device.submit_device_shutdown()
 
-    def get_reading(self) -> bytes:
+    def get_reading(self) -> float:
         """
         Useful for collecting many readings from different modules, rather than submitting all
         at once
@@ -65,8 +74,6 @@ def submit_reading(self) -> requests.Response:
         :return:
         """
         probe_1_temp = self.get_reading()
-
-        # FIXME: Should this be a float or a string? Broke the test
         data = {"temperature": str(probe_1_temp)}
 
         response = self.submission_service.submit(

standalone_modules/shed_pi_example_device_installation/tests/unit/test_device_protocol.py

@@ -1,4 +1,4 @@
-from unittest.mock import Mock
+from unittest.mock import Mock, patch
 
 import pytest
 from shed_pi_module_utils.data_submission import (
@@ -27,23 +27,6 @@ def test_device_protocol(temp_probe_path, live_server):
         },
     }
     temp_probe = DeviceModuleFactory(schema=schema)
-    # Submission service
-    submission_service = ReadingSubmissionService()
-    submission_service.base_url = live_server.url
-    # Device Protocol
-    device_protocol = DeviceProtocol(
-        submission_service=submission_service, temp_probe_device_id=temp_probe.id
-    )
-    # Override the loop timer for the test to end instantly
-    device_protocol.submission_delay = 0
-    device_protocol.stop = Mock(side_effect=[False, True])
-
-    device_protocol.temp_probe.read_temp_raw = Mock(
-        return_value=[
-            "YES",
-            "t=12345",
-        ]
-    )
     # RPI CPU temp probe
     rpi_schema = {
         "$id": "https://example.com/person.schema.json",
@@ -55,10 +38,35 @@ def test_device_protocol(temp_probe_path, live_server):
         },
     }
     rpi_cpu_temp = DeviceModuleFactory(schema=rpi_schema)
-    device_protocol.rpi_device.device_module_id = rpi_cpu_temp.id
+    # Submission service
+    submission_service = ReadingSubmissionService()
+    submission_service.base_url = live_server.url
+    config = {
+        "device": {
+            "module_id": "",
+        },
+        "external_temp": {
+            "module_id": temp_probe.id,
+        },
+        "cpu_temp": {"module_id": rpi_cpu_temp.id},
+    }
+    with patch.object(DeviceProtocol, "get_config", Mock(return_value=config)):
+        # Device Protocol
+        device_protocol = DeviceProtocol(submission_service=submission_service)
+
+    # Override the loop timer for the test to end instantly
+    # FIXME: This is just a patched sleep!
+    device_protocol.submission_delay = 0
+    device_protocol.stop = Mock(side_effect=[False, True])
+    device_protocol.temp_probe.read_temp = Mock(
+        return_value=30.00,
+    )
     device_protocol.rpi_device.get_cpu_temp = Mock(return_value=10.0)
 
-    device_protocol.run()
+    # FIXME: Would be better if we could run for a cycle and exit to prove out the run
+    #       method
+    device_protocol.submit_reading()
+    device_protocol.rpi_device.submit_reading()
 
     # Check that the data was submitted
     assert DeviceModuleReading.objects.filter(device_module=rpi_cpu_temp).count() == 1