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
|
"""Tests for the Bluetooth integration scanners."""
import asyncio
import platform
import time
from datetime import timedelta
from typing import Any
from unittest.mock import ANY, AsyncMock, MagicMock, Mock, patch
import pytest
from bleak import BleakError
from bleak.backends.scanner import AdvertisementDataCallback
from bleak_retry_connector import BleakSlotManager
from habluetooth import (
SCANNER_WATCHDOG_INTERVAL,
SCANNER_WATCHDOG_TIMEOUT,
BluetoothManager,
BluetoothScanningMode,
BluetoothServiceInfoBleak,
HaScanner,
HaScannerType,
ScannerStartError,
get_manager,
scanner,
set_manager,
)
from habluetooth.channels.bluez import (
BluetoothMGMTProtocol,
MGMTBluetoothCtl,
)
from habluetooth.scanner import (
InvalidMessageError,
bytes_mac_to_str,
make_bluez_details,
)
from . import (
async_fire_time_changed,
generate_advertisement_data,
generate_ble_device,
patch_bluetooth_time,
utcnow,
)
from .conftest import FakeBluetoothAdapters, MockBluetoothManagerWithCallbacks
DEVICE_FOUND = 0x0012
ADV_MONITOR_DEVICE_FOUND = 0x002F
IS_WINDOWS = 'os.name == "nt"'
IS_POSIX = 'os.name == "posix"'
NOT_POSIX = 'os.name != "posix"'
# or_patterns is a workaround for the fact that passive scanning
# needs at least one matcher to be set. The below matcher
# will match all devices.
if platform.system() == "Linux":
# On Linux, use the real BlueZScannerArgs to avoid mocking issues
from bleak.args.bluez import BlueZScannerArgs, OrPattern
from bleak.assigned_numbers import AdvertisementDataType
scanner.PASSIVE_SCANNER_ARGS = BlueZScannerArgs(
or_patterns=[
OrPattern(0, AdvertisementDataType.FLAGS, b"\x02"),
OrPattern(0, AdvertisementDataType.FLAGS, b"\x06"),
OrPattern(0, AdvertisementDataType.FLAGS, b"\x1a"),
]
)
else:
# On other platforms, we can use a simple mock
scanner.PASSIVE_SCANNER_ARGS = Mock()
# If the adapter is in a stuck state the following errors are raised:
NEED_RESET_ERRORS = [
"org.bluez.Error.Failed",
"org.bluez.Error.InProgress",
"org.bluez.Error.NotReady",
"not found",
]
@pytest.fixture(autouse=True, scope="module")
def disable_stop_discovery():
"""Disable stop discovery."""
with (
patch("habluetooth.scanner.stop_discovery"),
patch("habluetooth.scanner.restore_discoveries"),
):
yield
@pytest.fixture(autouse=True, scope="module")
def manager():
"""Return the BluetoothManager instance."""
adapters = FakeBluetoothAdapters()
slot_manager = BleakSlotManager()
manager = BluetoothManager(adapters, slot_manager)
set_manager(manager)
return manager
@pytest.fixture
def mock_btmgmt_socket():
"""Mock the btmgmt_socket module."""
with patch("habluetooth.channels.bluez.btmgmt_socket") as mock_btmgmt:
mock_socket = Mock()
# Make the socket look like a real socket with a file descriptor
mock_socket.fileno.return_value = 99
mock_btmgmt.open.return_value = mock_socket
yield mock_btmgmt
def test_bytes_mac_to_str() -> None:
"""Test bytes_mac_to_str."""
assert bytes_mac_to_str(b"\xff\xee\xdd\xcc\xbb\xaa") == "AA:BB:CC:DD:EE:FF"
assert bytes_mac_to_str(b"\xff\xee\xdd\xcc\xbb\xaa") == "AA:BB:CC:DD:EE:FF"
def test_make_bluez_details() -> None:
"""Test make_bluez_details."""
assert make_bluez_details("AA:BB:CC:DD:EE:FF", "hci0") == {
"path": "/org/bluez/hci0/dev_AA_BB_CC_DD_EE_FF",
"props": {"Adapter": "/org/bluez/hci0"},
}
@pytest.mark.asyncio
async def test_empty_data_no_scanner() -> None:
"""Test we handle empty data."""
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
assert scanner.discovered_devices == []
assert scanner.discovered_devices_and_advertisement_data == {}
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_dbus_socket_missing_in_container(
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test we handle dbus being missing in the container."""
with (
patch("habluetooth.scanner.is_docker_env", return_value=True),
patch(
"habluetooth.scanner.OriginalBleakScanner.start",
side_effect=FileNotFoundError,
),
patch(
"habluetooth.scanner.OriginalBleakScanner.stop",
) as mock_stop,
pytest.raises(
ScannerStartError,
match="DBus service not found; docker config may be missing",
),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert mock_stop.called
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_dbus_socket_missing(caplog: pytest.LogCaptureFixture) -> None:
"""Test we handle dbus being missing."""
with (
patch("habluetooth.scanner.is_docker_env", return_value=False),
patch(
"habluetooth.scanner.OriginalBleakScanner.start",
side_effect=FileNotFoundError,
),
patch(
"habluetooth.scanner.OriginalBleakScanner.stop",
) as mock_stop,
pytest.raises(
ScannerStartError,
match="DBus service not found; make sure the DBus socket is available",
),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert mock_stop.called
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_handle_cancellation(caplog: pytest.LogCaptureFixture) -> None:
"""Test cancellation stops."""
with (
patch("habluetooth.scanner.is_docker_env", return_value=False),
patch(
"habluetooth.scanner.OriginalBleakScanner.start",
side_effect=asyncio.CancelledError,
),
patch(
"habluetooth.scanner.OriginalBleakScanner.stop",
) as mock_stop,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
with pytest.raises(asyncio.CancelledError):
await scanner.async_start()
assert mock_stop.called
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_handle_stop_while_starting(caplog: pytest.LogCaptureFixture) -> None:
"""Test stop while starting."""
async def _start(*args, **kwargs):
await asyncio.sleep(1000)
with (
patch("habluetooth.scanner.is_docker_env", return_value=False),
patch("habluetooth.scanner.OriginalBleakScanner.start", _start),
patch(
"habluetooth.scanner.OriginalBleakScanner.stop",
) as mock_stop,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
task = asyncio.create_task(scanner.async_start())
await asyncio.sleep(0)
await asyncio.sleep(0)
await scanner.async_stop()
with pytest.raises(
ScannerStartError, match="Starting bluetooth scanner aborted"
):
await task
assert mock_stop.called
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_dbus_broken_pipe_in_container(caplog: pytest.LogCaptureFixture) -> None:
"""Test we handle dbus broken pipe in the container."""
with (
patch("habluetooth.scanner.is_docker_env", return_value=True),
patch(
"habluetooth.scanner.OriginalBleakScanner.start",
side_effect=BrokenPipeError,
),
patch(
"habluetooth.scanner.OriginalBleakScanner.stop",
) as mock_stop,
pytest.raises(ScannerStartError, match="DBus connection broken"),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert mock_stop.called
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_dbus_broken_pipe(caplog: pytest.LogCaptureFixture) -> None:
"""Test we handle dbus broken pipe."""
with (
patch("habluetooth.scanner.is_docker_env", return_value=False),
patch(
"habluetooth.scanner.OriginalBleakScanner.start",
side_effect=BrokenPipeError,
),
patch(
"habluetooth.scanner.OriginalBleakScanner.stop",
) as mock_stop,
pytest.raises(ScannerStartError, match="DBus connection broken:"),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert mock_stop.called
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_invalid_dbus_message(caplog: pytest.LogCaptureFixture) -> None:
"""Test we handle invalid dbus message."""
with (
patch(
"habluetooth.scanner.OriginalBleakScanner.start",
side_effect=InvalidMessageError,
),
pytest.raises(ScannerStartError, match="Invalid DBus message received"),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(IS_WINDOWS)
@pytest.mark.parametrize("error", NEED_RESET_ERRORS)
async def test_adapter_needs_reset_at_start(
caplog: pytest.LogCaptureFixture, error: str
) -> None:
"""Test we cycle the adapter when it needs a restart."""
called_start = 0
called_stop = 0
_callback = None
mock_discovered: list[Any] = []
class MockBleakScanner:
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
if called_start < 3:
raise BleakError(error)
async def stop(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_stop
called_stop += 1
@property
def discovered_devices(self):
"""Mock discovered_devices."""
nonlocal mock_discovered
return mock_discovered
def register_detection_callback(
self, callback: AdvertisementDataCallback
) -> None:
"""Mock Register Detection Callback."""
nonlocal _callback
_callback = callback
mock_scanner = MockBleakScanner()
with (
patch("habluetooth.scanner.OriginalBleakScanner", return_value=mock_scanner),
patch(
"habluetooth.util.recover_adapter", return_value=True
) as mock_recover_adapter,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert len(mock_recover_adapter.mock_calls) == 1
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(IS_WINDOWS)
async def test_recovery_from_dbus_restart() -> None:
"""Test we can recover when DBus gets restarted out from under us."""
called_start = 0
called_stop = 0
_callback = None
mock_discovered: list[Any] = []
class MockBleakScanner:
def __init__(self, detection_callback, *args, **kwargs):
nonlocal _callback
_callback = detection_callback
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
async def stop(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_stop
called_stop += 1
@property
def discovered_devices(self):
"""Mock discovered_devices."""
nonlocal mock_discovered
return mock_discovered
with patch(
"habluetooth.scanner.OriginalBleakScanner",
MockBleakScanner,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert called_start == 1
start_time_monotonic = time.monotonic()
mock_discovered = [MagicMock()]
# Ensure we don't restart the scanner if we don't need to
with patch_bluetooth_time(
start_time_monotonic + 10,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
assert called_start == 1
# Fire a callback to reset the timer
with patch_bluetooth_time(
start_time_monotonic,
):
_callback( # type: ignore
generate_ble_device("44:44:33:11:23:42", "any_name"),
generate_advertisement_data(local_name="any_name"),
)
# Ensure we don't restart the scanner if we don't need to
with patch_bluetooth_time(
start_time_monotonic + 20,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert called_start == 1
# We hit the timer, so we restart the scanner
with patch_bluetooth_time(
start_time_monotonic + SCANNER_WATCHDOG_TIMEOUT + 20,
):
async_fire_time_changed(
utcnow() + SCANNER_WATCHDOG_INTERVAL + timedelta(seconds=20)
)
await asyncio.sleep(0)
assert called_start == 2
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(IS_WINDOWS)
async def test_adapter_recovery() -> None:
"""Test we can recover when the adapter stops responding."""
called_start = 0
called_stop = 0
_callback = None
mock_discovered: list[Any] = []
class MockBleakScanner:
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
async def stop(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_stop
called_stop += 1
@property
def discovered_devices(self):
"""Mock discovered_devices."""
nonlocal mock_discovered
return mock_discovered
def register_detection_callback(
self, callback: AdvertisementDataCallback
) -> None:
"""Mock Register Detection Callback."""
nonlocal _callback
_callback = callback
mock_scanner = MockBleakScanner()
start_time_monotonic = time.monotonic()
with (
patch_bluetooth_time(
start_time_monotonic,
),
patch(
"habluetooth.scanner.OriginalBleakScanner",
return_value=mock_scanner,
),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert called_start == 1
mock_discovered = [MagicMock()]
# Ensure we don't restart the scanner if we don't need to
with patch_bluetooth_time(
start_time_monotonic + 10,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert called_start == 1
# Ensure we don't restart the scanner if we don't need to
with patch_bluetooth_time(
start_time_monotonic + 20,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert called_start == 1
# We hit the timer with no detections, so we
# reset the adapter and restart the scanner
with (
patch_bluetooth_time(
start_time_monotonic
+ SCANNER_WATCHDOG_TIMEOUT
+ SCANNER_WATCHDOG_INTERVAL.total_seconds(),
),
patch(
"habluetooth.util.recover_adapter", return_value=True
) as mock_recover_adapter,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert len(mock_recover_adapter.mock_calls) == 1
assert mock_recover_adapter.call_args_list[0][0] == (
0,
"AA:BB:CC:DD:EE:FF",
True,
)
assert called_start == 2
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(IS_WINDOWS)
async def test_adapter_scanner_fails_to_start_first_time() -> None:
"""
Test we can recover when the adapter stops responding.
The first recovery fails.
"""
called_start = 0
called_stop = 0
_callback = None
mock_discovered: list[Any] = []
class MockBleakScanner:
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
if called_start == 1:
return # Start ok the first time
if called_start < 4:
raise BleakError("Failed to start")
async def stop(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_stop
called_stop += 1
@property
def discovered_devices(self):
"""Mock discovered_devices."""
nonlocal mock_discovered
return mock_discovered
def register_detection_callback(
self, callback: AdvertisementDataCallback
) -> None:
"""Mock Register Detection Callback."""
nonlocal _callback
_callback = callback
mock_scanner = MockBleakScanner()
start_time_monotonic = time.monotonic()
with (
patch_bluetooth_time(
start_time_monotonic,
),
patch(
"habluetooth.scanner.OriginalBleakScanner",
return_value=mock_scanner,
),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert called_start == 1
mock_discovered = [MagicMock()]
# Ensure we don't restart the scanner if we don't need to
with patch_bluetooth_time(
start_time_monotonic + 10,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert called_start == 1
# Ensure we don't restart the scanner if we don't need to
with patch_bluetooth_time(
start_time_monotonic + 20,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert called_start == 1
# We hit the timer with no detections,
# so we reset the adapter and restart the scanner
with (
patch_bluetooth_time(
start_time_monotonic
+ SCANNER_WATCHDOG_TIMEOUT
+ SCANNER_WATCHDOG_INTERVAL.total_seconds(),
),
patch(
"habluetooth.util.recover_adapter", return_value=True
) as mock_recover_adapter,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert len(mock_recover_adapter.mock_calls) == 1
assert called_start == 4
assert scanner.scanning is True
now_monotonic = time.monotonic()
# We hit the timer again the previous start call failed, make sure
# we try again
with (
patch_bluetooth_time(
now_monotonic
+ SCANNER_WATCHDOG_TIMEOUT * 2
+ SCANNER_WATCHDOG_INTERVAL.total_seconds(),
),
patch(
"habluetooth.util.recover_adapter", return_value=True
) as mock_recover_adapter,
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
assert len(mock_recover_adapter.mock_calls) == 1
assert called_start == 5
await scanner.async_stop()
@pytest.mark.asyncio
async def test_adapter_fails_to_start_and_takes_a_bit_to_init(
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test we can recover the adapter at startup and we wait for Dbus to init."""
called_start = 0
called_stop = 0
_callback = None
mock_discovered: list[Any] = []
class MockBleakScanner:
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
if called_start == 1:
raise BleakError("org.freedesktop.DBus.Error.UnknownObject")
if called_start == 2:
raise BleakError("org.bluez.Error.InProgress")
if called_start == 3:
raise BleakError("org.bluez.Error.InProgress")
async def stop(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_stop
called_stop += 1
@property
def discovered_devices(self):
"""Mock discovered_devices."""
nonlocal mock_discovered
return mock_discovered
def register_detection_callback(
self, callback: AdvertisementDataCallback
) -> None:
"""Mock Register Detection Callback."""
nonlocal _callback
_callback = callback
mock_scanner = MockBleakScanner()
start_time_monotonic = time.monotonic()
with (
patch(
"habluetooth.scanner.ADAPTER_INIT_TIME",
0,
),
patch_bluetooth_time(
start_time_monotonic,
),
patch(
"habluetooth.scanner.OriginalBleakScanner",
return_value=mock_scanner,
),
patch(
"habluetooth.util.recover_adapter", return_value=True
) as mock_recover_adapter,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert called_start == 4
assert len(mock_recover_adapter.mock_calls) == 1
assert "Waiting for adapter to initialize" in caplog.text
await scanner.async_stop()
@pytest.mark.asyncio
async def test_restart_takes_longer_than_watchdog_time(
caplog: pytest.LogCaptureFixture,
) -> None:
"""
Test we do not try to recover the adapter again.
If the restart is still in progress.
"""
release_start_event = asyncio.Event()
called_start = 0
class MockBleakScanner:
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
if called_start == 1:
return
await release_start_event.wait()
async def stop(self, *args, **kwargs):
"""Mock Start."""
@property
def discovered_devices(self):
"""Mock discovered_devices."""
return []
def register_detection_callback(
self, callback: AdvertisementDataCallback
) -> None:
"""Mock Register Detection Callback."""
mock_scanner = MockBleakScanner()
start_time_monotonic = time.monotonic()
with (
patch(
"habluetooth.scanner.ADAPTER_INIT_TIME",
0,
),
patch_bluetooth_time(
start_time_monotonic,
),
patch(
"habluetooth.scanner.OriginalBleakScanner",
return_value=mock_scanner,
),
patch("habluetooth.util.recover_adapter", return_value=True),
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert called_start == 1
# Now force a recover adapter 2x
for _ in range(2):
with patch_bluetooth_time(
start_time_monotonic
+ SCANNER_WATCHDOG_TIMEOUT
+ SCANNER_WATCHDOG_INTERVAL.total_seconds(),
):
async_fire_time_changed(utcnow() + SCANNER_WATCHDOG_INTERVAL)
await asyncio.sleep(0)
# Now release the start event
release_start_event.set()
assert "already restarting" in caplog.text
await scanner.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif("platform.system() != 'Darwin'")
async def test_setup_and_stop_macos() -> None:
"""Test we enable use_bdaddr on MacOS."""
init_kwargs = None
class MockBleakScanner:
def __init__(self, *args, **kwargs):
"""Init the scanner."""
nonlocal init_kwargs
init_kwargs = kwargs
async def start(self, *args, **kwargs):
"""Start the scanner."""
async def stop(self, *args, **kwargs):
"""Stop the scanner."""
def register_detection_callback(self, *args, **kwargs):
"""Register a callback."""
with patch(
"habluetooth.scanner.OriginalBleakScanner",
MockBleakScanner,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert init_kwargs == {
"detection_callback": ANY,
"scanning_mode": "active",
"cb": {"use_bdaddr": True},
}
await scanner.async_stop()
@pytest.mark.asyncio
async def test_adapter_init_fails_fallback_to_passive(
caplog: pytest.LogCaptureFixture,
) -> None:
"""Test we fallback to passive when adapter init fails."""
called_start = 0
called_stop = 0
_callback = None
mock_discovered: list[Any] = []
class MockBleakScanner:
async def start(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_start
called_start += 1
if called_start == 1:
raise BleakError("org.freedesktop.DBus.Error.UnknownObject")
if called_start == 2:
raise BleakError("org.bluez.Error.InProgress")
if called_start == 3:
raise BleakError("org.bluez.Error.InProgress")
async def stop(self, *args, **kwargs):
"""Mock Start."""
nonlocal called_stop
called_stop += 1
@property
def discovered_devices(self):
"""Mock discovered_devices."""
nonlocal mock_discovered
return mock_discovered
def register_detection_callback(
self, callback: AdvertisementDataCallback
) -> None:
"""Mock Register Detection Callback."""
nonlocal _callback
_callback = callback
@property
def discovered_devices_and_advertisement_data(self) -> dict[str, Any]:
"""Mock discovered_devices."""
return {}
mock_scanner = MockBleakScanner()
start_time_monotonic = time.monotonic()
with (
patch(
"habluetooth.scanner.IS_LINUX",
True,
),
patch(
"habluetooth.scanner.ADAPTER_INIT_TIME",
0,
),
patch_bluetooth_time(
start_time_monotonic,
),
patch(
"habluetooth.scanner.OriginalBleakScanner",
return_value=mock_scanner,
),
patch(
"habluetooth.util.recover_adapter", return_value=True
) as mock_recover_adapter,
):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
await scanner.async_start()
assert called_start == 4
assert len(mock_recover_adapter.mock_calls) == 1
assert "Waiting for adapter to initialize" in caplog.text
assert (
"Successful fall-back to passive scanning mode after active scanning failed"
in caplog.text
)
assert await scanner.async_diagnostics() == {
"adapter": "hci0",
"connectable": True,
"current_mode": BluetoothScanningMode.PASSIVE,
"discovered_devices_and_advertisement_data": [],
"last_detection": ANY,
"monotonic_time": ANY,
"name": "hci0 (AA:BB:CC:DD:EE:FF)",
"requested_mode": BluetoothScanningMode.ACTIVE,
"scanning": True,
"source": "AA:BB:CC:DD:EE:FF",
"start_time": ANY,
"type": "HaScanner",
}
await scanner.async_stop()
assert await scanner.async_diagnostics() == {
"adapter": "hci0",
"connectable": True,
"current_mode": BluetoothScanningMode.PASSIVE,
"discovered_devices_and_advertisement_data": [],
"last_detection": ANY,
"monotonic_time": ANY,
"name": "hci0 (AA:BB:CC:DD:EE:FF)",
"requested_mode": BluetoothScanningMode.ACTIVE,
"scanning": False,
"source": "AA:BB:CC:DD:EE:FF",
"start_time": ANY,
"type": "HaScanner",
}
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_scanner_with_bluez_mgmt_side_channel(mock_btmgmt_socket: Mock) -> None:
"""Test scanner receiving advertisements via BlueZ management side channel."""
# Mock capability check for the entire test
with patch.object(MGMTBluetoothCtl, "_check_capabilities", return_value=True):
# Create a custom manager that tracks discovered devices
class TestBluetoothManager(BluetoothManager):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.discovered_infos = []
def _discover_service_info(
self, service_info: BluetoothServiceInfoBleak
) -> None:
"""Track discovered service info."""
self.discovered_infos.append(service_info)
# Create manager and setup mgmt controller
adapters = FakeBluetoothAdapters()
slot_manager = BleakSlotManager()
manager = TestBluetoothManager(adapters, slot_manager)
set_manager(manager)
# Set up the manager first
await manager.async_setup()
# Create and setup the mgmt controller with the manager's side channel scanners
mgmt_ctl = MGMTBluetoothCtl(
timeout=5.0, scanners=manager._side_channel_scanners
)
# Mock the protocol setup
mock_protocol = Mock(spec=BluetoothMGMTProtocol)
mock_transport = Mock()
mock_protocol.transport = mock_transport
async def mock_setup():
mgmt_ctl.protocol = mock_protocol
mgmt_ctl._on_connection_lost_future = (
asyncio.get_running_loop().create_future()
)
mgmt_ctl.setup = mock_setup # type: ignore[method-assign]
# Inject mgmt controller into manager
manager._mgmt_ctl = mgmt_ctl
manager.has_advertising_side_channel = True
# Verify get_bluez_mgmt_ctl returns our controller
assert manager.get_bluez_mgmt_ctl() is mgmt_ctl
# Register scanner
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
manager.async_register_scanner(scanner, connection_slots=2)
# Start scanner - should be created without detection callback
with patch("habluetooth.scanner.OriginalBleakScanner") as mock_scanner_class:
mock_scanner = Mock()
mock_scanner.start = AsyncMock()
mock_scanner.stop = AsyncMock()
mock_scanner.discovered_devices = []
mock_scanner_class.return_value = mock_scanner
await scanner.async_start()
# Verify scanner was created without detection callback
# since side channel is available
mock_scanner_class.assert_called_once()
call_kwargs = mock_scanner_class.call_args[1]
assert (
"detection_callback" not in call_kwargs
or call_kwargs["detection_callback"] is None
)
# Now simulate advertisement data coming through the mgmt protocol
# The manager should have registered the scanner with mgmt_ctl
assert 0 in mgmt_ctl.scanners # hci0 is index 0
assert mgmt_ctl.scanners[0] is scanner
# Simulate the protocol calling the scanner's raw advertisement handler
test_address = b"\xaa\xbb\xcc\xdd\xee\xff"
test_rssi = -60
test_flags = 0x06
# Create valid advertisement data with flags
# Each AD structure is: length (1 byte), type (1 byte), data
test_data = (
b"\x02\x01\x06" # Length=2, Type=0x01 (Flags), Data=0x06
# Length=8, Type=0x09 (Complete Local Name), Data="TestDev"
b"\x08\x09TestDev"
)
# Call the method that the protocol would call
scanner._async_on_raw_bluez_advertisement(
test_address,
1, # address_type: BDADDR_LE_PUBLIC
test_rssi,
test_flags,
test_data,
)
# Allow time for processing
await asyncio.sleep(0)
# Verify the device was discovered in the base scanner
assert len(scanner._previous_service_info) == 1
assert "FF:EE:DD:CC:BB:AA" in scanner._previous_service_info
service_info = scanner._previous_service_info["FF:EE:DD:CC:BB:AA"]
assert service_info.address == "FF:EE:DD:CC:BB:AA"
assert service_info.rssi == test_rssi
assert service_info.name == "TestDev"
# Verify the manager also received the advertisement
assert len(manager.discovered_infos) == 1
assert manager.discovered_infos[0] is service_info
await scanner.async_stop()
manager.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_scanner_without_bluez_mgmt_side_channel() -> None:
"""Test scanner uses normal detection callback when side channel unavailable."""
# Create manager without BlueZ mgmt support
class TestBluetoothManager(BluetoothManager):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.discovered_infos = []
def _discover_service_info(
self, service_info: BluetoothServiceInfoBleak
) -> None:
"""Track discovered service info."""
self.discovered_infos.append(service_info)
adapters = FakeBluetoothAdapters()
slot_manager = BleakSlotManager()
manager = TestBluetoothManager(adapters, slot_manager)
set_manager(manager)
# Setup without mgmt controller
await manager.async_setup()
assert manager.has_advertising_side_channel is False
# Register scanner
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
scanner.async_setup()
manager.async_register_scanner(scanner, connection_slots=2)
# Start scanner - should be created with detection callback
with patch("habluetooth.scanner.OriginalBleakScanner") as mock_scanner_class:
mock_scanner = Mock()
mock_scanner.start = AsyncMock()
mock_scanner.stop = AsyncMock()
mock_scanner.discovered_devices = []
mock_scanner_class.return_value = mock_scanner
await scanner.async_start()
# Verify scanner was created with detection callback since no side channel
mock_scanner_class.assert_called_once()
call_kwargs = mock_scanner_class.call_args[1]
assert "detection_callback" in call_kwargs
assert call_kwargs["detection_callback"] is not None
assert call_kwargs["detection_callback"] == scanner._async_detection_callback
await scanner.async_stop()
manager.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_bluez_mgmt_protocol_data_flow(mock_btmgmt_socket: Mock) -> None:
"""Test data flow from BlueZ protocol through manager to scanner."""
# Mock capability check for the entire test
with patch.object(MGMTBluetoothCtl, "_check_capabilities", return_value=True):
# Create manager
class TestBluetoothManager(BluetoothManager):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.discovered_infos = []
def _discover_service_info(
self, service_info: BluetoothServiceInfoBleak
) -> None:
"""Track discovered service info."""
self.discovered_infos.append(service_info)
adapters = FakeBluetoothAdapters()
slot_manager = BleakSlotManager()
manager = TestBluetoothManager(adapters, slot_manager)
set_manager(manager)
# Set up manager first
await manager.async_setup()
# Create mgmt controller with the manager's side channel scanners dictionary
mgmt_ctl = MGMTBluetoothCtl(
timeout=5.0, scanners=manager._side_channel_scanners
)
# We'll capture the protocol when it's created
captured_protocol: BluetoothMGMTProtocol | None = None
async def mock_create_connection(sock, protocol_factory, *args, **kwargs):
nonlocal captured_protocol
captured_protocol = protocol_factory()
mock_transport = Mock()
captured_protocol.connection_made(mock_transport)
return mock_transport, captured_protocol
with patch.object(
asyncio.get_running_loop(),
"_create_connection_transport",
mock_create_connection,
):
await mgmt_ctl.setup()
# Set mgmt controller on manager
manager._mgmt_ctl = mgmt_ctl
manager.has_advertising_side_channel = True
# Register scanners for hci0 and hci1
scanner0 = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:00")
scanner0.async_setup()
manager.async_register_scanner(scanner0, connection_slots=2)
scanner1 = HaScanner(BluetoothScanningMode.ACTIVE, "hci1", "AA:BB:CC:DD:EE:01")
scanner1.async_setup()
manager.async_register_scanner(scanner1, connection_slots=2)
# Start scanners
with patch("habluetooth.scanner.OriginalBleakScanner") as mock_scanner_class:
mock_scanner = Mock()
mock_scanner.start = AsyncMock()
mock_scanner.stop = AsyncMock()
mock_scanner.discovered_devices = []
mock_scanner_class.return_value = mock_scanner
await scanner0.async_start()
await scanner1.async_start()
# Verify scanners are registered in mgmt_ctl
assert 0 in mgmt_ctl.scanners
assert 1 in mgmt_ctl.scanners
assert mgmt_ctl.scanners[0] is scanner0
assert mgmt_ctl.scanners[1] is scanner1
# Test DEVICE_FOUND event for hci0
test_address = b"\x11\x22\x33\x44\x55\x66"
rssi_byte = b"\xc4" # -60 in signed byte
event_data = (
test_address
+ b"\x01" # address_type
+ rssi_byte
+ b"\x06\x00\x00\x00" # flags
+ b"\x03\x00" # data_len
+ b"\x02\x01\x06" # minimal adv data
)
packet = (
DEVICE_FOUND.to_bytes(2, "little")
+ b"\x00\x00" # controller_idx 0 (hci0)
+ len(event_data).to_bytes(2, "little")
+ event_data
)
# Feed packet to protocol
assert captured_protocol is not None
captured_protocol.data_received(packet)
# Verify device discovered on scanner0 only
assert len(scanner0._previous_service_info) == 1
assert "66:55:44:33:22:11" in scanner0._previous_service_info
assert len(scanner1._previous_service_info) == 0
# Test ADV_MONITOR_DEVICE_FOUND event for hci1
test_address2 = b"\xaa\xbb\xcc\xdd\xee\x02"
monitor_handle = b"\x01\x00"
rssi_byte2 = b"\xba" # -70 in signed byte
event_data2 = (
monitor_handle
+ test_address2
+ b"\x02" # address_type (random)
+ rssi_byte2
+ b"\x06\x00\x00\x00" # flags
+ b"\x03\x00" # data_len
+ b"\x02\x01\x06" # minimal adv data
)
packet2 = (
ADV_MONITOR_DEVICE_FOUND.to_bytes(2, "little")
+ b"\x01\x00" # controller_idx 1 (hci1)
+ len(event_data2).to_bytes(2, "little")
+ event_data2
)
assert captured_protocol is not None
captured_protocol.data_received(packet2)
# Verify device discovered on scanner1 only
assert len(scanner0._previous_service_info) == 1 # Still just the first device
assert len(scanner1._previous_service_info) == 1
assert "02:EE:DD:CC:BB:AA" in scanner1._previous_service_info
# Verify RSSI values
info0 = scanner0._previous_service_info["66:55:44:33:22:11"]
assert info0.rssi == -60
info1 = scanner1._previous_service_info["02:EE:DD:CC:BB:AA"]
assert info1.rssi == -70
await scanner0.async_stop()
await scanner1.async_stop()
manager.async_stop()
@pytest.mark.asyncio
@pytest.mark.skipif(NOT_POSIX)
async def test_mgmt_permission_error_fallback() -> None:
"""Test that permission errors in MGMT setup fall back to BlueZ-only mode."""
# Create manager
class TestBluetoothManager(BluetoothManager):
def _discover_service_info(
self, service_info: BluetoothServiceInfoBleak
) -> None:
"""Track discovered service info."""
pass
adapters = FakeBluetoothAdapters()
slot_manager = BleakSlotManager()
manager = TestBluetoothManager(adapters, slot_manager)
# Mock MGMTBluetoothCtl setup to raise PermissionError
with (
patch("habluetooth.manager.MGMTBluetoothCtl") as mock_mgmt_cls,
patch("habluetooth.manager.IS_LINUX", True),
):
mock_mgmt = Mock()
mock_mgmt.setup = AsyncMock(
side_effect=PermissionError(
"Missing NET_ADMIN/NET_RAW capabilities for Bluetooth management"
)
)
mock_mgmt_cls.return_value = mock_mgmt
# Setup should complete without raising the exception
await manager.async_setup()
# Verify MGMT was attempted but then set to None
mock_mgmt.setup.assert_called_once()
assert manager._mgmt_ctl is None
assert manager.has_advertising_side_channel is False
def test_usb_scanner_type() -> None:
"""Test that USB adapters get USB scanner type."""
manager = get_manager()
# Mock cached adapters with USB adapter
mock_adapters: dict[str, dict[str, Any]] = {
"hci0": {
"address": "00:1A:7D:DA:71:04",
"adapter_type": "usb",
"manufacturer": "TestManufacturer",
"product": "USB Bluetooth Adapter",
}
}
with patch.object(manager, "_adapters", mock_adapters):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner.details.scanner_type is HaScannerType.USB
def test_uart_scanner_type() -> None:
"""Test that UART adapters get UART scanner type."""
manager = get_manager()
# Mock cached adapters with UART adapter
mock_adapters: dict[str, dict[str, Any]] = {
"hci0": {
"address": "00:1A:7D:DA:71:04",
"adapter_type": "uart",
"manufacturer": "TestManufacturer",
"product": "UART Bluetooth Module",
}
}
with patch.object(manager, "_adapters", mock_adapters):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner.details.scanner_type is HaScannerType.UART
def test_unknown_scanner_type_no_cached_adapters() -> None:
"""Test that scanners get UNKNOWN type when no adapter info is cached."""
manager = get_manager()
# No cached adapters
with patch.object(manager, "_adapters", None):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner.details.scanner_type is HaScannerType.UNKNOWN
def test_unknown_scanner_type_adapter_not_found() -> None:
"""Test that scanners get UNKNOWN type when adapter is not in cache."""
manager = get_manager()
# Cached adapters but not the one we're looking for
mock_adapters: dict[str, dict[str, Any]] = {
"hci1": {
"address": "11:22:33:44:55:66",
"adapter_type": "usb",
}
}
with patch.object(manager, "_adapters", mock_adapters):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner.details.scanner_type is HaScannerType.UNKNOWN
def test_unknown_scanner_type_no_adapter_type() -> None:
"""Test that scanners get UNKNOWN type when adapter_type is None."""
manager = get_manager()
# Cached adapter without adapter_type field
mock_adapters: dict[str, dict[str, Any]] = {
"hci0": {
"address": "00:1A:7D:DA:71:04",
"adapter_type": None,
"manufacturer": "TestManufacturer",
}
}
with patch.object(manager, "_adapters", mock_adapters):
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner.details.scanner_type is HaScannerType.UNKNOWN
@pytest.mark.asyncio
async def test_scanner_type_with_real_adapter_data() -> None:
"""Test scanner type detection with realistic adapter data."""
# Create a custom manager for this test
manager = BluetoothManager(bluetooth_adapters=MagicMock())
set_manager(manager)
# Simulate real USB adapter data from Linux
usb_adapter_data: dict[str, dict[str, Any]] = {
"hci0": {
"address": "00:1A:7D:DA:71:04",
"sw_version": "homeassistant",
"hw_version": "usb:v1D6Bp0246d053F",
"passive_scan": False,
"manufacturer": "XTech",
"product": "Bluetooth 4.0 USB Adapter",
"vendor_id": "0a12",
"product_id": "0001",
"adapter_type": "usb",
}
}
manager._adapters = usb_adapter_data
# Create USB scanner
usb_scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert usb_scanner.details.scanner_type is HaScannerType.USB
assert usb_scanner.details.adapter == "hci0"
# Simulate real UART adapter data
uart_adapter_data: dict[str, dict[str, Any]] = {
"hci1": {
"address": "AA:BB:CC:DD:EE:FF",
"sw_version": "homeassistant",
"hw_version": "uart:ttyUSB0",
"passive_scan": False,
"manufacturer": "cyber-blue(HK)Ltd",
"product": "Bluetooth 4.0 UART Module",
"vendor_id": None,
"product_id": None,
"adapter_type": "uart",
}
}
manager._adapters = uart_adapter_data
# Create UART scanner
uart_scanner = HaScanner(BluetoothScanningMode.PASSIVE, "hci1", "AA:BB:CC:DD:EE:FF")
assert uart_scanner.details.scanner_type is HaScannerType.UART
assert uart_scanner.details.adapter == "hci1"
# Test with macOS/Windows adapter (no adapter_type)
macos_adapter_data = {
"Core Bluetooth": {
"address": "00:00:00:00:00:00",
"passive_scan": False,
"sw_version": "18.7.0",
"manufacturer": "Apple",
"product": "Unknown MacOS Model",
"vendor_id": "Unknown",
"product_id": "Unknown",
"adapter_type": None,
}
}
manager._adapters = macos_adapter_data
# Create scanner with unknown adapter type
macos_scanner = HaScanner(
BluetoothScanningMode.ACTIVE, "Core Bluetooth", "00:00:00:00:00:00"
)
assert macos_scanner.details.scanner_type is HaScannerType.UNKNOWN
@pytest.mark.asyncio
async def test_scanner_type_updates_after_adapter_refresh() -> None:
"""Test scanner type is UNKNOWN initially, determined after adapters load."""
# Create a custom manager for this test
manager = BluetoothManager(bluetooth_adapters=MagicMock())
set_manager(manager)
# Initially no adapters cached
manager._adapters = None # type: ignore[assignment]
# Create scanner - should be UNKNOWN
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner.details.scanner_type is HaScannerType.UNKNOWN
# Now simulate adapter data becoming available
manager._adapters = {
"hci0": {
"address": "00:1A:7D:DA:71:04",
"adapter_type": "usb",
"manufacturer": "TestManufacturer",
}
}
# Create a new scanner with the same adapter - should now be USB
scanner2 = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04")
assert scanner2.details.scanner_type is HaScannerType.USB
# Note: The first scanner still has UNKNOWN since scanner_type is set at init
assert scanner.details.scanner_type is HaScannerType.UNKNOWN
def test_multiple_scanner_types_simultaneously() -> None:
"""Test that multiple scanners can have different types at the same time."""
manager = get_manager()
# Set up adapters with different types
mock_adapters = {
"hci0": {
"address": "00:1A:7D:DA:71:04",
"adapter_type": "usb",
},
"hci1": {
"address": "AA:BB:CC:DD:EE:FF",
"adapter_type": "uart",
},
"hci2": {
"address": "11:22:33:44:55:66",
"adapter_type": None,
},
}
with patch.object(manager, "_adapters", mock_adapters):
# Create scanners of different types
usb_scanner = HaScanner(
BluetoothScanningMode.ACTIVE, "hci0", "00:1A:7D:DA:71:04"
)
uart_scanner = HaScanner(
BluetoothScanningMode.ACTIVE, "hci1", "AA:BB:CC:DD:EE:FF"
)
unknown_scanner = HaScanner(
BluetoothScanningMode.ACTIVE, "hci2", "11:22:33:44:55:66"
)
# Verify each has the correct type
assert usb_scanner.details.scanner_type is HaScannerType.USB
assert uart_scanner.details.scanner_type is HaScannerType.UART
assert unknown_scanner.details.scanner_type is HaScannerType.UNKNOWN
# Verify they all have different types
types = {
usb_scanner.details.scanner_type,
uart_scanner.details.scanner_type,
unknown_scanner.details.scanner_type,
}
assert len(types) == 3 # All different
def test_ha_scanner_get_allocations_no_slot_manager() -> None:
"""Test HaScanner.get_allocations returns None when manager has no slot_manager."""
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
manager = get_manager()
# Mock slot_manager as None
with patch.object(manager, "slot_manager", None):
assert scanner.get_allocations() is None
def test_ha_scanner_get_allocations_with_slot_manager() -> None:
"""Test HaScanner.get_allocations returns allocation info from BleakSlotManager."""
from bleak_retry_connector import Allocations
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
manager = get_manager()
# Create mock allocations
mock_allocations = Allocations(
adapter="hci0",
slots=5,
free=3,
allocated=["11:22:33:44:55:66", "AA:BB:CC:DD:EE:FF"],
)
# Mock slot_manager
mock_slot_manager = Mock(spec=BleakSlotManager)
mock_slot_manager.get_allocations.return_value = mock_allocations
with patch.object(manager, "slot_manager", mock_slot_manager):
allocations = scanner.get_allocations()
assert allocations is not None
assert allocations == mock_allocations
mock_slot_manager.get_allocations.assert_called_once_with("hci0")
def test_ha_scanner_get_allocations_updates_dynamically() -> None:
"""Test that HaScanner.get_allocations returns current values as they change."""
from bleak_retry_connector import Allocations
scanner = HaScanner(BluetoothScanningMode.ACTIVE, "hci0", "AA:BB:CC:DD:EE:FF")
manager = get_manager()
# Mock slot_manager
mock_slot_manager = Mock(spec=BleakSlotManager)
# Initial state - 3 free slots
mock_slot_manager.get_allocations.return_value = Allocations(
adapter="hci0", slots=3, free=3, allocated=[]
)
with patch.object(manager, "slot_manager", mock_slot_manager):
# Check initial state
allocations = scanner.get_allocations()
assert allocations is not None
assert allocations.free == 3
assert allocations.allocated == []
# Update mock to simulate connection made
mock_slot_manager.get_allocations.return_value = Allocations(
adapter="hci0", slots=3, free=2, allocated=["11:22:33:44:55:66"]
)
# Check updated state
allocations = scanner.get_allocations()
assert allocations is not None
assert allocations.free == 2
assert allocations.allocated == ["11:22:33:44:55:66"]
# Update mock to simulate another connection
mock_slot_manager.get_allocations.return_value = Allocations(
adapter="hci0",
slots=3,
free=1,
allocated=["11:22:33:44:55:66", "AA:BB:CC:DD:EE:FF"],
)
# Check final state
allocations = scanner.get_allocations()
assert allocations is not None
assert allocations.free == 1
assert len(allocations.allocated) == 2
@pytest.mark.asyncio
async def test_on_scanner_start_callback(
async_mock_manager_with_scanner_callbacks: MockBluetoothManagerWithCallbacks,
) -> None:
"""Test that on_scanner_start is called when a local scanner starts."""
manager = async_mock_manager_with_scanner_callbacks
# Create a local scanner (it will get the manager from get_manager())
scanner = HaScanner(
mode=BluetoothScanningMode.ACTIVE,
adapter="hci0",
address="00:00:00:00:00:00",
)
# Register scanner with manager
manager.async_register_scanner(scanner)
# Setup the scanner
scanner.async_setup()
# Directly call _on_start_success to test the callback
# (In real usage, this is called by HaScanner._async_start_attempt
# after successful start)
scanner._on_start_success()
# Verify the callback was called
assert len(manager.scanner_start_calls) == 1
assert manager.scanner_start_calls[0] is scanner
|