mirror of
https://github.com/home-assistant/core.git
synced 2026-08-06 13:26:29 +01:00
Erik Montnemery
758 lines
25 KiB
Python
758 lines
25 KiB
Python
"""Test device_registry API."""
|
|
|
|
from datetime import datetime
|
|
from typing import Any
|
|
|
|
from freezegun.api import FrozenDateTimeFactory
|
|
import pytest
|
|
from pytest_unordered import unordered
|
|
|
|
from homeassistant.components.config import DOMAIN, device_registry
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import device_registry as dr
|
|
from homeassistant.setup import async_setup_component
|
|
from homeassistant.util.dt import utcnow
|
|
|
|
from tests.common import MockConfigEntry, MockModule, mock_integration
|
|
from tests.typing import MockHAClientWebSocket, WebSocketGenerator
|
|
|
|
|
|
@pytest.fixture(name="client")
|
|
async def client_fixture(
|
|
hass: HomeAssistant, hass_ws_client: WebSocketGenerator
|
|
) -> MockHAClientWebSocket:
|
|
"""Fixture that can interact with the config manager API."""
|
|
device_registry.async_setup(hass)
|
|
return await hass_ws_client(hass)
|
|
|
|
|
|
@pytest.mark.usefixtures("freezer")
|
|
async def test_list_devices(
|
|
hass: HomeAssistant,
|
|
client: MockHAClientWebSocket,
|
|
device_registry: dr.DeviceRegistry,
|
|
) -> None:
|
|
"""Test list entries."""
|
|
entry = MockConfigEntry(title=None)
|
|
entry.add_to_hass(hass)
|
|
device1 = device_registry.async_get_or_create(
|
|
config_entry_id=entry.entry_id,
|
|
connections={("ethernet", "12:34:56:78:90:AB:CD:EF")},
|
|
identifiers={("bridgeid", "0123")},
|
|
manufacturer="manufacturer",
|
|
model="model",
|
|
)
|
|
device2 = device_registry.async_get_or_create(
|
|
config_entry_id=entry.entry_id,
|
|
identifiers={("bridgeid", "1234")},
|
|
manufacturer="manufacturer",
|
|
model="model",
|
|
via_device=("bridgeid", "0123"),
|
|
entry_type=dr.DeviceEntryType.SERVICE,
|
|
)
|
|
|
|
await client.send_json_auto_id({"type": "config/device_registry/list"})
|
|
msg = await client.receive_json()
|
|
|
|
dev1, _ = (entry.pop("id") for entry in msg["result"])
|
|
|
|
assert msg["result"] == [
|
|
{
|
|
"area_id": None,
|
|
"config_entries": [entry.entry_id],
|
|
"config_entries_subentries": {entry.entry_id: [None]},
|
|
"config_entry_id": entry.entry_id,
|
|
"config_subentry_id": None,
|
|
"configuration_url": None,
|
|
"connections": [["ethernet", "12:34:56:78:90:AB:CD:EF"]],
|
|
"created_at": utcnow().timestamp(),
|
|
"disabled_by": None,
|
|
"entry_type": None,
|
|
"hw_version": None,
|
|
"identifiers": [["bridgeid", "0123"]],
|
|
"labels": [],
|
|
"manufacturer": "manufacturer",
|
|
"model": "model",
|
|
"model_id": None,
|
|
"modified_at": utcnow().timestamp(),
|
|
"name_by_user": None,
|
|
"name": None,
|
|
"primary_config_entry": entry.entry_id,
|
|
"serial_number": None,
|
|
"sw_version": None,
|
|
"via_device_id": None,
|
|
},
|
|
{
|
|
"area_id": None,
|
|
"config_entries": [entry.entry_id],
|
|
"config_entries_subentries": {entry.entry_id: [None]},
|
|
"config_entry_id": entry.entry_id,
|
|
"config_subentry_id": None,
|
|
"configuration_url": None,
|
|
"connections": [],
|
|
"created_at": utcnow().timestamp(),
|
|
"disabled_by": None,
|
|
"entry_type": dr.DeviceEntryType.SERVICE,
|
|
"hw_version": None,
|
|
"identifiers": [["bridgeid", "1234"]],
|
|
"labels": [],
|
|
"manufacturer": "manufacturer",
|
|
"model": "model",
|
|
"model_id": None,
|
|
"modified_at": utcnow().timestamp(),
|
|
"name_by_user": None,
|
|
"name": None,
|
|
"primary_config_entry": entry.entry_id,
|
|
"serial_number": None,
|
|
"sw_version": None,
|
|
"via_device_id": dev1,
|
|
},
|
|
]
|
|
|
|
class Unserializable:
|
|
"""Good luck serializing me."""
|
|
|
|
device_registry.async_update_device(device2.id, name=Unserializable())
|
|
await hass.async_block_till_done()
|
|
|
|
await client.send_json_auto_id({"type": "config/device_registry/list"})
|
|
msg = await client.receive_json()
|
|
|
|
assert msg["result"] == [
|
|
{
|
|
"area_id": None,
|
|
"config_entries": [entry.entry_id],
|
|
"config_entries_subentries": {entry.entry_id: [None]},
|
|
"config_entry_id": entry.entry_id,
|
|
"config_subentry_id": None,
|
|
"configuration_url": None,
|
|
"connections": [["ethernet", "12:34:56:78:90:AB:CD:EF"]],
|
|
"created_at": utcnow().timestamp(),
|
|
"disabled_by": None,
|
|
"entry_type": None,
|
|
"hw_version": None,
|
|
"id": device1.id,
|
|
"identifiers": [["bridgeid", "0123"]],
|
|
"labels": [],
|
|
"manufacturer": "manufacturer",
|
|
"model": "model",
|
|
"model_id": None,
|
|
"modified_at": utcnow().timestamp(),
|
|
"name_by_user": None,
|
|
"name": None,
|
|
"primary_config_entry": entry.entry_id,
|
|
"serial_number": None,
|
|
"sw_version": None,
|
|
"via_device_id": None,
|
|
}
|
|
]
|
|
|
|
# Remove the bad device to avoid errors when test is being torn down
|
|
device_registry.async_remove_device(device2.id)
|
|
|
|
|
|
def _storage_device_v1_12(
|
|
device_id: str,
|
|
config_entries: list[str],
|
|
primary_config_entry: str | None,
|
|
identifier: str,
|
|
) -> dict[str, Any]:
|
|
"""Return a stored device in version 1.12 format."""
|
|
return {
|
|
"area_id": None,
|
|
"config_entries": config_entries,
|
|
"config_entries_subentries": {
|
|
config_entry: [None] for config_entry in config_entries
|
|
},
|
|
"configuration_url": None,
|
|
"connections": [],
|
|
"created_at": "1970-01-01T00:00:00+00:00",
|
|
"disabled_by": None,
|
|
"entry_type": None,
|
|
"hw_version": None,
|
|
"id": device_id,
|
|
"identifiers": [["test", identifier]],
|
|
"labels": [],
|
|
"manufacturer": None,
|
|
"model": None,
|
|
"model_id": None,
|
|
"modified_at": "1970-01-01T00:00:00+00:00",
|
|
"name": None,
|
|
"name_by_user": None,
|
|
"primary_config_entry": primary_config_entry,
|
|
"serial_number": None,
|
|
"sw_version": None,
|
|
"via_device_id": None,
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize("load_registries", [False])
|
|
async def test_list_composite_splits(
|
|
hass: HomeAssistant,
|
|
client: MockHAClientWebSocket,
|
|
hass_storage: dict[str, Any],
|
|
) -> None:
|
|
"""Test listing the devices pre-migration composite devices were split into."""
|
|
entry_1 = MockConfigEntry()
|
|
entry_1.add_to_hass(hass)
|
|
entry_2 = MockConfigEntry()
|
|
entry_2.add_to_hass(hass)
|
|
entry_3 = MockConfigEntry()
|
|
entry_3.add_to_hass(hass)
|
|
|
|
hass_storage[dr.STORAGE_KEY] = {
|
|
"version": 1,
|
|
"minor_version": 12,
|
|
"key": dr.STORAGE_KEY,
|
|
"data": {
|
|
"devices": [
|
|
# Composite spanning two config entries, with entry_1 as primary
|
|
_storage_device_v1_12(
|
|
"compositea000000000000000000000",
|
|
[entry_1.entry_id, entry_2.entry_id],
|
|
entry_1.entry_id,
|
|
"a",
|
|
),
|
|
# Composite spanning two config entries, without a primary
|
|
_storage_device_v1_12(
|
|
"compositeb000000000000000000000",
|
|
[entry_1.entry_id, entry_3.entry_id],
|
|
None,
|
|
"b",
|
|
),
|
|
# Single config entry device, not split
|
|
_storage_device_v1_12(
|
|
"single0000000000000000000000000",
|
|
[entry_1.entry_id],
|
|
entry_1.entry_id,
|
|
"c",
|
|
),
|
|
],
|
|
"deleted_devices": [],
|
|
},
|
|
}
|
|
|
|
dr.async_setup(hass)
|
|
await dr.async_load(hass)
|
|
# pylint: disable-next=home-assistant-tests-registry-fixtures
|
|
registry = dr.async_get(hass)
|
|
|
|
splits_a = registry.async_get_devices_for_composite_device_id(
|
|
"compositea000000000000000000000"
|
|
)
|
|
splits_b = registry.async_get_devices_for_composite_device_id(
|
|
"compositeb000000000000000000000"
|
|
)
|
|
assert len(splits_a) == 2
|
|
assert len(splits_b) == 2
|
|
primary_a = next(
|
|
device for device in splits_a if device.config_entry_id == entry_1.entry_id
|
|
)
|
|
|
|
await client.send_json_auto_id(
|
|
{"type": "config/device_registry/list_composite_splits"}
|
|
)
|
|
msg = await client.receive_json()
|
|
|
|
assert msg["success"]
|
|
assert msg["result"] == {
|
|
"compositea000000000000000000000": {
|
|
"split_ids": unordered([device.id for device in splits_a]),
|
|
"primary_id": primary_a.id,
|
|
},
|
|
"compositeb000000000000000000000": {
|
|
"split_ids": unordered([device.id for device in splits_b]),
|
|
"primary_id": None,
|
|
},
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
("payload_key", "payload_value"),
|
|
[
|
|
("area_id", "12345A"),
|
|
("area_id", None),
|
|
("disabled_by", dr.DeviceEntryDisabler.USER),
|
|
("disabled_by", "user"),
|
|
("disabled_by", None),
|
|
("name_by_user", "Test Friendly Name"),
|
|
("name_by_user", None),
|
|
],
|
|
)
|
|
async def test_update_device(
|
|
hass: HomeAssistant,
|
|
client: MockHAClientWebSocket,
|
|
device_registry: dr.DeviceRegistry,
|
|
freezer: FrozenDateTimeFactory,
|
|
payload_key: str,
|
|
payload_value: str | dr.DeviceEntryDisabler | None,
|
|
) -> None:
|
|
"""Test update entry."""
|
|
entry = MockConfigEntry(title=None)
|
|
entry.add_to_hass(hass)
|
|
created_at = datetime.fromisoformat("2024-07-16T13:30:00.900075+00:00")
|
|
freezer.move_to(created_at)
|
|
device = device_registry.async_get_or_create(
|
|
config_entry_id=entry.entry_id,
|
|
connections={("ethernet", "12:34:56:78:90:AB:CD:EF")},
|
|
identifiers={("bridgeid", "0123")},
|
|
manufacturer="manufacturer",
|
|
model="model",
|
|
)
|
|
|
|
assert not getattr(device, payload_key)
|
|
|
|
modified_at = datetime.fromisoformat("2024-07-16T13:45:00.900075+00:00")
|
|
freezer.move_to(modified_at)
|
|
|
|
await client.send_json_auto_id(
|
|
{
|
|
"type": "config/device_registry/update",
|
|
"device_id": device.id,
|
|
payload_key: payload_value,
|
|
}
|
|
)
|
|
|
|
msg = await client.receive_json()
|
|
await hass.async_block_till_done()
|
|
assert len(device_registry.devices) == 1
|
|
|
|
device = device_registry.async_get_device(
|
|
identifiers={("bridgeid", "0123")},
|
|
connections={("ethernet", "12:34:56:78:90:AB:CD:EF")},
|
|
)
|
|
|
|
assert msg["result"][payload_key] == payload_value
|
|
assert getattr(device, payload_key) == payload_value
|
|
for key, value in (
|
|
("created_at", created_at),
|
|
("modified_at", modified_at if payload_value is not None else created_at),
|
|
):
|
|
assert msg["result"][key] == value.timestamp()
|
|
assert getattr(device, key) == value
|
|
|
|
assert isinstance(device.disabled_by, (dr.DeviceEntryDisabler, type(None)))
|
|
|
|
|
|
async def test_update_device_labels(
|
|
hass: HomeAssistant,
|
|
client: MockHAClientWebSocket,
|
|
device_registry: dr.DeviceRegistry,
|
|
freezer: FrozenDateTimeFactory,
|
|
) -> None:
|
|
"""Test update entry labels."""
|
|
entry = MockConfigEntry(title=None)
|
|
entry.add_to_hass(hass)
|
|
created_at = datetime.fromisoformat("2024-07-16T13:30:00.900075+00:00")
|
|
freezer.move_to(created_at)
|
|
device = device_registry.async_get_or_create(
|
|
config_entry_id=entry.entry_id,
|
|
connections={("ethernet", "12:34:56:78:90:AB:CD:EF")},
|
|
identifiers={("bridgeid", "0123")},
|
|
manufacturer="manufacturer",
|
|
model="model",
|
|
)
|
|
|
|
assert not device.labels
|
|
modified_at = datetime.fromisoformat("2024-07-16T13:45:00.900075+00:00")
|
|
freezer.move_to(modified_at)
|
|
|
|
await client.send_json_auto_id(
|
|
{
|
|
"type": "config/device_registry/update",
|
|
"device_id": device.id,
|
|
"labels": ["label1", "label2"],
|
|
}
|
|
)
|
|
|
|
msg = await client.receive_json()
|
|
await hass.async_block_till_done()
|
|
assert len(device_registry.devices) == 1
|
|
|
|
device = device_registry.async_get_device(
|
|
identifiers={("bridgeid", "0123")},
|
|
connections={("ethernet", "12:34:56:78:90:AB:CD:EF")},
|
|
)
|
|
|
|
assert msg["result"]["labels"] == unordered(["label1", "label2"])
|
|
assert device.labels == {"label1", "label2"}
|
|
for key, value in (
|
|
("created_at", created_at),
|
|
("modified_at", modified_at),
|
|
):
|
|
assert msg["result"][key] == value.timestamp()
|
|
assert getattr(device, key) == value
|
|
|
|
|
|
async def test_remove_config_entry_from_device(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
device_registry: dr.DeviceRegistry,
|
|
) -> None:
|
|
"""Test removing config entry from device."""
|
|
assert await async_setup_component(hass, DOMAIN, {})
|
|
ws_client = await hass_ws_client(hass)
|
|
|
|
can_remove = False
|
|
|
|
async def async_remove_config_entry_device(
|
|
hass: HomeAssistant, config_entry: ConfigEntry, device_entry: dr.DeviceEntry
|
|
) -> bool:
|
|
return can_remove
|
|
|
|
mock_integration(
|
|
hass,
|
|
MockModule(
|
|
"comp1", async_remove_config_entry_device=async_remove_config_entry_device
|
|
),
|
|
)
|
|
mock_integration(
|
|
hass,
|
|
MockModule(
|
|
"comp2", async_remove_config_entry_device=async_remove_config_entry_device
|
|
),
|
|
)
|
|
|
|
entry_1 = MockConfigEntry(
|
|
domain="comp1",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_1.supports_remove_device = True
|
|
entry_1.add_to_hass(hass)
|
|
|
|
entry_2 = MockConfigEntry(
|
|
domain="comp1",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_2.supports_remove_device = True
|
|
entry_2.add_to_hass(hass)
|
|
|
|
device_entry_1 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_1.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
device_entry = device_registry.async_get_or_create(
|
|
config_entry_id=entry_2.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
# Identifiers and connections are unique per config entry, so the two config
|
|
# entries get separate devices even though they share a connection
|
|
assert device_entry_1.id != device_entry.id
|
|
assert device_entry.config_entries == {entry_2.entry_id}
|
|
|
|
# Try removing the config entry from the device, it should fail because
|
|
# async_remove_config_entry_device returns False
|
|
response = await ws_client.remove_device(device_entry.id, entry_2.entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
|
|
# Make async_remove_config_entry_device return True
|
|
can_remove = True
|
|
|
|
# Remove the config entry, this was the device's only config entry so the
|
|
# device is removed
|
|
response = await ws_client.remove_device(device_entry.id, entry_2.entry_id)
|
|
|
|
assert response["success"]
|
|
assert response["result"] is None
|
|
|
|
# This was the only config entry, the device is removed
|
|
assert not device_registry.async_get(device_entry.id)
|
|
|
|
# The device belonging to the other config entry is untouched
|
|
assert device_registry.async_get(device_entry_1.id).config_entries == {
|
|
entry_1.entry_id
|
|
}
|
|
|
|
|
|
async def test_remove_config_entry_from_device_fails(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
device_registry: dr.DeviceRegistry,
|
|
) -> None:
|
|
"""Test removing config entry from device failing cases."""
|
|
assert await async_setup_component(hass, DOMAIN, {})
|
|
ws_client = await hass_ws_client(hass)
|
|
|
|
async def async_remove_config_entry_device(
|
|
hass: HomeAssistant, config_entry: ConfigEntry, device_entry: dr.DeviceEntry
|
|
) -> bool:
|
|
return True
|
|
|
|
mock_integration(
|
|
hass,
|
|
MockModule("comp1"),
|
|
)
|
|
mock_integration(
|
|
hass,
|
|
MockModule(
|
|
"comp2", async_remove_config_entry_device=async_remove_config_entry_device
|
|
),
|
|
)
|
|
|
|
entry_1 = MockConfigEntry(
|
|
domain="comp1",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_1.add_to_hass(hass)
|
|
|
|
entry_2 = MockConfigEntry(
|
|
domain="comp2",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_2.supports_remove_device = True
|
|
entry_2.add_to_hass(hass)
|
|
|
|
entry_3 = MockConfigEntry(
|
|
domain="comp3",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_3.supports_remove_device = True
|
|
entry_3.add_to_hass(hass)
|
|
|
|
device_entry_1 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_1.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
device_entry_2 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_2.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
device_entry_3 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_3.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
# Identifiers and connections are unique per config entry, so each config entry
|
|
# gets its own device even though they share a connection
|
|
assert device_entry_1.config_entries == {entry_1.entry_id}
|
|
assert device_entry_2.config_entries == {entry_2.entry_id}
|
|
assert device_entry_3.config_entries == {entry_3.entry_id}
|
|
|
|
fake_entry_id = "abc123"
|
|
assert entry_1.entry_id != fake_entry_id
|
|
fake_device_id = "abc123"
|
|
assert device_entry_3.id != fake_device_id
|
|
|
|
# Try removing a non existing config entry from the device
|
|
response = await ws_client.remove_device(device_entry_3.id, fake_entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
assert response["error"]["message"] == "Unknown config entry"
|
|
|
|
# Try removing a config entry which does not support removal from the device
|
|
response = await ws_client.remove_device(device_entry_1.id, entry_1.entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
assert (
|
|
response["error"]["message"] == "Config entry does not support device removal"
|
|
)
|
|
|
|
# Try removing a config entry from a device which does not exist
|
|
response = await ws_client.remove_device(fake_device_id, entry_2.entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
assert response["error"]["message"] == "Unknown device"
|
|
|
|
# Try removing a config entry from a device which it's not connected to
|
|
response = await ws_client.remove_device(device_entry_3.id, entry_2.entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
assert response["error"]["message"] == "Config entry not in device"
|
|
|
|
# Removing a config entry which supports removal removes the device, since it is
|
|
# the device's only config entry
|
|
response = await ws_client.remove_device(device_entry_2.id, entry_2.entry_id)
|
|
|
|
assert response["success"]
|
|
assert response["result"] is None
|
|
assert not device_registry.async_get(device_entry_2.id)
|
|
|
|
# Try removing a config entry which can't be loaded from a device - allowed
|
|
response = await ws_client.remove_device(device_entry_3.id, entry_3.entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
assert response["error"]["message"] == "Integration not found"
|
|
|
|
|
|
async def test_remove_config_entry_from_device_if_integration_remove(
|
|
hass: HomeAssistant,
|
|
hass_ws_client: WebSocketGenerator,
|
|
device_registry: dr.DeviceRegistry,
|
|
) -> None:
|
|
"""Test removing config entry from device.
|
|
|
|
Should not error when the integration removes the entry.
|
|
"""
|
|
assert await async_setup_component(hass, DOMAIN, {})
|
|
ws_client = await hass_ws_client(hass)
|
|
|
|
can_remove = False
|
|
|
|
async def async_remove_config_entry_device(
|
|
hass: HomeAssistant, config_entry: ConfigEntry, device_entry: dr.DeviceEntry
|
|
) -> bool:
|
|
if can_remove:
|
|
device_registry.async_update_device(
|
|
device_entry.id, remove_config_entry_id=config_entry.entry_id
|
|
)
|
|
return can_remove
|
|
|
|
mock_integration(
|
|
hass,
|
|
MockModule(
|
|
"comp1", async_remove_config_entry_device=async_remove_config_entry_device
|
|
),
|
|
)
|
|
mock_integration(
|
|
hass,
|
|
MockModule(
|
|
"comp2", async_remove_config_entry_device=async_remove_config_entry_device
|
|
),
|
|
)
|
|
|
|
entry_1 = MockConfigEntry(
|
|
domain="comp1",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_1.supports_remove_device = True
|
|
entry_1.add_to_hass(hass)
|
|
|
|
entry_2 = MockConfigEntry(
|
|
domain="comp1",
|
|
title="Test 1",
|
|
source="bla",
|
|
)
|
|
entry_2.supports_remove_device = True
|
|
entry_2.add_to_hass(hass)
|
|
|
|
device_entry_1 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_1.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
device_entry = device_registry.async_get_or_create(
|
|
config_entry_id=entry_2.entry_id,
|
|
connections={(dr.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")},
|
|
)
|
|
# Identifiers and connections are unique per config entry, so the two config
|
|
# entries get separate devices even though they share a connection
|
|
assert device_entry_1.id != device_entry.id
|
|
assert device_entry.config_entries == {entry_2.entry_id}
|
|
|
|
# Try removing the config entry from the device, it should fail because
|
|
# async_remove_config_entry_device returns False
|
|
response = await ws_client.remove_device(device_entry.id, entry_2.entry_id)
|
|
|
|
assert not response["success"]
|
|
assert response["error"]["code"] == "home_assistant_error"
|
|
|
|
# Make async_remove_config_entry_device return True
|
|
can_remove = True
|
|
|
|
# Remove the config entry, this was the device's only config entry so the
|
|
# device is removed
|
|
response = await ws_client.remove_device(device_entry.id, entry_2.entry_id)
|
|
|
|
assert response["success"]
|
|
assert response["result"] is None
|
|
|
|
# This was the only config entry, the device is removed
|
|
assert not device_registry.async_get(device_entry.id)
|
|
|
|
# The device belonging to the other config entry is untouched
|
|
assert device_registry.async_get(device_entry_1.id).config_entries == {
|
|
entry_1.entry_id
|
|
}
|
|
|
|
|
|
async def test_list_linked_devices(
|
|
hass: HomeAssistant,
|
|
client: MockHAClientWebSocket,
|
|
device_registry: dr.DeviceRegistry,
|
|
) -> None:
|
|
"""Test listing devices sharing a connection or identifier."""
|
|
entry_1 = MockConfigEntry()
|
|
entry_1.add_to_hass(hass)
|
|
entry_2 = MockConfigEntry()
|
|
entry_2.add_to_hass(hass)
|
|
entry_3 = MockConfigEntry()
|
|
entry_3.add_to_hass(hass)
|
|
|
|
mac = (dr.CONNECTION_NETWORK_MAC, "12:34:56:ab:cd:ef")
|
|
|
|
# device_1 shares its identifier with device_2 and its connection with device_3
|
|
device_1 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_1.entry_id,
|
|
connections={mac},
|
|
identifiers={("bridgeid", "0123")},
|
|
)
|
|
device_2 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_2.entry_id,
|
|
identifiers={("bridgeid", "0123")},
|
|
)
|
|
device_3 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_3.entry_id,
|
|
connections={mac},
|
|
)
|
|
# device_4 shares nothing with the others
|
|
device_4 = device_registry.async_get_or_create(
|
|
config_entry_id=entry_1.entry_id,
|
|
identifiers={("bridgeid", "9999")},
|
|
)
|
|
assert len({device_1.id, device_2.id, device_3.id, device_4.id}) == 4
|
|
|
|
async def list_linked(device_id: str) -> dict:
|
|
await client.send_json_auto_id(
|
|
{
|
|
"type": "config/device_registry/list_linked_devices",
|
|
"device_id": device_id,
|
|
}
|
|
)
|
|
return await client.receive_json()
|
|
|
|
# device_1 is linked to both device_2 (identifier) and device_3 (connection)
|
|
msg = await list_linked(device_1.id)
|
|
assert msg["success"]
|
|
assert msg["result"]["linked_devices"] == unordered([device_2.id, device_3.id])
|
|
|
|
# device_2 and device_3 each only share with device_1, not with each other
|
|
msg = await list_linked(device_2.id)
|
|
assert msg["result"]["linked_devices"] == [device_1.id]
|
|
|
|
msg = await list_linked(device_3.id)
|
|
assert msg["result"]["linked_devices"] == [device_1.id]
|
|
|
|
# device_4 has no linked devices
|
|
msg = await list_linked(device_4.id)
|
|
assert msg["result"]["linked_devices"] == []
|
|
|
|
|
|
async def test_list_linked_devices_unknown_device(
|
|
hass: HomeAssistant,
|
|
client: MockHAClientWebSocket,
|
|
) -> None:
|
|
"""Test listing linked devices for an unknown device returns an error."""
|
|
await client.send_json_auto_id(
|
|
{
|
|
"type": "config/device_registry/list_linked_devices",
|
|
"device_id": "does_not_exist",
|
|
}
|
|
)
|
|
msg = await client.receive_json()
|
|
|
|
assert not msg["success"]
|
|
assert msg["error"]["code"] == "not_found"
|
|
assert msg["error"]["message"] == "Device not found"
|