fix on_attributes_update bacnet tests

Author: Andry925

tests/unit/connectors/bacnet/test_on_attribute_updates.py

@@ -25,44 +25,75 @@ class BacnetOnAttributeUpdatesTestCase(BacnetBaseTestCase):
     async def asyncSetUp(self):
         await super().asyncSetUp()
         self.connector._AsyncBACnetConnector__application = AsyncMock()
-        self._loop_thread = Thread(target=self.connector.loop.run_forever, daemon=True)
-        self._loop_thread.start()
 
     async def asyncTearDown(self):
-        self.connector.loop.call_soon_threadsafe(self.connector.loop.stop)
-        self._loop_thread.join(timeout=1)
-
         await super().asyncTearDown()
 
-    async def test_retrieve_device_obj_by_name_success(self):
-        payload = {'device': self.DEVICE_NAME, 'data': {'binaryValue2': True}}
-        device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
+    async def test_retrieve_device_by_name_success(self):
+        payload = {"device": self.DEVICE_NAME, "data": {"binaryValue2": True}}
+
+        fake_task = MagicMock()
+        fake_task.done.return_value = True
+        fake_task.result.return_value = self.device  # success
+
+        with patch.object(self.connector.loop, "create_task", return_value=fake_task) as ct_mock:
+            device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
+
+        ct_mock.assert_called_once()
         self.assertIsInstance(device, Device)
         self.assertIs(device, self.device)
         self.assertEqual(device.name, self.DEVICE_NAME)
 
     async def test_get_device_by_name_missing_device_key(self):
-        payload = {'data': {'binaryValue2': True}}
+        payload = {"data": {"binaryValue2": True}}
+        fake_task = MagicMock()
+        fake_task.done.return_value = True
+        fake_task.result.return_value = None
 
-        device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
+        with patch.object(self.connector.loop, "create_task", return_value=fake_task), \
+                self.assertLogs("Bacnet test", level="ERROR") as logcap:
+            device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
 
         self.assertIsNone(device)
+        self.assertTrue(any("does not contain a device name" in m for m in logcap.output))
 
-    async def test_retrieve_device_obj_on_non_existent_device(self):
-        payload = {'device': 'test emulator device22', 'data': {'binaryValue2': True}}
-        device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
+    async def test_retrieve_device_on_non_existent_device(self):
+        payload = {"device": "non-existent-device", "data": {"binaryValue2": True}}
+
+        fake_task = MagicMock()
+        fake_task.done.return_value = True
+        fake_task.result.return_value = None
+
+        with patch.object(self.connector.loop, "create_task", return_value=fake_task) as ct_mock:
+            device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
+
+        ct_mock.assert_called_once()
         self.assertIsNone(device)
 
     async def test_get_device_by_name_timeout(self):
-        payload = {'device': self.DEVICE_NAME, 'data': {'binaryValue2': True}}
-        with patch("asyncio.run_coroutine_threadsafe") as timeout_mock_task:
-            fake_future = MagicMock()
-            fake_future.result.side_effect = TimeoutError
-            fake_future.done.return_value = False
-            timeout_mock_task.return_value = fake_future
+        payload = {"device": self.DEVICE_NAME, "data": {"binaryValue2": True}}
+        fake_task = MagicMock()
+        fake_task.done.return_value = False
+
+        with patch.object(self.connector.loop, "create_task", return_value=fake_task) as ct_mock, \
+                patch.object(self.connector, "_AsyncBACnetConnector__wait_task_with_timeout",
+                             return_value=(False, None)) as waiter_mock, \
+                self.assertLogs("Bacnet test", level="DEBUG") as logcap:
             device = self.connector._AsyncBACnetConnector__get_device_by_name(payload=payload)
+
+        ct_mock.assert_called_once()
+        waiter_mock.assert_called_once()
         self.assertIsNone(device)
