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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
|
import asyncio
import contextlib
from datetime import UTC, datetime, timedelta
import pathlib
import threading
import time
import aiosqlite
import freezegun
import pytest
from tests.async_mock import AsyncMock, MagicMock, call, patch
from tests.conftest import (
make_app,
make_ieee,
make_node_desc,
mock_attribute_reads,
mock_attribute_report,
mock_attribute_writes,
)
from tests.test_backups import backup_factory # noqa: F401
from zigpy import profiles
import zigpy.appdb
import zigpy.application
import zigpy.config as conf
from zigpy.const import (
SIG_ENDPOINTS,
SIG_EP_INPUT,
SIG_EP_OUTPUT,
SIG_EP_PROFILE,
SIG_EP_TYPE,
SIG_MANUFACTURER,
SIG_MODEL,
SIG_NODE_DESC,
)
from zigpy.device import Device, Status
import zigpy.endpoint
import zigpy.ota
import zigpy.quirks
from zigpy.quirks import CustomCluster, CustomDevice
from zigpy.quirks.registry import DeviceRegistry
from zigpy.quirks.v2 import QuirkBuilder
import zigpy.types as t
import zigpy.zcl
from zigpy.zcl import ClusterType, UnsupportedAttribute
from zigpy.zcl.clusters.general import Basic, Identify, OnOff, Ota
from zigpy.zcl.foundation import Status as ZCLStatus, ZCLAttributeDef
from zigpy.zdo import types as zdo_t
@pytest.fixture(autouse=True)
def auto_kill_aiosqlite():
"""Aiosqlite's background thread does not let pytest exit when a failure occurs"""
yield
for thread in threading.enumerate():
if not isinstance(thread, aiosqlite.core.Connection):
continue
try:
conn = thread._conn
except ValueError:
pass
else:
with contextlib.suppress(zigpy.appdb.sqlite3.ProgrammingError):
conn.close()
thread._running = False
async def make_app_with_db(database_file):
if isinstance(database_file, pathlib.Path):
database_file = str(database_file)
app = make_app({conf.CONF_DATABASE: database_file})
await app._load_db()
return app
class FakeCustomDevice(CustomDevice):
replacement = {
"endpoints": {
# Endpoint exists on original device
1: {
"input_clusters": [0, 1, 3, 0x0008],
"output_clusters": [6],
},
# Endpoint is created only at runtime by the quirk
99: {
"input_clusters": [0, 1, 3, 0x0008],
"output_clusters": [6],
"profile_id": 65535,
"device_type": 123,
},
}
}
def mock_dev_init(initialize: bool):
"""Device schedule_initialize mock factory."""
def _initialize(self):
if initialize:
self.node_desc = zdo_t.NodeDescriptor(0, 1, 2, 3, 4, 5, 6, 7, 8)
return _initialize
def _mk_rar(attrid, value, status=0):
r = zigpy.zcl.foundation.ReadAttributeRecord()
r.attrid = attrid
r.status = status
r.value = zigpy.zcl.foundation.TypeValue()
r.value.value = value
return r
def fake_get_device(device):
if device.endpoints.get(1) is not None and device[1].profile_id == 65535:
return FakeCustomDevice(device.application, device.ieee, device.nwk, device)
return device
async def test_no_database(tmp_path):
with patch("zigpy.appdb.PersistingListener.new", AsyncMock()) as db_mock:
db_mock.return_value.load.side_effect = AsyncMock()
await make_app_with_db(None)
assert db_mock.return_value.load.call_count == 0
db = tmp_path / "test.db"
with patch("zigpy.appdb.PersistingListener.new", AsyncMock()) as db_mock:
db_mock.return_value.load.side_effect = AsyncMock()
await make_app_with_db(db)
assert db_mock.return_value.load.call_count == 1
@patch("zigpy.device.Device.schedule_initialize", new=mock_dev_init(True))
async def test_database(tmp_path):
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
relays_1 = [t.NWK(0x1234), t.NWK(0x2345)]
relays_2 = [t.NWK(0x3456), t.NWK(0x4567)]
app.handle_join(99, ieee, 0)
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
ep = dev.add_endpoint(2)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = 0xFFFD # Invalid
in_clus = ep.add_input_cluster(0)
out_clus = ep.add_output_cluster(0)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 49246
ep.device_type = profiles.zll.DeviceType.COLOR_LIGHT
app.device_initialized(dev)
in_clus.update_attribute(0, 99)
in_clus.update_attribute(4, b"Custom")
in_clus.update_attribute(5, b"Model")
in_clus.listener_event("cluster_command", 0)
in_clus.listener_event("general_command")
out_clus.update_attribute(0, 99)
dev.relays = relays_1
signature = dev.get_signature()
assert ep.endpoint_id in signature[SIG_ENDPOINTS]
assert SIG_MANUFACTURER not in signature
assert SIG_MODEL not in signature
dev.manufacturer = "Custom"
dev.model = "Model"
assert dev.get_signature()[SIG_MANUFACTURER] == "Custom"
assert dev.get_signature()[SIG_MODEL] == "Model"
ts = time.time()
dev.last_seen = ts
dev_last_seen = dev.last_seen
assert isinstance(dev.last_seen, float)
assert abs(dev.last_seen - ts) < 0.01
# Test a CustomDevice
custom_ieee = make_ieee(1)
app.handle_join(199, custom_ieee, 0)
dev = app.get_device(custom_ieee)
app.device_initialized(dev)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.device_type = profiles.zll.DeviceType.COLOR_LIGHT
ep.profile_id = 65535
with patch("zigpy.quirks.get_device", fake_get_device):
app.device_initialized(dev)
assert isinstance(app.get_device(custom_ieee), FakeCustomDevice)
assert isinstance(app.get_device(custom_ieee), CustomDevice)
dev = app.get_device(custom_ieee)
app.device_initialized(dev)
dev.relays = relays_2
dev.endpoints[1].level.update_attribute(0x0011, 17)
dev.endpoints[99].level.update_attribute(0x0011, 17)
assert dev.endpoints[1].in_clusters[0x0008]._attr_cache[0x0011] == 17
assert dev.endpoints[99].in_clusters[0x0008]._attr_cache[0x0011] == 17
custom_dev_last_seen = dev.last_seen
assert isinstance(custom_dev_last_seen, float)
await app.shutdown()
# Everything should've been saved - check that it re-loads
with patch("zigpy.quirks.get_device", fake_get_device):
app2 = await make_app_with_db(db)
dev = app2.get_device(ieee)
assert dev.endpoints[1].device_type == profiles.zha.DeviceType.PUMP
assert dev.endpoints[2].device_type == 0xFFFD
assert dev.endpoints[2].in_clusters[0].get(0x0000) == 99
assert dev.endpoints[2].in_clusters[0].get(0x0004) == b"Custom"
assert dev.endpoints[2].in_clusters[0].get(0x0005) == b"Model"
assert dev.endpoints[2].out_clusters[0].cluster_id == 0x0000
assert dev.endpoints[2].out_clusters[0].get(0) == 99
assert dev.endpoints[2].manufacturer == "Custom"
assert dev.endpoints[2].model == "Model"
assert dev.endpoints[3].device_type == profiles.zll.DeviceType.COLOR_LIGHT
assert dev.relays == relays_1
# The timestamp won't be restored exactly but it is more than close enough
assert abs(dev.last_seen - dev_last_seen) < 0.01
dev = app2.get_device(custom_ieee)
# This virtual attribute is added by the quirk, there is no corresponding cluster
# stored in the database, nor is there a corresponding endpoint 99
assert dev.endpoints[1].in_clusters[0x0008].get(0x0011) == 17
assert dev.endpoints[99].in_clusters[0x0008].get(0x0011) == 17
assert dev.relays == relays_2
assert abs(dev.last_seen - custom_dev_last_seen) < 0.01
dev.relays = None
app.handle_leave(99, ieee)
await app2.shutdown()
app3 = await make_app_with_db(db)
assert ieee in app3.devices
async def mockleave(*args, **kwargs):
return [0]
app3.devices[ieee].zdo.leave = mockleave
await app3.remove(ieee)
for _i in range(1, 20):
await asyncio.sleep(0)
assert ieee not in app3.devices
await app3.shutdown()
app4 = await make_app_with_db(db)
assert ieee not in app4.devices
dev = app4.get_device(custom_ieee)
assert dev.relays is None
await app4.shutdown()
@patch("zigpy.device.Device.schedule_group_membership_scan", MagicMock())
async def _test_null_padded(tmp_path, test_manufacturer=None, test_model=None):
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
with patch(
"zigpy.device.Device.schedule_initialize",
new=mock_dev_init(True),
):
app.handle_join(99, ieee, 0)
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0)
ep.add_output_cluster(1)
app.device_initialized(dev)
clus.update_attribute(4, test_manufacturer)
clus.update_attribute(5, test_model)
clus.listener_event("cluster_command", 0)
clus.listener_event("zdo_command")
await app.shutdown()
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
dev = app2.get_device(ieee)
assert dev.endpoints[3].device_type == profiles.zha.DeviceType.PUMP
assert dev.endpoints[3].in_clusters[0]._attr_cache[4] == test_manufacturer
assert dev.endpoints[3].in_clusters[0]._attr_cache[5] == test_model
await app2.shutdown()
return dev
async def test_appdb_load_null_padded_manuf(tmp_path):
manufacturer = b"Mock Manufacturer\x00\x04\\\x00\\\x00\x00\x00\x00\x00\x07"
model = b"Mock Model"
dev = await _test_null_padded(tmp_path, manufacturer, model)
assert dev.manufacturer == "Mock Manufacturer"
assert dev.model == "Mock Model"
assert dev.endpoints[3].manufacturer == "Mock Manufacturer"
assert dev.endpoints[3].model == "Mock Model"
async def test_appdb_load_null_padded_model(tmp_path):
manufacturer = b"Mock Manufacturer"
model = b"Mock Model\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
dev = await _test_null_padded(tmp_path, manufacturer, model)
assert dev.manufacturer == "Mock Manufacturer"
assert dev.model == "Mock Model"
assert dev.endpoints[3].manufacturer == "Mock Manufacturer"
assert dev.endpoints[3].model == "Mock Model"
async def test_appdb_load_null_padded_manuf_model(tmp_path):
manufacturer = b"Mock Manufacturer\x00\x04\\\x00\\\x00\x00\x00\x00\x00\x07"
model = b"Mock Model\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
dev = await _test_null_padded(tmp_path, manufacturer, model)
assert dev.manufacturer == "Mock Manufacturer"
assert dev.model == "Mock Model"
assert dev.endpoints[3].manufacturer == "Mock Manufacturer"
assert dev.endpoints[3].model == "Mock Model"
async def test_appdb_str_model(tmp_path):
manufacturer = "Mock Manufacturer"
model = "Mock Model"
dev = await _test_null_padded(tmp_path, manufacturer, model)
assert dev.manufacturer == "Mock Manufacturer"
assert dev.model == "Mock Model"
assert dev.endpoints[3].manufacturer == "Mock Manufacturer"
assert dev.endpoints[3].model == "Mock Model"
@patch.object(Device, "schedule_initialize", new=mock_dev_init(True))
@patch("zigpy.zcl.Cluster.request", new_callable=AsyncMock)
async def test_groups(mock_request, tmp_path):
"""Test group adding/removing."""
group_id, group_name = 0x1221, "app db Test Group 0x1221"
mock_request.return_value = [ZCLStatus.SUCCESS, group_id]
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
ep.add_input_cluster(4)
app.device_initialized(dev)
ieee_b = make_ieee(2)
app.handle_join(100, ieee_b, 0)
dev_b = app.get_device(ieee_b)
ep_b = dev_b.add_endpoint(2)
ep_b.status = zigpy.endpoint.Status.ZDO_INIT
ep_b.profile_id = 260
ep_b.device_type = profiles.zha.DeviceType.PUMP
ep_b.add_input_cluster(4)
app.device_initialized(dev_b)
await ep.add_to_group(group_id, group_name)
await ep_b.add_to_group(group_id, group_name)
assert group_id in app.groups
group = app.groups[group_id]
assert group.name == group_name
assert (dev.ieee, ep.endpoint_id) in group
assert (dev_b.ieee, ep_b.endpoint_id) in group
assert group_id in ep.member_of
assert group_id in ep_b.member_of
await app.shutdown()
del app, dev, dev_b, ep, ep_b
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
dev2 = app2.get_device(ieee)
assert group_id in app2.groups
group = app2.groups[group_id]
assert group.name == group_name
assert (dev2.ieee, 1) in group
assert group_id in dev2.endpoints[1].member_of
dev2_b = app2.get_device(ieee_b)
assert (dev2_b.ieee, 2) in group
assert group_id in dev2_b.endpoints[2].member_of
# check member removal
await dev2_b.remove_from_group(group_id)
await app2.shutdown()
del app2, dev2, dev2_b
app3 = await make_app_with_db(db)
dev3 = app3.get_device(ieee)
assert group_id in app3.groups
group = app3.groups[group_id]
assert group.name == group_name
assert (dev3.ieee, 1) in group
assert group_id in dev3.endpoints[1].member_of
dev3_b = app3.get_device(ieee_b)
assert (dev3_b.ieee, 2) not in group
assert group_id not in dev3_b.endpoints[2].member_of
# check group removal
await dev3.remove_from_group(group_id)
await app3.shutdown()
del app3, dev3, dev3_b
app4 = await make_app_with_db(db)
dev4 = app4.get_device(ieee)
assert group_id in app4.groups
assert not app4.groups[group_id]
assert group_id not in dev4.endpoints[1].member_of
app4.groups.pop(group_id)
await app4.shutdown()
del app4, dev4
app5 = await make_app_with_db(db)
assert not app5.groups
await app5.shutdown()
@pytest.mark.parametrize("dev_init", [True, False])
async def test_attribute_update(tmp_path, dev_init):
"""Test attribute update for initialized and uninitialized devices."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
with patch(
"zigpy.device.Device.schedule_initialize",
new=mock_dev_init(initialize=dev_init),
):
app.handle_join(99, ieee, 0)
test_manufacturer = "Test Manufacturer"
test_model = "Test Model"
dev = app.get_device(ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0x0000)
ep.add_output_cluster(0x0001)
clus.update_attribute(0x0004, test_manufacturer)
clus.update_attribute(0x0005, test_model)
app.device_initialized(dev)
await app.shutdown()
attr_update_time = clus._attr_cache.get_last_updated(
Basic.AttributeDefs.manufacturer
)
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
dev = app2.get_device(ieee)
assert dev.is_initialized == dev_init
assert dev.endpoints[3].device_type == profiles.zha.DeviceType.PUMP
clus = dev.endpoints[3].in_clusters[0x0000]
assert clus._attr_cache[0x0004] == test_manufacturer
assert clus._attr_cache[0x0005] == test_model
assert (
attr_update_time
- clus._attr_cache.get_last_updated(Basic.AttributeDefs.manufacturer)
) < timedelta(seconds=0.1)
await app2.shutdown()
@patch.object(Device, "schedule_initialize", new=mock_dev_init(True))
async def test_attribute_update_short_interval(tmp_path):
"""Test updating an attribute twice in a short interval."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0x0000)
ep.add_output_cluster(0x0001)
clus.update_attribute(0x0004, "Custom")
clus.update_attribute(0x0005, "Model")
app.device_initialized(dev)
# wait for the device initialization to write attribute cache to db
await asyncio.sleep(0.01)
# update an attribute twice in a short interval
clus.update_attribute(0x4000, "1.0")
attr_update_time_first = clus._attr_cache.get_last_updated(
Basic.AttributeDefs.sw_build_id
)
# update attribute again 10 seconds later
fake_time = datetime.now(UTC) + timedelta(seconds=10)
with freezegun.freeze_time(fake_time):
clus.update_attribute(0x4000, "2.0")
await app.shutdown()
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
dev = app2.get_device(ieee)
clus = dev.endpoints[3].in_clusters[0x0000]
assert clus._attr_cache[0x4000] == "2.0" # verify second attribute update was saved
# verify the first update attribute time was not overwritten, as it was within the short interval
assert (
attr_update_time_first
- clus._attr_cache.get_last_updated(Basic.AttributeDefs.sw_build_id)
) < timedelta(seconds=0.1)
await app2.shutdown()
@patch("zigpy.topology.REQUEST_DELAY", (0, 0))
@patch.object(Device, "schedule_initialize", new=mock_dev_init(True))
async def test_topology(tmp_path):
"""Test neighbor loading."""
ext_pid = t.EUI64.convert("aa:bb:cc:dd:ee:ff:01:02")
neighbor1 = zdo_t.Neighbor(
extended_pan_id=ext_pid,
ieee=make_ieee(1),
nwk=0x1111,
device_type=zdo_t.Neighbor.DeviceType.EndDevice,
rx_on_when_idle=1,
relationship=zdo_t.Neighbor.Relationship.Child,
reserved1=0,
permit_joining=0,
reserved2=0,
depth=15,
lqi=250,
)
neighbor2 = zdo_t.Neighbor(
extended_pan_id=ext_pid,
ieee=make_ieee(2),
nwk=0x1112,
device_type=zdo_t.Neighbor.DeviceType.EndDevice,
rx_on_when_idle=1,
relationship=zdo_t.Neighbor.Relationship.Child,
reserved1=0,
permit_joining=0,
reserved2=0,
depth=15,
lqi=250,
)
route1 = zdo_t.Route(
DstNWK=0x1234,
RouteStatus=zdo_t.RouteStatus.Active,
MemoryConstrained=0,
ManyToOne=0,
RouteRecordRequired=0,
Reserved=0,
NextHop=0x6789,
)
route2 = zdo_t.Route(
DstNWK=0x1235,
RouteStatus=zdo_t.RouteStatus.Active,
MemoryConstrained=0,
ManyToOne=0,
RouteRecordRequired=0,
Reserved=0,
NextHop=0x6790,
)
ieee = make_ieee(0)
nwk = 0x9876
db = tmp_path / "test.db"
app = await make_app_with_db(db)
app.handle_join(nwk, ieee, 0x0000)
dev = app.get_device(ieee)
dev.node_desc = zdo_t.NodeDescriptor(
logical_type=zdo_t.LogicalType.Router,
complex_descriptor_available=0,
user_descriptor_available=0,
reserved=0,
aps_flags=0,
frequency_band=zdo_t.NodeDescriptor.FrequencyBand.Freq2400MHz,
mac_capability_flags=zdo_t.NodeDescriptor.MACCapabilityFlags.AllocateAddress,
manufacturer_code=4174,
maximum_buffer_size=82,
maximum_incoming_transfer_size=82,
server_mask=0,
maximum_outgoing_transfer_size=82,
descriptor_capability_field=zdo_t.NodeDescriptor.DescriptorCapability.NONE,
)
ep1 = dev.add_endpoint(1)
ep1.status = zigpy.endpoint.Status.ZDO_INIT
ep1.profile_id = 260
ep1.device_type = 0x1234
app.device_initialized(dev)
p1 = patch.object(
app.topology,
"_scan_neighbors",
new=AsyncMock(return_value=[neighbor1, neighbor2]),
)
p2 = patch.object(
app.topology,
"_scan_routes",
new=AsyncMock(return_value=[route1, route2]),
)
with p1, p2:
await app.topology.scan()
assert len(app.topology.neighbors[ieee]) == 2
assert neighbor1 in app.topology.neighbors[ieee]
assert neighbor2 in app.topology.neighbors[ieee]
assert len(app.topology.routes[ieee]) == 2
assert route1 in app.topology.routes[ieee]
assert route2 in app.topology.routes[ieee]
await app.shutdown()
del dev
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
app2.get_device(ieee)
assert len(app2.topology.neighbors[ieee]) == 2
assert neighbor1 in app2.topology.neighbors[ieee]
assert neighbor2 in app2.topology.neighbors[ieee]
assert len(app2.topology.routes[ieee]) == 2
assert route1 in app2.topology.routes[ieee]
assert route2 in app2.topology.routes[ieee]
await app2.shutdown()
@patch("zigpy.device.Device.schedule_initialize", new=mock_dev_init(True))
async def test_device_rejoin(tmp_path):
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
nwk = 199
app.handle_join(nwk, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 65535
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0)
ep.add_output_cluster(1)
app.device_initialized(dev)
clus.update_attribute(4, "Custom")
clus.update_attribute(5, "Model")
await app.shutdown()
# Everything should've been saved - check that it re-loads
with patch("zigpy.quirks.get_device", fake_get_device):
app2 = await make_app_with_db(db)
dev = app2.get_device(ieee)
assert dev.nwk == nwk
assert dev.endpoints[1].device_type == profiles.zha.DeviceType.PUMP
assert dev.endpoints[1].in_clusters[0]._attr_cache[4] == "Custom"
assert dev.endpoints[1].in_clusters[0]._attr_cache[5] == "Model"
assert dev.endpoints[1].manufacturer == "Custom"
assert dev.endpoints[1].model == "Model"
# device rejoins
dev.nwk = nwk + 1
with patch("zigpy.quirks.get_device", fake_get_device):
app2.device_initialized(dev)
await app2.shutdown()
app3 = await make_app_with_db(db)
dev = app3.get_device(ieee)
assert dev.nwk == nwk + 1
assert dev.endpoints[1].device_type == profiles.zha.DeviceType.PUMP
assert 0 in dev.endpoints[1].in_clusters
assert dev.endpoints[1].manufacturer == "Custom"
assert dev.endpoints[1].model == "Model"
await app3.shutdown()
@patch("zigpy.device.Device.schedule_initialize", new=mock_dev_init(True))
async def test_stopped_appdb_listener(tmp_path):
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0)
ep.add_output_cluster(1)
app.device_initialized(dev)
with patch("zigpy.appdb.PersistingListener._save_attribute") as mock_attr_save:
clus.update_attribute(0, 99)
clus.update_attribute(4, b"Custom")
clus.update_attribute(5, b"Model")
await app.shutdown()
assert mock_attr_save.call_count == 3
clus.update_attribute(0, 100)
for _i in range(100):
await asyncio.sleep(0)
assert mock_attr_save.call_count == 3
@patch.object(Device, "schedule_initialize", new=mock_dev_init(True))
async def test_invalid_node_desc(tmp_path):
"""Devices without a valid node descriptor should not save the node descriptor."""
ieee_1 = make_ieee(1)
nwk_1 = 0x1111
db = tmp_path / "test.db"
app = await make_app_with_db(db)
app.handle_join(nwk_1, ieee_1, 0)
dev_1 = app.get_device(ieee_1)
dev_1.node_desc = None
ep = dev_1.add_endpoint(1)
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
ep.status = zigpy.endpoint.Status.ZDO_INIT
app.device_initialized(dev_1)
await app.shutdown()
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
dev_2 = app2.get_device(ieee=ieee_1)
assert dev_2.node_desc is None
assert dev_2.nwk == dev_1.nwk
assert dev_2.ieee == dev_1.ieee
assert dev_2.status == dev_1.status
await app2.shutdown()
async def test_appdb_worker_exception(tmp_path):
"""Exceptions should not kill the appdb worker."""
app_mock = MagicMock(name="ControllerApplication")
db = tmp_path / "test.db"
ieee_1 = make_ieee(1)
dev_1 = zigpy.device.Device(app_mock, ieee_1, 0x1111)
dev_1.status = Status.ENDPOINTS_INIT
dev_1.node_desc = MagicMock()
dev_1.node_desc.is_valid = True
dev_1.node_desc.serialize.side_effect = AttributeError
with patch(
"zigpy.appdb.PersistingListener._save_device",
wraps=zigpy.appdb.PersistingListener._save_device,
) as save_mock:
db_listener = await zigpy.appdb.PersistingListener.new(db, app_mock)
for _ in range(3):
db_listener.raw_device_initialized(dev_1)
await db_listener.shutdown()
assert save_mock.await_count == 3
@pytest.mark.parametrize("dev_init", [True, False])
async def test_unsupported_attribute(tmp_path, dev_init):
"""Test adding unsupported attributes for initialized and uninitialized devices."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
with patch(
"zigpy.device.Device.schedule_initialize",
new=mock_dev_init(initialize=dev_init),
):
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
in_clus = ep.add_input_cluster(0)
in_clus.update_attribute(4, "Custom")
in_clus.update_attribute(5, "Model")
app.device_initialized(dev)
in_clus.add_unsupported_attribute(Basic.AttributeDefs.location_desc.id)
in_clus.add_unsupported_attribute("physical_env")
out_clus = ep.add_output_cluster(0)
out_clus.add_unsupported_attribute(Basic.AttributeDefs.location_desc.id)
await app.shutdown()
# Everything should've been saved - check that it re-loads
app2 = await make_app_with_db(db)
dev = app2.get_device(ieee)
assert dev.is_initialized == dev_init
assert dev.endpoints[3].device_type == profiles.zha.DeviceType.PUMP
assert (
dev.endpoints[3]
.out_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
)
assert (
dev.endpoints[3]
.in_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
)
assert (
dev.endpoints[3]
.in_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.physical_env)
)
await app2.shutdown()
# Now lets remove an unsupported attribute and make sure it is removed
app3 = await make_app_with_db(db)
dev = app3.get_device(ieee)
assert dev.is_initialized == dev_init
assert dev.endpoints[3].device_type == profiles.zha.DeviceType.PUMP
in_cluster = dev.endpoints[3].in_clusters[0]
# `location_desc` on the in cluster flips from unsupported to unsupported
assert in_cluster._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
in_cluster.update_attribute(Basic.AttributeDefs.location_desc, "Not Removed")
assert not in_cluster._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
assert in_cluster.get(Basic.AttributeDefs.location_desc.id) == "Not Removed"
assert in_cluster._attr_cache.is_unsupported(Basic.AttributeDefs.physical_env)
out_cluster = dev.endpoints[3].out_clusters[0]
out_cluster.update_attribute(Basic.AttributeDefs.location_desc, "test")
await app3.shutdown()
# Everything should've been saved - check that it re-loads
app4 = await make_app_with_db(db)
dev = app4.get_device(ieee)
assert dev.is_initialized == dev_init
assert dev.endpoints[3].device_type == profiles.zha.DeviceType.PUMP
assert (
dev.endpoints[3].in_clusters[0].get(Basic.AttributeDefs.location_desc)
== "Not Removed"
)
assert (
not dev.endpoints[3]
.in_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
)
assert (
not dev.endpoints[3]
.out_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
)
assert (
not dev.endpoints[3]
.in_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.location_desc)
)
assert (
dev.endpoints[3]
.in_clusters[0]
._attr_cache.is_unsupported(Basic.AttributeDefs.physical_env)
)
await app4.shutdown()
@patch.object(Device, "schedule_initialize", new=mock_dev_init(True))
async def test_load_unsupp_attr_wrong_cluster(tmp_path):
"""Test loading unsupported attribute from the wrong cluster."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0)
ep.add_output_cluster(1)
clus.update_attribute(4, "Custom")
clus.update_attribute(5, "Model")
app.device_initialized(dev)
await app.shutdown()
del clus
del ep
del dev
# add unsupported attr for missing endpoint
app = await make_app_with_db(db)
dev = app.get_device(ieee)
ep = dev.endpoints[3]
clus = ep.add_input_cluster(2)
clus.add_unsupported_attribute(0)
await app.shutdown()
del clus
del ep
del dev
# reload
app = await make_app_with_db(db)
await app.shutdown()
@patch.object(Device, "schedule_initialize", new=mock_dev_init(True))
async def test_load_unsupp_attr_missing_endpoint(tmp_path):
"""Test loading unsupported attribute from the wrong cluster."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0x0000)
ep.add_output_cluster(0x0001)
clus.update_attribute(0x0004, "Custom")
clus.update_attribute(0x0005, "Model")
ep = dev.add_endpoint(4)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0x0006)
app.device_initialized(dev)
# Make an attribute unsupported
clus.add_unsupported_attribute(0x0000)
await app.shutdown()
del clus
del ep
del dev
def remove_cluster(device):
device.endpoints.pop(4)
return device
# Simulate a quirk that removes the entire endpoint
with patch("zigpy.quirks.get_device", side_effect=remove_cluster):
# The application should still load
app = await make_app_with_db(db)
dev = app.get_device(ieee)
assert 4 not in dev.endpoints
await app.shutdown()
async def test_last_seen(tmp_path):
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = make_ieee()
app.handle_join(99, ieee, 0)
dev = app.get_device(ieee=ieee)
ep = dev.add_endpoint(3)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
clus = ep.add_input_cluster(0)
ep.add_output_cluster(1)
clus.update_attribute(4, "Custom")
clus.update_attribute(5, "Model")
app.device_initialized(dev)
old_last_seen = dev.last_seen
await app.shutdown()
# The `last_seen` of a joined device persists
app = await make_app_with_db(db)
dev = app.get_device(ieee=ieee)
await app.shutdown()
next_last_seen = dev.last_seen
assert abs(next_last_seen - old_last_seen) < 0.01
app = await make_app_with_db(db)
dev = app.get_device(ieee=ieee)
# Last-seen is only written to the db every 30s (no write case)
now = datetime.fromtimestamp(dev.last_seen + 5, UTC)
with freezegun.freeze_time(now):
dev.last_seen = datetime.now(UTC)
await app.shutdown()
app = await make_app_with_db(db)
dev = app.get_device(ieee=ieee)
assert dev.last_seen == next_last_seen # no change
await app.shutdown()
app = await make_app_with_db(db)
dev = app.get_device(ieee=ieee)
# Last-seen is only written to the db every 30s (write case)
now = datetime.fromtimestamp(dev.last_seen + 35, UTC)
with freezegun.freeze_time(now):
dev.last_seen = datetime.now(UTC)
await app.shutdown()
# And it will be updated when the database next loads
app = await make_app_with_db(db)
dev = app.get_device(ieee=ieee)
assert dev.last_seen >= next_last_seen + 35 # updated
await app.shutdown()
async def test_appdb_network_backups(tmp_path, backup_factory): # noqa: F811
db = tmp_path / "test.db"
backup = backup_factory()
app1 = await make_app_with_db(db)
app1.backups.add_backup(backup)
await app1.shutdown()
# The backup is reloaded from the database as well
app2 = await make_app_with_db(db)
assert len(app2.backups.backups) == 1
assert app2.backups.backups[0] == backup
new_backup = backup_factory()
new_backup.network_info.network_key.tx_counter += 10000
app2.backups.add_backup(new_backup)
await app2.shutdown()
# The database will contain only the single backup
app3 = await make_app_with_db(db)
assert len(app3.backups.backups) == 1
assert app3.backups.backups[0] == new_backup
assert app3.backups.backups[0] != backup
await app3.shutdown()
async def test_appdb_network_backups_format_change(tmp_path, backup_factory): # noqa: F811
db = tmp_path / "test.db"
backup = backup_factory()
backup.as_dict = MagicMock(return_value={"some new key": 1, **backup.as_dict()})
app1 = await make_app_with_db(db)
app1.backups.add_backup(backup)
await app1.shutdown()
# The backup is reloaded from the database as well
app2 = await make_app_with_db(db)
assert len(app2.backups.backups) == 1
assert app2.backups.backups[0] == backup
new_backup = backup_factory()
new_backup.network_info.network_key.tx_counter += 10000
app2.backups.add_backup(new_backup)
await app2.shutdown()
# The database will contain only the single backup
with patch("zigpy.backups.BackupManager.add_backup") as mock_add_backup:
app3 = await make_app_with_db(db)
await app3.shutdown()
assert mock_add_backup.mock_calls == [call(new_backup, suppress_event=True)]
async def test_appdb_persist_coordinator_info(tmp_path): # noqa: F811
db = tmp_path / "test.db"
with patch(
"zigpy.appdb.PersistingListener._save_attribute_cache",
wraps=zigpy.appdb.PersistingListener._save_attribute_cache,
) as mock_save_attr_cache:
app = await make_app_with_db(db)
await app.initialize()
await app.shutdown()
assert mock_save_attr_cache.mock_calls == [call(app._device.endpoints[1])]
async def test_appdb_attribute_clear(tmp_path):
db = tmp_path / "test.db"
app = await make_app_with_db(db)
dev = app.add_device(nwk=0x1234, ieee=t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
basic = ep.add_input_cluster(Basic.cluster_id)
app.device_initialized(dev)
basic.update_attribute(Basic.AttributeDefs.zcl_version.id, 0x12)
await app.shutdown()
# Upon reload, the attribute exists and is in the cache
app2 = await make_app_with_db(db)
dev2 = app2.get_device(ieee=dev.ieee)
assert (
dev2.endpoints[1].basic._attr_cache[Basic.AttributeDefs.zcl_version.id] == 0x12
)
# Clear an existing attribute
dev2.endpoints[1].basic.update_attribute(Basic.AttributeDefs.zcl_version.id, None)
# Clear an attribute not in the cache
dev2.endpoints[1].basic.update_attribute(Basic.AttributeDefs.manufacturer.id, None)
assert Basic.AttributeDefs.zcl_version.id not in dev2.endpoints[1].basic._attr_cache
await asyncio.sleep(0.1)
await app2.shutdown()
# The attribute has been removed from the database
app3 = await make_app_with_db(db)
dev3 = app3.get_device(ieee=dev.ieee)
assert Basic.AttributeDefs.zcl_version.id not in dev3.endpoints[1].basic._attr_cache
await app3.shutdown()
async def test_appdb_complex_quirk_matching(tmp_path) -> None:
"""Test quirks are given full attribute state for matching."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
# Create a simple device
dev = app.add_device(nwk=0x1234, ieee=t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
basic = ep.add_input_cluster(Basic.cluster_id)
basic.update_attribute(Basic.AttributeDefs.model.id, "Some Model")
basic.update_attribute(Basic.AttributeDefs.manufacturer.id, "Some Manufacturer")
ota = ep.add_output_cluster(Ota.cluster_id)
ota.update_attribute(Ota.AttributeDefs.current_file_version.id, 0x12345678)
app.device_initialized(dev)
await app.shutdown()
# Ensure quirks have the correct information to match properly
registry = DeviceRegistry()
# Doesn't match
_quirk1 = (
QuirkBuilder("Some Manufacturer", "Some Model", registry=registry)
.firmware_version_filter(
min_version=0x12345678 - 1,
max_version=0x12345678,
allow_missing=False,
)
.add_to_registry()
)
# Matches
quirk2 = (
QuirkBuilder("Some Manufacturer", "Some Model", registry=registry)
.firmware_version_filter(
min_version=0x12345678,
max_version=0x12345678 + 1,
allow_missing=False,
)
.add_to_registry()
)
# Doesn't match
_quirk3 = (
QuirkBuilder("Some Manufacturer", "Some Model", registry=registry)
.firmware_version_filter(
min_version=0x12345678 + 1,
max_version=0x12345678 + 2,
allow_missing=False,
)
.add_to_registry()
)
with patch("zigpy.quirks.get_device", side_effect=registry.get_device):
app2 = await make_app_with_db(db)
# Only the second quirk should match
dev2 = app2.get_device(t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
assert dev2.quirk_metadata == quirk2
await app2.shutdown()
@patch("zigpy.quirks.DEVICE_REGISTRY", new=DeviceRegistry())
async def test_attribute_reads_persist(tmp_path) -> None:
"""Test that attribute reads are persisted to the database."""
class CustomBasicCluster(CustomCluster, Basic):
class AttributeDefs(Basic.AttributeDefs):
# This attribute intentionally collides with `model`
custom_attr = ZCLAttributeDef(
id=0x0004, type=t.uint8_t, manufacturer_code=0x1234
)
(
QuirkBuilder(
"some manufacturer", "some model", registry=zigpy.quirks.DEVICE_REGISTRY
)
.replaces(CustomBasicCluster, endpoint_id=1)
.add_to_registry()
)
db = tmp_path / "test.db"
app = await make_app_with_db(db)
dev = app.add_device(nwk=0x1234, ieee=t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
basic = ep.add_input_cluster(Basic.cluster_id)
basic.update_attribute(Basic.AttributeDefs.model, "some model")
basic.update_attribute(Basic.AttributeDefs.manufacturer, "some manufacturer")
await dev.initialize()
dev = app.get_device(ieee=dev.ieee)
assert isinstance(dev.endpoints[1].basic, CustomBasicCluster)
with mock_attribute_reads(
dev.endpoints[1].basic,
{
CustomBasicCluster.AttributeDefs.product_label: "some label",
CustomBasicCluster.AttributeDefs.serial_number: ZCLStatus.UNSUPPORTED_ATTRIBUTE,
CustomBasicCluster.AttributeDefs.custom_attr: 0xAB,
},
):
await dev.endpoints[1].basic.read_attributes(
[
CustomBasicCluster.AttributeDefs.product_label,
CustomBasicCluster.AttributeDefs.serial_number,
CustomBasicCluster.AttributeDefs.custom_attr,
]
)
await app.shutdown()
# Load it back from disk
app2 = await make_app_with_db(db)
dev2 = app2.get_device(t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
assert (
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.product_label
)
== "some label"
)
with pytest.raises(UnsupportedAttribute):
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.serial_number
)
assert (
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.custom_attr
)
== 0xAB
)
await app2.shutdown()
@patch("zigpy.quirks.DEVICE_REGISTRY", new=DeviceRegistry())
async def test_attribute_reports_persist(tmp_path) -> None:
"""Test that attribute reports are persisted to the database."""
class CustomBasicCluster(CustomCluster, Basic):
class AttributeDefs(Basic.AttributeDefs):
# This attribute intentionally collides with `model`
custom_attr = ZCLAttributeDef(
id=0x0004, type=t.uint8_t, manufacturer_code=0x1234
)
(
QuirkBuilder(
"some manufacturer", "some model", registry=zigpy.quirks.DEVICE_REGISTRY
)
.replaces(CustomBasicCluster, endpoint_id=1)
.add_to_registry()
)
db = tmp_path / "test.db"
app = await make_app_with_db(db)
dev = app.add_device(nwk=0x1234, ieee=t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
basic = ep.add_input_cluster(Basic.cluster_id)
basic.update_attribute(Basic.AttributeDefs.model, "some model")
basic.update_attribute(Basic.AttributeDefs.manufacturer, "some manufacturer")
await dev.initialize()
dev = app.get_device(ieee=dev.ieee)
assert isinstance(dev.endpoints[1].basic, CustomBasicCluster)
await mock_attribute_report(
dev.endpoints[1].basic,
{CustomBasicCluster.AttributeDefs.product_label: "some label"},
)
await mock_attribute_report(
dev.endpoints[1].basic,
{CustomBasicCluster.AttributeDefs.custom_attr: 0xAB},
)
await app.shutdown()
# Load it back from disk
app2 = await make_app_with_db(db)
dev2 = app2.get_device(t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
assert (
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.product_label
)
== "some label"
)
assert (
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.custom_attr
)
== 0xAB
)
await app2.shutdown()
@patch("zigpy.quirks.DEVICE_REGISTRY", new=DeviceRegistry())
async def test_attribute_writes_persist(tmp_path) -> None:
"""Test that attribute writes are persisted to the database."""
class CustomBasicCluster(CustomCluster, Basic):
class AttributeDefs(Basic.AttributeDefs):
# This attribute intentionally collides with `model`
custom_attr = ZCLAttributeDef(
id=0x0004, type=t.uint8_t, manufacturer_code=0x1234
)
(
QuirkBuilder(
"some manufacturer", "some model", registry=zigpy.quirks.DEVICE_REGISTRY
)
.replaces(CustomBasicCluster, endpoint_id=1)
.add_to_registry()
)
db = tmp_path / "test.db"
app = await make_app_with_db(db)
dev = app.add_device(nwk=0x1234, ieee=t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
basic = ep.add_input_cluster(Basic.cluster_id)
basic.update_attribute(Basic.AttributeDefs.model, "some model")
basic.update_attribute(Basic.AttributeDefs.manufacturer, "some manufacturer")
await dev.initialize()
dev = app.get_device(ieee=dev.ieee)
assert isinstance(dev.endpoints[1].basic, CustomBasicCluster)
with mock_attribute_writes(
dev.endpoints[1].basic,
{
CustomBasicCluster.AttributeDefs.product_label: ZCLStatus.SUCCESS,
CustomBasicCluster.AttributeDefs.serial_number: ZCLStatus.UNSUPPORTED_ATTRIBUTE,
CustomBasicCluster.AttributeDefs.custom_attr: ZCLStatus.SUCCESS,
},
):
await dev.endpoints[1].basic.write_attributes(
{
CustomBasicCluster.AttributeDefs.product_label: "some label",
CustomBasicCluster.AttributeDefs.serial_number: "some serial",
CustomBasicCluster.AttributeDefs.custom_attr: 0xAB,
}
)
await app.shutdown()
# Load it back from disk
app2 = await make_app_with_db(db)
dev2 = app2.get_device(t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
assert (
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.product_label
)
== "some label"
)
with pytest.raises(UnsupportedAttribute):
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.serial_number
)
assert (
dev2.endpoints[1].basic.get_cached_value(
CustomBasicCluster.AttributeDefs.custom_attr
)
== 0xAB
)
await app2.shutdown()
async def test_attribute_cache_null_manufacturer_code_uniqueness(tmp_path):
"""Test that NULL manufacturer_code is treated as unique in the attribute cache."""
db = tmp_path / "test.db"
app = await make_app_with_db(db)
ieee = t.EUI64.convert("aa:bb:cc:dd:11:22:33:44")
dev = app.add_device(ieee=ieee, nwk=0x1234)
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = profiles.zha.PROFILE_ID
ep.device_type = profiles.zha.DeviceType.ON_OFF_SWITCH
basic = ep.add_input_cluster(Basic.cluster_id)
app.device_initialized(dev)
# Write an attribute with NULL manufacturer_code twice
basic.update_attribute(Basic.AttributeDefs.model, "Model 1")
basic.update_attribute(Basic.AttributeDefs.model, "Model 2")
await app.shutdown()
# Verify there is only one row in the database
async with aiosqlite.connect(db) as conn:
cursor = await conn.execute(
f"SELECT COUNT(*) FROM attributes_cache{zigpy.appdb.DB_V} WHERE attr_id = :attr_id AND manufacturer_code IS NULL",
{"attr_id": Basic.AttributeDefs.model.id},
)
row = await cursor.fetchone()
assert row[0] == 1
# And the value is the latest one
cursor = await conn.execute(
f"SELECT value FROM attributes_cache{zigpy.appdb.DB_V} WHERE attr_id = :attr_id AND manufacturer_code IS NULL",
{"attr_id": Basic.AttributeDefs.model.id},
)
row = await cursor.fetchone()
assert row[0] == "Model 2"
@patch("zigpy.quirks.DEVICE_REGISTRY", new=DeviceRegistry())
async def test_device_signature_ignores_quirks(tmp_path) -> None:
"""Test that `device.original_signature` is populated before quirks modify the device."""
(
QuirkBuilder(
"some manufacturer", "some model", registry=zigpy.quirks.DEVICE_REGISTRY
)
.adds_endpoint(99)
.adds(Basic.cluster_id, endpoint_id=99)
.adds(Identify.cluster_id, endpoint_id=1)
.removes(OnOff.cluster_id, cluster_type=ClusterType.Client, endpoint_id=1)
.add_to_registry()
)
expected_signature = {
SIG_MANUFACTURER: "some manufacturer",
SIG_MODEL: "some model",
SIG_NODE_DESC: {
"logical_type": zdo_t.LogicalType.Router,
"complex_descriptor_available": 0,
"user_descriptor_available": 0,
"reserved": 0,
"aps_flags": 0,
"frequency_band": zdo_t.NodeDescriptor.FrequencyBand.Freq2400MHz,
"mac_capability_flags": zdo_t.NodeDescriptor.MACCapabilityFlags.AllocateAddress,
"manufacturer_code": 4174,
"maximum_buffer_size": 82,
"maximum_incoming_transfer_size": 82,
"server_mask": 0,
"maximum_outgoing_transfer_size": 82,
"descriptor_capability_field": zdo_t.NodeDescriptor.DescriptorCapability.NONE,
},
SIG_ENDPOINTS: {
1: {
SIG_EP_PROFILE: 260,
SIG_EP_TYPE: profiles.zha.DeviceType.PUMP,
SIG_EP_INPUT: [Basic.cluster_id],
SIG_EP_OUTPUT: [OnOff.cluster_id],
},
},
}
db = tmp_path / "test.db"
app = await make_app_with_db(db)
dev = app.add_device(nwk=0x1234, ieee=t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = profiles.zha.DeviceType.PUMP
ep.add_output_cluster(OnOff.cluster_id)
basic = ep.add_input_cluster(Basic.cluster_id)
basic.update_attribute(Basic.AttributeDefs.model, "some model")
basic.update_attribute(Basic.AttributeDefs.manufacturer, "some manufacturer")
dev.model = "some model"
dev.manufacturer = "some manufacturer"
# When a device joins at runtime, `device_initialized` applies quirks
app.device_initialized(dev)
dev = app.get_device(t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
# The quirk modified the device object
assert 99 in dev.endpoints
assert Identify.cluster_id in dev.endpoints[1].in_clusters
assert OnOff.cluster_id not in dev.endpoints[1].out_clusters
# But the original signature was captured before quirks were applied
assert dev.original_signature == expected_signature
await app.shutdown()
# Also verify loading from the database preserves the original signature
app2 = await make_app_with_db(db)
dev2 = app2.get_device(t.EUI64.convert("aa:bb:cc:dd:11:22:33:44"))
# The quirk modified the device object
assert 99 in dev2.endpoints
assert Identify.cluster_id in dev2.endpoints[1].in_clusters
assert OnOff.cluster_id not in dev2.endpoints[1].out_clusters
# The original signature is still preserved
assert dev2.original_signature == expected_signature
await app2.shutdown()
|