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
|
"""Test `load_network_info` and `write_network_info` methods."""
import importlib.metadata
from unittest.mock import ANY, call
import pytest
from zigpy.exceptions import CannotWriteNetworkSettings, NetworkNotFormed
import zigpy.state as app_state
import zigpy.types as t
import zigpy.zdo.types as zdo_t
import zigpy_deconz
import zigpy_deconz.api
import zigpy_deconz.exception
import zigpy_deconz.types
import zigpy_deconz.zigbee.application as application
from tests.async_mock import AsyncMock, patch
from tests.test_application import api, app, device_path # noqa: F401
def merge_objects(obj: object, update: dict) -> None:
for key, value in update.items():
if "." not in key:
setattr(obj, key, value)
else:
subkey, rest = key.split(".", 1)
merge_objects(getattr(obj, subkey), {rest: value})
@pytest.fixture
def node_info():
return app_state.NodeInfo(
nwk=t.NWK(0x0000),
ieee=t.EUI64.convert("93:2C:A9:34:D9:D0:5D:12"),
logical_type=zdo_t.LogicalType.Coordinator,
manufacturer="dresden elektronik",
model="Conbee II",
version="0x26580700",
)
@pytest.fixture
def network_info(node_info):
return app_state.NetworkInfo(
extended_pan_id=t.ExtendedPanId.convert("0D:49:91:99:AE:CD:3C:35"),
pan_id=t.PanId(0x9BB0),
nwk_update_id=0x12,
nwk_manager_id=t.NWK(0x0000),
channel=t.uint8_t(15),
channel_mask=t.Channels.from_channel_list([15, 20, 25]),
security_level=t.uint8_t(5),
network_key=app_state.Key(
key=t.KeyData.convert("9A:79:D6:9A:DA:EC:45:C6:F2:EF:EB:AF:DA:A3:07:B6"),
seq=108,
tx_counter=39009277,
),
tc_link_key=app_state.Key(
key=t.KeyData(b"ZigBeeAlliance09"),
partner_ieee=node_info.ieee,
tx_counter=8712428,
),
key_table=[],
children=[],
nwk_addresses={},
stack_specific={},
source=f"zigpy-deconz@{importlib.metadata.version('zigpy-deconz')}",
metadata={"deconz": {"version": "0x26580700"}},
)
@patch.object(application, "CHANGE_NETWORK_POLL_TIME", 0.001)
@patch.object(application, "CHANGE_NETWORK_STATE_DELAY", 0.001)
@pytest.mark.parametrize(
(
"channel_mask",
"channel",
"security_level",
"fw_supports_fc",
"logical_type",
"tx_counter",
"should_error",
),
[
# FW supports frame counter
(
t.Channels.from_channel_list([15]),
15,
0,
True,
zdo_t.LogicalType.Coordinator,
39009277,
False,
),
# FW doesn't support but we're writing blank settings (tx_counter == 0)
(
t.Channels.from_channel_list([15]),
15,
5,
False,
zdo_t.LogicalType.Coordinator,
0,
False,
),
# FW doesn't support and we're writing real settings (should error)
(
t.Channels.from_channel_list([15]),
15,
0,
False,
zdo_t.LogicalType.Coordinator,
39009277,
True,
),
# Additional test cases with FW support
(
t.Channels.from_channel_list([15, 20]),
15,
5,
True,
zdo_t.LogicalType.Coordinator,
39009277,
False,
),
(
t.Channels.from_channel_list([15, 20, 25]),
None,
5,
True,
zdo_t.LogicalType.Router,
39009277,
False,
),
(
None,
15,
5,
True,
zdo_t.LogicalType.Coordinator,
39009277,
False,
),
],
)
async def test_write_network_info(
app, # noqa: F811
network_info,
node_info,
channel_mask,
channel,
security_level,
fw_supports_fc,
logical_type,
tx_counter,
should_error,
):
"""Test that network info is correctly written."""
params = {}
async def write_parameter(param, *args):
if (
not fw_supports_fc
and param == zigpy_deconz.api.NetworkParameter.nwk_frame_counter
):
raise zigpy_deconz.exception.CommandError(
"Command is unsupported",
status=zigpy_deconz.api.Status.UNSUPPORTED,
command=None,
)
params[param.name] = args
app._change_network_state = AsyncMock()
app._api.write_parameter = AsyncMock(side_effect=write_parameter)
network_info = network_info.replace(
channel=channel,
channel_mask=channel_mask,
security_level=security_level,
network_key=network_info.network_key.replace(tx_counter=tx_counter),
)
node_info = node_info.replace(logical_type=logical_type)
if should_error:
with pytest.raises(
CannotWriteNetworkSettings,
match=(
"Please upgrade your adapter firmware. Firmware version 0x26580700 does"
" not support writing the network key frame counter, which is required"
" for migration to succeed."
),
):
await app.write_network_info(
network_info=network_info,
node_info=node_info,
)
return
await app.write_network_info(
network_info=network_info,
node_info=node_info,
)
params = {
call[0][0].name: call[0][1:]
for call in app._api.write_parameter.await_args_list
}
# Only check frame counter if firmware supports it
if fw_supports_fc:
assert params["nwk_frame_counter"] == (network_info.network_key.tx_counter,)
if node_info.logical_type == zdo_t.LogicalType.Coordinator:
assert params["aps_designed_coordinator"] == (1,)
else:
assert params["aps_designed_coordinator"] == (0,)
assert params["nwk_address"] == (node_info.nwk,)
assert params["mac_address"] == (node_info.ieee,)
if channel is not None:
assert params["channel_mask"] == (
t.Channels.from_channel_list([network_info.channel]),
)
elif channel_mask is not None:
assert params["channel_mask"] == (network_info.channel_mask,)
else:
assert False
assert params["use_predefined_nwk_panid"] == (True,)
assert params["nwk_panid"] == (network_info.pan_id,)
assert params["aps_extended_panid"] == (network_info.extended_pan_id,)
assert params["nwk_update_id"] == (network_info.nwk_update_id,)
assert params["network_key"] == (
zigpy_deconz.api.IndexedKey(index=0, key=network_info.network_key.key),
)
assert params["trust_center_address"] == (node_info.ieee,)
assert params["link_key"] == (
zigpy_deconz.api.LinkKey(ieee=node_info.ieee, key=network_info.tc_link_key.key),
)
if security_level == 0:
assert params["security_mode"] == (zigpy_deconz.api.SecurityMode.NO_SECURITY,)
else:
assert params["security_mode"] == (zigpy_deconz.api.SecurityMode.ONLY_TCLK,)
@patch.object(application, "CHANGE_NETWORK_POLL_TIME", 0.001)
@patch.object(application, "CHANGE_NETWORK_STATE_DELAY", 0.001)
@pytest.mark.parametrize(
"error, param_overrides, nwk_state_changes, node_state_changes",
[
(None, {}, {}, {}),
(
None,
{("aps_designed_coordinator",): 0x00},
{},
{"logical_type": zdo_t.LogicalType.Router},
),
(
None,
{
("aps_extended_panid",): t.EUI64.convert("00:00:00:00:00:00:00:00"),
("nwk_extended_panid",): t.EUI64.convert("0D:49:91:99:AE:CD:3C:35"),
},
{},
{},
),
(NetworkNotFormed, {("current_channel",): 0}, {}, {}),
(
None,
{
("nwk_frame_counter",): zigpy_deconz.exception.CommandError(
"Some error",
status=zigpy_deconz.api.Status.UNSUPPORTED,
command=None,
)
},
{"network_key.tx_counter": 1073741824},
{},
),
(
None,
{("security_mode",): zigpy_deconz.api.SecurityMode.NO_SECURITY},
{"security_level": 0},
{},
),
(
None,
{
(
"security_mode",
): zigpy_deconz.api.SecurityMode.PRECONFIGURED_NETWORK_KEY
},
{"security_level": 5},
{},
),
],
)
async def test_load_network_info(
app, # noqa: F811
network_info,
node_info,
error,
param_overrides,
nwk_state_changes,
node_state_changes,
):
"""Test that network info is correctly read."""
params = {
("nwk_frame_counter",): network_info.network_key.tx_counter,
("aps_designed_coordinator",): 1,
("nwk_address",): node_info.nwk,
("mac_address",): node_info.ieee,
("current_channel",): network_info.channel,
("channel_mask",): t.Channels.from_channel_list([network_info.channel]),
("use_predefined_nwk_panid",): True,
("nwk_panid",): network_info.pan_id,
("aps_extended_panid",): network_info.extended_pan_id,
("nwk_update_id",): network_info.nwk_update_id,
("network_key", 0): zigpy_deconz.api.IndexedKey(
index=0, key=network_info.network_key.key
),
("trust_center_address",): node_info.ieee,
("link_key", node_info.ieee): zigpy_deconz.api.LinkKey(
ieee=node_info.ieee, key=network_info.tc_link_key.key
),
("security_mode",): zigpy_deconz.api.SecurityMode.ONLY_TCLK,
("protocol_version",): 0x010E,
}
params.update(param_overrides)
async def read_param(param, *args):
try:
value = params[(param.name,) + args]
except KeyError:
raise zigpy_deconz.exception.CommandError(
zigpy_deconz.api.Status.UNSUPPORTED, f"Unsupported: {param!r} {args!r}"
)
if isinstance(value, Exception):
raise value
return value
app._api.firmware_version = zigpy_deconz.api.FirmwareVersion(0x26580700)
app._api.read_parameter = AsyncMock(side_effect=read_param)
if error is not None:
with pytest.raises(error):
await app.load_network_info()
return
assert app.state.network_info != network_info
assert app.state.node_info != node_info
await app.load_network_info()
# Almost all of the info matches
network_info = network_info.replace(
channel_mask=t.Channels.from_channel_list([network_info.channel]),
network_key=network_info.network_key.replace(seq=0),
tc_link_key=network_info.tc_link_key.replace(tx_counter=0),
)
merge_objects(network_info, nwk_state_changes)
assert app.state.network_info == network_info
assert app.state.node_info == node_info.replace(**node_state_changes)
@patch.object(application, "CHANGE_NETWORK_POLL_TIME", 0.001)
@patch.object(application, "CHANGE_NETWORK_STATE_DELAY", 0.001)
async def test_form_network_fast_without_frame_counter_support(app): # noqa: F811
"""Test that form_network(fast=True) works when FW doesn't support frame counter."""
async def write_parameter(param, *args):
if param == zigpy_deconz.api.NetworkParameter.nwk_frame_counter:
raise zigpy_deconz.exception.CommandError(
"Command is unsupported",
status=zigpy_deconz.api.Status.UNSUPPORTED,
command=None,
)
app._change_network_state = AsyncMock()
app._api.write_parameter = AsyncMock(side_effect=write_parameter)
app.backups = AsyncMock()
app.backups.restore_backup = AsyncMock()
# This should not raise an error because fast=True sets form_quickly
await app.form_network(fast=True)
# Verify that restore_backup was called with create_new=False (due to fast=True)
assert app.backups.restore_backup.mock_calls == [
call(backup=ANY, counter_increment=0, allow_incomplete=True, create_new=False)
]
@patch.object(application, "CHANGE_NETWORK_POLL_TIME", 0.001)
@patch.object(application, "CHANGE_NETWORK_STATE_DELAY", 0.001)
async def test_reset_network_info_without_frame_counter_support(app): # noqa: F811
"""Test that reset_network_info works even when FW doesn't support frame counter."""
async def write_parameter(param, *args):
if param == zigpy_deconz.api.NetworkParameter.nwk_frame_counter:
raise zigpy_deconz.exception.CommandError(
"Command is unsupported",
status=zigpy_deconz.api.Status.UNSUPPORTED,
command=None,
)
app._change_network_state = AsyncMock()
app._api.write_parameter = AsyncMock(side_effect=write_parameter)
app._api.read_parameter = AsyncMock(
return_value=t.EUI64.convert("00:11:22:33:44:55:66:77")
)
# Should not raise an error despite frame counter not being supported
await app.reset_network_info()
# Verify that write_parameter was called (including the frame counter attempt)
assert any(
mock_call.args[0] == zigpy_deconz.api.NetworkParameter.nwk_frame_counter
for mock_call in app._api.write_parameter.mock_calls
)
# Verify network state changes were awaited
assert app._change_network_state.mock_calls == [
call(zigpy_deconz.api.NetworkState.OFFLINE)
]
|