483 lines
18 KiB
Python
483 lines
18 KiB
Python
"""Test the Min/Max integration."""
|
|
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components import threshold
|
|
from homeassistant.components.threshold.config_flow import ConfigFlowHandler
|
|
from homeassistant.components.threshold.const import DOMAIN
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import Event, HomeAssistant
|
|
from homeassistant.helpers import device_registry as dr, entity_registry as er
|
|
from homeassistant.helpers.event import async_track_entity_registry_updated_event
|
|
|
|
from tests.common import MockConfigEntry
|
|
|
|
|
|
@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 threshold_config_entry(
|
|
hass: HomeAssistant,
|
|
sensor_entity_entry: er.RegistryEntry,
|
|
) -> MockConfigEntry:
|
|
"""Fixture to create a threshold config entry."""
|
|
config_entry = MockConfigEntry(
|
|
data={},
|
|
domain=DOMAIN,
|
|
options={
|
|
"entity_id": sensor_entity_entry.entity_id,
|
|
"hysteresis": 0.0,
|
|
"lower": -2.0,
|
|
"name": "My threshold",
|
|
"upper": None,
|
|
},
|
|
title="My threshold",
|
|
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
|
|
|
|
|
|
@pytest.mark.parametrize("platform", ["binary_sensor"])
|
|
async def test_setup_and_remove_config_entry(
|
|
hass: HomeAssistant,
|
|
entity_registry: er.EntityRegistry,
|
|
platform: str,
|
|
) -> None:
|
|
"""Test setting up and removing a config entry."""
|
|
hass.states.async_set("sensor.input", "-10")
|
|
|
|
input_sensor = "sensor.input"
|
|
|
|
threshold_entity_id = f"{platform}.input_threshold"
|
|
|
|
# Setup the config entry
|
|
config_entry = MockConfigEntry(
|
|
data={},
|
|
domain=DOMAIN,
|
|
options={
|
|
"entity_id": input_sensor,
|
|
"hysteresis": 0.0,
|
|
"lower": -2.0,
|
|
"name": "Input threshold",
|
|
"upper": None,
|
|
},
|
|
title="Input threshold",
|
|
)
|
|
config_entry.add_to_hass(hass)
|
|
assert await hass.config_entries.async_setup(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Check the entity is registered in the entity registry
|
|
assert entity_registry.async_get(threshold_entity_id) is not None
|
|
|
|
# Check the platform is setup correctly
|
|
state = hass.states.get(threshold_entity_id)
|
|
assert state
|
|
assert state.state == "on"
|
|
assert state.attributes["entity_id"] == input_sensor
|
|
assert state.attributes["hysteresis"] == 0.0
|
|
assert state.attributes["lower"] == -2.0
|
|
assert state.attributes["position"] == "below"
|
|
assert state.attributes["sensor_value"] == -10.0
|
|
assert state.attributes["type"] == "lower"
|
|
assert state.attributes["upper"] is None
|
|
|
|
# Remove the config entry
|
|
assert await hass.config_entries.async_remove(config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Check the state and entity registry entry are removed
|
|
assert hass.states.get(threshold_entity_id) is None
|
|
assert entity_registry.async_get(threshold_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
|
|
run1_entry = _create_mock_entity("sensor", "initial")
|
|
run2_entry = _create_mock_entity("sensor", "changed")
|
|
|
|
# Setup the config entry
|
|
config_entry = MockConfigEntry(
|
|
data={},
|
|
domain=DOMAIN,
|
|
options={
|
|
"entity_id": "sensor.initial",
|
|
"hysteresis": 0.0,
|
|
"lower": -2.0,
|
|
"name": "My threshold",
|
|
"upper": None,
|
|
},
|
|
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(run1_entry)
|
|
assert config_entry.entry_id not in _get_device_config_entries(run2_entry)
|
|
|
|
hass.config_entries.async_update_entry(
|
|
config_entry, options={**config_entry.options, "entity_id": "sensor.changed"}
|
|
)
|
|
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(run1_entry)
|
|
assert config_entry.entry_id in _get_device_config_entries(run2_entry)
|
|
|
|
|
|
async def test_device_cleaning(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
entity_registry: er.EntityRegistry,
|
|
) -> None:
|
|
"""Test for source entity device for Threshold."""
|
|
|
|
# Source entity device config entry
|
|
source_config_entry = MockConfigEntry()
|
|
source_config_entry.add_to_hass(hass)
|
|
|
|
# Device entry of the source entity
|
|
source_device1_entry = device_registry.async_get_or_create(
|
|
config_entry_id=source_config_entry.entry_id,
|
|
identifiers={("sensor", "identifier_test1")},
|
|
connections={("mac", "30:31:32:33:34:01")},
|
|
)
|
|
|
|
# Source entity registry
|
|
source_entity = entity_registry.async_get_or_create(
|
|
"sensor",
|
|
"test",
|
|
"source",
|
|
config_entry=source_config_entry,
|
|
device_id=source_device1_entry.id,
|
|
)
|
|
await hass.async_block_till_done()
|
|
assert entity_registry.async_get("sensor.test_source") is not None
|
|
|
|
# Configure the configuration entry for Threshold
|
|
threshold_config_entry = MockConfigEntry(
|
|
data={},
|
|
domain=DOMAIN,
|
|
options={
|
|
"entity_id": "sensor.test_source",
|
|
"hysteresis": 0.0,
|
|
"lower": -2.0,
|
|
"name": "Threshold",
|
|
"upper": None,
|
|
},
|
|
title="Threshold",
|
|
)
|
|
threshold_config_entry.add_to_hass(hass)
|
|
assert await hass.config_entries.async_setup(threshold_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Confirm the link between the source entity device and the threshold sensor
|
|
threshold_entity = entity_registry.async_get("binary_sensor.threshold")
|
|
assert threshold_entity is not None
|
|
assert threshold_entity.device_id == source_entity.device_id
|
|
|
|
# Device entry incorrectly linked to Threshold config entry
|
|
device_registry.async_get_or_create(
|
|
config_entry_id=threshold_config_entry.entry_id,
|
|
identifiers={("sensor", "identifier_test2")},
|
|
connections={("mac", "30:31:32:33:34:02")},
|
|
)
|
|
device_registry.async_get_or_create(
|
|
config_entry_id=threshold_config_entry.entry_id,
|
|
identifiers={("sensor", "identifier_test3")},
|
|
connections={("mac", "30:31:32:33:34:03")},
|
|
)
|
|
await hass.async_block_till_done()
|
|
|
|
# Before reloading the config entry, two devices are expected to be linked
|
|
devices_before_reload = device_registry.devices.get_devices_for_config_entry_id(
|
|
threshold_config_entry.entry_id
|
|
)
|
|
assert len(devices_before_reload) == 3
|
|
|
|
# Config entry reload
|
|
await hass.config_entries.async_reload(threshold_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
# Confirm the link between the source entity device and the threshold sensor after reload
|
|
threshold_entity = entity_registry.async_get("binary_sensor.threshold")
|
|
assert threshold_entity is not None
|
|
assert threshold_entity.device_id == source_entity.device_id
|
|
|
|
# After reloading the config entry, only one linked device is expected
|
|
devices_after_reload = device_registry.devices.get_devices_for_config_entry_id(
|
|
threshold_config_entry.entry_id
|
|
)
|
|
assert len(devices_after_reload) == 1
|
|
|
|
|
|
async def test_async_handle_source_entity_changes_source_entity_removed(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
entity_registry: er.EntityRegistry,
|
|
threshold_config_entry: MockConfigEntry,
|
|
sensor_config_entry: ConfigEntry,
|
|
sensor_device: dr.DeviceEntry,
|
|
sensor_entity_entry: er.RegistryEntry,
|
|
) -> None:
|
|
"""Test the threshold 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(threshold_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
threshold_entity_entry = entity_registry.async_get("binary_sensor.my_threshold")
|
|
assert threshold_entity_entry.device_id == sensor_entity_entry.device_id
|
|
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id in sensor_device.config_entries
|
|
|
|
events = track_entity_registry_actions(hass, threshold_entity_entry.entity_id)
|
|
|
|
# Remove the source sensor's config entry from the device, this removes the
|
|
# source sensor
|
|
with patch(
|
|
"homeassistant.components.threshold.async_unload_entry",
|
|
wraps=threshold.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 threshold config entry is removed from the device
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id not in sensor_device.config_entries
|
|
|
|
# Check that the threshold config entry is not removed
|
|
assert threshold_config_entry.entry_id in hass.config_entries.async_entry_ids()
|
|
|
|
# Check we got the expected events
|
|
assert events == ["update"]
|
|
|
|
|
|
async def test_async_handle_source_entity_changes_source_entity_removed_from_device(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
entity_registry: er.EntityRegistry,
|
|
threshold_config_entry: MockConfigEntry,
|
|
sensor_device: dr.DeviceEntry,
|
|
sensor_entity_entry: er.RegistryEntry,
|
|
) -> None:
|
|
"""Test the source entity removed from the source device."""
|
|
assert await hass.config_entries.async_setup(threshold_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
threshold_entity_entry = entity_registry.async_get("binary_sensor.my_threshold")
|
|
assert threshold_entity_entry.device_id == sensor_entity_entry.device_id
|
|
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id in sensor_device.config_entries
|
|
|
|
events = track_entity_registry_actions(hass, threshold_entity_entry.entity_id)
|
|
|
|
# Remove the source sensor from the device
|
|
with patch(
|
|
"homeassistant.components.threshold.async_unload_entry",
|
|
wraps=threshold.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 threshold config entry is removed from the device
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id not in sensor_device.config_entries
|
|
|
|
# Check that the threshold config entry is not removed
|
|
assert threshold_config_entry.entry_id in hass.config_entries.async_entry_ids()
|
|
|
|
# Check we got the expected events
|
|
assert events == ["update"]
|
|
|
|
|
|
async def test_async_handle_source_entity_changes_source_entity_moved_other_device(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
entity_registry: er.EntityRegistry,
|
|
threshold_config_entry: MockConfigEntry,
|
|
sensor_config_entry: ConfigEntry,
|
|
sensor_device: dr.DeviceEntry,
|
|
sensor_entity_entry: er.RegistryEntry,
|
|
) -> 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(threshold_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
threshold_entity_entry = entity_registry.async_get("binary_sensor.my_threshold")
|
|
assert threshold_entity_entry.device_id == sensor_entity_entry.device_id
|
|
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id in sensor_device.config_entries
|
|
sensor_device_2 = device_registry.async_get(sensor_device_2.id)
|
|
assert threshold_config_entry.entry_id not in sensor_device_2.config_entries
|
|
|
|
events = track_entity_registry_actions(hass, threshold_entity_entry.entity_id)
|
|
|
|
# Move the source sensor to another device
|
|
with patch(
|
|
"homeassistant.components.threshold.async_unload_entry",
|
|
wraps=threshold.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 threshold config entry is moved to the other device
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id not in sensor_device.config_entries
|
|
sensor_device_2 = device_registry.async_get(sensor_device_2.id)
|
|
assert threshold_config_entry.entry_id in sensor_device_2.config_entries
|
|
|
|
# Check that the threshold config entry is not removed
|
|
assert threshold_config_entry.entry_id in hass.config_entries.async_entry_ids()
|
|
|
|
# Check we got the expected events
|
|
assert events == ["update"]
|
|
|
|
|
|
async def test_async_handle_source_entity_new_entity_id(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
entity_registry: er.EntityRegistry,
|
|
threshold_config_entry: MockConfigEntry,
|
|
sensor_device: dr.DeviceEntry,
|
|
sensor_entity_entry: er.RegistryEntry,
|
|
) -> None:
|
|
"""Test the source entity's entity ID is changed."""
|
|
assert await hass.config_entries.async_setup(threshold_config_entry.entry_id)
|
|
await hass.async_block_till_done()
|
|
|
|
threshold_entity_entry = entity_registry.async_get("binary_sensor.my_threshold")
|
|
assert threshold_entity_entry.device_id == sensor_entity_entry.device_id
|
|
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id in sensor_device.config_entries
|
|
|
|
events = track_entity_registry_actions(hass, threshold_entity_entry.entity_id)
|
|
|
|
# Change the source entity's entity ID
|
|
with patch(
|
|
"homeassistant.components.threshold.async_unload_entry",
|
|
wraps=threshold.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 threshold config entry is updated with the new entity ID
|
|
assert threshold_config_entry.options["entity_id"] == "sensor.new_entity_id"
|
|
|
|
# Check that the helper config is still in the device
|
|
sensor_device = device_registry.async_get(sensor_device.id)
|
|
assert threshold_config_entry.entry_id in sensor_device.config_entries
|
|
|
|
# Check that the threshold config entry is not removed
|
|
assert threshold_config_entry.entry_id in hass.config_entries.async_entry_ids()
|
|
|
|
# Check we got the expected events
|
|
assert events == []
|