jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-27 15:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Do not add trend config entry to source device (#148733)

Browse Source
This commit is contained in:
Erik Montnemery 2025-07-14 20:00:49 +02:00 committed by GitHub
parent 92bb1f2551
commit 57f89dd606
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 199 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
homeassistant/components/trend/__init__.py
View File

@ -2,6 +2,8 @@
from __future__ import annotations
import logging
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_ENTITY_ID, Platform
from homeassistant.core import HomeAssistant
@ -9,14 +11,20 @@ from homeassistant.helpers.device import (
async_entity_id_to_device_id,
async_remove_stale_devices_links_keep_entity_device,
)
from homeassistant.helpers.helper_integration import async_handle_source_entity_changes
from homeassistant.helpers.helper_integration import (
async_handle_source_entity_changes,
async_remove_helper_config_entry_from_source_device,
)
PLATFORMS = [Platform.BINARY_SENSOR]
_LOGGER = logging.getLogger(__name__)
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up Trend from a config entry."""
# This can be removed in HA Core 2026.2
async_remove_stale_devices_links_keep_entity_device(
hass,
entry.entry_id,
@ -37,6 +45,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
entry.async_on_unload(
async_handle_source_entity_changes(
hass,
add_helper_config_entry_to_device=False,
helper_config_entry_id=entry.entry_id,
set_source_entity_id_or_uuid=set_source_entity_id_or_uuid,
source_device_id=async_entity_id_to_device_id(
@ -53,6 +62,40 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
return True
async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
"""Migrate old entry."""
_LOGGER.debug(
"Migrating from version %s.%s", config_entry.version, config_entry.minor_version
)
if config_entry.version > 1:
# This means the user has downgraded from a future version
return False
if config_entry.version == 1:
options = {**config_entry.options}
if config_entry.minor_version < 2:
# Remove the trend config entry from the source device
if source_device_id := async_entity_id_to_device_id(
hass, options[CONF_ENTITY_ID]
):
async_remove_helper_config_entry_from_source_device(
hass,
helper_config_entry_id=config_entry.entry_id,
source_device_id=source_device_id,
)
hass.config_entries.async_update_entry(
config_entry, options=options, minor_version=2
)
_LOGGER.debug(
"Migration to version %s.%s successful",
config_entry.version,
config_entry.minor_version,
)
return True
async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
"""Handle an Trend options update."""
await hass.config_entries.async_reload(entry.entry_id)

20
homeassistant/components/trend/binary_sensor.py
View File

@ -33,8 +33,8 @@ from homeassistant.const import (
STATE_UNKNOWN,
)
from homeassistant.core import Event, EventStateChangedData, HomeAssistant, callback
from homeassistant.helpers import config_validation as cv, device_registry as dr
from homeassistant.helpers.device import async_device_info_to_link_from_entity
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.device import async_entity_id_to_device
from homeassistant.helpers.entity import generate_entity_id
from homeassistant.helpers.entity_platform import (
AddConfigEntryEntitiesCallback,
@ -114,6 +114,7 @@ async def async_setup_platform(
for sensor_name, sensor_config in config[CONF_SENSORS].items():
entities.append(
SensorTrend(
hass,
name=sensor_config.get(CONF_FRIENDLY_NAME, sensor_name),
entity_id=sensor_config[CONF_ENTITY_ID],
attribute=sensor_config.get(CONF_ATTRIBUTE),
@ -140,14 +141,10 @@ async def async_setup_entry(
) -> None:
"""Set up trend sensor from config entry."""
device_info = async_device_info_to_link_from_entity(
hass,
entry.options[CONF_ENTITY_ID],
)
async_add_entities(
[
SensorTrend(
hass,
name=entry.title,
entity_id=entry.options[CONF_ENTITY_ID],
attribute=entry.options.get(CONF_ATTRIBUTE),
@ -159,7 +156,6 @@ async def async_setup_entry(
min_samples=entry.options.get(CONF_MIN_SAMPLES, DEFAULT_MIN_SAMPLES),
max_samples=entry.options.get(CONF_MAX_SAMPLES, DEFAULT_MAX_SAMPLES),
unique_id=entry.entry_id,
device_info=device_info,
)
]
)
@ -174,6 +170,8 @@ class SensorTrend(BinarySensorEntity, RestoreEntity):
def __init__(
self,
hass: HomeAssistant,
*,
name: str,
entity_id: str,
attribute: str | None,
@ -185,7 +183,6 @@ class SensorTrend(BinarySensorEntity, RestoreEntity):
unique_id: str | None = None,
device_class: BinarySensorDeviceClass | None = None,
sensor_entity_id: str | None = None,
device_info: dr.DeviceInfo | None = None,
) -> None:
"""Initialize the sensor."""
self._entity_id = entity_id
@ -199,7 +196,10 @@ class SensorTrend(BinarySensorEntity, RestoreEntity):
self._attr_name = name
self._attr_device_class = device_class
self._attr_unique_id = unique_id
self._attr_device_info = device_info
self.device_entry = async_entity_id_to_device(
hass,
entity_id,
)
if sensor_entity_id:
self.entity_id = sensor_entity_id

2
homeassistant/components/trend/config_flow.py
View File

@ -101,6 +101,8 @@ CONFIG_SCHEMA = vol.Schema(
class ConfigFlowHandler(SchemaConfigFlowHandler, domain=DOMAIN):
"""Handle a config or options flow for Trend."""
MINOR_VERSION = 2
config_flow = {
"user": SchemaFlowFormStep(schema=CONFIG_SCHEMA, next_step="settings"),
"settings": SchemaFlowFormStep(get_base_options_schema),

156
tests/components/trend/test_init.py
View File

@ -8,7 +8,7 @@ from homeassistant.components import trend
from homeassistant.components.trend.config_flow import ConfigFlowHandler
from homeassistant.components.trend.const import DOMAIN
from homeassistant.config_entries import ConfigEntry, ConfigEntryState
from homeassistant.core import Event, HomeAssistant
from homeassistant.core import Event, HomeAssistant, callback
from homeassistant.helpers import device_registry as dr, entity_registry as er
from homeassistant.helpers.event import async_track_entity_registry_updated_event
@ -81,6 +81,7 @@ def track_entity_registry_actions(hass: HomeAssistant, entity_id: str) -> list[s
"""Track entity registry actions for an entity."""
events = []
@callback
def add_event(event: Event[er.EventEntityRegistryUpdatedData]) -> None:
"""Add entity registry updated event to the list."""
events.append(event.data["action"])
@ -199,7 +200,7 @@ async def test_device_cleaning(
devices_before_reload = device_registry.devices.get_devices_for_config_entry_id(
trend_config_entry.entry_id
)
assert len(devices_before_reload) == 3
assert len(devices_before_reload) == 2
# Config entry reload
await hass.config_entries.async_reload(trend_config_entry.entry_id)
@ -214,7 +215,7 @@ async def test_device_cleaning(
devices_after_reload = device_registry.devices.get_devices_for_config_entry_id(
trend_config_entry.entry_id
)
assert len(devices_after_reload) == 1
assert len(devices_after_reload) == 0
async def test_async_handle_source_entity_changes_source_entity_removed(
@ -225,6 +226,53 @@ async def test_async_handle_source_entity_changes_source_entity_removed(
sensor_config_entry: ConfigEntry,
sensor_device: dr.DeviceEntry,
sensor_entity_entry: er.RegistryEntry,
) -> None:
"""Test the trend config entry is removed when the source entity is removed."""
assert await hass.config_entries.async_setup(trend_config_entry.entry_id)
await hass.async_block_till_done()
trend_entity_entry = entity_registry.async_get("binary_sensor.my_trend")
assert trend_entity_entry.device_id == sensor_entity_entry.device_id
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id not in sensor_device.config_entries
events = track_entity_registry_actions(hass, trend_entity_entry.entity_id)
# Remove the source sensor's config entry from the device, this removes the
# source sensor
with patch(
"homeassistant.components.trend.async_unload_entry",
wraps=trend.async_unload_entry,
) as mock_unload_entry:
device_registry.async_update_device(
sensor_device.id, remove_config_entry_id=sensor_config_entry.entry_id
)
await hass.async_block_till_done()
await hass.async_block_till_done()
mock_unload_entry.assert_called_once()
# Check that the helper entity is removed
assert not entity_registry.async_get("binary_sensor.my_trend")
# Check that the device is removed
assert not device_registry.async_get(sensor_device.id)
# Check that the trend config entry is removed
assert trend_config_entry.entry_id not in hass.config_entries.async_entry_ids()
# Check we got the expected events
assert events == ["remove"]
async def test_async_handle_source_entity_changes_source_entity_removed_shared_device(
hass: HomeAssistant,
device_registry: dr.DeviceRegistry,
entity_registry: er.EntityRegistry,
trend_config_entry: MockConfigEntry,
sensor_config_entry: ConfigEntry,
sensor_device: dr.DeviceEntry,
sensor_entity_entry: er.RegistryEntry,
) -> None:
"""Test the trend config entry is removed when the source entity is removed."""
# Add another config entry to the sensor device
@ -241,7 +289,7 @@ async def test_async_handle_source_entity_changes_source_entity_removed(
assert trend_entity_entry.device_id == sensor_entity_entry.device_id
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id in sensor_device.config_entries
assert trend_config_entry.entry_id not in sensor_device.config_entries
events = track_entity_registry_actions(hass, trend_entity_entry.entity_id)
@ -258,7 +306,10 @@ async def test_async_handle_source_entity_changes_source_entity_removed(
await hass.async_block_till_done()
mock_unload_entry.assert_called_once()
# Check that the trend config entry is removed from the device
# Check that the helper entity is removed
assert not entity_registry.async_get("binary_sensor.my_trend")
# Check that the trend config entry is not in the device
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id not in sensor_device.config_entries
@ -285,7 +336,7 @@ async def test_async_handle_source_entity_changes_source_entity_removed_from_dev
assert trend_entity_entry.device_id == sensor_entity_entry.device_id
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id in sensor_device.config_entries
assert trend_config_entry.entry_id not in sensor_device.config_entries
events = track_entity_registry_actions(hass, trend_entity_entry.entity_id)
@ -300,7 +351,11 @@ async def test_async_handle_source_entity_changes_source_entity_removed_from_dev
await hass.async_block_till_done()
mock_unload_entry.assert_called_once()
# Check that the trend config entry is removed from the device
# Check that the entity is no longer linked to the source device
trend_entity_entry = entity_registry.async_get("binary_sensor.my_trend")
assert trend_entity_entry.device_id is None
# Check that the trend config entry is not in the device
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id not in sensor_device.config_entries
@ -333,7 +388,7 @@ async def test_async_handle_source_entity_changes_source_entity_moved_other_devi
assert trend_entity_entry.device_id == sensor_entity_entry.device_id
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id in sensor_device.config_entries
assert trend_config_entry.entry_id not in sensor_device.config_entries
sensor_device_2 = device_registry.async_get(sensor_device_2.id)
assert trend_config_entry.entry_id not in sensor_device_2.config_entries
@ -350,11 +405,15 @@ async def test_async_handle_source_entity_changes_source_entity_moved_other_devi
await hass.async_block_till_done()
mock_unload_entry.assert_called_once()
# Check that the trend config entry is moved to the other device
# Check that the entity is linked to the other device
trend_entity_entry = entity_registry.async_get("binary_sensor.my_trend")
assert trend_entity_entry.device_id == sensor_device_2.id
# Check that the trend config entry is not in any of the devices
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id not in sensor_device.config_entries
sensor_device_2 = device_registry.async_get(sensor_device_2.id)
assert trend_config_entry.entry_id in sensor_device_2.config_entries
assert trend_config_entry.entry_id not in sensor_device_2.config_entries
# Check that the trend config entry is not removed
assert trend_config_entry.entry_id in hass.config_entries.async_entry_ids()
@ -379,7 +438,7 @@ async def test_async_handle_source_entity_new_entity_id(
assert trend_entity_entry.device_id == sensor_entity_entry.device_id
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id in sensor_device.config_entries
assert trend_config_entry.entry_id not in sensor_device.config_entries
events = track_entity_registry_actions(hass, trend_entity_entry.entity_id)
@ -397,12 +456,83 @@ async def test_async_handle_source_entity_new_entity_id(
# Check that the trend config entry is updated with the new entity ID
assert trend_config_entry.options["entity_id"] == "sensor.new_entity_id"
# Check that the helper config is still in the device
# Check that the helper config is not in the device
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id in sensor_device.config_entries
assert trend_config_entry.entry_id not in sensor_device.config_entries
# Check that the trend config entry is not removed
assert trend_config_entry.entry_id in hass.config_entries.async_entry_ids()
# Check we got the expected events
assert events == []
async def test_migration_1_1(
hass: HomeAssistant,
device_registry: dr.DeviceRegistry,
entity_registry: er.EntityRegistry,
sensor_entity_entry: er.RegistryEntry,
sensor_device: dr.DeviceEntry,
) -> None:
"""Test migration from v1.1 removes trend config entry from device."""
trend_config_entry = MockConfigEntry(
data={},
domain=DOMAIN,
options={
"name": "My trend",
"entity_id": sensor_entity_entry.entity_id,
"invert": False,
},
title="My trend",
version=1,
minor_version=1,
)
trend_config_entry.add_to_hass(hass)
# Add the helper config entry to the device
device_registry.async_update_device(
sensor_device.id, add_config_entry_id=trend_config_entry.entry_id
)
# Check preconditions
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id in sensor_device.config_entries
await hass.config_entries.async_setup(trend_config_entry.entry_id)
await hass.async_block_till_done()
assert trend_config_entry.state is ConfigEntryState.LOADED
# Check that the helper config entry is removed from the device and the helper
# entity is linked to the source device
sensor_device = device_registry.async_get(sensor_device.id)
assert trend_config_entry.entry_id not in sensor_device.config_entries
trend_entity_entry = entity_registry.async_get("binary_sensor.my_trend")
assert trend_entity_entry.device_id == sensor_entity_entry.device_id
assert trend_config_entry.version == 1
assert trend_config_entry.minor_version == 2
async def test_migration_from_future_version(
hass: HomeAssistant,
) -> None:
"""Test migration from future version."""
config_entry = MockConfigEntry(
data={},
domain=DOMAIN,
options={
"name": "My trend",
"entity_id": "sensor.test",
"invert": False,
},
title="My trend",
version=2,
minor_version=1,
)
config_entry.add_to_hass(hass)
await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.state is ConfigEntryState.MIGRATION_ERROR