1
mirror of https://github.com/home-assistant/core synced 2024-09-12 15:16:21 +02:00

Exclude static siren attributes from being recorded in the database (#69196)

This commit is contained in:
J. Nick Koston 2022-04-03 09:16:49 -06:00 committed by GitHub
parent e48cec4b33
commit e364456a46
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1,12 @@
"""Integration platform for recorder."""
from __future__ import annotations
from homeassistant.core import HomeAssistant, callback
from . import ATTR_AVAILABLE_TONES
@callback
def exclude_attributes(hass: HomeAssistant) -> set[str]:
"""Exclude static attributes from being recorded in the database."""
return {ATTR_AVAILABLE_TONES}

View File

@ -0,0 +1,43 @@
"""The tests for siren recorder."""
from __future__ import annotations
from datetime import timedelta
from homeassistant.components import siren
from homeassistant.components.recorder.models import StateAttributes, States
from homeassistant.components.recorder.util import session_scope
from homeassistant.components.siren import ATTR_AVAILABLE_TONES
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 siren registered attributes to be excluded."""
await async_init_recorder_component(hass)
await async_setup_component(
hass, siren.DOMAIN, {siren.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_AVAILABLE_TONES not in state.attributes
assert ATTR_FRIENDLY_NAME in state.attributes