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
|
from __future__ import annotations
import asyncio
import logging
import time
import typing
import pytest
from zigpy import util
from zigpy.exceptions import ControllerException
from zigpy.types.named import KeyData
from .async_mock import AsyncMock, MagicMock, call, patch, sentinel
class Listenable(util.ListenableMixin):
def __init__(self):
self._listeners = {}
def test_listenable():
listen = Listenable()
# Python 3.7 guarantees dict ordering so this will be called first to test error
# handling
broken_listener = MagicMock()
broken_listener.event.side_effect = Exception()
listen.add_listener(broken_listener)
listener = MagicMock(spec_set=["event"])
listen.add_listener(listener)
listen.add_listener(listener)
context_listener = MagicMock(spec_set=["event"])
listen.add_context_listener(context_listener)
listen.listener_event("event", "test1")
listener.event.assert_has_calls([call("test1"), call("test1")], any_order=True)
context_listener.event.assert_has_calls([call(listen, "test1")], any_order=True)
broken_listener.event.assert_has_calls([call("test1")], any_order=True)
assert listener.event.call_count == 2
assert context_listener.event.call_count == 1
assert broken_listener.event.call_count == 1
listen.listener_event("non_existing_event", "test2")
listener.event.assert_has_calls([call("test1"), call("test1")], any_order=True)
context_listener.event.assert_has_calls([call(listen, "test1")], any_order=True)
broken_listener.event.assert_has_calls([call("test1")], any_order=True)
assert listener.event.call_count == 2
assert context_listener.event.call_count == 1
assert broken_listener.event.call_count == 1
listen.remove_listener(object())
listen.remove_listener(listener)
listen.remove_listener(listener)
listen.remove_listener(broken_listener)
listen.remove_listener(context_listener)
listen.listener_event("event", "test1")
assert listener.event.call_count == 2
assert context_listener.event.call_count == 1
assert broken_listener.event.call_count == 1
def test_listenable_mutating():
listen = Listenable()
mutating_listener = MagicMock()
mutating_listener.event.side_effect = lambda value: listen.remove_listener(
mutating_listener
)
listen.add_listener(mutating_listener)
listen.listener_event("event", "value")
assert mutating_listener.event.mock_calls == [call("value")]
assert listen._listeners == {}
class Logger(util.LocalLogMixin):
log = MagicMock()
def test_log():
log = Logger()
log.debug("Test debug")
log.exception("Test exception")
log.info("Test info")
log.warning("Test warn")
log.error("Test error")
def test_log_stacklevel():
class MockHandler(logging.Handler):
emit = MagicMock()
handler = MockHandler()
LOGGER = logging.getLogger("test_log_stacklevel")
LOGGER.setLevel(logging.DEBUG)
LOGGER.addHandler(handler)
class TestClass(util.LocalLogMixin):
def log(self, lvl, msg, *args, **kwargs):
LOGGER.log(lvl, msg, *args, **kwargs)
def test_method(self):
self.info("Test1")
LOGGER.info("Test2")
TestClass().test_method()
assert handler.emit.call_count == 2
indirect_call, direct_call = handler.emit.mock_calls
(indirect,) = indirect_call.args
(direct,) = direct_call.args
assert indirect.message == "Test1"
assert direct.message == "Test2"
assert direct.levelname == indirect.levelname
assert direct.module == indirect.module
assert direct.filename == indirect.filename
assert direct.funcName == indirect.funcName
assert direct.lineno == indirect.lineno + 1
async def _test_retry(exception, retry_exceptions, n):
counter = 0
async def count():
nonlocal counter
counter += 1
if counter <= n:
exc = exception()
exc._counter = counter
raise exc
await util.retry(count, retry_exceptions)
return counter
async def test_retry_no_retries():
counter = await _test_retry(Exception, Exception, 0)
assert counter == 1
async def test_retry_always():
with pytest.raises(ValueError) as exc_info:
await _test_retry(ValueError, (IndexError, ValueError), 999)
assert exc_info.value._counter == 3
async def test_retry_once():
counter = await _test_retry(ValueError, ValueError, 1)
assert counter == 2
async def _test_retryable(exception, retry_exceptions, n, tries=3, delay=0.001):
counter = 0
@util.retryable(retry_exceptions, tries=tries, delay=delay)
async def count(x, y, z):
assert x == y == z == 9
nonlocal counter
counter += 1
if counter <= n:
exc = exception()
exc._counter = counter
raise exc
await count(9, 9, 9)
return counter
async def test_retryable_no_retry():
counter = await _test_retryable(Exception, Exception, 0, 0, 0)
assert counter == 1
async def test_retryable_exception_no_retry():
with pytest.raises(Exception) as exc_info:
await _test_retryable(Exception, Exception, 1, 0, 0)
assert exc_info.value._counter == 1
async def test_retryable_no_retries():
counter = await _test_retryable(Exception, Exception, 0)
assert counter == 1
async def test_retryable_always():
with pytest.raises(ValueError) as exc_info:
await _test_retryable(ValueError, (IndexError, ValueError), 999)
assert exc_info.value._counter == 3
async def test_retryable_once():
counter = await _test_retryable(ValueError, ValueError, 1)
assert counter == 2
def test_zigbee_security_hash():
message = bytes.fromhex("11223344556677884AF7")
key = util.aes_mmo_hash(message)
assert key == KeyData.convert("41618FC0C83B0E14A589954B16E31466")
message = bytes.fromhex("7A939723A5C639B269161802819B")
key = util.aes_mmo_hash(message)
assert key == KeyData.convert("F93903721685FD329D26849B90F2959A")
message = bytes.fromhex("83FED3407A939723A5C639B269161802AEBB")
key = util.aes_mmo_hash(message)
assert key == KeyData.convert("333C23686079468EB27BA24BD9C7E564")
@pytest.mark.parametrize(
("message", "expected_key"),
[
(
bytes.fromhex("11223344556677884AF7"),
KeyData.convert("41618FC0C83B0E14A589954B16E31466"),
),
(
bytes.fromhex("83FED3407A939723A5C639B26916D505C3B5"),
KeyData.convert("66B6900981E1EE3CA4206B6B861C02BB"),
),
],
)
def test_convert_install_code(message, expected_key):
key = util.convert_install_code(message)
assert key == expected_key
def test_fail_convert_install_code():
key = util.convert_install_code(bytes([]))
assert key is None
message = bytes([0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0xFF, 0xFF])
key = util.convert_install_code(message)
assert key is None
async def test_async_listener():
listenable = Listenable()
listener_1 = MagicMock(spec=["async_event"])
listener_1.async_event.side_effect = AsyncMock(return_value=sentinel.result_1)
listener_2 = MagicMock(spec=["async_event"])
listener_2.async_event.side_effect = AsyncMock(return_value=sentinel.result_2)
failed = MagicMock(spec=["async_event"])
failed.async_event = AsyncMock(side_effect=RuntimeError("async listener exception"))
listenable.add_listener(listener_1)
listenable.add_context_listener(listener_2)
listenable.add_listener(failed)
r = await listenable.async_event("async_event", sentinel.data)
assert len(r) == 2
assert sentinel.result_1 in r
assert sentinel.result_2 in r
assert listener_1.async_event.call_count == 1
assert listener_1.async_event.call_args[0][0] is sentinel.data
# context listener
assert listener_2.async_event.call_count == 1
assert listener_2.async_event.call_args[0][0] is listenable
assert listener_2.async_event.call_args[0][1] is sentinel.data
# failed listener
assert failed.async_event.call_count == 1
assert failed.async_event.call_args[0][0] is sentinel.data
r = await listenable.async_event("no_such_event", sentinel.no_data)
assert r == []
def test_requests(monkeypatch):
req_mock = MagicMock()
monkeypatch.setattr(util, "Request", req_mock)
r = util.Requests()
r.new(sentinel.seq)
assert req_mock.call_count == 1
async def test_request():
pending = util.Requests()
seq = 0x11
req = pending.new(seq)
assert seq not in pending
assert req.result.done() is False
with req:
assert seq in pending
assert req.result.done() is False
assert req.sequence is seq
assert req.result.done() is True
assert req.result.cancelled() is True
assert seq not in pending
seq = sentinel.seq
req = pending.new(seq)
assert seq not in pending
assert req.result.done() is False
with req:
assert seq in pending
assert req.result.done() is False
assert req.sequence is seq
req.result.set_result(True)
assert req.result.done() is True
assert req.result.cancelled() is False
assert seq not in pending
async def test_request_duplicate():
pending = util.Requests()
seq = 0x23
with pending.new(seq):
with pytest.raises(ControllerException):
with pending.new(seq):
pass
class _ClusterMock(util.CatchingTaskMixin):
"""Test class."""
def __init__(self, logger):
logger.setLevel(logging.DEBUG)
self._logger = logger
def log(self, lvl, msg, *args, **kwargs):
return self._logger.log(lvl, msg, *args, **kwargs)
async def a(self, exception=None):
self.debug("test a")
return await self._b(exception)
async def _b(self, exception):
self.warning("test b")
if exception is None:
return True
raise exception()
@patch("zigpy.util.CatchingTaskMixin.catching_coro")
async def test_create_catching_task(catching_coro_mock):
"""Test catching task."""
mock_cluster = _ClusterMock(logging.getLogger(__name__))
coro = AsyncMock()
mock_cluster.create_catching_task(coro)
assert catching_coro_mock.call_count == 1
assert catching_coro_mock.call_args[0][0] is coro
async def test_catching_coro(caplog):
"""Test catching_coro no exception."""
caplog.set_level(level=logging.DEBUG)
mock_cluster = _ClusterMock(logging.getLogger(__name__))
await mock_cluster.catching_coro(mock_cluster.a())
records = [r for r in caplog.records if r.name == __name__]
assert records[0].levelno == logging.DEBUG
assert records[0].message == "test a"
assert records[1].levelno == logging.WARNING
assert records[1].message == "test b"
assert len(records) == 2
@pytest.mark.parametrize("exception", [None, asyncio.TimeoutError])
async def test_catching_task_expected_exception(exception, caplog):
"""Test CatchingTaskMixin allowed exceptions."""
mock_cluster = _ClusterMock(logging.getLogger("expected_exceptions"))
await mock_cluster.catching_coro(
mock_cluster.a(asyncio.TimeoutError), exceptions=exception
)
records = [r for r in caplog.records if r.name == "expected_exceptions"]
assert records[0].levelno == logging.DEBUG
assert records[0].message == "test a"
assert records[1].levelno == logging.WARNING
assert records[1].message == "test b"
assert len(records) == 2
@pytest.mark.parametrize(
("to_raise", "exception"),
[(RuntimeError, None), (asyncio.TimeoutError, RuntimeError)],
)
async def test_catching_task_unexpected_exception(to_raise, exception, caplog):
"""Test CatchingTaskMixin unexpected exceptions."""
mock_cluster = _ClusterMock(logging.getLogger("unexpected_exceptions"))
await mock_cluster.catching_coro(mock_cluster.a(to_raise), exceptions=exception)
records = [r for r in caplog.records if r.name == "unexpected_exceptions"]
assert records[0].levelno == logging.DEBUG
assert records[0].message == "test a"
assert records[1].levelno == logging.WARNING
assert records[1].message == "test b"
assert records[2].levelno == logging.ERROR
assert records[2].message.startswith("Traceback (most recent call last)")
assert len(records) == 3
@pytest.mark.parametrize(
"plot",
[
r"""
11 #########
12 #################################################################
13 ##################################################################
14 ################################################################
15 ##############
16 ######################################################
17 #########################
18 ##########
19 ###########
20 ################
21 ###########
22 ###########
23 #
24 ##
[25] #################
26 ##
""",
r"""
11 ##################
12
13
14 ########
15 ##################
16 ########
17
18
19 ########
20 ##################
21 ########
22
23
24 ########
[25] ##################
26
""",
r"""
11 ##################
12 #
13 #
14 ########
15 ##################
16 ########
17
18
19 ########
[20] ##################
21 ########
22
23
24 ########
25 ##################
26 ########
""",
],
)
def test_picking_optimal_channel(plot):
expected_channel = int(plot.split("[")[1].split("]")[0])
plot = plot.replace("[", " ").replace("]", " ")
channel_energy = {
int(line.split()[0]): line.count("#") for line in plot.strip().splitlines()
}
assert util.pick_optimal_channel(channel_energy) == expected_channel
def test_singleton():
singleton = util.Singleton("NAME")
assert str(singleton) == repr(singleton) == "<Singleton 'NAME'>"
assert singleton == singleton # noqa: PLR0124
obj = {}
obj[singleton] = 5
assert obj[singleton] == 5
@pytest.mark.parametrize(
("input_relays", "expected_relays"),
[
([0x0000, 0x0000, 0x0001, 0x0001, 0x0002], [0x0001, 0x0002]),
([0x0001, 0x0002], [0x0001, 0x0002]),
([], []),
([0x0000], []),
],
)
def test_relay_filtering(input_relays: list[int], expected_relays: list[int]):
assert util.filter_relays(input_relays) == expected_relays
async def test_combine_concurrent_calls():
class TestFuncs:
def __init__(self):
self.slow_calls = 0
self.slow_error_calls = 0
async def slow(self, n=None):
await asyncio.sleep(0.1)
self.slow_calls += 1
return (self.slow_calls, n)
async def slow_error(self, n=None):
await asyncio.sleep(0.1)
self.slow_error_calls += 1
raise RuntimeError
combined_slow = util.combine_concurrent_calls(slow)
combined_slow_error = util.combine_concurrent_calls(slow_error)
f = TestFuncs()
assert f.slow_calls == 0
await f.slow()
assert f.slow_calls == 1
await f.combined_slow()
assert f.slow_calls == 2
results = await asyncio.gather(*[f.combined_slow() for _ in range(5)])
assert results == [(3, None)] * 5
assert f.slow_calls == 3
results = await asyncio.gather(*[f.combined_slow() for _ in range(5)])
assert results == [(4, None)] * 5
assert f.slow_calls == 4
# Unique keyword arguments
results = await asyncio.gather(*[f.combined_slow(n=i) for i in range(5)])
assert results == [(5 + i, 0 + i) for i in range(5)]
assert f.slow_calls == 9
# Non-unique keyword arguments
results = await asyncio.gather(*[f.combined_slow(i // 2) for i in range(5)])
assert results == [(10, 0), (10, 0), (11, 1), (11, 1), (12, 2)]
assert f.slow_calls == 12
# Mixed keyword and non-keyword
results = await asyncio.gather(
f.combined_slow(0),
f.combined_slow(n=0),
f.combined_slow(1),
f.combined_slow(n=1),
f.combined_slow(n=1),
)
assert results == [(13, 0), (13, 0), (14, 1), (14, 1), (14, 1)]
assert f.slow_calls == 14
assert f.slow_error_calls == 0
with pytest.raises(RuntimeError):
await f.slow_error()
assert f.slow_error_calls == 1
for coro in asyncio.as_completed([f.combined_slow_error() for _ in range(5)]):
with pytest.raises(RuntimeError):
await coro
assert f.slow_error_calls == 2
@pytest.mark.filterwarnings("ignore::DeprecationWarning")
def test_deprecated():
@util.deprecated("This function is deprecated")
def foo():
return 1
with pytest.deprecated_call():
foo()
class Bar:
pass
obj = util.deprecated_attrs({"foo": Bar})
assert obj("foo") == Bar
with pytest.raises(AttributeError):
obj("baz")
async def test_async_iterate_in_chunks() -> None:
def iterator(n: int) -> typing.Generator[int, None, None]:
for i in range(n):
time.sleep(0.1)
yield i
chunks = [c async for c in util.async_iterate_in_chunks(iterator(10), chunk_size=3)]
assert chunks == [[0, 1, 2], [3, 4, 5], [6, 7, 8], [9]]
|