Update links between config entry and device on sensor change in integral (#119213)

This commit is contained in:
Joakim Plate 2024-06-09 18:26:33 +02:00 committed by GitHub
parent 09ba9547ed
commit 30e11ed068
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 72 additions and 1 deletions

View File

@ -5,6 +5,7 @@ from __future__ import annotations
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
@ -16,6 +17,16 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
async def config_entry_update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
"""Update listener, called when the config entry options are changed."""
# Remove device link for entry, the source device may have changed.
# The link will be recreated after load.
device_registry = dr.async_get(hass)
devices = device_registry.devices.get_devices_for_config_entry_id(entry.entry_id)
for device in devices:
device_registry.async_update_device(
device.id, remove_config_entry_id=entry.entry_id
)
await hass.config_entries.async_reload(entry.entry_id)

View File

@ -4,7 +4,7 @@ import pytest
from homeassistant.components.integration.const import DOMAIN
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from homeassistant.helpers import device_registry as dr, entity_registry as er
from tests.common import MockConfigEntry
@ -61,3 +61,63 @@ async def test_setup_and_remove_config_entry(
# Check the state and entity registry entry are removed
assert hass.states.get(integration_entity_id) is None
assert entity_registry.async_get(integration_entity_id) is None
@pytest.mark.parametrize("platform", ["sensor"])
async def test_entry_changed(hass: HomeAssistant, platform) -> None:
"""Test reconfiguring."""
device_registry = dr.async_get(hass)
entity_registry = er.async_get(hass)
def _create_mock_entity(domain: str, name: str) -> er.RegistryEntry:
config_entry = MockConfigEntry(
data={},
domain="test",
title=f"{name}",
)
config_entry.add_to_hass(hass)
device_entry = device_registry.async_get_or_create(
identifiers={("test", name)}, config_entry_id=config_entry.entry_id
)
return entity_registry.async_get_or_create(
domain, "test", name, suggested_object_id=name, device_id=device_entry.id
)
def _get_device_config_entries(entry: er.RegistryEntry) -> set[str]:
assert entry.device_id
device = device_registry.async_get(entry.device_id)
assert device
return device.config_entries
# Set up entities, with backing devices and config entries
input_entry = _create_mock_entity("sensor", "input")
valid_entry = _create_mock_entity("sensor", "valid")
# Setup the config entry
config_entry = MockConfigEntry(
data={},
domain=DOMAIN,
options={
"method": "left",
"name": "My integration",
"source": "sensor.input",
"unit_time": "min",
},
title="My integration",
)
config_entry.add_to_hass(hass)
assert await hass.config_entries.async_setup(config_entry.entry_id)
await hass.async_block_till_done()
assert config_entry.entry_id in _get_device_config_entries(input_entry)
assert config_entry.entry_id not in _get_device_config_entries(valid_entry)
hass.config_entries.async_update_entry(
config_entry, options={**config_entry.options, "source": "sensor.valid"}
)
await hass.async_block_till_done()
# Check that the config entry association has updated
assert config_entry.entry_id not in _get_device_config_entries(input_entry)
assert config_entry.entry_id in _get_device_config_entries(valid_entry)