mirror of
https://github.com/home-assistant/supervisor.git
synced 2026-05-02 06:11:00 +01:00
da800b8889
* Raise HomeAssistantWSError when Core WebSocket is unreachable Previously, async_send_command silently returned None when Home Assistant Core was not reachable, leading to misleading error messages downstream (e.g. "returned invalid response of None instead of a list of users"). Refactor _can_send to _ensure_connected which now raises HomeAssistantWSError on connection failures while still returning False for silent-skip cases (shutdown, unsupported version). async_send_message catches the exception to preserve fire-and-forget behavior. Update callers that don't handle HomeAssistantWSError: _hardware_events and addon auto-update in tasks. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Simplify HomeAssistantWebSocket command/message distinction The WebSocket layer had a confusing split between "messages" (fire-and-forget) and "commands" (request/response) that didn't reflect Home Assistant Core's architecture where everything is just a WS command. - Remove dead WSClient.async_send_message (never called) - Rename async_send_message → _async_send_command (private, fire-and-forget) - Rename send_message → send_command (sync wrapper) - Simplify _ensure_connected: drop message param, always raise on failure - Simplify async_send_command: always raise on connection errors - Remove MIN_VERSION gating (minimum supported Core is now 2024.2+) - Remove begin_backup/end_backup version guards for Core < 2022.1.0 - Add debug logging for silently ignored connection errors Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Wait for Core to come up before backup This is crucial since the WebSocket command to Core now fails with the new error handling if Core is not running yet. * Wait for Core install job instead * Use CLI to fetch jobs instead of Supervisor API The Supervisor API needs authentication token, which we have not available at this point in the workflow. Instead of fetching the token, we can use the CLI, which is available in the container. --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
109 lines
3.7 KiB
Python
109 lines
3.7 KiB
Python
"""Test websocket."""
|
|
|
|
# pylint: disable=import-error
|
|
import asyncio
|
|
from unittest.mock import AsyncMock, patch
|
|
|
|
import pytest
|
|
|
|
from supervisor.const import CoreState
|
|
from supervisor.coresys import CoreSys
|
|
from supervisor.exceptions import HomeAssistantWSError
|
|
from supervisor.homeassistant.const import WSEvent, WSType
|
|
|
|
|
|
async def test_send_command(coresys: CoreSys, ha_ws_client: AsyncMock):
|
|
"""Test sending a command returns a response."""
|
|
await coresys.homeassistant.websocket.async_send_command({"type": "test"})
|
|
ha_ws_client.async_send_command.assert_called_with({"type": "test"})
|
|
|
|
await coresys.homeassistant.websocket.async_supervisor_update_event(
|
|
"test", {"lorem": "ipsum"}
|
|
)
|
|
ha_ws_client.async_send_command.assert_called_with(
|
|
{
|
|
"type": WSType.SUPERVISOR_EVENT,
|
|
"data": {
|
|
"event": WSEvent.SUPERVISOR_UPDATE,
|
|
"update_key": "test",
|
|
"data": {"lorem": "ipsum"},
|
|
},
|
|
}
|
|
)
|
|
|
|
|
|
async def test_fire_and_forget_during_startup(
|
|
coresys: CoreSys, ha_ws_client: AsyncMock
|
|
):
|
|
"""Test fire-and-forget commands queue during startup and replay when running."""
|
|
await coresys.homeassistant.websocket.load()
|
|
await coresys.core.set_state(CoreState.SETUP)
|
|
|
|
await coresys.homeassistant.websocket.async_supervisor_update_event(
|
|
"test", {"lorem": "ipsum"}
|
|
)
|
|
ha_ws_client.async_send_command.assert_not_called()
|
|
|
|
await coresys.core.set_state(CoreState.RUNNING)
|
|
await asyncio.sleep(0)
|
|
|
|
assert ha_ws_client.async_send_command.call_count == 2
|
|
assert ha_ws_client.async_send_command.call_args_list[0][0][0] == {
|
|
"type": WSType.SUPERVISOR_EVENT,
|
|
"data": {
|
|
"event": WSEvent.SUPERVISOR_UPDATE,
|
|
"update_key": "test",
|
|
"data": {"lorem": "ipsum"},
|
|
},
|
|
}
|
|
assert ha_ws_client.async_send_command.call_args_list[1][0][0] == {
|
|
"type": WSType.SUPERVISOR_EVENT,
|
|
"data": {
|
|
"event": WSEvent.SUPERVISOR_UPDATE,
|
|
"update_key": "info",
|
|
"data": {"state": "running"},
|
|
},
|
|
}
|
|
|
|
ha_ws_client.reset_mock()
|
|
await coresys.core.set_state(CoreState.SHUTDOWN)
|
|
|
|
await coresys.homeassistant.websocket.async_supervisor_update_event(
|
|
"test", {"lorem": "ipsum"}
|
|
)
|
|
ha_ws_client.async_send_command.assert_not_called()
|
|
|
|
|
|
async def test_send_command_core_not_reachable(
|
|
coresys: CoreSys, ha_ws_client: AsyncMock
|
|
):
|
|
"""Test async_send_command raises when Core API is not reachable."""
|
|
ha_ws_client.connected = False
|
|
with (
|
|
patch.object(coresys.homeassistant.api, "check_api_state", return_value=False),
|
|
pytest.raises(HomeAssistantWSError, match="not reachable"),
|
|
):
|
|
await coresys.homeassistant.websocket.async_send_command({"type": "test"})
|
|
|
|
ha_ws_client.async_send_command.assert_not_called()
|
|
|
|
|
|
async def test_fire_and_forget_core_not_reachable(
|
|
coresys: CoreSys, ha_ws_client: AsyncMock
|
|
):
|
|
"""Test fire-and-forget command silently skips when Core API is not reachable."""
|
|
ha_ws_client.connected = False
|
|
with patch.object(coresys.homeassistant.api, "check_api_state", return_value=False):
|
|
await coresys.homeassistant.websocket._async_send_command({"type": "test"})
|
|
|
|
ha_ws_client.async_send_command.assert_not_called()
|
|
|
|
|
|
async def test_send_command_during_shutdown(coresys: CoreSys, ha_ws_client: AsyncMock):
|
|
"""Test async_send_command raises during shutdown."""
|
|
await coresys.core.set_state(CoreState.SHUTDOWN)
|
|
with pytest.raises(HomeAssistantWSError, match="shutting down"):
|
|
await coresys.homeassistant.websocket.async_send_command({"type": "test"})
|
|
|
|
ha_ws_client.async_send_command.assert_not_called()
|