mirror of
https://github.com/home-assistant/core.git
synced 2026-05-31 04:34:10 +01:00
Mike Degatano
d9fae7fecf
- Add config_flow.py with a minimal system config flow - Split async_setup (lightweight: YAML config, labs feature, discovery flow, websocket/HTTP registration) from async_setup_entry (heavy: Analytics init, load, scheduling, listeners) - Add async_unload_entry that cancels scheduled analytics tasks - Thread snapshots_url from YAML through hass.data so it reaches async_setup_entry without persisting to config entry data, keeping the option as a hidden developer-only YAML setting for now - Catch HassioNotReadyError from Analytics.load and raise ConfigEntryNotReady so setup is retried when Supervisor is not yet ready - Register websocket commands and HTTP view in async_setup so they survive entry reload; guard both handlers with ERR_NOT_FOUND when the entry is not loaded - Replace async_listen_once(EVENT_HOMEASSISTANT_STARTED) with async_at_started so the schedule starts immediately on reload when HA is already running - Add cancel_scheduled() to Analytics class - Update stale comments in Analytics.load and send_analytics - Add supervisor_not_ready exception translation key - Add tests for: ConfigEntryNotReady on supervisor failure, schedule fires and sends analytics, unload stops the schedule, websocket error when entry not loaded, snapshots_url routes to custom URL Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
283 lines
9.6 KiB
Python
283 lines
9.6 KiB
Python
"""The tests for the analytics ."""
|
|
|
|
from datetime import timedelta
|
|
from typing import Any
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components.analytics import CONF_SNAPSHOTS_URL, LABS_SNAPSHOT_FEATURE
|
|
from homeassistant.components.analytics.const import (
|
|
BASIC_ENDPOINT_URL,
|
|
BASIC_ENDPOINT_URL_DEV,
|
|
DOMAIN,
|
|
SNAPSHOT_DEFAULT_URL,
|
|
SNAPSHOT_URL_PATH,
|
|
STORAGE_KEY,
|
|
)
|
|
from homeassistant.components.hassio import HassioNotReadyError
|
|
from homeassistant.components.labs import async_update_preview_feature
|
|
from homeassistant.config_entries import ConfigEntryState
|
|
from homeassistant.const import EVENT_HOMEASSISTANT_STARTED
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.setup import async_setup_component
|
|
from homeassistant.util import dt as dt_util
|
|
|
|
from tests.common import async_fire_time_changed
|
|
from tests.test_util.aiohttp import AiohttpClientMocker
|
|
from tests.typing import WebSocketGenerator
|
|
|
|
MOCK_VERSION = "1970.1.0"
|
|
|
|
SNAPSHOT_ENDPOINT_URL = SNAPSHOT_DEFAULT_URL + SNAPSHOT_URL_PATH
|
|
|
|
|
|
async def test_setup(hass: HomeAssistant) -> None:
|
|
"""Test setup of the integration."""
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
assert DOMAIN in hass.data
|
|
|
|
|
|
async def test_setup_with_snapshots_url(
|
|
hass: HomeAssistant,
|
|
hass_storage: dict[str, Any],
|
|
hass_ws_client: WebSocketGenerator,
|
|
aioclient_mock: AiohttpClientMocker,
|
|
) -> None:
|
|
"""Test setup with snapshots_url in YAML config sends snapshots to that URL."""
|
|
custom_url = "https://custom-snapshot-endpoint.example.com"
|
|
snapshot_endpoint = custom_url + SNAPSHOT_URL_PATH
|
|
aioclient_mock.post(snapshot_endpoint, status=200, json={})
|
|
|
|
with patch(
|
|
"homeassistant.components.analytics.analytics._async_snapshot_payload",
|
|
return_value={"mock": {}},
|
|
):
|
|
assert await async_setup_component(hass, "labs", {})
|
|
assert await async_setup_component(
|
|
hass, DOMAIN, {DOMAIN: {CONF_SNAPSHOTS_URL: custom_url}}
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
await ws_client.send_json_auto_id(
|
|
{"type": "analytics/preferences", "preferences": {"snapshots": True}}
|
|
)
|
|
assert (await ws_client.receive_json())["success"]
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(hours=25))
|
|
await hass.async_block_till_done()
|
|
|
|
assert any(str(call[1]) == snapshot_endpoint for call in aioclient_mock.mock_calls)
|
|
|
|
|
|
async def test_setup_entry_supervisor_not_ready(hass: HomeAssistant) -> None:
|
|
"""Test that HassioNotReadyError raises ConfigEntryNotReady."""
|
|
with (
|
|
patch(
|
|
"homeassistant.components.analytics.analytics.is_hassio",
|
|
return_value=True,
|
|
),
|
|
patch(
|
|
"homeassistant.components.hassio.get_supervisor_info",
|
|
side_effect=HassioNotReadyError,
|
|
),
|
|
):
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
entry = hass.config_entries.async_entries(DOMAIN)[0]
|
|
assert entry.state is ConfigEntryState.SETUP_RETRY
|
|
|
|
|
|
async def test_schedule_starts_and_sends_analytics(
|
|
hass: HomeAssistant,
|
|
hass_storage: dict[str, Any],
|
|
hass_ws_client: WebSocketGenerator,
|
|
aioclient_mock: AiohttpClientMocker,
|
|
) -> None:
|
|
"""Test that the analytics schedule fires and sends analytics after time travel."""
|
|
aioclient_mock.post(BASIC_ENDPOINT_URL, status=200)
|
|
aioclient_mock.post(BASIC_ENDPOINT_URL_DEV, status=200)
|
|
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
with patch("homeassistant.components.analytics.analytics.HA_VERSION", MOCK_VERSION):
|
|
await ws_client.send_json_auto_id(
|
|
{"type": "analytics/preferences", "preferences": {"base": True}}
|
|
)
|
|
assert (await ws_client.receive_json())["success"]
|
|
|
|
assert len(aioclient_mock.mock_calls) == 0
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=901))
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(aioclient_mock.mock_calls) == 1
|
|
|
|
|
|
async def test_unload_entry(
|
|
hass: HomeAssistant,
|
|
hass_storage: dict[str, Any],
|
|
hass_ws_client: WebSocketGenerator,
|
|
aioclient_mock: AiohttpClientMocker,
|
|
) -> None:
|
|
"""Test that unloading the config entry stops the analytics schedule."""
|
|
aioclient_mock.post(BASIC_ENDPOINT_URL, status=200)
|
|
aioclient_mock.post(BASIC_ENDPOINT_URL_DEV, status=200)
|
|
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
with patch("homeassistant.components.analytics.analytics.HA_VERSION", MOCK_VERSION):
|
|
await ws_client.send_json_auto_id(
|
|
{"type": "analytics/preferences", "preferences": {"base": True}}
|
|
)
|
|
await ws_client.receive_json()
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=901))
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(aioclient_mock.mock_calls) == 1
|
|
|
|
entry = hass.config_entries.async_entries(DOMAIN)[0]
|
|
await hass.config_entries.async_unload(entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(days=2))
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(aioclient_mock.mock_calls) == 1
|
|
|
|
|
|
async def test_websocket_not_loaded(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
) -> None:
|
|
"""Test websocket returns error when analytics entry failed to load."""
|
|
with (
|
|
patch(
|
|
"homeassistant.components.analytics.analytics.is_hassio",
|
|
return_value=True,
|
|
),
|
|
patch(
|
|
"homeassistant.components.hassio.get_supervisor_info",
|
|
side_effect=HassioNotReadyError,
|
|
),
|
|
):
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
await ws_client.send_json_auto_id({"type": "analytics"})
|
|
response = await ws_client.receive_json()
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "not_found"
|
|
|
|
|
|
async def test_websocket_preferences_not_loaded(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
) -> None:
|
|
"""Test preferences websocket returns error when analytics entry failed to load."""
|
|
with (
|
|
patch(
|
|
"homeassistant.components.analytics.analytics.is_hassio",
|
|
return_value=True,
|
|
),
|
|
patch(
|
|
"homeassistant.components.hassio.get_supervisor_info",
|
|
side_effect=HassioNotReadyError,
|
|
),
|
|
):
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
await ws_client.send_json_auto_id(
|
|
{"type": "analytics/preferences", "preferences": {"base": True}}
|
|
)
|
|
response = await ws_client.receive_json()
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "not_found"
|
|
|
|
|
|
@pytest.mark.usefixtures("mock_snapshot_payload")
|
|
async def test_labs_feature_toggle(
|
|
hass: HomeAssistant,
|
|
hass_storage: dict[str, Any],
|
|
aioclient_mock: AiohttpClientMocker,
|
|
) -> None:
|
|
"""Test that snapshots can be toggled via labs feature."""
|
|
aioclient_mock.post(SNAPSHOT_ENDPOINT_URL, status=200, json={})
|
|
|
|
assert await async_setup_component(hass, "labs", {})
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
|
|
hass.bus.async_fire(EVENT_HOMEASSISTANT_STARTED)
|
|
await hass.async_block_till_done()
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(hours=25))
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(aioclient_mock.mock_calls) == 0
|
|
|
|
await async_update_preview_feature(hass, DOMAIN, LABS_SNAPSHOT_FEATURE, True)
|
|
|
|
assert hass_storage[STORAGE_KEY]["data"]["preferences"]["snapshots"] is True
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(hours=25))
|
|
await hass.async_block_till_done()
|
|
|
|
assert any(
|
|
str(call[1]) == SNAPSHOT_ENDPOINT_URL for call in aioclient_mock.mock_calls
|
|
)
|
|
|
|
aioclient_mock.clear_requests()
|
|
|
|
await async_update_preview_feature(hass, DOMAIN, LABS_SNAPSHOT_FEATURE, False)
|
|
|
|
assert hass_storage[STORAGE_KEY]["data"]["preferences"]["snapshots"] is False
|
|
|
|
async_fire_time_changed(hass, dt_util.utcnow() + timedelta(hours=25))
|
|
await hass.async_block_till_done()
|
|
|
|
assert len(aioclient_mock.mock_calls) == 0
|
|
|
|
|
|
@pytest.mark.usefixtures("supervisor_client")
|
|
async def test_websocket(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
aioclient_mock: AiohttpClientMocker,
|
|
) -> None:
|
|
"""Test WebSocket commands."""
|
|
aioclient_mock.post(BASIC_ENDPOINT_URL, status=200)
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
await ws_client.send_json_auto_id({"type": "analytics"})
|
|
|
|
response = await ws_client.receive_json()
|
|
|
|
assert response["success"]
|
|
|
|
with patch("homeassistant.components.analytics.analytics.HA_VERSION", MOCK_VERSION):
|
|
await ws_client.send_json_auto_id(
|
|
{"type": "analytics/preferences", "preferences": {"base": True}}
|
|
)
|
|
response = await ws_client.receive_json()
|
|
assert response["result"]["preferences"]["base"]
|
|
|
|
await ws_client.send_json_auto_id({"type": "analytics"})
|
|
response = await ws_client.receive_json()
|
|
assert response["result"]["preferences"]["base"]
|