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
|
"""Common fixtures."""
from __future__ import annotations
import asyncio
from contextlib import contextmanager
import copy
import logging
import threading
import typing
from unittest.mock import Mock, patch
import pytest
import zigpy.application
from zigpy.config import (
CONF_DATABASE,
CONF_DEVICE,
CONF_DEVICE_PATH,
CONF_OTA,
CONF_OTA_ENABLED,
)
import zigpy.state as app_state
import zigpy.types as t
from zigpy.zcl import Cluster, foundation
import zigpy.zdo.types as zdo_t
from .async_mock import AsyncMock, MagicMock
if typing.TYPE_CHECKING:
import zigpy.device
_LOGGER = logging.getLogger(__name__)
NCP_IEEE = t.EUI64.convert("aa:11:22:bb:33:44:be:ef")
class FailOnBadFormattingHandler(logging.Handler):
def emit(self, record):
try:
record.msg % record.args
except Exception as e: # noqa: BLE001
pytest.fail(
f"Failed to format log message {record.msg!r} with {record.args!r}: {e}"
)
@pytest.fixture(autouse=True)
def raise_on_bad_log_formatting():
handler = FailOnBadFormattingHandler()
root = logging.getLogger()
root.addHandler(handler)
root.setLevel(logging.DEBUG)
try:
yield
finally:
root.removeHandler(handler)
class BaseApp(zigpy.application.ControllerApplication):
async def send_packet(self, packet):
async with self._limit_concurrency(priority=packet.priority):
return await self._send_packet(packet)
async def _send_packet(self, packet):
await asyncio.sleep(0)
async def connect(self):
pass
async def disconnect(self):
pass
async def start_network(self):
dev = add_initialized_device(
app=self, nwk=self.state.node_info.nwk, ieee=self.state.node_info.ieee
)
dev.model = "Coordinator Model"
dev.manufacturer = "Coordinator Manufacturer"
dev.zdo.Mgmt_NWK_Update_req = AsyncMock(
return_value=[
zdo_t.Status.SUCCESS,
t.Channels.ALL_CHANNELS,
0,
0,
[80] * 16,
]
)
async def force_remove(self, dev):
pass
async def add_endpoint(self, descriptor):
pass
async def permit_ncp(self, time_s=60):
pass
async def permit_with_link_key(self, node, link_key, time_s=60):
pass
async def reset_network_info(self):
pass
async def write_network_info(self, *, network_info, node_info):
pass
async def load_network_info(self, *, load_devices=False):
self.state.network_info.channel = 15
class FeaturelessApp(BaseApp):
"""Zigpy application implementation that supports no optional features."""
class App(BaseApp):
"""Zigpy application implementation that supports all optional features."""
async def _network_scan(self, channels, duration_exp):
if False:
yield
async def _packet_capture(self, channel):
if False:
yield
async def _packet_capture_change_channel(self, channel):
pass
async def _set_tx_power(self, tx_power: float) -> float:
return round(tx_power)
async def _get_recommended_tx_power(self, country: str) -> float:
if country == "US":
return 8
else:
return 10
async def _get_maximum_tx_power(self, country: str) -> float:
if country == "US":
return 8
else:
return 10
def recursive_dict_merge(
obj: dict[str, typing.Any], updates: dict[str, typing.Any]
) -> dict[str, typing.Any]:
result = copy.deepcopy(obj)
for key, update in updates.items():
if isinstance(update, dict) and key in result:
result[key] = recursive_dict_merge(result[key], update)
else:
result[key] = update
return result
def make_app(
config_updates: dict[str, typing.Any],
app_base: zigpy.application.ControllerApplication = App,
) -> zigpy.application.ControllerApplication:
config = recursive_dict_merge(
{
CONF_DATABASE: None,
CONF_DEVICE: {CONF_DEVICE_PATH: "/dev/null"},
CONF_OTA: {
CONF_OTA_ENABLED: False,
},
},
config_updates,
)
app = app_base(config)
app.state.node_info = app_state.NodeInfo(
nwk=t.NWK(0x0000), ieee=NCP_IEEE, logical_type=zdo_t.LogicalType.Coordinator
)
app.device_initialized = Mock(wraps=app.device_initialized)
app.listener_event = Mock(wraps=app.listener_event)
app.get_sequence = MagicMock(wraps=app.get_sequence, return_value=123)
app.send_packet = AsyncMock(wraps=app.send_packet)
app.write_network_info = AsyncMock(wraps=app.write_network_info)
return app
@pytest.fixture
def app():
"""ControllerApplication Mock."""
return make_app({})
@pytest.fixture
def app_mock():
"""ControllerApplication Mock."""
return make_app({})
def make_ieee(start=0):
return t.EUI64(map(t.uint8_t, range(start, start + 8)))
def make_node_desc(
*, logical_type: zdo_t.LogicalType = zdo_t.LogicalType.Router
) -> zdo_t.NodeDescriptor:
return zdo_t.NodeDescriptor(
logical_type=logical_type,
complex_descriptor_available=0,
user_descriptor_available=0,
reserved=0,
aps_flags=0,
frequency_band=zdo_t.NodeDescriptor.FrequencyBand.Freq2400MHz,
mac_capability_flags=zdo_t.NodeDescriptor.MACCapabilityFlags.AllocateAddress,
manufacturer_code=4174,
maximum_buffer_size=82,
maximum_incoming_transfer_size=82,
server_mask=0,
maximum_outgoing_transfer_size=82,
descriptor_capability_field=zdo_t.NodeDescriptor.DescriptorCapability.NONE,
)
def add_initialized_device(app, nwk, ieee):
dev = app.add_device(nwk=nwk, ieee=ieee)
dev.node_desc = make_node_desc(logical_type=zdo_t.LogicalType.Router)
ep = dev.add_endpoint(1)
ep.status = zigpy.endpoint.Status.ZDO_INIT
ep.profile_id = 260
ep.device_type = zigpy.profiles.zha.DeviceType.PUMP
return dev
@pytest.fixture
def make_initialized_device():
count = 1
def inner(app):
nonlocal count
dev = add_initialized_device(app, nwk=0x1000 + count, ieee=make_ieee(count))
count += 1
return dev
return inner
def make_neighbor(
*,
ieee: t.EUI64,
nwk: t.NWK,
device_type: zdo_t.Neighbor.DeviceType = zdo_t.Neighbor.DeviceType.Router,
rx_on_when_idle=True,
relationship: zdo_t.Neighbor.Relationship = zdo_t.Neighbor.Relationship.Child,
) -> zdo_t.Neighbor:
return zdo_t.Neighbor(
extended_pan_id=make_ieee(start=0),
ieee=ieee,
nwk=nwk,
device_type=device_type,
rx_on_when_idle=int(rx_on_when_idle),
relationship=relationship,
reserved1=0,
permit_joining=0,
reserved2=0,
depth=15,
lqi=250,
)
def make_neighbor_from_device(
device: zigpy.device.Device,
*,
relationship: zdo_t.Neighbor.Relationship = zdo_t.Neighbor.Relationship.Child,
):
assert device.node_desc is not None
return make_neighbor(
ieee=device.ieee,
nwk=device.nwk,
device_type=zdo_t.Neighbor.DeviceType(int(device.node_desc.logical_type)),
rx_on_when_idle=device.node_desc.is_receiver_on_when_idle,
relationship=relationship,
)
def make_route(
*,
dest_nwk: t.NWK,
next_hop: t.NWK,
status: zdo_t.RouteStatus = zdo_t.RouteStatus.Active,
) -> zdo_t.Route:
return zdo_t.Route(
DstNWK=dest_nwk,
RouteStatus=status,
MemoryConstrained=0,
ManyToOne=0,
RouteRecordRequired=0,
Reserved=0,
NextHop=next_hop,
)
@pytest.fixture(scope="function")
def event_loop() -> typing.Generator[asyncio.AbstractEventLoop, None, None]:
"""Create an instance of the default event loop for each test case."""
loop = asyncio.new_event_loop()
yield loop
loop.close()
# Taken from Home Assistant's `conftest.py`
@pytest.fixture(autouse=True)
def verify_cleanup(
event_loop: asyncio.AbstractEventLoop,
) -> typing.Generator[None, None, None]:
"""Verify that the test has cleaned up resources correctly."""
threads_before = frozenset(threading.enumerate())
tasks_before = asyncio.all_tasks(event_loop)
yield
event_loop.run_until_complete(event_loop.shutdown_default_executor())
# Warn and clean-up lingering tasks and timers
# before moving on to the next test.
tasks = asyncio.all_tasks(event_loop) - tasks_before
for task in tasks:
_LOGGER.warning("Linger task after test %r", task)
task.cancel()
if tasks:
event_loop.run_until_complete(asyncio.wait(tasks))
for handle in event_loop._scheduled: # type: ignore[attr-defined]
if not handle.cancelled():
_LOGGER.warning("Lingering timer after test %r", handle)
handle.cancel()
# Verify no threads where left behind.
threads = frozenset(threading.enumerate()) - threads_before
for thread in threads:
assert isinstance(thread, threading._DummyThread)
@contextmanager
def mock_attribute_reads(
cluster: Cluster, mock_attributes: dict[str | int, typing.Any]
) -> typing.Generator[tuple[AsyncMock, dict[str | int, AsyncMock]], None, None]:
"""Mock attribute reads on a cluster."""
mock_reads = {}
for key, value in mock_attributes.items():
if not callable(value):
value = Mock(return_value=value)
mock_reads[cluster.find_attribute(key)] = value
async def read_attributes_raw(attributes, *args, **kwargs):
records = []
for attrid in attributes:
record = foundation.ReadAttributeRecord(attrid=attrid)
attr_def = cluster.find_attribute(attrid)
if attr_def in mock_reads:
record.status = foundation.Status.SUCCESS
record.value = foundation.TypeValue(
type=attr_def.zcl_type, value=mock_reads[attr_def]()
)
else:
record.status = foundation.Status.UNSUPPORTED_ATTRIBUTE
records.append(record)
return [records]
with patch.object(
cluster, "read_attributes_raw", autospec=True, side_effect=read_attributes_raw
) as mock_read:
yield mock_read, mock_attributes
|