1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
|
"""Unit test for KNX/IP gateway scanner."""
import asyncio
from typing import Any
from unittest.mock import Mock, create_autospec, patch
import pytest
from xknx import XKNX
from xknx.exceptions import XKNXException
from xknx.io import GatewayScanFilter, GatewayScanner
from xknx.io.gateway_scanner import GatewayDescriptor
from xknx.io.transport import UDPTransport
from xknx.knxip import (
HPAI,
DIBDeviceInformation,
DIBServiceFamily,
DIBSuppSVCFamilies,
KNXIPFrame,
SearchRequest,
SearchRequestExtended,
SearchResponse,
SearchResponseExtended,
)
from xknx.telegram import IndividualAddress
from ..conftest import EventLoopClockAdvancer
class TestGatewayDescriptor:
"""Test GatewayDescriptor object."""
@pytest.mark.parametrize(
"raw,expected",
[
(
# MDT SCN-IP000.03 IP Interface (IP-Secure enabled)
bytes.fromhex(
"0610020c00a20801c0a800ba0e57360102001101000000837b40054500000000"
"cc1be080b80153434e2d49503030302e303320495020496e7465726661636520"
"6d6974200c02020203020402070209010808000000f000121003000000004005"
"45000000000001041404c0a800ba40054500c0a800010000000004000c051101"
"1102110311041105060603010401140700f01102000011030000110400001105"
"0000"
),
{
"supports_routing": False,
"supports_tunnelling": True,
"supports_tunnelling_tcp": True,
"supports_secure": True,
"routing_requires_secure": False,
"tunnelling_requires_secure": True,
},
),
(
# MDT SCN-IP100.02 IP Router (no IP-Secure support, CoreV1)
bytes.fromhex(
"06100202004e08010a0102280e5736010200200000000083477f0124e000170c"
"cc1be08004c44d4454204b4e5820495020526f75746572000000000000000000"
"000000000a020201030104010501"
),
{
"supports_routing": True,
"supports_tunnelling": True,
"supports_tunnelling_tcp": False,
"supports_secure": False,
"routing_requires_secure": None,
"tunnelling_requires_secure": None,
},
),
(
# Gira X1 (no IP-Secure support but CoreV2)
bytes.fromhex(
"0610020c006408010a0100290e57360102001001000000081171012600000000"
"000ab3290b134769726120583100000000000000000000000000000000000000"
"000000000c0202020302040207010901140700dc10fbfff810fcffff10fdffff"
"10feffff"
),
{
"supports_routing": False,
"supports_tunnelling": True,
"supports_tunnelling_tcp": True,
"supports_secure": True,
"routing_requires_secure": None,
"tunnelling_requires_secure": None,
},
),
(
# Gira IP-Router I12 (no IP-Secure support but CoreV2)
bytes.fromhex(
"0610020c006608010a0100280e57360102001000000000082d40834de000170c"
"000ab3274a3247697261204b4e582f49502d526f757465720000000000000000"
"000000000e02020203020402050207010901140700dc10f1fffe10f2ffff10f3"
"ffff10f4ffff"
),
{
"supports_routing": True,
"supports_tunnelling": True,
"supports_tunnelling_tcp": True,
"supports_secure": True,
"routing_requires_secure": None,
"tunnelling_requires_secure": None,
},
),
(
# Jung IPR 300 SREG (IP-Secure disabled)
bytes.fromhex(
"0610020c007408010a0101550e57360102004000000000a615000037e000170c"
"0022d10400374a756e67204b4e582049502d526f757465720000000000000000"
"000000000c0202020302040205020901240700f8400100054002000540030005"
"4004000540050005400600054007000540080005"
),
{
"supports_routing": True,
"supports_tunnelling": True,
"supports_tunnelling_tcp": True,
"supports_secure": True,
"routing_requires_secure": None,
"tunnelling_requires_secure": None,
},
),
(
# Jung IPR 300 SREG (IP-Secure enabled)
bytes.fromhex(
"0610020c008408010a0101550e57360102004000000000a615000037e000170c"
"0022d10400374b4e582049502d526f7574657200000000000000000000000000"
"000000000c02020203020402050209010808000004b0091a0806030104010501"
"240700f840010005400200054003000540040005400500054006000540070005"
"40080005"
),
{
"supports_routing": True,
"supports_tunnelling": True,
"supports_tunnelling_tcp": True,
"supports_secure": True,
"routing_requires_secure": True,
"tunnelling_requires_secure": True,
},
),
],
)
def test_parser(self, raw: bytes, expected: dict[str, Any]) -> None:
"""Test parsing GatewayDescriptor objects from real-world responses."""
response, _ = KNXIPFrame.from_knx(raw)
assert isinstance(response.body, SearchResponse | SearchResponseExtended)
descriptor = GatewayDescriptor(
ip_addr=response.body.control_endpoint.ip_addr,
port=response.body.control_endpoint.port,
)
descriptor.parse_dibs(response.body.dibs)
assert descriptor.supports_routing is expected["supports_routing"]
assert descriptor.supports_tunnelling is expected["supports_tunnelling"]
assert descriptor.supports_tunnelling_tcp is expected["supports_tunnelling_tcp"]
assert descriptor.supports_secure is expected["supports_secure"]
assert descriptor.routing_requires_secure is expected["routing_requires_secure"]
assert (
descriptor.tunnelling_requires_secure
is expected["tunnelling_requires_secure"]
)
class TestGatewayScanner:
"""Test class for xknx/io/GatewayScanner objects."""
gateway_desc_interface = GatewayDescriptor(
name="KNX-Interface",
ip_addr="10.1.1.11",
port=3761,
local_interface="en1",
local_ip="10.1.1.100",
supports_tunnelling=True,
supports_routing=False,
)
gateway_desc_router = GatewayDescriptor(
name="KNX-Router",
ip_addr="10.1.1.12",
port=3761,
local_interface="en1",
local_ip="10.1.1.100",
supports_tunnelling=False,
supports_routing=True,
)
gateway_desc_both = GatewayDescriptor(
name="Gira KNX/IP-Router",
ip_addr="192.168.42.10",
port=3671,
local_interface="en1",
local_ip="192.168.42.50",
supports_tunnelling=True,
supports_tunnelling_tcp=True,
supports_routing=True,
individual_address=IndividualAddress("1.1.0"),
)
gateway_desc_both.tunnelling_requires_secure = False
gateway_desc_neither = GatewayDescriptor(
name="AC/S 1.1.1 Application Control",
ip_addr="10.1.1.15",
port=3671,
local_interface="en1",
local_ip="192.168.42.50",
supports_tunnelling=False,
supports_routing=False,
)
gateway_desc_secure_tunnel = GatewayDescriptor(
name="KNX-Interface",
ip_addr="10.1.1.11",
port=3761,
local_interface="en1",
local_ip="10.1.1.111",
supports_routing=False,
supports_tunnelling=True,
supports_tunnelling_tcp=True,
supports_secure=True,
)
gateway_desc_secure_tunnel.tunnelling_requires_secure = True
gateway_desc_secure_router = GatewayDescriptor(
name="KNX-Secure-Router",
ip_addr="10.1.1.12",
port=3761,
local_interface="en1",
local_ip="10.1.1.100",
supports_tunnelling=False,
supports_routing=True,
)
gateway_desc_secure_router.routing_requires_secure = True
def test_gateway_scan_filter_match(self) -> None:
"""Test match function of gateway filter."""
filter_default = GatewayScanFilter()
filter_tunnel = GatewayScanFilter(routing=False, secure_routing=False)
filter_tcp_tunnel = GatewayScanFilter(
tunnelling=False,
tunnelling_tcp=True,
secure_tunnelling=None,
routing=False,
secure_routing=False,
)
filter_secure_tunnel = GatewayScanFilter(
tunnelling=False,
tunnelling_tcp=False,
secure_tunnelling=True,
routing=False,
secure_routing=False,
)
filter_router = GatewayScanFilter(
tunnelling=False,
tunnelling_tcp=False,
secure_tunnelling=False,
routing=True,
secure_routing=False,
)
filter_name = GatewayScanFilter(name="KNX-Router")
filter_secure_router = GatewayScanFilter(
tunnelling=False,
tunnelling_tcp=False,
secure_tunnelling=False,
routing=False,
secure_routing=True,
)
assert filter_default.match(self.gateway_desc_interface)
assert filter_default.match(self.gateway_desc_router)
assert filter_default.match(self.gateway_desc_both)
assert not filter_default.match(self.gateway_desc_neither)
assert filter_default.match(self.gateway_desc_secure_tunnel)
assert filter_default.match(self.gateway_desc_secure_router)
assert filter_tunnel.match(self.gateway_desc_interface)
assert not filter_tunnel.match(self.gateway_desc_router)
assert filter_tunnel.match(self.gateway_desc_both)
assert not filter_tunnel.match(self.gateway_desc_neither)
assert filter_tunnel.match(self.gateway_desc_secure_tunnel)
assert not filter_tunnel.match(self.gateway_desc_secure_router)
assert not filter_tcp_tunnel.match(self.gateway_desc_interface)
assert not filter_tcp_tunnel.match(self.gateway_desc_router)
assert filter_tcp_tunnel.match(self.gateway_desc_both)
assert not filter_tcp_tunnel.match(self.gateway_desc_neither)
assert not filter_tcp_tunnel.match(self.gateway_desc_secure_tunnel)
assert not filter_tcp_tunnel.match(self.gateway_desc_secure_router)
assert not filter_secure_tunnel.match(self.gateway_desc_interface)
assert not filter_secure_tunnel.match(self.gateway_desc_router)
assert not filter_secure_tunnel.match(self.gateway_desc_both)
assert not filter_secure_tunnel.match(self.gateway_desc_neither)
assert filter_secure_tunnel.match(self.gateway_desc_secure_tunnel)
assert not filter_secure_tunnel.match(self.gateway_desc_secure_router)
assert not filter_router.match(self.gateway_desc_interface)
assert filter_router.match(self.gateway_desc_router)
assert filter_router.match(self.gateway_desc_both)
assert not filter_router.match(self.gateway_desc_neither)
assert not filter_router.match(self.gateway_desc_secure_tunnel)
assert not filter_router.match(self.gateway_desc_secure_router)
assert not filter_name.match(self.gateway_desc_interface)
assert filter_name.match(self.gateway_desc_router)
assert not filter_name.match(self.gateway_desc_both)
assert not filter_name.match(self.gateway_desc_neither)
assert not filter_name.match(self.gateway_desc_secure_tunnel)
assert not filter_name.match(self.gateway_desc_secure_router)
assert not filter_secure_router.match(self.gateway_desc_interface)
assert not filter_secure_router.match(self.gateway_desc_router)
assert not filter_secure_router.match(self.gateway_desc_both)
assert not filter_secure_router.match(self.gateway_desc_neither)
assert not filter_secure_router.match(self.gateway_desc_secure_tunnel)
assert filter_secure_router.match(self.gateway_desc_secure_router)
def test_search_response_reception(self) -> None:
"""Test function of gateway scanner."""
xknx = XKNX()
gateway_scanner = GatewayScanner(xknx)
test_search_response = fake_router_search_response()
udp_transport_mock = create_autospec(UDPTransport)
udp_transport_mock.local_addr = ("192.168.42.50", 0)
udp_transport_mock.getsockname.return_value = ("192.168.42.50", 0)
assert not gateway_scanner.found_gateways
gateway_scanner._response_rec_callback(
test_search_response,
HPAI("192.168.42.50", 0),
udp_transport_mock,
interface="en1",
)
assert len(gateway_scanner.found_gateways) == 1
gateway_scanner._response_rec_callback(
test_search_response,
HPAI("192.168.42.230", 0),
udp_transport_mock,
interface="eth1",
)
assert len(gateway_scanner.found_gateways) == 1
assert str(
gateway_scanner.found_gateways[test_search_response.body.control_endpoint]
) == str(self.gateway_desc_both)
@patch("xknx.io.gateway_scanner.UDPTransport.connect")
@patch("xknx.io.gateway_scanner.UDPTransport.send")
@patch(
"xknx.io.gateway_scanner.UDPTransport.getsockname",
return_value=("10.1.1.2", 56789),
)
async def test_scan_timeout(
self,
getsockname_mock: Mock,
udp_transport_send_mock: Mock,
udp_transport_connect_mock: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test gateway scanner timeout."""
xknx = XKNX()
gateway_scanner = GatewayScanner(xknx)
timed_out_scan_task = asyncio.create_task(gateway_scanner.scan())
await time_travel(gateway_scanner.timeout_in_seconds)
# Unsuccessful scan() returns empty list
assert await timed_out_scan_task == []
@patch("xknx.io.gateway_scanner.UDPTransport.connect")
@patch("xknx.io.gateway_scanner.UDPTransport.send")
async def test_async_scan_timeout(
self,
udp_transport_send_mock: Mock,
udp_transport_connect_mock: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test gateway scanner timeout for async generator."""
async def test() -> bool:
xknx = XKNX()
async for _ in GatewayScanner(xknx).async_scan():
break
else:
return True
# timeout
with (
patch(
"xknx.io.util.get_default_local_ip",
return_value="10.1.1.2",
),
patch(
"xknx.io.gateway_scanner.UDPTransport.getsockname",
return_value=("10.1.1.2", 56789),
),
):
timed_out_scan_task = asyncio.create_task(test())
await time_travel(3)
assert await timed_out_scan_task
# no matching interface found
with patch(
"xknx.io.util.get_default_local_ip",
return_value=None,
):
timed_out_scan_task = asyncio.create_task(test())
await time_travel(3)
with pytest.raises(XKNXException):
await timed_out_scan_task
@patch("xknx.io.gateway_scanner.UDPTransport.connect")
@patch("xknx.io.gateway_scanner.UDPTransport.send")
async def test_async_scan_exit(
self,
udp_transport_send_mock: Mock,
udp_transport_connect_mock: Mock,
time_travel: EventLoopClockAdvancer,
) -> None:
"""Test gateway scanner timeout for async generator."""
xknx = XKNX()
test_search_response = fake_router_search_response()
udp_transport_mock = Mock()
udp_transport_mock.local_addr = ("10.1.1.2", 56789)
gateway_scanner = GatewayScanner(xknx, local_ip="10.1.1.2")
async def test() -> bool:
async for gateway in gateway_scanner.async_scan():
assert isinstance(gateway, GatewayDescriptor)
return True
return False
with (
patch(
"xknx.io.gateway_scanner.UDPTransport.getsockname",
return_value=("10.1.1.2", 56789),
),
patch(
"xknx.io.gateway_scanner.UDPTransport.register_callback"
) as register_callback_mock,
):
scan_task = asyncio.create_task(test())
await time_travel(0)
_fished_response_rec_callback = register_callback_mock.call_args.args[0]
_fished_response_rec_callback(
test_search_response,
HPAI("192.168.42.50", 0),
udp_transport_mock,
)
assert await scan_task
await time_travel(0) # for task cleanup
@patch("xknx.io.gateway_scanner.UDPTransport.connect")
@patch("xknx.io.gateway_scanner.UDPTransport.send")
async def test_send_search_requests(
self,
udp_transport_send_mock: Mock,
udp_transport_connect_mock: Mock,
) -> None:
"""Test if both search requests are sent per interface."""
xknx = XKNX()
gateway_scanner = GatewayScanner(xknx, timeout_in_seconds=0)
with (
patch(
"xknx.io.util.get_default_local_ip",
return_value="10.1.1.2",
),
patch(
"xknx.io.util.get_local_interface_name",
return_value="en_0123",
),
patch(
"xknx.io.gateway_scanner.UDPTransport.getsockname",
return_value=("10.1.1.2", 56789),
),
):
await gateway_scanner.scan()
assert udp_transport_connect_mock.call_count == 1
assert udp_transport_send_mock.call_count == 2
frame_1 = udp_transport_send_mock.call_args_list[0].args[0]
frame_2 = udp_transport_send_mock.call_args_list[1].args[0]
assert isinstance(frame_1.body, SearchRequestExtended)
assert isinstance(frame_2.body, SearchRequest)
assert frame_1.body.discovery_endpoint == HPAI(ip_addr="10.1.1.2", port=56789)
def test_gateway_scan_filter_compare(self) -> None:
"""Test GatewayScanFilter comparison."""
assert GatewayScanFilter() == GatewayScanFilter()
assert GatewayScanFilter() != GatewayScanFilter(tunnelling=False)
def fake_router_search_response() -> KNXIPFrame:
"""Return the KNXIPFrame of a KNX/IP Router with a SearchResponse body."""
frame_body = SearchResponse()
frame_body.control_endpoint = HPAI(ip_addr="192.168.42.10", port=3671)
device_information = DIBDeviceInformation()
device_information.name = "Gira KNX/IP-Router"
device_information.serial_number = "11:22:33:44:55:66"
device_information.individual_address = IndividualAddress("1.1.0")
device_information.mac_address = "01:02:03:04:05:06"
svc_families = DIBSuppSVCFamilies()
svc_families.families.append(
DIBSuppSVCFamilies.Family(name=DIBServiceFamily.CORE, version=1)
)
svc_families.families.append(
DIBSuppSVCFamilies.Family(name=DIBServiceFamily.DEVICE_MANAGEMENT, version=2)
)
svc_families.families.append(
DIBSuppSVCFamilies.Family(name=DIBServiceFamily.TUNNELING, version=1)
)
svc_families.families.append(
DIBSuppSVCFamilies.Family(name=DIBServiceFamily.ROUTING, version=1)
)
svc_families.families.append(
DIBSuppSVCFamilies.Family(
name=DIBServiceFamily.REMOTE_CONFIGURATION_DIAGNOSIS, version=1
)
)
frame_body.dibs.append(device_information)
frame_body.dibs.append(svc_families)
return KNXIPFrame.init_from_body(frame_body)
|
