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 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
|
"""Unit tests for zeroconf._services.browser."""
from __future__ import annotations
import asyncio
import logging
import os
import socket
import time
import unittest
from collections.abc import Iterable
from threading import Event
from typing import cast
from unittest.mock import patch
import pytest
import zeroconf as r
import zeroconf._services.browser as _services_browser
from zeroconf import (
DNSPointer,
DNSQuestion,
Zeroconf,
_engine,
const,
current_time_millis,
millis_to_seconds,
)
from zeroconf._services import ServiceStateChange
from zeroconf._services.browser import ServiceBrowser, _ScheduledPTRQuery
from zeroconf._services.info import ServiceInfo
from zeroconf.asyncio import AsyncServiceBrowser, AsyncZeroconf
from .. import (
QuestionHistoryWithoutSuppression,
_inject_response,
_wait_for_start,
has_working_ipv6,
time_changed_millis,
)
log = logging.getLogger("zeroconf")
original_logging_level = logging.NOTSET
def setup_module():
global original_logging_level
original_logging_level = log.level
log.setLevel(logging.DEBUG)
def teardown_module():
if original_logging_level != logging.NOTSET:
log.setLevel(original_logging_level)
def mock_incoming_msg(records: Iterable[r.DNSRecord]) -> r.DNSIncoming:
generated = r.DNSOutgoing(const._FLAGS_QR_RESPONSE)
for record in records:
generated.add_answer_at_time(record, 0)
return r.DNSIncoming(generated.packets()[0])
def test_service_browser_cancel_multiple_times():
"""Test we can cancel a ServiceBrowser multiple times before close."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
class MyServiceListener(r.ServiceListener):
pass
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
browser.cancel()
browser.cancel()
browser.cancel()
zc.close()
def test_service_browser_cancel_context_manager():
"""Test we can cancel a ServiceBrowser with it being used as a context manager."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
class MyServiceListener(r.ServiceListener):
pass
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
assert cast(bool, browser.done) is False
with browser:
pass
# ensure call_soon_threadsafe in ServiceBrowser.cancel is run
assert zc.loop is not None
asyncio.run_coroutine_threadsafe(asyncio.sleep(0), zc.loop).result()
assert cast(bool, browser.done) is True
zc.close()
def test_service_browser_cancel_multiple_times_after_close():
"""Test we can cancel a ServiceBrowser multiple times after close."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
class MyServiceListener(r.ServiceListener):
pass
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
zc.close()
browser.cancel()
browser.cancel()
browser.cancel()
def test_service_browser_started_after_zeroconf_closed():
"""Test starting a ServiceBrowser after close raises RuntimeError."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
class MyServiceListener(r.ServiceListener):
pass
listener = MyServiceListener()
zc.close()
with pytest.raises(RuntimeError):
r.ServiceBrowser(zc, type_, None, listener)
def test_multiple_instances_running_close():
"""Test we can shutdown multiple instances."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
zc2 = Zeroconf(interfaces=["127.0.0.1"])
zc3 = Zeroconf(interfaces=["127.0.0.1"])
assert zc.loop != zc2.loop
assert zc.loop != zc3.loop
class MyServiceListener(r.ServiceListener):
pass
listener = MyServiceListener()
zc2.add_service_listener("zca._hap._tcp.local.", listener)
zc.close()
zc2.remove_service_listener(listener)
zc2.close()
zc3.close()
class TestServiceBrowser(unittest.TestCase):
def test_update_record(self):
enable_ipv6 = has_working_ipv6() and not os.environ.get("SKIP_IPV6")
service_name = "name._type._tcp.local."
service_type = "_type._tcp.local."
service_server = "ash-1.local."
service_text = b"path=/~matt1/"
service_address = "10.0.1.2"
service_v6_address = "2001:db8::1"
service_v6_second_address = "6001:db8::1"
service_added_count = 0
service_removed_count = 0
service_updated_count = 0
service_add_event = Event()
service_removed_event = Event()
service_updated_event = Event()
class MyServiceListener(r.ServiceListener):
def add_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
nonlocal service_added_count
service_added_count += 1
service_add_event.set()
def remove_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
nonlocal service_removed_count
service_removed_count += 1
service_removed_event.set()
def update_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
nonlocal service_updated_count
service_updated_count += 1
service_info = zc.get_service_info(type_, name)
assert socket.inet_aton(service_address) in service_info.addresses
if enable_ipv6:
assert socket.inet_pton(
socket.AF_INET6, service_v6_address
) in service_info.addresses_by_version(r.IPVersion.V6Only)
assert socket.inet_pton(
socket.AF_INET6, service_v6_second_address
) in service_info.addresses_by_version(r.IPVersion.V6Only)
assert service_info.text == service_text
assert service_info.server.lower() == service_server.lower()
service_updated_event.set()
def mock_record_update_incoming_msg(
service_state_change: r.ServiceStateChange,
) -> r.DNSIncoming:
generated = r.DNSOutgoing(const._FLAGS_QR_RESPONSE)
assert generated.is_response() is True
if service_state_change == r.ServiceStateChange.Removed:
ttl = 0
else:
ttl = 120
generated.add_answer_at_time(
r.DNSText(
service_name,
const._TYPE_TXT,
const._CLASS_IN | const._CLASS_UNIQUE,
ttl,
service_text,
),
0,
)
generated.add_answer_at_time(
r.DNSService(
service_name,
const._TYPE_SRV,
const._CLASS_IN | const._CLASS_UNIQUE,
ttl,
0,
0,
80,
service_server,
),
0,
)
# Send the IPv6 address first since we previously
# had a bug where the IPv4 would be missing if the
# IPv6 was seen first
if enable_ipv6:
generated.add_answer_at_time(
r.DNSAddress(
service_server,
const._TYPE_AAAA,
const._CLASS_IN | const._CLASS_UNIQUE,
ttl,
socket.inet_pton(socket.AF_INET6, service_v6_address),
),
0,
)
generated.add_answer_at_time(
r.DNSAddress(
service_server,
const._TYPE_AAAA,
const._CLASS_IN | const._CLASS_UNIQUE,
ttl,
socket.inet_pton(socket.AF_INET6, service_v6_second_address),
),
0,
)
generated.add_answer_at_time(
r.DNSAddress(
service_server,
const._TYPE_A,
const._CLASS_IN | const._CLASS_UNIQUE,
ttl,
socket.inet_aton(service_address),
),
0,
)
generated.add_answer_at_time(
r.DNSPointer(service_type, const._TYPE_PTR, const._CLASS_IN, ttl, service_name),
0,
)
return r.DNSIncoming(generated.packets()[0])
zeroconf = r.Zeroconf(interfaces=["127.0.0.1"])
service_browser = r.ServiceBrowser(zeroconf, service_type, listener=MyServiceListener())
try:
wait_time = 3
# service added
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Added))
service_add_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 0
assert service_removed_count == 0
# service SRV updated
service_updated_event.clear()
service_server = "ash-2.local."
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Updated))
service_updated_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 1
assert service_removed_count == 0
# service TXT updated
service_updated_event.clear()
service_text = b"path=/~matt2/"
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Updated))
service_updated_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 2
assert service_removed_count == 0
# service TXT updated - duplicate update should not trigger another service_updated
service_updated_event.clear()
service_text = b"path=/~matt2/"
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Updated))
service_updated_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 2
assert service_removed_count == 0
# service A updated
service_updated_event.clear()
service_address = "10.0.1.3"
# Verify we match on uppercase
service_server = service_server.upper()
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Updated))
service_updated_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 3
assert service_removed_count == 0
# service all updated
service_updated_event.clear()
service_server = "ash-3.local."
service_text = b"path=/~matt3/"
service_address = "10.0.1.3"
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Updated))
service_updated_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 4
assert service_removed_count == 0
# service removed
_inject_response(zeroconf, mock_record_update_incoming_msg(r.ServiceStateChange.Removed))
service_removed_event.wait(wait_time)
assert service_added_count == 1
assert service_updated_count == 4
assert service_removed_count == 1
finally:
assert len(zeroconf.listeners) == 1
service_browser.cancel()
time.sleep(0.2)
assert len(zeroconf.listeners) == 0
zeroconf.remove_all_service_listeners()
zeroconf.close()
class TestServiceBrowserMultipleTypes(unittest.TestCase):
def test_update_record(self):
service_names = [
"name2._type2._tcp.local.",
"name._type._tcp.local.",
"name._type._udp.local",
]
service_types = ["_type2._tcp.local.", "_type._tcp.local.", "_type._udp.local."]
service_added_count = 0
service_removed_count = 0
service_add_event = Event()
service_removed_event = Event()
class MyServiceListener(r.ServiceListener):
def add_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
nonlocal service_added_count
service_added_count += 1
if service_added_count == 3:
service_add_event.set()
def remove_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
nonlocal service_removed_count
service_removed_count += 1
if service_removed_count == 3:
service_removed_event.set()
def mock_record_update_incoming_msg(
service_state_change: r.ServiceStateChange,
service_type: str,
service_name: str,
ttl: int,
) -> r.DNSIncoming:
generated = r.DNSOutgoing(const._FLAGS_QR_RESPONSE)
generated.add_answer_at_time(
r.DNSPointer(service_type, const._TYPE_PTR, const._CLASS_IN, ttl, service_name),
0,
)
return r.DNSIncoming(generated.packets()[0])
zeroconf = r.Zeroconf(interfaces=["127.0.0.1"])
service_browser = r.ServiceBrowser(zeroconf, service_types, listener=MyServiceListener())
try:
wait_time = 3
# all three services added
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Added, service_types[0], service_names[0], 120
),
)
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Added, service_types[1], service_names[1], 120
),
)
time.sleep(0.1)
called_with_refresh_time_check = False
def _mock_get_expiration_time(self, percent):
nonlocal called_with_refresh_time_check
if percent == const._EXPIRE_REFRESH_TIME_PERCENT:
called_with_refresh_time_check = True
return 0
return self.created + (percent * self.ttl * 10)
# Set an expire time that will force a refresh
with patch("zeroconf.DNSRecord.get_expiration_time", new=_mock_get_expiration_time):
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Added,
service_types[0],
service_names[0],
120,
),
)
# Add the last record after updating the first one
# to ensure the service_add_event only gets set
# after the update
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Added,
service_types[2],
service_names[2],
120,
),
)
service_add_event.wait(wait_time)
assert called_with_refresh_time_check is True
assert service_added_count == 3
assert service_removed_count == 0
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Updated, service_types[0], service_names[0], 0
),
)
# all three services removed
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Removed, service_types[0], service_names[0], 0
),
)
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Removed, service_types[1], service_names[1], 0
),
)
_inject_response(
zeroconf,
mock_record_update_incoming_msg(
r.ServiceStateChange.Removed, service_types[2], service_names[2], 0
),
)
service_removed_event.wait(wait_time)
assert service_added_count == 3
assert service_removed_count == 3
except TypeError:
# Cannot be patched with cython as get_expiration_time is immutable
pass
finally:
assert len(zeroconf.listeners) == 1
service_browser.cancel()
time.sleep(0.2)
assert len(zeroconf.listeners) == 0
zeroconf.remove_all_service_listeners()
zeroconf.close()
def test_first_query_delay():
"""Verify the first query is delayed.
https://datatracker.ietf.org/doc/html/rfc6762#section-5.2
"""
type_ = "_http._tcp.local."
zeroconf_browser = Zeroconf(interfaces=["127.0.0.1"])
_wait_for_start(zeroconf_browser)
# we are going to patch the zeroconf send to check query transmission
old_send = zeroconf_browser.async_send
first_query_time = None
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT):
"""Sends an outgoing packet."""
nonlocal first_query_time
if first_query_time is None:
first_query_time = current_time_millis()
old_send(out, addr=addr, port=port)
# patch the zeroconf send
with patch.object(zeroconf_browser, "async_send", send):
# dummy service callback
def on_service_state_change(zeroconf, service_type, state_change, name):
pass
start_time = current_time_millis()
browser = ServiceBrowser(zeroconf_browser, type_, [on_service_state_change])
time.sleep(millis_to_seconds(_services_browser._FIRST_QUERY_DELAY_RANDOM_INTERVAL[1] + 5))
try:
assert (
current_time_millis() - start_time > _services_browser._FIRST_QUERY_DELAY_RANDOM_INTERVAL[0]
)
finally:
browser.cancel()
zeroconf_browser.close()
@pytest.mark.asyncio
async def test_asking_default_is_asking_qm_questions_after_the_first_qu():
"""Verify the service browser's first questions are QU and refresh queries are QM."""
service_added = asyncio.Event()
service_removed = asyncio.Event()
unexpected_ttl = asyncio.Event()
got_query = asyncio.Event()
type_ = "_http._tcp.local."
registration_name = f"xxxyyy.{type_}"
def on_service_state_change(zeroconf, service_type, state_change, name):
if name == registration_name:
if state_change is ServiceStateChange.Added:
service_added.set()
elif state_change is ServiceStateChange.Removed:
service_removed.set()
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_browser = aiozc.zeroconf
zeroconf_browser.question_history = QuestionHistoryWithoutSuppression()
await zeroconf_browser.async_wait_for_start()
# we are going to patch the zeroconf send to check packet sizes
old_send = zeroconf_browser.async_send
expected_ttl = const._DNS_OTHER_TTL
questions: list[list[DNSQuestion]] = []
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
questions.append(pout.questions)
got_query.set()
old_send(out, addr=addr, port=port, v6_flow_scope=v6_flow_scope)
assert len(zeroconf_browser.engine.protocols) == 2
aio_zeroconf_registrar = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_registrar = aio_zeroconf_registrar.zeroconf
await aio_zeroconf_registrar.zeroconf.async_wait_for_start()
assert len(zeroconf_registrar.engine.protocols) == 2
# patch the zeroconf send so we can capture what is being sent
with patch.object(zeroconf_browser, "async_send", send):
service_added = asyncio.Event()
service_removed = asyncio.Event()
browser = AsyncServiceBrowser(zeroconf_browser, type_, [on_service_state_change])
info = ServiceInfo(
type_,
registration_name,
80,
0,
0,
{"path": "/~paulsm/"},
"ash-2.local.",
addresses=[socket.inet_aton("10.0.1.2")],
)
task = await aio_zeroconf_registrar.async_register_service(info)
await task
loop = asyncio.get_running_loop()
try:
await asyncio.wait_for(service_added.wait(), 1)
assert service_added.is_set()
# Make sure the startup queries are sent
original_now = loop.time()
now_millis = original_now * 1000
for query_count in range(_services_browser.STARTUP_QUERIES):
now_millis += (2**query_count) * 1000
time_changed_millis(now_millis)
got_query.clear()
now_millis = original_now * 1000
assert not unexpected_ttl.is_set()
# Move time forward past when the TTL is no longer
# fresh (AKA 75% of the TTL)
now_millis += (expected_ttl * 1000) * 0.80
time_changed_millis(now_millis)
await asyncio.wait_for(got_query.wait(), 1)
assert not unexpected_ttl.is_set()
assert len(questions) == _services_browser.STARTUP_QUERIES + 1
# The first question should be QU to try to
# populate the known answers and limit the impact
# of the QM questions that follow. We still
# have to ask QM questions for the startup queries
# because some devices will not respond to QU
assert questions[0][0].unicast is True
# The remaining questions should be QM questions
for question in questions[1:]:
assert question[0].unicast is False
# Don't remove service, allow close() to cleanup
finally:
await aio_zeroconf_registrar.async_close()
await asyncio.wait_for(service_removed.wait(), 1)
assert service_removed.is_set()
await browser.async_cancel()
await aiozc.async_close()
@pytest.mark.asyncio
async def test_ttl_refresh_cancelled_rescue_query():
"""Verify seeing a name again cancels the rescue query."""
service_added = asyncio.Event()
service_removed = asyncio.Event()
unexpected_ttl = asyncio.Event()
got_query = asyncio.Event()
type_ = "_http._tcp.local."
registration_name = f"xxxyyy.{type_}"
def on_service_state_change(zeroconf, service_type, state_change, name):
if name == registration_name:
if state_change is ServiceStateChange.Added:
service_added.set()
elif state_change is ServiceStateChange.Removed:
service_removed.set()
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_browser = aiozc.zeroconf
zeroconf_browser.question_history = QuestionHistoryWithoutSuppression()
await zeroconf_browser.async_wait_for_start()
# we are going to patch the zeroconf send to check packet sizes
old_send = zeroconf_browser.async_send
expected_ttl = const._DNS_OTHER_TTL
packets = []
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
packets.append(pout)
got_query.set()
old_send(out, addr=addr, port=port, v6_flow_scope=v6_flow_scope)
assert len(zeroconf_browser.engine.protocols) == 2
aio_zeroconf_registrar = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_registrar = aio_zeroconf_registrar.zeroconf
await aio_zeroconf_registrar.zeroconf.async_wait_for_start()
assert len(zeroconf_registrar.engine.protocols) == 2
# patch the zeroconf send so we can capture what is being sent
with patch.object(zeroconf_browser, "async_send", send):
service_added = asyncio.Event()
service_removed = asyncio.Event()
browser = AsyncServiceBrowser(zeroconf_browser, type_, [on_service_state_change])
info = ServiceInfo(
type_,
registration_name,
80,
0,
0,
{"path": "/~paulsm/"},
"ash-2.local.",
addresses=[socket.inet_aton("10.0.1.2")],
)
task = await aio_zeroconf_registrar.async_register_service(info)
await task
loop = asyncio.get_running_loop()
try:
await asyncio.wait_for(service_added.wait(), 1)
assert service_added.is_set()
# Make sure the startup queries are sent
original_now = loop.time()
now_millis = original_now * 1000
for query_count in range(_services_browser.STARTUP_QUERIES):
now_millis += (2**query_count) * 1000
time_changed_millis(now_millis)
now_millis = original_now * 1000
assert not unexpected_ttl.is_set()
await asyncio.wait_for(got_query.wait(), 1)
got_query.clear()
assert len(packets) == _services_browser.STARTUP_QUERIES
packets.clear()
# Move time forward past when the TTL is no longer
# fresh (AKA 75% of the TTL)
now_millis += (expected_ttl * 1000) * 0.80
# Inject a response that will reschedule
# the rescue query so it does not happen
with patch("time.monotonic", return_value=now_millis / 1000):
zeroconf_browser.record_manager.async_updates_from_response(
mock_incoming_msg([info.dns_pointer()]),
)
time_changed_millis(now_millis)
await asyncio.sleep(0)
# Verify we did not send a rescue query
assert not packets
# We should still get a rescue query once the rescheduled
# query time is reached
now_millis += (expected_ttl * 1000) * 0.76
time_changed_millis(now_millis)
await asyncio.wait_for(got_query.wait(), 1)
assert len(packets) == 1
# Don't remove service, allow close() to cleanup
finally:
await aio_zeroconf_registrar.async_close()
await asyncio.wait_for(service_removed.wait(), 1)
assert service_removed.is_set()
await browser.async_cancel()
await aiozc.async_close()
@pytest.mark.asyncio
async def test_asking_qm_questions():
"""Verify explicitly asking QM questions."""
type_ = "_quservice._tcp.local."
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_browser = aiozc.zeroconf
await zeroconf_browser.async_wait_for_start()
# we are going to patch the zeroconf send to check query transmission
old_send = zeroconf_browser.async_send
first_outgoing = None
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT):
"""Sends an outgoing packet."""
nonlocal first_outgoing
if first_outgoing is None:
first_outgoing = out
old_send(out, addr=addr, port=port)
# patch the zeroconf send
with patch.object(zeroconf_browser, "async_send", send):
# dummy service callback
def on_service_state_change(zeroconf, service_type, state_change, name):
pass
browser = AsyncServiceBrowser(
zeroconf_browser,
type_,
[on_service_state_change],
question_type=r.DNSQuestionType.QM,
)
await asyncio.sleep(millis_to_seconds(_services_browser._FIRST_QUERY_DELAY_RANDOM_INTERVAL[1] + 5))
try:
assert first_outgoing.questions[0].unicast is False # type: ignore[union-attr]
finally:
await browser.async_cancel()
await aiozc.async_close()
@pytest.mark.asyncio
async def test_asking_qu_questions():
"""Verify the service browser can ask QU questions."""
type_ = "_quservice._tcp.local."
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_browser = aiozc.zeroconf
await zeroconf_browser.async_wait_for_start()
# we are going to patch the zeroconf send to check query transmission
old_send = zeroconf_browser.async_send
first_outgoing = None
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT):
"""Sends an outgoing packet."""
nonlocal first_outgoing
if first_outgoing is None:
first_outgoing = out
old_send(out, addr=addr, port=port)
# patch the zeroconf send
with patch.object(zeroconf_browser, "async_send", send):
# dummy service callback
def on_service_state_change(zeroconf, service_type, state_change, name):
pass
browser = AsyncServiceBrowser(
zeroconf_browser,
type_,
[on_service_state_change],
question_type=r.DNSQuestionType.QU,
)
await asyncio.sleep(millis_to_seconds(_services_browser._FIRST_QUERY_DELAY_RANDOM_INTERVAL[1] + 5))
try:
assert first_outgoing.questions[0].unicast is True # type: ignore[union-attr]
finally:
await browser.async_cancel()
await aiozc.async_close()
def test_legacy_record_update_listener():
"""Test a RecordUpdateListener that does not implement update_records."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
with pytest.raises(RuntimeError):
r.RecordUpdateListener().update_record(
zc,
0,
r.DNSRecord("irrelevant", const._TYPE_SRV, const._CLASS_IN, const._DNS_HOST_TTL),
)
updates = []
class LegacyRecordUpdateListener(r.RecordUpdateListener):
"""A RecordUpdateListener that does not implement update_records."""
def update_record(self, zc: Zeroconf, now: float, record: r.DNSRecord) -> None:
updates.append(record)
listener = LegacyRecordUpdateListener()
zc.add_listener(listener, None)
# dummy service callback
def on_service_state_change(zeroconf, service_type, state_change, name):
pass
# start a browser
type_ = "_homeassistant._tcp.local."
name = "MyTestHome"
browser = ServiceBrowser(zc, type_, [on_service_state_change])
info_service = ServiceInfo(
type_,
f"{name}.{type_}",
80,
0,
0,
{"path": "/~paulsm/"},
"ash-2.local.",
addresses=[socket.inet_aton("10.0.1.2")],
)
zc.register_service(info_service)
time.sleep(0.001)
browser.cancel()
assert updates
assert len([isinstance(update, r.DNSPointer) and update.name == type_ for update in updates]) >= 1
zc.remove_listener(listener)
# Removing a second time should not throw
zc.remove_listener(listener)
zc.close()
def test_service_browser_is_aware_of_port_changes():
"""Test that the ServiceBrowser is aware of port changes."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
registration_name = f"xxxyyy.{type_}"
callbacks = []
# dummy service callback
def on_service_state_change(zeroconf, service_type, state_change, name):
"""Dummy callback."""
if name == registration_name:
callbacks.append((service_type, state_change, name))
browser = ServiceBrowser(zc, type_, [on_service_state_change])
desc = {"path": "/~paulsm/"}
address_parsed = "10.0.1.2"
address = socket.inet_aton(address_parsed)
info = ServiceInfo(type_, registration_name, 80, 0, 0, desc, "ash-2.local.", addresses=[address])
_inject_response(
zc,
mock_incoming_msg(
[
info.dns_pointer(),
info.dns_service(),
info.dns_text(),
*info.dns_addresses(),
]
),
)
time.sleep(0.1)
assert callbacks == [("_hap._tcp.local.", ServiceStateChange.Added, "xxxyyy._hap._tcp.local.")]
service_info = zc.get_service_info(type_, registration_name)
assert service_info is not None
assert service_info.port == 80
info.port = 400
info._dns_service_cache = None # we are mutating the record so clear the cache
_inject_response(
zc,
mock_incoming_msg([info.dns_service()]),
)
time.sleep(0.1)
assert callbacks == [
("_hap._tcp.local.", ServiceStateChange.Added, "xxxyyy._hap._tcp.local."),
("_hap._tcp.local.", ServiceStateChange.Updated, "xxxyyy._hap._tcp.local."),
]
service_info = zc.get_service_info(type_, registration_name)
assert service_info is not None
assert service_info.port == 400
browser.cancel()
zc.close()
def test_service_browser_listeners_update_service():
"""Test that the ServiceBrowser ServiceListener that implements update_service."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
registration_name = f"xxxyyy.{type_}"
callbacks = []
class MyServiceListener(r.ServiceListener):
def add_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("add", type_, name))
def remove_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("remove", type_, name))
def update_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("update", type_, name))
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
desc = {"path": "/~paulsm/"}
address_parsed = "10.0.1.2"
address = socket.inet_aton(address_parsed)
info = ServiceInfo(type_, registration_name, 80, 0, 0, desc, "ash-2.local.", addresses=[address])
_inject_response(
zc,
mock_incoming_msg(
[
info.dns_pointer(),
info.dns_service(),
info.dns_text(),
*info.dns_addresses(),
]
),
)
time.sleep(0.2)
info._dns_service_cache = None # we are mutating the record so clear the cache
info.port = 400
_inject_response(
zc,
mock_incoming_msg([info.dns_service()]),
)
time.sleep(0.2)
assert callbacks == [
("add", type_, registration_name),
("update", type_, registration_name),
]
browser.cancel()
zc.close()
def test_service_browser_listeners_no_update_service():
"""Test that the ServiceBrowser ServiceListener that does not implement update_service."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_hap._tcp.local."
registration_name = f"xxxyyy.{type_}"
callbacks = []
class MyServiceListener(r.ServiceListener):
def add_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("add", type_, name))
def remove_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("remove", type_, name))
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
desc = {"path": "/~paulsm/"}
address_parsed = "10.0.1.2"
address = socket.inet_aton(address_parsed)
info = ServiceInfo(type_, registration_name, 80, 0, 0, desc, "ash-2.local.", addresses=[address])
_inject_response(
zc,
mock_incoming_msg(
[
info.dns_pointer(),
info.dns_service(),
info.dns_text(),
*info.dns_addresses(),
]
),
)
time.sleep(0.2)
info.port = 400
info._dns_service_cache = None # we are mutating the record so clear the cache
_inject_response(
zc,
mock_incoming_msg([info.dns_service()]),
)
time.sleep(0.2)
assert callbacks == [
("add", type_, registration_name),
]
browser.cancel()
zc.close()
def test_service_browser_uses_non_strict_names():
"""Verify we can look for technically invalid names as we cannot change what others do."""
# dummy service callback
def on_service_state_change(zeroconf, service_type, state_change, name):
pass
zc = r.Zeroconf(interfaces=["127.0.0.1"])
browser = ServiceBrowser(zc, ["_tivo-videostream._tcp.local."], [on_service_state_change])
browser.cancel()
# Still fail on completely invalid
with pytest.raises(r.BadTypeInNameException):
browser = ServiceBrowser(zc, ["tivo-videostream._tcp.local."], [on_service_state_change])
zc.close()
def test_group_ptr_queries_with_known_answers():
questions_with_known_answers: _services_browser._QuestionWithKnownAnswers = {}
now = current_time_millis()
for i in range(120):
name = f"_hap{i}._tcp._local."
questions_with_known_answers[DNSQuestion(name, const._TYPE_PTR, const._CLASS_IN)] = {
DNSPointer(
name,
const._TYPE_PTR,
const._CLASS_IN,
4500,
f"zoo{counter}.{name}",
)
for counter in range(i)
}
outs = _services_browser.group_ptr_queries_with_known_answers(now, True, questions_with_known_answers)
for out in outs:
packets = out.packets()
# If we generate multiple packets there must
# only be one question
assert len(packets) == 1 or len(out.questions) == 1
# This test uses asyncio because it needs to access the cache directly
# which is not threadsafe
@pytest.mark.asyncio
async def test_generate_service_query_suppress_duplicate_questions():
"""Generate a service query for sending with zeroconf.send."""
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zc = aiozc.zeroconf
now = current_time_millis()
name = "_suppresstest._tcp.local."
question = r.DNSQuestion(name, const._TYPE_PTR, const._CLASS_IN)
answer = r.DNSPointer(
name,
const._TYPE_PTR,
const._CLASS_IN,
10000,
f"known-to-other.{name}",
)
other_known_answers: set[r.DNSRecord] = {answer}
zc.question_history.add_question_at_time(question, now, other_known_answers)
assert zc.question_history.suppresses(question, now, other_known_answers)
# The known answer list is different, do not suppress
outs = _services_browser.generate_service_query(zc, now, {name}, multicast=True, question_type=None)
assert outs
zc.cache.async_add_records([answer])
# The known answer list contains all the asked questions in the history
# we should suppress
outs = _services_browser.generate_service_query(zc, now, {name}, multicast=True, question_type=None)
assert not outs
# We do not suppress once the question history expires
outs = _services_browser.generate_service_query(
zc, now + 1000, {name}, multicast=True, question_type=None
)
assert outs
# We do not suppress QU queries ever
outs = _services_browser.generate_service_query(zc, now, {name}, multicast=False, question_type=None)
assert outs
zc.question_history.async_expire(now + 2000)
# No suppression after clearing the history
outs = _services_browser.generate_service_query(zc, now, {name}, multicast=True, question_type=None)
assert outs
# The previous query we just sent is still remembered and
# the next one is suppressed
outs = _services_browser.generate_service_query(zc, now, {name}, multicast=True, question_type=None)
assert not outs
await aiozc.async_close()
@pytest.mark.asyncio
async def test_query_scheduler():
delay = const._BROWSER_TIME
types_ = {"_hap._tcp.local.", "_http._tcp.local."}
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
await aiozc.zeroconf.async_wait_for_start()
zc = aiozc.zeroconf
sends: list[r.DNSIncoming] = []
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
sends.append(pout)
query_scheduler = _services_browser.QueryScheduler(zc, types_, None, 0, True, delay, (0, 0), None)
loop = asyncio.get_running_loop()
# patch the zeroconf send so we can capture what is being sent
with patch.object(zc, "async_send", send):
query_scheduler.start(loop)
original_now = loop.time()
now_millis = original_now * 1000
for query_count in range(_services_browser.STARTUP_QUERIES):
now_millis += (2**query_count) * 1000
time_changed_millis(now_millis)
ptr_record = r.DNSPointer(
"_hap._tcp.local.",
const._TYPE_PTR,
const._CLASS_IN,
const._DNS_OTHER_TTL,
"zoomer._hap._tcp.local.",
)
ptr2_record = r.DNSPointer(
"_hap._tcp.local.",
const._TYPE_PTR,
const._CLASS_IN,
const._DNS_OTHER_TTL,
"disappear._hap._tcp.local.",
)
query_scheduler.reschedule_ptr_first_refresh(ptr_record)
expected_when_time = ptr_record.get_expiration_time(const._EXPIRE_REFRESH_TIME_PERCENT)
expected_expire_time = ptr_record.get_expiration_time(100)
ptr_query = _ScheduledPTRQuery(
ptr_record.alias,
ptr_record.name,
int(ptr_record.ttl),
expected_expire_time,
expected_when_time,
)
assert query_scheduler._query_heap == [ptr_query]
query_scheduler.reschedule_ptr_first_refresh(ptr2_record)
expected_when_time = ptr2_record.get_expiration_time(const._EXPIRE_REFRESH_TIME_PERCENT)
expected_expire_time = ptr2_record.get_expiration_time(100)
ptr2_query = _ScheduledPTRQuery(
ptr2_record.alias,
ptr2_record.name,
int(ptr2_record.ttl),
expected_expire_time,
expected_when_time,
)
assert query_scheduler._query_heap == [ptr_query, ptr2_query]
# Simulate PTR one goodbye
query_scheduler.cancel_ptr_refresh(ptr_record)
ptr_query.cancelled = True
assert query_scheduler._query_heap == [ptr_query, ptr2_query]
assert query_scheduler._query_heap[0].cancelled is True
assert query_scheduler._query_heap[1].cancelled is False
# Move time forward past when the TTL is no longer
# fresh (AKA 75% of the TTL)
now_millis += (ptr2_record.ttl * 1000) * 0.80
time_changed_millis(now_millis)
assert len(query_scheduler._query_heap) == 1
first_heap = query_scheduler._query_heap[0]
assert first_heap.cancelled is False
assert first_heap.alias == ptr2_record.alias
# Move time forward past when the record expires
now_millis += (ptr2_record.ttl * 1000) * 0.20
time_changed_millis(now_millis)
assert len(query_scheduler._query_heap) == 0
await aiozc.async_close()
@pytest.mark.asyncio
async def test_query_scheduler_rescue_records():
delay = const._BROWSER_TIME
types_ = {"_hap._tcp.local.", "_http._tcp.local."}
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
await aiozc.zeroconf.async_wait_for_start()
zc = aiozc.zeroconf
sends: list[r.DNSIncoming] = []
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
sends.append(pout)
query_scheduler = _services_browser.QueryScheduler(zc, types_, None, 0, True, delay, (0, 0), None)
loop = asyncio.get_running_loop()
# patch the zeroconf send so we can capture what is being sent
with patch.object(zc, "async_send", send):
query_scheduler.start(loop)
original_now = loop.time()
now_millis = original_now * 1000
for query_count in range(_services_browser.STARTUP_QUERIES):
now_millis += (2**query_count) * 1000
time_changed_millis(now_millis)
ptr_record = r.DNSPointer(
"_hap._tcp.local.",
const._TYPE_PTR,
const._CLASS_IN,
const._DNS_OTHER_TTL,
"zoomer._hap._tcp.local.",
)
query_scheduler.reschedule_ptr_first_refresh(ptr_record)
expected_when_time = ptr_record.get_expiration_time(const._EXPIRE_REFRESH_TIME_PERCENT)
expected_expire_time = ptr_record.get_expiration_time(100)
ptr_query = _ScheduledPTRQuery(
ptr_record.alias,
ptr_record.name,
int(ptr_record.ttl),
expected_expire_time,
expected_when_time,
)
assert query_scheduler._query_heap == [ptr_query]
assert query_scheduler._query_heap[0].cancelled is False
# Move time forward past when the TTL is no longer
# fresh (AKA 75% of the TTL)
now_millis += (ptr_record.ttl * 1000) * 0.76
time_changed_millis(now_millis)
assert len(query_scheduler._query_heap) == 1
new_when = query_scheduler._query_heap[0].when_millis
assert query_scheduler._query_heap[0].cancelled is False
assert new_when >= expected_when_time
# Move time forward again, but not enough to expire the
# record to make sure we try to rescue it
now_millis += (ptr_record.ttl * 1000) * 0.11
time_changed_millis(now_millis)
assert len(query_scheduler._query_heap) == 1
second_new_when = query_scheduler._query_heap[0].when_millis
assert query_scheduler._query_heap[0].cancelled is False
assert second_new_when >= new_when
# Move time forward again, enough that we will no longer
# try to rescue the record
now_millis += (ptr_record.ttl * 1000) * 0.11
time_changed_millis(now_millis)
assert len(query_scheduler._query_heap) == 0
await aiozc.async_close()
def test_service_browser_matching():
"""Test that the ServiceBrowser matching does not match partial names."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_http._tcp.local."
registration_name = f"xxxyyy.{type_}"
not_match_type_ = "_asustor-looksgood_http._tcp.local."
not_match_registration_name = f"xxxyyy.{not_match_type_}"
callbacks = []
class MyServiceListener(r.ServiceListener):
def add_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("add", type_, name))
def remove_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("remove", type_, name))
def update_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("update", type_, name))
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
desc = {"path": "/~paulsm/"}
address_parsed = "10.0.1.2"
address = socket.inet_aton(address_parsed)
info = ServiceInfo(type_, registration_name, 80, 0, 0, desc, "ash-2.local.", addresses=[address])
should_not_match = ServiceInfo(
not_match_type_,
not_match_registration_name,
80,
0,
0,
desc,
"ash-2.local.",
addresses=[address],
)
_inject_response(
zc,
mock_incoming_msg(
[
info.dns_pointer(),
info.dns_service(),
info.dns_text(),
*info.dns_addresses(),
]
),
)
_inject_response(
zc,
mock_incoming_msg(
[
should_not_match.dns_pointer(),
should_not_match.dns_service(),
should_not_match.dns_text(),
*should_not_match.dns_addresses(),
]
),
)
time.sleep(0.2)
info.port = 400
info._dns_service_cache = None # we are mutating the record so clear the cache
_inject_response(
zc,
mock_incoming_msg([info.dns_service()]),
)
should_not_match.port = 400
_inject_response(
zc,
mock_incoming_msg([should_not_match.dns_service()]),
)
time.sleep(0.2)
assert callbacks == [
("add", type_, registration_name),
("update", type_, registration_name),
]
browser.cancel()
zc.close()
@pytest.mark.skipif(os.environ.get("DEBIAN_TEST"), reason="disabled by Debian builder")
@patch.object(_engine, "_CACHE_CLEANUP_INTERVAL", 0.01)
def test_service_browser_expire_callbacks():
"""Test that the ServiceBrowser matching does not match partial names."""
# instantiate a zeroconf instance
zc = Zeroconf(interfaces=["127.0.0.1"])
# start a browser
type_ = "_old._tcp.local."
registration_name = f"uniquezip323.{type_}"
callbacks = []
class MyServiceListener(r.ServiceListener):
def add_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("add", type_, name))
def remove_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("remove", type_, name))
def update_service(self, zc, type_, name) -> None: # type: ignore[no-untyped-def]
if name == registration_name:
callbacks.append(("update", type_, name))
listener = MyServiceListener()
browser = r.ServiceBrowser(zc, type_, None, listener)
desc = {"path": "/~paul2/"}
address_parsed = "10.0.1.3"
address = socket.inet_aton(address_parsed)
info = ServiceInfo(
type_,
registration_name,
80,
0,
0,
desc,
"newname-2.local.",
host_ttl=1,
other_ttl=1,
addresses=[address],
)
_inject_response(
zc,
mock_incoming_msg(
[
info.dns_pointer(),
info.dns_service(),
info.dns_text(),
*info.dns_addresses(),
]
),
)
# Force the ttl to be 1 second
now = current_time_millis()
for cache_record in list(zc.cache.cache.values()):
for record in cache_record:
zc.cache._async_set_created_ttl(record, now, 1)
time.sleep(0.3)
info.port = 400
info._dns_service_cache = None # we are mutating the record so clear the cache
_inject_response(
zc,
mock_incoming_msg([info.dns_service()]),
)
for _ in range(10):
time.sleep(0.05)
if len(callbacks) == 2:
break
assert callbacks == [
("add", type_, registration_name),
("update", type_, registration_name),
]
for _ in range(25):
time.sleep(0.05)
if len(callbacks) == 3:
break
assert callbacks == [
("add", type_, registration_name),
("update", type_, registration_name),
("remove", type_, registration_name),
]
browser.cancel()
zc.close()
def test_scheduled_ptr_query_dunder_methods():
query75 = _ScheduledPTRQuery("zoomy._hap._tcp.local.", "_hap._tcp.local.", 120, 120, 75)
query80 = _ScheduledPTRQuery("zoomy._hap._tcp.local.", "_hap._tcp.local.", 120, 120, 80)
query75_2 = _ScheduledPTRQuery("zoomy._hap._tcp.local.", "_hap._tcp.local.", 120, 140, 75)
other = object()
stringified = str(query75)
assert "zoomy._hap._tcp.local." in stringified
assert "120" in stringified
assert "75" in stringified
assert "ScheduledPTRQuery" in stringified
assert query75 == query75
assert query75 != query80
assert query75 == query75_2
assert query75 < query80
assert query75 <= query80
assert query80 > query75
assert query80 >= query75
assert query75 != other
with pytest.raises(TypeError):
assert query75 < other # type: ignore[operator]
with pytest.raises(TypeError):
assert query75 <= other # type: ignore[operator]
with pytest.raises(TypeError):
assert query75 > other # type: ignore[operator]
with pytest.raises(TypeError):
assert query75 >= other # type: ignore[operator]
@pytest.mark.asyncio
async def test_close_zeroconf_without_browser_before_start_up_queries():
"""Test that we stop sending startup queries if zeroconf is closed out from under the browser."""
service_added = asyncio.Event()
type_ = "_http._tcp.local."
registration_name = f"xxxyyy.{type_}"
def on_service_state_change(zeroconf, service_type, state_change, name):
if name == registration_name:
if state_change is ServiceStateChange.Added:
service_added.set()
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_browser = aiozc.zeroconf
zeroconf_browser.question_history = QuestionHistoryWithoutSuppression()
await zeroconf_browser.async_wait_for_start()
sends: list[r.DNSIncoming] = []
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
sends.append(pout)
assert len(zeroconf_browser.engine.protocols) == 2
aio_zeroconf_registrar = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_registrar = aio_zeroconf_registrar.zeroconf
await aio_zeroconf_registrar.zeroconf.async_wait_for_start()
assert len(zeroconf_registrar.engine.protocols) == 2
# patch the zeroconf send so we can capture what is being sent
with patch.object(zeroconf_browser, "async_send", send):
service_added = asyncio.Event()
browser = AsyncServiceBrowser(zeroconf_browser, type_, [on_service_state_change])
info = ServiceInfo(
type_,
registration_name,
80,
0,
0,
{"path": "/~paulsm/"},
"ash-2.local.",
addresses=[socket.inet_aton("10.0.1.2")],
)
task = await aio_zeroconf_registrar.async_register_service(info)
await task
loop = asyncio.get_running_loop()
try:
await asyncio.wait_for(service_added.wait(), 1)
assert service_added.is_set()
await aiozc.async_close()
sends.clear()
# Make sure the startup queries are sent
original_now = loop.time()
now_millis = original_now * 1000
for query_count in range(_services_browser.STARTUP_QUERIES):
now_millis += (2**query_count) * 1000
time_changed_millis(now_millis)
# We should not send any queries after close
assert not sends
finally:
await aio_zeroconf_registrar.async_close()
await browser.async_cancel()
@pytest.mark.asyncio
async def test_close_zeroconf_without_browser_after_start_up_queries():
"""Test that we stop sending rescue queries if zeroconf is closed out from under the browser."""
service_added = asyncio.Event()
type_ = "_http._tcp.local."
registration_name = f"xxxyyy.{type_}"
def on_service_state_change(zeroconf, service_type, state_change, name):
if name == registration_name:
if state_change is ServiceStateChange.Added:
service_added.set()
aiozc = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_browser = aiozc.zeroconf
zeroconf_browser.question_history = QuestionHistoryWithoutSuppression()
await zeroconf_browser.async_wait_for_start()
sends: list[r.DNSIncoming] = []
def send(out, addr=const._MDNS_ADDR, port=const._MDNS_PORT, v6_flow_scope=()):
"""Sends an outgoing packet."""
pout = r.DNSIncoming(out.packets()[0])
sends.append(pout)
assert len(zeroconf_browser.engine.protocols) == 2
aio_zeroconf_registrar = AsyncZeroconf(interfaces=["127.0.0.1"])
zeroconf_registrar = aio_zeroconf_registrar.zeroconf
await aio_zeroconf_registrar.zeroconf.async_wait_for_start()
assert len(zeroconf_registrar.engine.protocols) == 2
# patch the zeroconf send so we can capture what is being sent
with patch.object(zeroconf_browser, "async_send", send):
service_added = asyncio.Event()
browser = AsyncServiceBrowser(zeroconf_browser, type_, [on_service_state_change])
expected_ttl = const._DNS_OTHER_TTL
info = ServiceInfo(
type_,
registration_name,
80,
0,
0,
{"path": "/~paulsm/"},
"ash-2.local.",
addresses=[socket.inet_aton("10.0.1.2")],
)
task = await aio_zeroconf_registrar.async_register_service(info)
await task
loop = asyncio.get_running_loop()
try:
await asyncio.wait_for(service_added.wait(), 1)
assert service_added.is_set()
sends.clear()
# Make sure the startup queries are sent
original_now = loop.time()
now_millis = original_now * 1000
for query_count in range(_services_browser.STARTUP_QUERIES):
now_millis += (2**query_count) * 1000
time_changed_millis(now_millis)
# We should not send any queries after close
assert sends
await aiozc.async_close()
sends.clear()
now_millis = original_now * 1000
# Move time forward past when the TTL is no longer
# fresh (AKA 75% of the TTL)
now_millis += (expected_ttl * 1000) * 0.80
time_changed_millis(now_millis)
# We should not send the query after close
assert not sends
finally:
await aio_zeroconf_registrar.async_close()
await browser.async_cancel()
|