Handle changes to source entity in utility_meter (#146526)

homeassistant/components/utility_meter/__init__.py

@@ -17,9 +17,11 @@ from homeassistant.helpers import (
     entity_registry as er,
 )
 from homeassistant.helpers.device import (
+    async_entity_id_to_device_id,
     async_remove_stale_devices_links_keep_entity_device,
 )
 from homeassistant.helpers.dispatcher import async_dispatcher_send
+from homeassistant.helpers.helper_integration import async_handle_source_entity_changes
 from homeassistant.helpers.typing import ConfigType
 
 from .const import (
@@ -217,6 +219,29 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         )
         return False
 
+    def set_source_entity_id_or_uuid(source_entity_id: str) -> None:
+        hass.config_entries.async_update_entry(
+            entry,
+            options={**entry.options, CONF_SOURCE_SENSOR: source_entity_id},
+        )
+
+    async def source_entity_removed() -> None:
+        # The source entity has been removed, we need to clean the device links.
+        async_remove_stale_devices_links_keep_entity_device(hass, entry.entry_id, None)
+
+    entry.async_on_unload(
+        async_handle_source_entity_changes(
+            hass,
+            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(
+                hass, entry.options[CONF_SOURCE_SENSOR]
+            ),
+            source_entity_id_or_uuid=entry.options[CONF_SOURCE_SENSOR],
+            source_entity_removed=source_entity_removed,
+        )
+    )
+
     if not entry.options.get(CONF_TARIFFS):
         # Only a single meter sensor is required
         hass.data[DATA_UTILITY][entry.entry_id][CONF_TARIFF_ENTITY] = None

tests/components/utility_meter/test_init.py

@@ -3,10 +3,12 @@
 from __future__ import annotations
 
 from datetime import timedelta
+from unittest.mock import patch
 
 from freezegun import freeze_time
 import pytest
 
+from homeassistant.components import utility_meter
 from homeassistant.components.select import (
     ATTR_OPTION,
     DOMAIN as SELECT_DOMAIN,
@@ -16,7 +18,9 @@ from homeassistant.components.utility_meter import (
     select as um_select,
     sensor as um_sensor,
 )
+from homeassistant.components.utility_meter.config_flow import ConfigFlowHandler
 from homeassistant.components.utility_meter.const import DOMAIN, SERVICE_RESET
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     ATTR_ENTITY_ID,
     ATTR_UNIT_OF_MEASUREMENT,
@@ -25,14 +29,94 @@ from homeassistant.const import (
     Platform,
     UnitOfEnergy,
 )
-from homeassistant.core import HomeAssistant, State
+from homeassistant.core import Event, HomeAssistant, State
 from homeassistant.helpers import device_registry as dr, entity_registry as er
+from homeassistant.helpers.event import async_track_entity_registry_updated_event
 from homeassistant.setup import async_setup_component
 from homeassistant.util import dt as dt_util
 
 from tests.common import MockConfigEntry, mock_restore_cache
 
 
+@pytest.fixture
+def sensor_config_entry(hass: HomeAssistant) -> er.RegistryEntry:
+    """Fixture to create a sensor config entry."""
+    sensor_config_entry = MockConfigEntry()
+    sensor_config_entry.add_to_hass(hass)
+    return sensor_config_entry
+
+
+@pytest.fixture
+def sensor_device(
+    device_registry: dr.DeviceRegistry, sensor_config_entry: ConfigEntry
+) -> dr.DeviceEntry:
+    """Fixture to create a sensor device."""
+    return device_registry.async_get_or_create(
+        config_entry_id=sensor_config_entry.entry_id,
+        connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
+    )
+
+
+@pytest.fixture
+def sensor_entity_entry(
+    entity_registry: er.EntityRegistry,
+    sensor_config_entry: ConfigEntry,
+    sensor_device: dr.DeviceEntry,
+) -> er.RegistryEntry:
+    """Fixture to create a sensor entity entry."""
+    return entity_registry.async_get_or_create(
+        "sensor",
+        "test",
+        "unique",
+        config_entry=sensor_config_entry,
+        device_id=sensor_device.id,
+        original_name="ABC",
+    )
+
+
+@pytest.fixture
+def utility_meter_config_entry(
+    hass: HomeAssistant,
+    sensor_entity_entry: er.RegistryEntry,
+    tariffs: list[str],
+) -> MockConfigEntry:
+    """Fixture to create a utility_meter config entry."""
+    config_entry = MockConfigEntry(
+        data={},
+        domain=DOMAIN,
+        options={
+            "cycle": "monthly",
+            "delta_values": False,
+            "name": "My utility meter",
+            "net_consumption": False,
+            "offset": 0,
+            "periodically_resetting": True,
+            "source": sensor_entity_entry.entity_id,
+            "tariffs": tariffs,
+        },
+        title="My utility meter",
+        version=ConfigFlowHandler.VERSION,
+        minor_version=ConfigFlowHandler.MINOR_VERSION,
+    )
+
+    config_entry.add_to_hass(hass)
+
+    return config_entry
+
+
+def track_entity_registry_actions(hass: HomeAssistant, entity_id: str) -> list[str]:
+    """Track entity registry actions for an entity."""
+    events = []
+
+    def add_event(event: Event[er.EventEntityRegistryUpdatedData]) -> None:
+        """Add entity registry updated event to the list."""
+        events.append(event.data["action"])
+
+    async_track_entity_registry_updated_event(hass, entity_id, add_event)
+
+    return events
+
+
 async def test_restore_state(hass: HomeAssistant) -> None:
     """Test utility sensor restore state."""
     config = {
@@ -533,3 +617,286 @@ async def test_device_cleaning(
         utility_meter_config_entry.entry_id
     )
     assert len(devices_after_reload) == 1
+
+
+@pytest.mark.parametrize(
+    ("tariffs", "expected_entities"),
+    [
+        ([], {"sensor.my_utility_meter"}),
+        (
+            ["peak", "offpeak"],
+            {
+                "select.my_utility_meter",
+                "sensor.my_utility_meter_offpeak",
+                "sensor.my_utility_meter_peak",
+            },
+        ),
+    ],
+)
+async def test_async_handle_source_entity_changes_source_entity_removed(
+    hass: HomeAssistant,
+    device_registry: dr.DeviceRegistry,
+    entity_registry: er.EntityRegistry,
+    utility_meter_config_entry: MockConfigEntry,
+    sensor_config_entry: ConfigEntry,
+    sensor_device: dr.DeviceEntry,
+    sensor_entity_entry: er.RegistryEntry,
+    expected_entities: set[str],
+) -> None:
+    """Test the utility_meter config entry is removed when the source entity is removed."""
+    # Add another config entry to the sensor device
+    other_config_entry = MockConfigEntry()
+    other_config_entry.add_to_hass(hass)
+    device_registry.async_update_device(
+        sensor_device.id, add_config_entry_id=other_config_entry.entry_id
+    )
+
+    assert await hass.config_entries.async_setup(utility_meter_config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    events = {}
+    for (
+        utility_meter_entity
+    ) in entity_registry.entities.get_entries_for_config_entry_id(
+        utility_meter_config_entry.entry_id
+    ):
+        assert utility_meter_entity.device_id == sensor_entity_entry.device_id
+        events[utility_meter_entity.entity_id] = track_entity_registry_actions(
+            hass, utility_meter_entity.entity_id
+        )
+    assert set(events) == expected_entities
+
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id in sensor_device.config_entries
+
+    # Remove the source sensor's config entry from the device, this removes the
+    # source sensor
+    with patch(
+        "homeassistant.components.utility_meter.async_unload_entry",
+        wraps=utility_meter.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_not_called()
+
+    # Check that the utility_meter config entry is removed from the device
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id not in sensor_device.config_entries
+
+    # Check that the utility_meter config entry is not removed
+    assert utility_meter_config_entry.entry_id in hass.config_entries.async_entry_ids()
+
+    # Check we got the expected events
+    for entity_events in events.values():
+        assert entity_events == ["update"]
+
+
+@pytest.mark.parametrize(
+    ("tariffs", "expected_entities"),
+    [
+        ([], {"sensor.my_utility_meter"}),
+        (
+            ["peak", "offpeak"],
+            {
+                "select.my_utility_meter",
+                "sensor.my_utility_meter_offpeak",
+                "sensor.my_utility_meter_peak",
+            },
+        ),
+    ],
+)
+async def test_async_handle_source_entity_changes_source_entity_removed_from_device(
+    hass: HomeAssistant,
+    device_registry: dr.DeviceRegistry,
+    entity_registry: er.EntityRegistry,
+    utility_meter_config_entry: MockConfigEntry,
+    sensor_device: dr.DeviceEntry,
+    sensor_entity_entry: er.RegistryEntry,
+    expected_entities: set[str],
+) -> None:
+    """Test the source entity removed from the source device."""
+    assert await hass.config_entries.async_setup(utility_meter_config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    events = {}
+    for (
+        utility_meter_entity
+    ) in entity_registry.entities.get_entries_for_config_entry_id(
+        utility_meter_config_entry.entry_id
+    ):
+        assert utility_meter_entity.device_id == sensor_entity_entry.device_id
+        events[utility_meter_entity.entity_id] = track_entity_registry_actions(
+            hass, utility_meter_entity.entity_id
+        )
+    assert set(events) == expected_entities
+
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id in sensor_device.config_entries
+
+    # Remove the source sensor from the device
+    with patch(
+        "homeassistant.components.utility_meter.async_unload_entry",
+        wraps=utility_meter.async_unload_entry,
+    ) as mock_unload_entry:
+        entity_registry.async_update_entity(
+            sensor_entity_entry.entity_id, device_id=None
+        )
+        await hass.async_block_till_done()
+    mock_unload_entry.assert_called_once()
+
+    # Check that the utility_meter config entry is removed from the device
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id not in sensor_device.config_entries
+
+    # Check that the utility_meter config entry is not removed
+    assert utility_meter_config_entry.entry_id in hass.config_entries.async_entry_ids()
+
+    # Check we got the expected events
+    for entity_events in events.values():
+        assert entity_events == ["update"]
+
+
+@pytest.mark.parametrize(
+    ("tariffs", "expected_entities"),
+    [
+        ([], {"sensor.my_utility_meter"}),
+        (
+            ["peak", "offpeak"],
+            {
+                "select.my_utility_meter",
+                "sensor.my_utility_meter_offpeak",
+                "sensor.my_utility_meter_peak",
+            },
+        ),
+    ],
+)
+async def test_async_handle_source_entity_changes_source_entity_moved_other_device(
+    hass: HomeAssistant,
+    device_registry: dr.DeviceRegistry,
+    entity_registry: er.EntityRegistry,
+    utility_meter_config_entry: MockConfigEntry,
+    sensor_config_entry: ConfigEntry,
+    sensor_device: dr.DeviceEntry,
+    sensor_entity_entry: er.RegistryEntry,
+    expected_entities: set[str],
+) -> None:
+    """Test the source entity is moved to another device."""
+    sensor_device_2 = device_registry.async_get_or_create(
+        config_entry_id=sensor_config_entry.entry_id,
+        connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:FF")},
+    )
+
+    assert await hass.config_entries.async_setup(utility_meter_config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    events = {}
+    for (
+        utility_meter_entity
+    ) in entity_registry.entities.get_entries_for_config_entry_id(
+        utility_meter_config_entry.entry_id
+    ):
+        assert utility_meter_entity.device_id == sensor_entity_entry.device_id
+        events[utility_meter_entity.entity_id] = track_entity_registry_actions(
+            hass, utility_meter_entity.entity_id
+        )
+    assert set(events) == expected_entities
+
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id in sensor_device.config_entries
+    sensor_device_2 = device_registry.async_get(sensor_device_2.id)
+    assert utility_meter_config_entry.entry_id not in sensor_device_2.config_entries
+
+    # Move the source sensor to another device
+    with patch(
+        "homeassistant.components.utility_meter.async_unload_entry",
+        wraps=utility_meter.async_unload_entry,
+    ) as mock_unload_entry:
+        entity_registry.async_update_entity(
+            sensor_entity_entry.entity_id, device_id=sensor_device_2.id
+        )
+        await hass.async_block_till_done()
+    mock_unload_entry.assert_called_once()
+
+    # Check that the utility_meter config entry is moved to the other device
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id not in sensor_device.config_entries
+    sensor_device_2 = device_registry.async_get(sensor_device_2.id)
+    assert utility_meter_config_entry.entry_id in sensor_device_2.config_entries
+
+    # Check that the utility_meter config entry is not removed
+    assert utility_meter_config_entry.entry_id in hass.config_entries.async_entry_ids()
+
+    # Check we got the expected events
+    for entity_events in events.values():
+        assert entity_events == ["update"]
+
+
+@pytest.mark.parametrize(
+    ("tariffs", "expected_entities"),
+    [
+        ([], {"sensor.my_utility_meter"}),
+        (
+            ["peak", "offpeak"],
+            {
+                "select.my_utility_meter",
+                "sensor.my_utility_meter_offpeak",
+                "sensor.my_utility_meter_peak",
+            },
+        ),
+    ],
+)
+async def test_async_handle_source_entity_new_entity_id(
+    hass: HomeAssistant,
+    device_registry: dr.DeviceRegistry,
+    entity_registry: er.EntityRegistry,
+    utility_meter_config_entry: MockConfigEntry,
+    sensor_device: dr.DeviceEntry,
+    sensor_entity_entry: er.RegistryEntry,
+    expected_entities: set[str],
+) -> None:
+    """Test the source entity's entity ID is changed."""
+    assert await hass.config_entries.async_setup(utility_meter_config_entry.entry_id)
+    await hass.async_block_till_done()
+
+    events = {}
+    for (
+        utility_meter_entity
+    ) in entity_registry.entities.get_entries_for_config_entry_id(
+        utility_meter_config_entry.entry_id
+    ):
+        assert utility_meter_entity.device_id == sensor_entity_entry.device_id
+        events[utility_meter_entity.entity_id] = track_entity_registry_actions(
+            hass, utility_meter_entity.entity_id
+        )
+    assert set(events) == expected_entities
+
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id in sensor_device.config_entries
+
+    # Change the source entity's entity ID
+    with patch(
+        "homeassistant.components.utility_meter.async_unload_entry",
+        wraps=utility_meter.async_unload_entry,
+    ) as mock_unload_entry:
+        entity_registry.async_update_entity(
+            sensor_entity_entry.entity_id, new_entity_id="sensor.new_entity_id"
+        )
+        await hass.async_block_till_done()
+    mock_unload_entry.assert_called_once()
+
+    # Check that the utility_meter config entry is updated with the new entity ID
+    assert utility_meter_config_entry.options["source"] == "sensor.new_entity_id"
+
+    # Check that the helper config is still in the device
+    sensor_device = device_registry.async_get(sensor_device.id)
+    assert utility_meter_config_entry.entry_id in sensor_device.config_entries
+
+    # Check that the utility_meter config entry is not removed
+    assert utility_meter_config_entry.entry_id in hass.config_entries.async_entry_ids()
+
+    # Check we got the expected events
+    for entity_events in events.values():
+        assert entity_events == []