Implement provisional zigpy network management API

Author: puddly

tests/application/test_connect.py

@@ -4,7 +4,6 @@
 
 import zigpy_znp.config as conf
 from zigpy_znp.uart import connect as uart_connect
-from zigpy_znp.zigbee.application import ControllerApplication
 
 from ..conftest import FORMED_DEVICES, FormedLaunchpadCC26X2R1, swap_attribute
 
@@ -50,60 +49,9 @@ def count_connected():
     assert count_connected() == 0
 
 
-async def test_probe_unsuccessful():
-    assert not (
-        await ControllerApplication.probe(
-            conf.SCHEMA_DEVICE({conf.CONF_DEVICE_PATH: "/dev/null"})
-        )
-    )
-
-
-@pytest.mark.parametrize("device", FORMED_DEVICES)
-async def test_probe_unsuccessful_slow(device, make_znp_server, mocker):
-    znp_server = make_znp_server(server_cls=device)
-
-    # Don't respond to anything
-    znp_server._listeners.clear()
-
-    mocker.patch("zigpy_znp.zigbee.application.PROBE_TIMEOUT", new=0.1)
-
-    assert not (
-        await ControllerApplication.probe(
-            conf.SCHEMA_DEVICE({conf.CONF_DEVICE_PATH: znp_server.serial_port})
-        )
-    )
-
-    assert not any([t._is_connected for t in znp_server._transports])
-
-
-@pytest.mark.parametrize("device", FORMED_DEVICES)
-async def test_probe_successful(device, make_znp_server):
-    znp_server = make_znp_server(server_cls=device)
-
-    assert await ControllerApplication.probe(
-        conf.SCHEMA_DEVICE({conf.CONF_DEVICE_PATH: znp_server.serial_port})
-    )
-    assert not any([t._is_connected for t in znp_server._transports])
-
-
-@pytest.mark.parametrize("device", FORMED_DEVICES)
-async def test_probe_multiple(device, make_znp_server):
-    # Make sure that our listeners don't get cleaned up after each probe
-    znp_server = make_znp_server(server_cls=device)
-    znp_server.close = lambda: None
-
-    config = conf.SCHEMA_DEVICE({conf.CONF_DEVICE_PATH: znp_server.serial_port})
-
-    assert await ControllerApplication.probe(config)
-    assert await ControllerApplication.probe(config)
-    assert await ControllerApplication.probe(config)
-    assert await ControllerApplication.probe(config)
-    assert not any([t._is_connected for t in znp_server._transports])
-
-
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_reconnect(device, event_loop, make_application):
-    app, znp_server = make_application(
+    app, znp_server = await make_application(
         server_cls=device,
         client_config={
             # Make auto-reconnection happen really fast
@@ -144,7 +92,7 @@ async def test_reconnect(device, event_loop, make_application):
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_shutdown_from_app(device, mocker, make_application):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
 
     await app.startup(auto_form=False)
 
@@ -160,7 +108,7 @@ async def test_shutdown_from_app(device, mocker, make_application):
 
 
 async def test_clean_shutdown(make_application):
-    app, znp_server = make_application(server_cls=FormedLaunchpadCC26X2R1)
+    app, znp_server = await make_application(server_cls=FormedLaunchpadCC26X2R1)
     await app.startup(auto_form=False)
 
     # This should not throw
@@ -171,7 +119,7 @@ async def test_clean_shutdown(make_application):
 
 
 async def test_multiple_shutdown(make_application):
-    app, znp_server = make_application(server_cls=FormedLaunchpadCC26X2R1)
+    app, znp_server = await make_application(server_cls=FormedLaunchpadCC26X2R1)
     await app.startup(auto_form=False)
 
     await app.shutdown()
@@ -183,7 +131,7 @@ async def test_multiple_shutdown(make_application):
 async def test_reconnect_lockup(device, event_loop, make_application, mocker):
     mocker.patch("zigpy_znp.zigbee.application.WATCHDOG_PERIOD", 0.1)
 
-    app, znp_server = make_application(
+    app, znp_server = await make_application(
         server_cls=device,
         client_config={
             # Make auto-reconnection happen really fast
@@ -224,7 +172,7 @@ async def test_reconnect_lockup(device, event_loop, make_application, mocker):
 async def test_reconnect_lockup_pyserial(device, event_loop, make_application, mocker):
     mocker.patch("zigpy_znp.zigbee.application.WATCHDOG_PERIOD", 0.1)
 
-    app, znp_server = make_application(
+    app, znp_server = await make_application(
         server_cls=device,
         client_config={
             conf.CONF_ZNP_CONFIG: {
@@ -245,9 +193,9 @@ async def test_reconnect_lockup_pyserial(device, event_loop, make_application, m
 
     did_load_info = asyncio.get_running_loop().create_future()
 
-    async def patched_load_network_info(*, old_load=app.load_network_info):
+    async def patched_load_network_info(old_load=app.load_network_info, **kwargs):
         try:
-            return await old_load()
+            return await old_load(**kwargs)
         finally:
             did_load_info.set_result(True)
 

tests/application/test_joining.py

@@ -27,7 +27,7 @@ async def test_permit_join(device, fixed_joining_bug, mocker, make_application):
     if fixed_joining_bug:
         mocker.patch.object(device, "code_revision", 20210708)
 
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
 
     # Handle us opening joins on the coordinator
     permit_join_coordinator = znp_server.reply_once_to(
@@ -68,7 +68,7 @@ async def test_permit_join(device, fixed_joining_bug, mocker, make_application):
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_join_coordinator(device, make_application):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
 
     # Handle us opening joins on the coordinator
     permit_join_coordinator = znp_server.reply_once_to(
@@ -82,7 +82,7 @@ async def test_join_coordinator(device, make_application):
     )
 
     await app.startup(auto_form=False)
-    await app.permit(node=app.ieee)
+    await app.permit(node=app.state.node_info.ieee)
 
     await permit_join_coordinator
 
@@ -92,7 +92,7 @@ async def test_join_coordinator(device, make_application):
 @pytest.mark.parametrize("device", FORMED_ZSTACK3_DEVICES)
 @pytest.mark.parametrize("permit_result", [None, asyncio.TimeoutError()])
 async def test_permit_join_with_key(device, permit_result, make_application, mocker):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
 
     # Consciot bulb
     ieee = t.EUI64.convert("EC:1B:BD:FF:FE:54:4F:40")
@@ -114,10 +114,6 @@ async def test_permit_join_with_key(device, permit_result, make_application, moc
         ],
     )
 
-    mocker.patch.object(
-        app, "permit", new=CoroutineMock(side_effect=[None, permit_result])
-    )
-
     join_disable_install_code = znp_server.reply_once_to(
         c.AppConfig.BDBSetJoinUsesInstallCodeKey.Req(BdbJoinUsesInstallCodeKey=False),
         responses=[
@@ -127,14 +123,16 @@ async def test_permit_join_with_key(device, permit_result, make_application, moc
 
     await app.startup(auto_form=False)
 
+    mocker.patch.object(app, "permit", new=CoroutineMock(side_effect=permit_result))
+
     with contextlib.nullcontext() if permit_result is None else pytest.raises(
         asyncio.TimeoutError
     ):
         await app.permit_with_key(node=ieee, code=code, time_s=1)
 
     await bdb_add_install_code
     await join_enable_install_code
-    assert app.permit.call_count == 2
+    assert app.permit.call_count == 1
 
     # The install code policy is reset right after
     await join_disable_install_code
@@ -144,7 +142,7 @@ async def test_permit_join_with_key(device, permit_result, make_application, moc
 
 @pytest.mark.parametrize("device", FORMED_ZSTACK3_DEVICES)
 async def test_permit_join_with_invalid_key(device, make_application):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
 
     # Consciot bulb
     ieee = t.EUI64.convert("EC:1B:BD:FF:FE:54:4F:40")
@@ -158,7 +156,7 @@ async def test_permit_join_with_invalid_key(device, make_application):
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_on_zdo_device_join(device, make_application, mocker):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
     await app.startup(auto_form=False)
 
     mocker.patch.object(app, "handle_join")
@@ -178,7 +176,7 @@ async def test_on_zdo_device_join(device, make_application, mocker):
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_on_zdo_device_join_and_announce_fast(device, make_application, mocker):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
     await app.startup(auto_form=False)
 
     mocker.patch.object(app, "handle_join")
@@ -215,7 +213,7 @@ async def test_on_zdo_device_join_and_announce_fast(device, make_application, mo
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_on_zdo_device_join_and_announce_slow(device, make_application, mocker):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
     await app.startup(auto_form=False)
 
     mocker.patch.object(app, "handle_join")
@@ -253,7 +251,7 @@ async def test_on_zdo_device_join_and_announce_slow(device, make_application, mo
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_new_device_join_and_bind_complex(device, make_application, mocker):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
     await app.startup(auto_form=False)
 
     nwk = 0x6A7C
@@ -504,7 +502,7 @@ def bind_req_callback(request):
         ep = device.endpoints[request.SrcEndpoint]
         assert cluster in ep.in_clusters or cluster in ep.out_clusters
 
-        assert request.Address.ieee == app.ieee
+        assert request.Address.ieee == app.state.node_info.ieee
         assert request.Address.addrmode == 0x03
 
         # Make sure the endpoint profiles match up
@@ -530,7 +528,7 @@ def bind_req_callback(request):
 
 @pytest.mark.parametrize("device", FORMED_DEVICES)
 async def test_unknown_device_discovery(device, make_application, mocker):
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
     await app.startup(auto_form=False)
 
     mocker.spy(app, "handle_join")
@@ -604,4 +602,4 @@ async def test_unknown_device_discovery(device, make_application, mocker):
     assert new_dev.nwk == new_nwk
     assert new_dev.ieee == new_ieee
 
-    await app.pre_shutdown()
+    await app.shutdown()

tests/application/test_nvram_migration.py

@@ -62,7 +62,7 @@ async def test_addrmgr_rewrite_fix(device, make_application, mocker):
         extAddr=t.EUI64.convert("FF:FF:FF:FF:FF:FF:FF:FF"),
     )
 
-    app, znp_server = make_application(server_cls=device)
+    app, znp_server = await make_application(server_cls=device)
     znp_server.callback_for_response(
         c.SYS.OSALNVReadExt.Req(Id=OsalNvIds.ADDRMGR, Offset=0), addrmgr_reads.append
     )
@@ -96,6 +96,7 @@ async def test_addrmgr_rewrite_fix(device, make_application, mocker):
 
     # Will not be read again
     assert len(addrmgr_reads) == 2
+    await app.connect()
     await app.startup()
     await app.shutdown()
     assert len(addrmgr_reads) == 2
@@ -106,6 +107,7 @@ async def test_addrmgr_rewrite_fix(device, make_application, mocker):
     old_addrmgr2 = nvram[OsalNvIds.ADDRMGR]
 
     assert len(addrmgr_reads) == 2
+    await app.connect()
     await app.startup()
     await app.shutdown()
     assert len(addrmgr_reads) == 3