consistent interfaces

Author: dmulcahey

tests/conftest.py

@@ -24,17 +24,21 @@
 import zigpy.zdo.types as zdo_t
 
 from zha.application import Platform
-from zha.application.gateway import Gateway, WebSocketServerGateway
+from zha.application.gateway import (
+    Gateway,
+    WebSocketClientGateway,
+    WebSocketServerGateway,
+)
 from zha.application.helpers import (
     AlarmControlPanelOptions,
     CoordinatorConfiguration,
     LightOptions,
-    ServerConfiguration,
+    WebsocketClientConfiguration,
+    WebsocketServerConfiguration,
     ZHAConfiguration,
     ZHAData,
 )
 from zha.async_ import ZHAJob
-from zha.websocket.client.controller import Controller
 
 FIXTURE_GRP_ID = 0x1001
 FIXTURE_GRP_NAME = "fixture group"
@@ -287,11 +291,14 @@ def zha_data_fixture() -> ZHAData:
                 failed_tries=2,
             ),
         ),
-        server_config=ServerConfiguration(
+        ws_server_config=WebsocketServerConfiguration(
             host="localhost",
             port=port,
             network_auto_start=False,
         ),
+        ws_client_config=WebsocketClientConfiguration(
+            host="localhost", port=port, aiohttp_session=None
+        ),
     )
 
 
