diff --git a/homeassistant/components/zwave_js/api.py b/homeassistant/components/zwave_js/api.py index 1ab8e831b74..05591e8ecfb 100644 --- a/homeassistant/components/zwave_js/api.py +++ b/homeassistant/components/zwave_js/api.py @@ -236,6 +236,36 @@ QR_PROVISIONING_INFORMATION_SCHEMA = vol.All( QR_CODE_STRING_SCHEMA = vol.All(str, vol.Length(min=MINIMUM_QR_STRING_LENGTH)) +async def _async_get_entry( + hass: HomeAssistant, connection: ActiveConnection, msg: dict, entry_id: str +) -> tuple[ConfigEntry | None, Client | None, Driver | None]: + """Get config entry and client from message data.""" + entry = hass.config_entries.async_get_entry(entry_id) + if entry is None: + connection.send_error( + msg[ID], ERR_NOT_FOUND, f"Config entry {entry_id} not found" + ) + return None, None, None + + if entry.state is not ConfigEntryState.LOADED: + connection.send_error( + msg[ID], ERR_NOT_LOADED, f"Config entry {entry_id} not loaded" + ) + return None, None, None + + client: Client = hass.data[DOMAIN][entry_id][DATA_CLIENT] + + if client.driver is None: + connection.send_error( + msg[ID], + ERR_NOT_LOADED, + f"Config entry {msg[ENTRY_ID]} not loaded, driver not ready", + ) + return None, None, None + + return entry, client, client.driver + + def async_get_entry(orig_func: Callable) -> Callable: """Decorate async function to get entry.""" @@ -244,35 +274,33 @@ def async_get_entry(orig_func: Callable) -> Callable: hass: HomeAssistant, connection: ActiveConnection, msg: dict ) -> None: """Provide user specific data and store to function.""" - entry_id = msg[ENTRY_ID] - entry = hass.config_entries.async_get_entry(entry_id) - if entry is None: - connection.send_error( - msg[ID], ERR_NOT_FOUND, f"Config entry {entry_id} not found" - ) + entry, client, driver = await _async_get_entry( + hass, connection, msg, msg[ENTRY_ID] + ) + + if not entry and not client and not driver: return - if entry.state is not ConfigEntryState.LOADED: - connection.send_error( - msg[ID], ERR_NOT_LOADED, f"Config entry {entry_id} not loaded" - ) - return - - client: Client = hass.data[DOMAIN][entry_id][DATA_CLIENT] - - if client.driver is None: - connection.send_error( - msg[ID], - ERR_NOT_LOADED, - f"Config entry {entry_id} not loaded, driver not ready", - ) - return - - await orig_func(hass, connection, msg, entry, client, client.driver) + await orig_func(hass, connection, msg, entry, client, driver) return async_get_entry_func +async def _async_get_node( + hass: HomeAssistant, connection: ActiveConnection, msg: dict, device_id: str +) -> Node | None: + """Get node from message data.""" + try: + node = async_get_node_from_device_id(hass, device_id) + except ValueError as err: + error_code = ERR_NOT_FOUND + if "loaded" in err.args[0]: + error_code = ERR_NOT_LOADED + connection.send_error(msg[ID], error_code, err.args[0]) + return None + return node + + def async_get_node(orig_func: Callable) -> Callable: """Decorate async function to get node.""" @@ -281,15 +309,8 @@ def async_get_node(orig_func: Callable) -> Callable: hass: HomeAssistant, connection: ActiveConnection, msg: dict ) -> None: """Provide user specific data and store to function.""" - device_id = msg[DEVICE_ID] - - try: - node = async_get_node_from_device_id(hass, device_id) - except ValueError as err: - error_code = ERR_NOT_FOUND - if "loaded" in err.args[0]: - error_code = ERR_NOT_LOADED - connection.send_error(msg[ID], error_code, err.args[0]) + node = await _async_get_node(hass, connection, msg, msg[DEVICE_ID]) + if not node: return await orig_func(hass, connection, msg, node) @@ -388,24 +409,37 @@ def async_register_api(hass: HomeAssistant) -> None: @websocket_api.require_admin @websocket_api.websocket_command( - {vol.Required(TYPE): "zwave_js/network_status", vol.Required(ENTRY_ID): str} + { + vol.Required(TYPE): "zwave_js/network_status", + vol.Exclusive(DEVICE_ID, "id"): str, + vol.Exclusive(ENTRY_ID, "id"): str, + } ) @websocket_api.async_response -@async_get_entry async def websocket_network_status( - hass: HomeAssistant, - connection: ActiveConnection, - msg: dict, - entry: ConfigEntry, - client: Client, - driver: Driver, + hass: HomeAssistant, connection: ActiveConnection, msg: dict ) -> None: """Get the status of the Z-Wave JS network.""" + if ENTRY_ID in msg: + _, client, driver = await _async_get_entry(hass, connection, msg, msg[ENTRY_ID]) + if not client or not driver: + return + elif DEVICE_ID in msg: + node = await _async_get_node(hass, connection, msg, msg[DEVICE_ID]) + if not node: + return + client = node.client + assert client.driver + driver = client.driver + else: + connection.send_error( + msg[ID], ERR_INVALID_FORMAT, "Must specify either device_id or entry_id" + ) + return controller = driver.controller + await controller.async_get_state() client_version_info = client.version assert client_version_info # When client is connected version info is set. - - await controller.async_get_state() data = { "client": { "ws_server_url": client.ws_server_url, @@ -1723,6 +1757,7 @@ async def websocket_get_log_config( driver: Driver, ) -> None: """Get log configuration for the Z-Wave JS driver.""" + assert client and client.driver connection.send_result( msg[ID], dataclasses.asdict(driver.log_config), @@ -1781,6 +1816,7 @@ async def websocket_data_collection_status( driver: Driver, ) -> None: """Return data collection preference and status.""" + assert client and client.driver result = { OPTED_IN: entry.data.get(CONF_DATA_COLLECTION_OPTED_IN), ENABLED: await driver.async_is_statistics_enabled(), diff --git a/tests/components/zwave_js/test_api.py b/tests/components/zwave_js/test_api.py index 2309e7b02bf..ee6a85db70f 100644 --- a/tests/components/zwave_js/test_api.py +++ b/tests/components/zwave_js/test_api.py @@ -28,7 +28,10 @@ from zwave_js_server.model.controller import ( ) from zwave_js_server.model.node import Node -from homeassistant.components.websocket_api.const import ERR_NOT_FOUND +from homeassistant.components.websocket_api.const import ( + ERR_INVALID_FORMAT, + ERR_NOT_FOUND, +) from homeassistant.components.zwave_js.api import ( ADDITIONAL_PROPERTIES, APPLICATION_VERSION, @@ -82,14 +85,19 @@ def get_device(hass, node): return dev_reg.async_get_device({device_id}) -async def test_network_status(hass, integration, hass_ws_client): +async def test_network_status(hass, multisensor_6, integration, hass_ws_client): """Test the network status websocket command.""" entry = integration ws_client = await hass_ws_client(hass) + # Try API call with entry ID with patch("zwave_js_server.model.controller.Controller.async_get_state"): await ws_client.send_json( - {ID: 2, TYPE: "zwave_js/network_status", ENTRY_ID: entry.entry_id} + { + ID: 1, + TYPE: "zwave_js/network_status", + ENTRY_ID: entry.entry_id, + } ) msg = await ws_client.receive_json() result = msg["result"] @@ -98,18 +106,94 @@ async def test_network_status(hass, integration, hass_ws_client): assert result["client"]["server_version"] == "1.0.0" assert result["controller"]["inclusion_state"] == InclusionState.IDLE - # Test sending command with not loaded entry fails + # Try API call with device ID + dev_reg = dr.async_get(hass) + device = dev_reg.async_get_device( + identifiers={(DOMAIN, "3245146787-52")}, + ) + assert device + with patch("zwave_js_server.model.controller.Controller.async_get_state"): + await ws_client.send_json( + { + ID: 2, + TYPE: "zwave_js/network_status", + DEVICE_ID: device.id, + } + ) + msg = await ws_client.receive_json() + result = msg["result"] + + assert result["client"]["ws_server_url"] == "ws://test:3000/zjs" + assert result["client"]["server_version"] == "1.0.0" + assert result["controller"]["inclusion_state"] == InclusionState.IDLE + + # Test sending command with invalid config entry ID fails + await ws_client.send_json( + { + ID: 3, + TYPE: "zwave_js/network_status", + ENTRY_ID: "fake_id", + } + ) + msg = await ws_client.receive_json() + + assert not msg["success"] + assert msg["error"]["code"] == ERR_NOT_FOUND + + # Test sending command with invalid device ID fails + await ws_client.send_json( + { + ID: 4, + TYPE: "zwave_js/network_status", + DEVICE_ID: "fake_id", + } + ) + msg = await ws_client.receive_json() + + assert not msg["success"] + assert msg["error"]["code"] == ERR_NOT_FOUND + + # Test sending command with not loaded entry fails with config entry ID await hass.config_entries.async_unload(entry.entry_id) await hass.async_block_till_done() await ws_client.send_json( - {ID: 3, TYPE: "zwave_js/network_status", ENTRY_ID: entry.entry_id} + { + ID: 5, + TYPE: "zwave_js/network_status", + ENTRY_ID: entry.entry_id, + } ) msg = await ws_client.receive_json() assert not msg["success"] assert msg["error"]["code"] == ERR_NOT_LOADED + # Test sending command with not loaded entry fails with device ID + await ws_client.send_json( + { + ID: 6, + TYPE: "zwave_js/network_status", + DEVICE_ID: device.id, + } + ) + msg = await ws_client.receive_json() + + assert not msg["success"] + assert msg["error"]["code"] == ERR_NOT_LOADED + + # Test sending command with no device ID or entry ID fails + await ws_client.send_json( + { + ID: 7, + TYPE: "zwave_js/network_status", + } + ) + msg = await ws_client.receive_json() + + assert not msg["success"] + assert msg["error"]["code"] == ERR_INVALID_FORMAT + async def test_node_ready( hass,