Improve entity registry tests related to config entries in devices (#148399)

Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
This commit is contained in:
Erik Montnemery 2025-07-08 16:24:06 +02:00 committed by GitHub
parent ae7bc14059
commit aab8908af8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1640,6 +1640,8 @@ async def test_remove_config_entry_from_device_removes_entities_2(
config_entry_1.add_to_hass(hass)
config_entry_2 = MockConfigEntry(domain="device_tracker")
config_entry_2.add_to_hass(hass)
config_entry_3 = MockConfigEntry(domain="some_helper")
config_entry_3.add_to_hass(hass)
# Create device with two config entries
device_registry.async_get_or_create(
@ -1662,8 +1664,18 @@ async def test_remove_config_entry_from_device_removes_entities_2(
"5678",
device_id=device_entry.id,
)
# Create an entity with a config entry not in the device
entry_2 = entity_registry.async_get_or_create(
"light",
"some_helper",
"5678",
config_entry=config_entry_3,
device_id=device_entry.id,
)
assert entry_1.entity_id != entry_2.entity_id
assert entity_registry.async_is_registered(entry_1.entity_id)
assert entity_registry.async_is_registered(entry_2.entity_id)
# Remove the first config entry from the device
device_registry.async_update_device(
@ -1673,6 +1685,19 @@ async def test_remove_config_entry_from_device_removes_entities_2(
assert device_registry.async_get(device_entry.id)
assert entity_registry.async_is_registered(entry_1.entity_id)
# Entities with a config entry not in the device are removed
assert not entity_registry.async_is_registered(entry_2.entity_id)
# Remove the second config entry from the device
device_registry.async_update_device(
device_entry.id, remove_config_entry_id=config_entry_2.entry_id
)
await hass.async_block_till_done()
assert not device_registry.async_get(device_entry.id)
# The device is removed, both entities are now removed
assert not entity_registry.async_is_registered(entry_1.entity_id)
assert not entity_registry.async_is_registered(entry_2.entity_id)
async def test_remove_config_subentry_from_device_removes_entities(
@ -1797,10 +1822,19 @@ async def test_remove_config_subentry_from_device_removes_entities(
assert not entity_registry.async_is_registered(entry_3.entity_id)
@pytest.mark.parametrize(
("subentries_in_device", "subentry_in_entity"),
[
(["mock-subentry-id-1", "mock-subentry-id-2"], None),
([None, "mock-subentry-id-2"], "mock-subentry-id-1"),
],
)
async def test_remove_config_subentry_from_device_removes_entities_2(
hass: HomeAssistant,
device_registry: dr.DeviceRegistry,
entity_registry: er.EntityRegistry,
subentries_in_device: list[str | None],
subentry_in_entity: str | None,
) -> None:
"""Test that we don't remove entities with no config entry when device is modified."""
config_entry_1 = MockConfigEntry(
@ -1820,28 +1854,31 @@ async def test_remove_config_subentry_from_device_removes_entities_2(
title="Mock title",
unique_id="test",
),
config_entries.ConfigSubentryData(
data={},
subentry_id="mock-subentry-id-3",
subentry_type="test",
title="Mock title",
unique_id="test",
),
],
)
config_entry_1.add_to_hass(hass)
# Create device with three config subentries
# Create device with two config subentries
device_registry.async_get_or_create(
config_entry_id=config_entry_1.entry_id,
config_subentry_id="mock-subentry-id-1",
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
)
device_registry.async_get_or_create(
config_entry_id=config_entry_1.entry_id,
config_subentry_id="mock-subentry-id-2",
config_subentry_id=subentries_in_device[0],
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
)
device_entry = device_registry.async_get_or_create(
config_entry_id=config_entry_1.entry_id,
config_subentry_id=subentries_in_device[1],
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
)
assert device_entry.config_entries == {config_entry_1.entry_id}
assert device_entry.config_entries_subentries == {
config_entry_1.entry_id: {None, "mock-subentry-id-1", "mock-subentry-id-2"},
config_entry_1.entry_id: set(subentries_in_device),
}
# Create an entity without config entry or subentry
@ -1851,30 +1888,57 @@ async def test_remove_config_subentry_from_device_removes_entities_2(
"5678",
device_id=device_entry.id,
)
# Create an entity for same config entry but subentry not in device
entry_2 = entity_registry.async_get_or_create(
"light",
"some_helper",
"5678",
config_entry=config_entry_1,
config_subentry_id=subentry_in_entity,
device_id=device_entry.id,
)
# Create an entity for same config entry but subentry not in device
entry_3 = entity_registry.async_get_or_create(
"light",
"some_helper",
"abcd",
config_entry=config_entry_1,
config_subentry_id="mock-subentry-id-3",
device_id=device_entry.id,
)
assert len({entry_1.entity_id, entry_2.entity_id, entry_3.entity_id}) == 3
assert entity_registry.async_is_registered(entry_1.entity_id)
assert entity_registry.async_is_registered(entry_2.entity_id)
assert entity_registry.async_is_registered(entry_3.entity_id)
# Remove the first config subentry from the device
device_registry.async_update_device(
device_entry.id,
remove_config_entry_id=config_entry_1.entry_id,
remove_config_subentry_id=None,
remove_config_subentry_id=subentries_in_device[0],
)
await hass.async_block_till_done()
assert device_registry.async_get(device_entry.id)
assert entity_registry.async_is_registered(entry_1.entity_id)
# Entities with a config subentry not in the device are removed
assert not entity_registry.async_is_registered(entry_2.entity_id)
assert not entity_registry.async_is_registered(entry_3.entity_id)
# Remove the second config subentry from the device
device_registry.async_update_device(
device_entry.id,
remove_config_entry_id=config_entry_1.entry_id,
remove_config_subentry_id="mock-subentry-id-1",
remove_config_subentry_id=subentries_in_device[1],
)
await hass.async_block_till_done()
assert device_registry.async_get(device_entry.id)
assert entity_registry.async_is_registered(entry_1.entity_id)
assert not device_registry.async_get(device_entry.id)
# All entities are now removed
assert not entity_registry.async_is_registered(entry_1.entity_id)
assert not entity_registry.async_is_registered(entry_2.entity_id)
assert not entity_registry.async_is_registered(entry_3.entity_id)
async def test_update_device_race(