@@ -326,7 +333,7 @@ async def connected_client_and_server(
     zha_data: ZHAData,
     zigpy_app_controller: ControllerApplication,
     caplog: pytest.LogCaptureFixture,  # pylint: disable=unused-argument
-) -> AsyncGenerator[tuple[Controller, WebSocketServerGateway], None]:
+) -> AsyncGenerator[tuple[WebSocketClientGateway, WebSocketServerGateway], None]:
     """Return the connected client and server fixture."""
 
     with (
@@ -345,7 +352,7 @@ async def connected_client_and_server(
         await ws_gateway.async_initialize_devices_and_entities()
         async with (
             ws_gateway as gateway,
-            Controller(f"ws://localhost:{zha_data.server_config.port}") as controller,
+            WebSocketClientGateway(zha_data) as controller,
         ):
             await controller.clients.listen()
             yield controller, gateway

tests/websocket/test_alarm_control_panel.py

@@ -9,10 +9,9 @@
 import zigpy.zcl.foundation as zcl_f
 
 from zha.application import Platform
-from zha.application.gateway import WebSocketServerGateway as Server
+from zha.application.gateway import WebSocketClientGateway, WebSocketServerGateway
 from zha.application.platforms.model import AlarmControlPanelEntity
-from zha.websocket.client.controller import Controller
-from zha.websocket.client.proxy import DeviceProxy
+from zha.zigbee.device import WebSocketClientDevice
 
 from ..common import (
     SIG_EP_INPUT,
@@ -31,7 +30,7 @@
     new=AsyncMock(return_value=[sentinel.data, zcl_f.Status.SUCCESS]),
 )
 async def test_alarm_control_panel(
-    connected_client_and_server: tuple[Controller, Server],
+    connected_client_and_server: tuple[WebSocketClientGateway, WebSocketServerGateway],
 ) -> None:
     """Test zhaws alarm control panel platform."""
     controller, server = connected_client_and_server
@@ -51,9 +50,11 @@ async def test_alarm_control_panel(
     zhaws_device = await join_zigpy_device(server, zigpy_device)
 
     cluster: security.IasAce = zigpy_device.endpoints.get(1).ias_ace
-    client_device: Optional[DeviceProxy] = controller.devices.get(zhaws_device.ieee)
+    client_device: Optional[WebSocketClientDevice] = controller.devices.get(
+        zhaws_device.ieee
+    )
     assert client_device is not None
-    alarm_entity: AlarmControlPanelEntity = client_device.device_model.entities.get(
+    alarm_entity: AlarmControlPanelEntity = client_device.platform_entities.get(
         (Platform.ALARM_CONTROL_PANEL, "00:0d:6f:00:0a:90:69:e7-1")
     )
     assert alarm_entity is not None
@@ -223,8 +224,8 @@ async def test_alarm_control_panel(
 
 
 async def reset_alarm_panel(
-    server: Server,
-    controller: Controller,
+    server: WebSocketServerGateway,
+    controller: WebSocketClientGateway,
     cluster: security.IasAce,
     entity: AlarmControlPanelEntity,
 ) -> None:

tests/websocket/test_binary_sensor.py

@@ -8,10 +8,9 @@
 from zigpy.zcl.clusters import general, measurement, security
 
 from zha.application.discovery import Platform
-from zha.application.gateway import WebSocketServerGateway as Server
+from zha.application.gateway import WebSocketClientGateway, WebSocketServerGateway
 from zha.application.platforms.model import BasePlatformEntity, BinarySensorEntity
-from zha.websocket.client.controller import Controller
-from zha.websocket.client.proxy import DeviceProxy
+from zha.zigbee.device import WebSocketClientDevice
 
 from ..common import (
     SIG_EP_INPUT,
@@ -26,10 +25,10 @@
 
 
 def find_entity(
-    device_proxy: DeviceProxy, platform: Platform
+    device_proxy: WebSocketClientDevice, platform: Platform
 ) -> Optional[BasePlatformEntity]:
     """Find an entity for the specified platform on the given device."""
-    for entity in device_proxy.device_model.entities.values():
+    for entity in device_proxy.platform_entities.values():
         if entity.platform == platform:
             return entity
     return None
@@ -56,7 +55,7 @@ def find_entity(
 
 
 async def async_test_binary_sensor_on_off(
-    server: Server, cluster: general.OnOff, entity: BinarySensorEntity
+    server: WebSocketServerGateway, cluster: general.OnOff, entity: BinarySensorEntity
 ) -> None:
     """Test getting on and off messages for binary sensors."""
     # binary sensor on
@@ -69,7 +68,9 @@ async def async_test_binary_sensor_on_off(
 
 
 async def async_test_iaszone_on_off(
-    server: Server, cluster: security.IasZone, entity: BinarySensorEntity
+    server: WebSocketServerGateway,
+    cluster: security.IasZone,
+    entity: BinarySensorEntity,
 ) -> None:
     """Test getting on and off messages for iaszone binary sensors."""
     # binary sensor on
@@ -91,7 +92,7 @@ async def async_test_iaszone_on_off(
     ],
 )
 async def test_binary_sensor(
-    connected_client_and_server: tuple[Controller, Server],
+    connected_client_and_server: tuple[WebSocketClientGateway, WebSocketServerGateway],
     device: dict,
     on_off_test: Callable[..., Awaitable[None]],
     cluster_name: str,
@@ -104,7 +105,9 @@ async def test_binary_sensor(
 
     await server.async_block_till_done()
 
-    client_device: Optional[DeviceProxy] = controller.devices.get(zhaws_device.ieee)
+    client_device: Optional[WebSocketClientDevice] = controller.devices.get(
+        zhaws_device.ieee
+    )
     assert client_device is not None
     entity: BinarySensorEntity = find_entity(client_device, Platform.BINARY_SENSOR)  # type: ignore
     assert entity is not None

tests/websocket/test_button.py

@@ -9,10 +9,9 @@
 import zigpy.zcl.foundation as zcl_f
 
 from zha.application.discovery import Platform
-from zha.application.gateway import WebSocketServerGateway as Server
+from zha.application.gateway import WebSocketClientGateway, WebSocketServerGateway
 from zha.application.platforms.model import BasePlatformEntity, ButtonEntity
-from zha.websocket.client.controller import Controller
-from zha.websocket.client.proxy import DeviceProxy
+from zha.zigbee.device import WebSocketClientDevice
 
 from ..common import (
     SIG_EP_INPUT,
@@ -25,17 +24,17 @@
 
 
 def find_entity(
-    device_proxy: DeviceProxy, platform: Platform
+    device_proxy: WebSocketClientDevice, platform: Platform
 ) -> Optional[BasePlatformEntity]:
     """Find an entity for the specified platform on the given device."""
-    for entity in device_proxy.device_model.entities.values():
+    for entity in device_proxy.platform_entities.values():
         if entity.platform == platform:
             return entity
     return None
 
 
 async def test_button(
-    connected_client_and_server: tuple[Controller, Server],
+    connected_client_and_server: tuple[WebSocketClientGateway, WebSocketServerGateway],
 ) -> None:
     """Test zha button platform."""
     controller, server = connected_client_and_server
@@ -58,7 +57,9 @@ async def test_button(
     cluster = zigpy_device.endpoints[1].identify
 
     assert cluster is not None
-    client_device: Optional[DeviceProxy] = controller.devices.get(zhaws_device.ieee)
+    client_device: Optional[WebSocketClientDevice] = controller.devices.get(
+        zhaws_device.ieee
+    )
     assert client_device is not None
     entity: ButtonEntity = find_entity(client_device, Platform.BUTTON)  # type: ignore
     assert entity is not None