-        fake_future.cancel.assert_called_once()
+        self.assertTrue(any("look up task failed on timeout" in m for m in logcap.output))
+
+    async def test_update_attribute_update_with_device_not_found(self):
+        self.connector._AsyncBACnetConnector__get_device_by_name = MagicMock()
+        self.connector._AsyncBACnetConnector__get_device_by_name.return_value = None
+        payload = {'device': 'test emulator device22', 'data': {'binaryValue2': True}}
+        with patch.object(self.connector, "_AsyncBACnetConnector__create_task") as create_task_mock, \
+                self.assertLogs("Bacnet test", level="ERROR") as logcap:
+            self.connector.on_attributes_update(payload)
+        create_task_mock.assert_not_called()
 
     async def test_update_when_device_has_no_mapping(self):
         payload = {"device": self.device.name, "data": {"binaryValue2": True}}
@@ -71,6 +102,8 @@ async def test_update_when_device_has_no_mapping(self):
             'attribute_updates/on_attribute_updates_bacnet_config_empty_section.json'
         )
         await self.connector._AsyncBACnetConnector__devices.add(self.device)
+        self.connector._AsyncBACnetConnector__get_device_by_name = MagicMock()
+        self.connector._AsyncBACnetConnector__get_device_by_name.return_value = self.device
 
         with patch.object(self.connector, "_AsyncBACnetConnector__create_task") as create_task_mock, \
                 self.assertLogs("Bacnet test", level="ERROR") as logcap:
@@ -86,6 +119,8 @@ async def test_update_incorrect_object_id_mixed(self):
             "attribute_updates/on_attribute_updates_bacnet_config_incorrect_object_id.json"
         )
         await self.connector._AsyncBACnetConnector__devices.add(self.device)
+        self.connector._AsyncBACnetConnector__get_device_by_name = MagicMock()
+        self.connector._AsyncBACnetConnector__get_device_by_name.return_value = self.device
 
         with patch.object(self.connector, "_AsyncBACnetConnector__create_task") as ct_mock, \
                 self.assertLogs("Bacnet test", level="ERROR") as logcap:
@@ -109,6 +144,8 @@ async def test_update_multiple_correct_attribute(self):
             "attribute_updates/on_attribute_updates_bacnet_connector_multiple_updates.json"
         )
         await self.connector._AsyncBACnetConnector__devices.add(self.device)
+        self.connector._AsyncBACnetConnector__get_device_by_name = MagicMock()
+        self.connector._AsyncBACnetConnector__get_device_by_name.return_value = self.device
 
         with patch.object(self.connector, "_AsyncBACnetConnector__create_task") as ct_mock:
             self.connector.on_attributes_update(content=payload)
@@ -122,6 +159,8 @@ async def test_update_attribute_update_with_incorrect_object_id_datatype(self):
             "attribute_updates/on_attribute_updates_bacnet_config_invalid_data_type.json"
         )
         await self.connector._AsyncBACnetConnector__devices.add(self.device)
+        self.connector._AsyncBACnetConnector__get_device_by_name = MagicMock()
+        self.connector._AsyncBACnetConnector__get_device_by_name.return_value = self.device
 
         with patch.object(self.connector, "_AsyncBACnetConnector__create_task") as ct_mock, \
                 self.assertLogs("Bacnet test", level="ERROR") as logcap:
@@ -130,17 +169,18 @@ async def test_update_attribute_update_with_incorrect_object_id_datatype(self):
         ct_mock.assert_not_called()
         self.assertTrue(any("for key" in m for m in logcap.output))
 
-    async def test_update_continues_when_first_task_raises(self):
+    async def test_update_continues_when_first_task_failed(self):
         payload = {"device": self.device.name, "data": {"binaryValue2": True, "binaryInput1": 56}}
         await self.connector._AsyncBACnetConnector__devices.remove(self.device)
         self.device = self.create_fake_device(
             "attribute_updates/on_attribute_updates_bacnet_connector_multiple_updates.json"
         )
         await self.connector._AsyncBACnetConnector__devices.add(self.device)
+        self.connector._AsyncBACnetConnector__get_device_by_name = MagicMock()
+        self.connector._AsyncBACnetConnector__get_device_by_name.return_value = self.device
 
         with patch.object(self.connector, "_AsyncBACnetConnector__create_task") as ct_mock, \
                 self.assertLogs("Bacnet test", level="ERROR") as logcap:
             ct_mock.side_effect = [Exception(""), None]
             self.connector.on_attributes_update(payload)
         self.assertEqual(ct_mock.call_count, 2)
-