mirror of
https://github.com/home-assistant/core.git
synced 2025-12-03 14:38:06 +00:00
505 lines
17 KiB
Python
505 lines
17 KiB
Python
"""The tests for the Everything but the Kitchen Sink integration."""
|
|
|
|
import datetime
|
|
from http import HTTPStatus
|
|
from unittest.mock import ANY
|
|
|
|
import pytest
|
|
from syrupy.assertion import SnapshotAssertion
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.kitchen_sink import DOMAIN
|
|
from homeassistant.components.labs import EVENT_LABS_UPDATED
|
|
from homeassistant.components.recorder import get_instance
|
|
from homeassistant.components.recorder.statistics import (
|
|
StatisticMeanType,
|
|
async_add_external_statistics,
|
|
get_last_statistics,
|
|
list_statistic_ids,
|
|
)
|
|
from homeassistant.components.repairs import DOMAIN as REPAIRS_DOMAIN
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import issue_registry as ir
|
|
from homeassistant.setup import async_setup_component
|
|
from homeassistant.util import dt as dt_util
|
|
from homeassistant.util.unit_system import US_CUSTOMARY_SYSTEM
|
|
|
|
from tests.components.recorder.common import async_wait_recording_done
|
|
from tests.typing import ClientSessionGenerator, WebSocketGenerator
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_history(hass: HomeAssistant) -> None:
|
|
"""Mock history component loaded."""
|
|
hass.config.components.add("history")
|
|
|
|
|
|
@pytest.mark.usefixtures("recorder_mock", "mock_history")
|
|
async def test_demo_statistics(hass: HomeAssistant) -> None:
|
|
"""Test that the kitchen sink component makes some statistics available."""
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
await hass.async_start()
|
|
await async_wait_recording_done(hass)
|
|
|
|
statistic_ids = await get_instance(hass).async_add_executor_job(
|
|
list_statistic_ids, hass
|
|
)
|
|
assert {
|
|
"display_unit_of_measurement": "°C",
|
|
"has_mean": True,
|
|
"mean_type": StatisticMeanType.ARITHMETIC,
|
|
"has_sum": False,
|
|
"name": "Outdoor temperature",
|
|
"source": DOMAIN,
|
|
"statistic_id": f"{DOMAIN}:temperature_outdoor",
|
|
"statistics_unit_of_measurement": "°C",
|
|
"unit_class": "temperature",
|
|
} in statistic_ids
|
|
assert {
|
|
"display_unit_of_measurement": "kWh",
|
|
"has_mean": False,
|
|
"mean_type": StatisticMeanType.NONE,
|
|
"has_sum": True,
|
|
"name": "Energy consumption 1",
|
|
"source": DOMAIN,
|
|
"statistic_id": f"{DOMAIN}:energy_consumption_kwh",
|
|
"statistics_unit_of_measurement": "kWh",
|
|
"unit_class": "energy",
|
|
} in statistic_ids
|
|
|
|
|
|
@pytest.mark.usefixtures("recorder_mock", "mock_history")
|
|
async def test_demo_statistics_growth(hass: HomeAssistant) -> None:
|
|
"""Test that the kitchen sink sum statistics adds to the previous state."""
|
|
hass.config.units = US_CUSTOMARY_SYSTEM
|
|
|
|
now = dt_util.now()
|
|
last_week = now - datetime.timedelta(days=7)
|
|
last_week_midnight = last_week.replace(hour=0, minute=0, second=0, microsecond=0)
|
|
|
|
statistic_id = f"{DOMAIN}:energy_consumption_kwh"
|
|
metadata = {
|
|
"source": DOMAIN,
|
|
"name": "Energy consumption 1",
|
|
"statistic_id": statistic_id,
|
|
"unit_class": "volume",
|
|
"unit_of_measurement": "m³",
|
|
"mean_type": StatisticMeanType.NONE,
|
|
"has_sum": True,
|
|
}
|
|
statistics = [
|
|
{
|
|
"start": last_week_midnight,
|
|
"sum": 2**20,
|
|
}
|
|
]
|
|
async_add_external_statistics(hass, metadata, statistics)
|
|
await async_wait_recording_done(hass)
|
|
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
await hass.async_start()
|
|
await async_wait_recording_done(hass)
|
|
|
|
statistics = await get_instance(hass).async_add_executor_job(
|
|
get_last_statistics, hass, 1, statistic_id, False, {"sum"}
|
|
)
|
|
assert statistics[statistic_id][0]["sum"] > 2**20
|
|
assert statistics[statistic_id][0]["sum"] <= (2**20 + 24)
|
|
|
|
|
|
@pytest.mark.usefixtures("recorder_mock", "mock_history")
|
|
async def test_statistics_issues(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
snapshot: SnapshotAssertion,
|
|
) -> None:
|
|
"""Test that the kitchen sink sum statistics causes statistics issues."""
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
await hass.async_start()
|
|
await async_wait_recording_done(hass)
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
await ws_client.send_json_auto_id({"type": "recorder/validate_statistics"})
|
|
response = await ws_client.receive_json()
|
|
assert response["success"]
|
|
assert response["result"] == snapshot
|
|
|
|
|
|
@pytest.mark.freeze_time("2023-10-21")
|
|
@pytest.mark.usefixtures("mock_history")
|
|
async def test_issues_created(
|
|
hass: HomeAssistant,
|
|
hass_client: ClientSessionGenerator,
|
|
hass_ws_client: WebSocketGenerator,
|
|
) -> None:
|
|
"""Test issues are created and can be fixed."""
|
|
assert await async_setup_component(hass, REPAIRS_DOMAIN, {REPAIRS_DOMAIN: {}})
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
await hass.async_start()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
client = await hass_client()
|
|
|
|
await ws_client.send_json({"id": 1, "type": "repairs/list_issues"})
|
|
msg = await ws_client.receive_json()
|
|
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"issues": [
|
|
{
|
|
"breaks_in_ha_version": "2023.1.1",
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": False,
|
|
"issue_id": "transmogrifier_deprecated",
|
|
"issue_domain": None,
|
|
"learn_more_url": "https://en.wiktionary.org/wiki/transmogrifier",
|
|
"severity": "warning",
|
|
"translation_key": "transmogrifier_deprecated",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": "2023.1.1",
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": True,
|
|
"issue_id": "out_of_blinker_fluid",
|
|
"issue_domain": None,
|
|
"learn_more_url": "https://www.youtube.com/watch?v=b9rntRxLlbU",
|
|
"severity": "critical",
|
|
"translation_key": "out_of_blinker_fluid",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": False,
|
|
"issue_id": "unfixable_problem",
|
|
"issue_domain": None,
|
|
"learn_more_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
|
|
"severity": "warning",
|
|
"translation_key": "unfixable_problem",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": True,
|
|
"issue_domain": None,
|
|
"issue_id": "bad_psu",
|
|
"learn_more_url": "https://www.youtube.com/watch?v=b9rntRxLlbU",
|
|
"severity": "critical",
|
|
"translation_key": "bad_psu",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"is_fixable": True,
|
|
"issue_domain": None,
|
|
"issue_id": "cold_tea",
|
|
"learn_more_url": None,
|
|
"severity": "warning",
|
|
"translation_key": "cold_tea",
|
|
"translation_placeholders": None,
|
|
"ignored": False,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": "homeassistant",
|
|
"is_fixable": False,
|
|
"issue_domain": DOMAIN,
|
|
"issue_id": ANY,
|
|
"learn_more_url": None,
|
|
"severity": "error",
|
|
"translation_key": "config_entry_reauth",
|
|
"translation_placeholders": {"name": "Kitchen Sink"},
|
|
"ignored": False,
|
|
},
|
|
]
|
|
}
|
|
|
|
url = "/api/repairs/issues/fix"
|
|
resp = await client.post(
|
|
url, json={"handler": DOMAIN, "issue_id": "out_of_blinker_fluid"}
|
|
)
|
|
|
|
assert resp.status == HTTPStatus.OK
|
|
data = await resp.json()
|
|
|
|
flow_id = data["flow_id"]
|
|
assert data == {
|
|
"data_schema": [],
|
|
"description_placeholders": None,
|
|
"errors": None,
|
|
"flow_id": ANY,
|
|
"handler": DOMAIN,
|
|
"last_step": None,
|
|
"preview": None,
|
|
"step_id": "confirm",
|
|
"type": "form",
|
|
}
|
|
|
|
url = f"/api/repairs/issues/fix/{flow_id}"
|
|
resp = await client.post(url)
|
|
|
|
assert resp.status == HTTPStatus.OK
|
|
data = await resp.json()
|
|
|
|
flow_id = data["flow_id"]
|
|
assert data == {
|
|
"description": None,
|
|
"description_placeholders": None,
|
|
"flow_id": flow_id,
|
|
"handler": DOMAIN,
|
|
"type": "create_entry",
|
|
}
|
|
|
|
await ws_client.send_json({"id": 4, "type": "repairs/list_issues"})
|
|
msg = await ws_client.receive_json()
|
|
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"issues": [
|
|
{
|
|
"breaks_in_ha_version": "2023.1.1",
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": False,
|
|
"issue_id": "transmogrifier_deprecated",
|
|
"issue_domain": None,
|
|
"learn_more_url": "https://en.wiktionary.org/wiki/transmogrifier",
|
|
"severity": "warning",
|
|
"translation_key": "transmogrifier_deprecated",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": False,
|
|
"issue_id": "unfixable_problem",
|
|
"issue_domain": None,
|
|
"learn_more_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
|
|
"severity": "warning",
|
|
"translation_key": "unfixable_problem",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"ignored": False,
|
|
"is_fixable": True,
|
|
"issue_domain": None,
|
|
"issue_id": "bad_psu",
|
|
"learn_more_url": "https://www.youtube.com/watch?v=b9rntRxLlbU",
|
|
"severity": "critical",
|
|
"translation_key": "bad_psu",
|
|
"translation_placeholders": None,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": DOMAIN,
|
|
"is_fixable": True,
|
|
"issue_domain": None,
|
|
"issue_id": "cold_tea",
|
|
"learn_more_url": None,
|
|
"severity": "warning",
|
|
"translation_key": "cold_tea",
|
|
"translation_placeholders": None,
|
|
"ignored": False,
|
|
},
|
|
{
|
|
"breaks_in_ha_version": None,
|
|
"created": "2023-10-21T00:00:00+00:00",
|
|
"dismissed_version": None,
|
|
"domain": "homeassistant",
|
|
"is_fixable": False,
|
|
"issue_domain": DOMAIN,
|
|
"issue_id": ANY,
|
|
"learn_more_url": None,
|
|
"severity": "error",
|
|
"translation_key": "config_entry_reauth",
|
|
"translation_placeholders": {"name": "Kitchen Sink"},
|
|
"ignored": False,
|
|
},
|
|
]
|
|
}
|
|
|
|
|
|
async def test_service(
|
|
hass: HomeAssistant,
|
|
) -> None:
|
|
"""Test we can call the service."""
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
|
|
with pytest.raises(vol.error.MultipleInvalid):
|
|
await hass.services.async_call(DOMAIN, "test_service_1", blocking=True)
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN, "test_service_1", {"field_1": 1, "field_2": "auto"}, blocking=True
|
|
)
|
|
|
|
await hass.services.async_call(
|
|
DOMAIN,
|
|
"test_service_1",
|
|
{"field_1": 1, "field_2": "auto", "field_3": 1, "field_4": "forwards"},
|
|
blocking=True,
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("preview_feature_enabled", "should_create_issue"),
|
|
[
|
|
(False, False),
|
|
(True, True),
|
|
],
|
|
ids=["preview_feature_disabled", "preview_feature_enabled"],
|
|
)
|
|
async def test_special_repair_preview_feature_state(
|
|
hass: HomeAssistant,
|
|
issue_registry: ir.IssueRegistry,
|
|
hass_ws_client: WebSocketGenerator,
|
|
preview_feature_enabled: bool,
|
|
should_create_issue: bool,
|
|
) -> None:
|
|
"""Test that special repair issue is created/removed based on preview feature state."""
|
|
assert await async_setup_component(hass, "labs", {})
|
|
assert await async_setup_component(hass, "repairs", {})
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
if preview_feature_enabled:
|
|
ws_client = await hass_ws_client(hass)
|
|
|
|
# Enable the special repair preview feature
|
|
await ws_client.send_json_auto_id(
|
|
{
|
|
"type": "labs/update",
|
|
"domain": "kitchen_sink",
|
|
"preview_feature": "special_repair",
|
|
"enabled": True,
|
|
}
|
|
)
|
|
msg = await ws_client.receive_json()
|
|
assert msg["success"]
|
|
|
|
# Wait for event handling
|
|
await hass.async_block_till_done()
|
|
|
|
# Check if issue exists based on preview feature state
|
|
issue = issue_registry.async_get_issue(DOMAIN, "kitchen_sink_special_repair_issue")
|
|
if should_create_issue:
|
|
assert issue is not None
|
|
assert issue.domain == DOMAIN
|
|
assert issue.translation_key == "special_repair"
|
|
assert issue.is_fixable is False
|
|
assert issue.severity == ir.IssueSeverity.WARNING
|
|
else:
|
|
assert issue is None
|
|
|
|
|
|
async def test_special_repair_preview_feature_toggle(
|
|
hass: HomeAssistant,
|
|
issue_registry: ir.IssueRegistry,
|
|
hass_ws_client: WebSocketGenerator,
|
|
) -> None:
|
|
"""Test that special repair issue is created/deleted when preview feature is toggled."""
|
|
# Setup repairs and kitchen_sink first
|
|
assert await async_setup_component(hass, "labs", {})
|
|
assert await async_setup_component(hass, "repairs", {})
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
ws_client = await hass_ws_client(hass)
|
|
|
|
# Enable the special repair preview feature
|
|
await ws_client.send_json_auto_id(
|
|
{
|
|
"type": "labs/update",
|
|
"domain": "kitchen_sink",
|
|
"preview_feature": "special_repair",
|
|
"enabled": True,
|
|
}
|
|
)
|
|
msg = await ws_client.receive_json()
|
|
assert msg["success"]
|
|
await hass.async_block_till_done()
|
|
|
|
# Check issue exists
|
|
issue = issue_registry.async_get_issue(DOMAIN, "kitchen_sink_special_repair_issue")
|
|
assert issue is not None
|
|
|
|
# Disable the special repair preview feature
|
|
await ws_client.send_json_auto_id(
|
|
{
|
|
"type": "labs/update",
|
|
"domain": "kitchen_sink",
|
|
"preview_feature": "special_repair",
|
|
"enabled": False,
|
|
}
|
|
)
|
|
msg = await ws_client.receive_json()
|
|
assert msg["success"]
|
|
await hass.async_block_till_done()
|
|
|
|
# Check issue is removed
|
|
issue = issue_registry.async_get_issue(DOMAIN, "kitchen_sink_special_repair_issue")
|
|
assert issue is None
|
|
|
|
|
|
async def test_preview_feature_event_handler_registered(
|
|
hass: HomeAssistant,
|
|
) -> None:
|
|
"""Test that preview feature event handler is registered on setup."""
|
|
# Setup kitchen_sink
|
|
assert await async_setup_component(hass, "labs", {})
|
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {}})
|
|
await hass.async_block_till_done()
|
|
|
|
# Track if event is handled
|
|
events_received = []
|
|
|
|
def track_event(event):
|
|
events_received.append(event)
|
|
|
|
hass.bus.async_listen(EVENT_LABS_UPDATED, track_event)
|
|
await hass.async_block_till_done()
|
|
|
|
# Fire a labs updated event for kitchen_sink preview feature
|
|
hass.bus.async_fire(
|
|
EVENT_LABS_UPDATED,
|
|
{"feature_id": "kitchen_sink.special_repair", "enabled": True},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
# Verify event was received by our tracker
|
|
assert len(events_received) == 1
|
|
assert events_received[0].data["feature_id"] == "kitchen_sink.special_repair"
|