mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 21:27:38 +00:00
Exclude large and chatty attributes from being recorded for update entities (#68940)
Co-authored-by: Joakim Sørensen <hi@ludeeus.dev>
This commit is contained in:
parent
f7c936e842
commit
185aa025ac
12
homeassistant/components/update/recorder.py
Normal file
12
homeassistant/components/update/recorder.py
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
"""Integration platform for recorder."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from homeassistant.core import HomeAssistant, callback
|
||||||
|
|
||||||
|
from . import ATTR_IN_PROGRESS, ATTR_RELEASE_SUMMARY
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def exclude_attributes(hass: HomeAssistant) -> set[str]:
|
||||||
|
"""Exclude large and chatty update attributes from being recorded in the database."""
|
||||||
|
return {ATTR_IN_PROGRESS, ATTR_RELEASE_SUMMARY}
|
55
tests/components/update/test_recorder.py
Normal file
55
tests/components/update/test_recorder.py
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
"""The tests for update recorder."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import timedelta
|
||||||
|
|
||||||
|
from homeassistant.components.recorder.models import StateAttributes, States
|
||||||
|
from homeassistant.components.recorder.util import session_scope
|
||||||
|
from homeassistant.components.update.const import (
|
||||||
|
ATTR_CURRENT_VERSION,
|
||||||
|
ATTR_IN_PROGRESS,
|
||||||
|
ATTR_RELEASE_SUMMARY,
|
||||||
|
DOMAIN,
|
||||||
|
)
|
||||||
|
from homeassistant.const import CONF_PLATFORM
|
||||||
|
from homeassistant.core import HomeAssistant, 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: HomeAssistant, enable_custom_integrations: None
|
||||||
|
):
|
||||||
|
"""Test update attributes to be excluded."""
|
||||||
|
await async_init_recorder_component(hass)
|
||||||
|
platform = getattr(hass.components, f"test.{DOMAIN}")
|
||||||
|
platform.init()
|
||||||
|
assert await async_setup_component(hass, DOMAIN, {DOMAIN: {CONF_PLATFORM: "test"}})
|
||||||
|
await hass.async_block_till_done()
|
||||||
|
state = hass.states.get("update.update_already_in_progress")
|
||||||
|
assert state.attributes[ATTR_IN_PROGRESS] == 50
|
||||||
|
await async_setup_component(hass, DOMAIN, {})
|
||||||
|
|
||||||
|
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_IN_PROGRESS not in state.attributes
|
||||||
|
assert ATTR_RELEASE_SUMMARY not in state.attributes
|
||||||
|
assert ATTR_CURRENT_VERSION in state.attributes
|
Loading…
x
Reference in New Issue
Block a user