|
| 1 | +# Copyright 2026. ThingsBoard |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +import logging |
| 16 | +from types import SimpleNamespace |
| 17 | +from unittest import IsolatedAsyncioTestCase |
| 18 | +from unittest.mock import AsyncMock |
| 19 | + |
| 20 | +from bacpypes3.basetypes import Segmentation |
| 21 | +from bacpypes3.pdu import Address |
| 22 | + |
| 23 | +from thingsboard_gateway.connectors.bacnet.bacnet_connector import AsyncBACnetConnector |
| 24 | + |
| 25 | + |
| 26 | +class TestConfiguredIAmFallback(IsolatedAsyncioTestCase): |
| 27 | + |
| 28 | + async def asyncSetUp(self): |
| 29 | + self.connector = AsyncBACnetConnector.__new__(AsyncBACnetConnector) |
| 30 | + self.connector._AsyncBACnetConnector__log = logging.getLogger("bacnet configured i-am tests") |
| 31 | + self.connector._AsyncBACnetConnector__application = AsyncMock() |
| 32 | + self.connector._AsyncBACnetConnector__stopped = False |
| 33 | + |
| 34 | + async def test_build_i_am_from_device_config_without_probe(self): |
| 35 | + device_config = { |
| 36 | + "objectName": "manual-device", |
| 37 | + "vendorIdentifier": "221", |
| 38 | + "maxApduLengthAccepted": "2048", |
| 39 | + "segmentationSupported": "segmentedBoth" |
| 40 | + } |
| 41 | + |
| 42 | + apdu = await self.connector._AsyncBACnetConnector__build_i_am_like_apdu( |
| 43 | + Address("192.168.1.199:47808"), |
| 44 | + 101, |
| 45 | + device_config |
| 46 | + ) |
| 47 | + |
| 48 | + self.assertIsNotNone(apdu) |
| 49 | + self.assertEqual(apdu.iAmDeviceIdentifier, ("device", 101)) |
| 50 | + self.assertEqual(apdu.deviceName, "manual-device") |
| 51 | + self.assertEqual(apdu.vendorID, 221) |
| 52 | + self.assertEqual(apdu.maxAPDULengthAccepted, 2048) |
| 53 | + self.assertEqual(apdu.segmentationSupported, Segmentation.segmentedBoth) |
| 54 | + self.connector._AsyncBACnetConnector__application.read_property.assert_not_called() |
| 55 | + |
| 56 | + async def test_build_i_am_returns_defaults_without_probe(self): |
| 57 | + self.connector._AsyncBACnetConnector__application.read_property = AsyncMock(side_effect=RuntimeError("No response")) |
| 58 | + |
| 59 | + apdu = await self.connector._AsyncBACnetConnector__build_i_am_like_apdu( |
| 60 | + Address("192.168.1.200:47808"), |
| 61 | + 102, |
| 62 | + {} |
| 63 | + ) |
| 64 | + |
| 65 | + self.assertIsNotNone(apdu) |
| 66 | + self.assertEqual(apdu.deviceName, "102") |
| 67 | + self.assertEqual(apdu.vendorID, 0) |
| 68 | + self.assertEqual(apdu.maxAPDULengthAccepted, 50) |
| 69 | + self.assertEqual(apdu.segmentationSupported, Segmentation.noSegmentation) |
| 70 | + self.assertEqual(self.connector._AsyncBACnetConnector__application.read_property.await_count, 4) |
| 71 | + |
| 72 | + async def test_build_i_am_with_partial_config_and_probe_fill(self): |
| 73 | + self.connector._AsyncBACnetConnector__application.read_property = AsyncMock(side_effect=[ |
| 74 | + "probed-device-name", |
| 75 | + 1476, |
| 76 | + Segmentation.segmentedTransmit |
| 77 | + ]) |
| 78 | + |
| 79 | + device_config = { |
| 80 | + "vendorIdentifier": 99 |
| 81 | + } |
| 82 | + |
| 83 | + apdu = await self.connector._AsyncBACnetConnector__build_i_am_like_apdu( |
| 84 | + Address("192.168.1.201:47808"), |
| 85 | + 103, |
| 86 | + device_config |
| 87 | + ) |
| 88 | + |
| 89 | + self.assertIsNotNone(apdu) |
| 90 | + self.assertEqual(apdu.deviceName, "probed-device-name") |
| 91 | + self.assertEqual(apdu.vendorID, 99) |
| 92 | + self.assertEqual(apdu.maxAPDULengthAccepted, 1476) |
| 93 | + self.assertEqual(apdu.segmentationSupported, Segmentation.segmentedTransmit) |
| 94 | + self.assertEqual( |
| 95 | + [call.args[2] for call in self.connector._AsyncBACnetConnector__application.read_property.await_args_list], |
| 96 | + ["objectName", "maxApduLengthAccepted", "segmentationSupported"] |
| 97 | + ) |
| 98 | + |
| 99 | + async def test_discover_devices_defaults_to_setup_without_discovery(self): |
| 100 | + self.connector._AsyncBACnetConnector__config = { |
| 101 | + "devices": [ |
| 102 | + { |
| 103 | + "address": "192.168.1.202:47808", |
| 104 | + "deviceId": 104 |
| 105 | + } |
| 106 | + ] |
| 107 | + } |
| 108 | + self.connector._AsyncBACnetConnector__add_configured_device_without_iam = AsyncMock() |
| 109 | + |
| 110 | + await self.connector._AsyncBACnetConnector__discover_devices() |
| 111 | + |
| 112 | + self.connector._AsyncBACnetConnector__add_configured_device_without_iam.assert_awaited_once() |
| 113 | + self.connector._AsyncBACnetConnector__application.do_who_is.assert_not_awaited() |
| 114 | + |
| 115 | + async def test_discover_devices_runs_who_is_when_setup_without_discovery_disabled(self): |
| 116 | + self.connector._AsyncBACnetConnector__config = { |
| 117 | + "devices": [ |
| 118 | + { |
| 119 | + "address": "192.168.1.202:47808", |
| 120 | + "deviceId": 104, |
| 121 | + "setupWithoutDiscovery": False |
| 122 | + } |
| 123 | + ] |
| 124 | + } |
| 125 | + self.connector._AsyncBACnetConnector__add_configured_device_without_iam = AsyncMock() |
| 126 | + |
| 127 | + await self.connector._AsyncBACnetConnector__discover_devices() |
| 128 | + |
| 129 | + self.connector._AsyncBACnetConnector__application.do_who_is.assert_awaited_once_with( |
| 130 | + device_address="192.168.1.202:47808" |
| 131 | + ) |
| 132 | + self.connector._AsyncBACnetConnector__add_configured_device_without_iam.assert_not_awaited() |
| 133 | + |
| 134 | + async def test_discover_devices_uses_who_is_for_pattern_address(self): |
| 135 | + self.connector._AsyncBACnetConnector__config = { |
| 136 | + "devices": [ |
| 137 | + { |
| 138 | + "address": "192.168.1.X:47808", |
| 139 | + "deviceId": 104 |
| 140 | + } |
| 141 | + ] |
| 142 | + } |
| 143 | + self.connector._AsyncBACnetConnector__add_configured_device_without_iam = AsyncMock() |
| 144 | + |
| 145 | + await self.connector._AsyncBACnetConnector__discover_devices() |
| 146 | + |
| 147 | + self.connector._AsyncBACnetConnector__application.do_who_is.assert_awaited_once() |
| 148 | + self.connector._AsyncBACnetConnector__add_configured_device_without_iam.assert_not_awaited() |
| 149 | + |
| 150 | + async def test_set_additional_device_info_keeps_manual_name_when_probe_fails(self): |
| 151 | + self.connector._AsyncBACnetConnector__application.get_device_name = AsyncMock(return_value=None) |
| 152 | + apdu = SimpleNamespace( |
| 153 | + pduSource=Address("192.168.1.203:47808"), |
| 154 | + iAmDeviceIdentifier=("device", 105), |
| 155 | + deviceName="manual-name" |
| 156 | + ) |
| 157 | + device_config = { |
| 158 | + "deviceInfo": { |
| 159 | + "deviceNameExpression": "BACnet Device ${objectName}", |
| 160 | + "deviceProfileExpression": "default" |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | + await self.connector._AsyncBACnetConnector__set_additional_device_info_to_apdu(apdu, device_config) |
| 165 | + |
| 166 | + self.assertEqual(apdu.deviceName, "manual-name") |
0 commit comments