Allowing CR1000X properties to be set

Author: lewis-chambers

src/iotdevicesimulator/devices.py

@@ -2,6 +2,7 @@
 
 import asyncio
 import logging
+from iotdevicesimulator import __version__ as package_version
 from iotdevicesimulator.queries import CosmosQuery
 from iotdevicesimulator.db import BaseDatabase, Oracle
 from iotdevicesimulator.messaging.core import MessagingBaseClass
@@ -287,6 +288,42 @@ class CR1000XDevice(BaseDevice):
 
     device_type = "CR1000X"
 
+    serial_number: str = "00000"
+    """Serial number of the device instance."""
+
+    os_version: str = f"{device_type}.Std.07.02"
+    """Operating system installed on the device."""
+
+    program_name: str = f"CPU:iotdevicesimulator-{package_version}.CR1X"
+    """Name of logger program being run."""
+
+    table_name: str = "default"
+    """Name of table being submitted by logger."""
+
+    def __init__(
+        self,
+        *args,
+        serial_number: str | None = None,
+        os_version: str | None = None,
+        program_name: str | None = None,
+        table_name: str | None = None,
+        **kwargs,
+    ):
+        """Initialises the class"""
+        super().__init__(*args, **kwargs)
+
+        if serial_number is not None:
+            self.serial_number = str(serial_number)
+
+        if os_version is not None:
+            self.os_version = str(os_version)
+
+        if program_name is not None:
+            self.program_name = str(program_name)
+
+        if table_name is not None:
+            self.table_name = str(table_name)
+
     @staticmethod
     def _build_field(
         name: str,
@@ -333,11 +370,11 @@ def _format_payload(self, payload: dict) -> dict:
             "signature": 111111,
             "environment": {
                 "station_name": self.device_id,
-                "table_name": "no table",
+                "table_name": self.table_name,
                 "model": self.device_type,
-                "serial_no": "00000",
-                "os_version": f"{self.device_type}.Std.07.02",
-                "prog_name": "CPU:not_real.CR1X",
+                "serial_no": self.serial_number,
+                "os_version": self.os_version,
+                "prog_name": self.program_name,
             },
         }
 

src/tests/test_devices.py

@@ -454,6 +454,7 @@ def setUp(self):
         self.conn = MockMessageConnection()
         self.maxDiff = None
 
+    
     def test_instantiation(self):
         """Tests that object can be instantiated."""
 
@@ -463,6 +464,34 @@ def test_instantiation(self):
         self.assertIsInstance(inst, BaseDevice)
         self.assertEqual(inst.device_type, "CR1000X")
 
+    @parameterized.expand([123456, "newserial", 123.2])
+    def test_serial_number_set(self, arg):
+        """Tests that serial number gets set when argument given."""
+        inst = CR1000XDevice("device", self.db, self.conn, serial_number=arg)
+
+        self.assertEqual(inst.serial_number, str(arg))
+
+    @parameterized.expand(["test os version", "newserial", 123.2])
+    def test_os_version_set(self, arg):
+        """Tests that os_version gets set when argument given."""
+        inst = CR1000XDevice("device", self.db, self.conn, os_version=arg)
+
+        self.assertEqual(inst.os_version, str(arg))
+
+    @parameterized.expand([123456, "newserial", 123.2])
+    def test_program_name_set(self, arg):
+        """Tests that program name gets set when argument given."""
+        inst = CR1000XDevice("device", self.db, self.conn, program_name=arg)
+
+        self.assertEqual(inst.program_name, str(arg))
+
+    @parameterized.expand([123456, "newserial", 123.2])
+    def test_table_name_set(self, arg):
+        """Tests that table_name gets set when argument given."""
+        inst = CR1000XDevice("device", self.db, self.conn, table_name=arg)
+
+        self.assertEqual(inst.table_name, str(arg))
+
     def test_list_payload_formatting(self):
         payload = [1,"data", "true", True]
 
@@ -475,12 +504,12 @@ def test_list_payload_formatting(self):
                 "transaction": 0,
                 "signature": 111111,
                 "environment": {
-                    "station_name": "my_device",
-                    "table_name": "no table",
+                    "station_name": device.device_id,
+                    "table_name": device.table_name,
                     "model": device.device_type,
-                    "serial_no": "00000",
-                    "os_version": f"{device.device_type}.Std.07.02",
-                    "prog_name": "CPU:not_real.CR1X"
+                    "serial_no": device.serial_number,
+                    "os_version": device.os_version,
+                    "prog_name": device.program_name
                 },
                 "fields": [
                     {
@@ -540,11 +569,11 @@ def test_dict_payload_formatting(self):
                 "signature": 111111,
                 "environment": {
                     "station_name": device.device_id,
-                    "table_name": "no table",
+                    "table_name": device.table_name,
                     "model": device.device_type,
-                    "serial_no": "00000",
-                    "os_version": f"{device.device_type}.Std.07.02",
-                    "prog_name": "CPU:not_real.CR1X"
+                    "serial_no": device.serial_number,
+                    "os_version": device.os_version,
+                    "prog_name": device.program_name
                 },
                 "fields": [
                     {