From 42bf62e187bf3ce62ac8438dd36fe80072d43f94 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sat, 2 Apr 2022 21:46:41 -0600 Subject: [PATCH] Exclude static water_heater attributes from being recorded in the database (#69159) --- .../components/water_heater/recorder.py | 12 +++++ .../components/water_heater/test_recorder.py | 49 +++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 homeassistant/components/water_heater/recorder.py create mode 100644 tests/components/water_heater/test_recorder.py diff --git a/homeassistant/components/water_heater/recorder.py b/homeassistant/components/water_heater/recorder.py new file mode 100644 index 00000000000..d76b96936fa --- /dev/null +++ b/homeassistant/components/water_heater/recorder.py @@ -0,0 +1,12 @@ +"""Integration platform for recorder.""" +from __future__ import annotations + +from homeassistant.core import HomeAssistant, callback + +from . import ATTR_MAX_TEMP, ATTR_MIN_TEMP, ATTR_OPERATION_LIST + + +@callback +def exclude_attributes(hass: HomeAssistant) -> set[str]: + """Exclude static attributes from being recorded in the database.""" + return {ATTR_OPERATION_LIST, ATTR_MIN_TEMP, ATTR_MAX_TEMP} diff --git a/tests/components/water_heater/test_recorder.py b/tests/components/water_heater/test_recorder.py new file mode 100644 index 00000000000..b7e7fc4bb10 --- /dev/null +++ b/tests/components/water_heater/test_recorder.py @@ -0,0 +1,49 @@ +"""The tests for water_heater recorder.""" +from __future__ import annotations + +from datetime import timedelta + +from homeassistant.components import water_heater +from homeassistant.components.recorder.models import StateAttributes, States +from homeassistant.components.recorder.util import session_scope +from homeassistant.components.water_heater import ( + ATTR_MAX_TEMP, + ATTR_MIN_TEMP, + ATTR_OPERATION_LIST, +) +from homeassistant.const import ATTR_FRIENDLY_NAME +from homeassistant.core import State +from homeassistant.setup import async_setup_component +from homeassistant.util import dt as dt_util + +from tests.common import async_fire_time_changed, async_init_recorder_component +from tests.components.recorder.common import async_wait_recording_done_without_instance + + +async def test_exclude_attributes(hass): + """Test water_heater registered attributes to be excluded.""" + await async_init_recorder_component(hass) + await async_setup_component( + hass, water_heater.DOMAIN, {water_heater.DOMAIN: {"platform": "demo"}} + ) + await hass.async_block_till_done() + async_fire_time_changed(hass, dt_util.utcnow() + timedelta(minutes=5)) + await hass.async_block_till_done() + await async_wait_recording_done_without_instance(hass) + + def _fetch_states() -> list[State]: + with session_scope(hass=hass) as session: + native_states = [] + for db_state, db_state_attributes in session.query(States, StateAttributes): + state = db_state.to_native() + state.attributes = db_state_attributes.to_native() + native_states.append(state) + return native_states + + states: list[State] = await hass.async_add_executor_job(_fetch_states) + assert len(states) > 1 + for state in states: + assert ATTR_OPERATION_LIST not in state.attributes + assert ATTR_MIN_TEMP not in state.attributes + assert ATTR_MAX_TEMP not in state.attributes + assert ATTR_FRIENDLY_NAME in state.attributes