jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-11-29 04:28:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
05175294f64e9d5e79e499b367f6b04d1357850e
core/tests/components/light/test_trigger.py
Erik Montnemery 05175294f6 Check from state in light triggers (#156443)
2025-11-12 13:15:30 +01:00

392 lines
14 KiB
Python
Raw Blame History

"""Test light trigger."""
import pytest
from homeassistant.components import automation
from homeassistant.const import (
ATTR_AREA_ID,
ATTR_DEVICE_ID,
ATTR_FLOOR_ID,
ATTR_LABEL_ID,
CONF_ENTITY_ID,
CONF_OPTIONS,
CONF_PLATFORM,
CONF_TARGET,
STATE_OFF,
STATE_ON,
STATE_UNAVAILABLE,
STATE_UNKNOWN,
)
from homeassistant.core import HomeAssistant, ServiceCall
from homeassistant.helpers import (
area_registry as ar,
device_registry as dr,
entity_registry as er,
floor_registry as fr,
label_registry as lr,
)
from homeassistant.setup import async_setup_component
from tests.common import MockConfigEntry, mock_device_registry
@pytest.fixture(autouse=True, name="stub_blueprint_populate")
def stub_blueprint_populate_autouse(stub_blueprint_populate: None) -> None:
"""Stub copying the blueprints to the config folder."""
@pytest.fixture
async def target_lights(hass: HomeAssistant) -> None:
"""Create multiple light entities associated with different targets."""
await async_setup_component(hass, "light", {})
config_entry = MockConfigEntry(domain="test")
config_entry.add_to_hass(hass)
floor_reg = fr.async_get(hass)
floor = floor_reg.async_create("Test Floor")
area_reg = ar.async_get(hass)
area = area_reg.async_create("Test Area", floor_id=floor.floor_id)
label_reg = lr.async_get(hass)
label = label_reg.async_create("Test Label")
device = dr.DeviceEntry(id="test_device", area_id=area.id, labels={label.label_id})
mock_device_registry(hass, {device.id: device})
entity_reg = er.async_get(hass)
# Light associated with area
light_area = entity_reg.async_get_or_create(
domain="light",
platform="test",
unique_id="light_area",
suggested_object_id="area_light",
)
entity_reg.async_update_entity(light_area.entity_id, area_id=area.id)
# Light associated with device
entity_reg.async_get_or_create(
domain="light",
platform="test",
unique_id="light_device",
suggested_object_id="device_light",
device_id=device.id,
)
# Light associated with label
light_label = entity_reg.async_get_or_create(
domain="light",
platform="test",
unique_id="light_label",
suggested_object_id="label_light",
)
entity_reg.async_update_entity(light_label.entity_id, labels={label.label_id})
# Return all available light entities
return [
"light.standalone_light",
"light.label_light",
"light.area_light",
"light.device_light",
]
def set_or_remove_state(hass: HomeAssistant, entity_id: str, state: str | None) -> None:
"""Set or clear the state of an entity."""
if state is None:
hass.states.async_remove(entity_id)
else:
hass.states.async_set(entity_id, state, force_update=True)
async def setup_automation(
hass: HomeAssistant, trigger: str, trigger_options: dict, trigger_target: dict
) -> None:
"""Set up automation component with given config."""
await async_setup_component(
hass,
automation.DOMAIN,
{
automation.DOMAIN: {
"trigger": {
CONF_PLATFORM: trigger,
CONF_OPTIONS: {**trigger_options},
CONF_TARGET: {**trigger_target},
},
"action": {
"service": "test.automation",
"data_template": {CONF_ENTITY_ID: "{{ trigger.entity_id }}"},
},
}
},
)
@pytest.mark.parametrize(
("trigger_target_config", "entity_id", "lights_in_target"),
[
({CONF_ENTITY_ID: "light.standalone_light"}, "light.standalone_light", 1),
({ATTR_LABEL_ID: "test_label"}, "light.label_light", 2),
({ATTR_AREA_ID: "test_area"}, "light.area_light", 2),
({ATTR_FLOOR_ID: "test_floor"}, "light.area_light", 2),
({ATTR_LABEL_ID: "test_label"}, "light.device_light", 2),
({ATTR_AREA_ID: "test_area"}, "light.device_light", 2),
({ATTR_FLOOR_ID: "test_floor"}, "light.device_light", 2),
({ATTR_DEVICE_ID: "test_device"}, "light.device_light", 1),
],
)
@pytest.mark.parametrize(
("trigger", "initial_state", "states"),
[
# Initial state None
("light.turned_on", None, [(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)]),
("light.turned_off", None, [(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)]),
# Initial state opposite of target state
("light.turned_on", STATE_OFF, [(STATE_ON, 1), (STATE_OFF, 0), (STATE_ON, 1)]),
("light.turned_off", STATE_ON, [(STATE_OFF, 1), (STATE_ON, 0), (STATE_OFF, 1)]),
# Initial state same as target state
("light.turned_on", STATE_ON, [(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)]),
(
"light.turned_off",
STATE_OFF,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
# Initial state unavailable / unknown
(
"light.turned_on",
STATE_UNAVAILABLE,
[(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)],
),
(
"light.turned_off",
STATE_UNAVAILABLE,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
(
"light.turned_on",
STATE_UNKNOWN,
[(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)],
),
(
"light.turned_off",
STATE_UNKNOWN,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
],
)
async def test_light_state_trigger_behavior_any(
hass: HomeAssistant,
service_calls: list[ServiceCall],
target_lights: list[str],
trigger_target_config: dict,
entity_id: str,
lights_in_target: int,
trigger: str,
initial_state: str,
states: list[tuple[str, int]],
) -> None:
"""Test that the light state trigger fires when any light state changes to a specific state."""
await async_setup_component(hass, "light", {})
other_entity_ids = set(target_lights) - {entity_id}
# Set all lights, including the tested light, to the initial state
for eid in target_lights:
set_or_remove_state(hass, eid, initial_state)
await hass.async_block_till_done()
await setup_automation(hass, trigger, {}, trigger_target_config)
for state, expected_calls in states:
set_or_remove_state(hass, entity_id, state)
await hass.async_block_till_done()
assert len(service_calls) == expected_calls
for service_call in service_calls:
assert service_call.data[CONF_ENTITY_ID] == entity_id
service_calls.clear()
# Check if changing other lights also triggers
for other_entity_id in other_entity_ids:
set_or_remove_state(hass, other_entity_id, state)
await hass.async_block_till_done()
assert len(service_calls) == (lights_in_target - 1) * expected_calls
service_calls.clear()
@pytest.mark.parametrize(
("trigger_target_config", "entity_id"),
[
({CONF_ENTITY_ID: "light.standalone_light"}, "light.standalone_light"),
({ATTR_LABEL_ID: "test_label"}, "light.label_light"),
({ATTR_AREA_ID: "test_area"}, "light.area_light"),
({ATTR_FLOOR_ID: "test_floor"}, "light.area_light"),
({ATTR_LABEL_ID: "test_label"}, "light.device_light"),
({ATTR_AREA_ID: "test_area"}, "light.device_light"),
({ATTR_FLOOR_ID: "test_floor"}, "light.device_light"),
({ATTR_DEVICE_ID: "test_device"}, "light.device_light"),
],
)
@pytest.mark.parametrize(
("trigger", "initial_state", "states"),
[
# Initial state None
("light.turned_on", None, [(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)]),
("light.turned_off", None, [(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)]),
# Initial state opposite of target state
("light.turned_on", STATE_OFF, [(STATE_ON, 1), (STATE_OFF, 0), (STATE_ON, 1)]),
("light.turned_off", STATE_ON, [(STATE_OFF, 1), (STATE_ON, 0), (STATE_OFF, 1)]),
# Initial state same as target state
("light.turned_on", STATE_ON, [(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)]),
(
"light.turned_off",
STATE_OFF,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
# Initial state unavailable / unknown
(
"light.turned_on",
STATE_UNAVAILABLE,
[(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)],
),
(
"light.turned_off",
STATE_UNAVAILABLE,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
(
"light.turned_on",
STATE_UNKNOWN,
[(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)],
),
(
"light.turned_off",
STATE_UNKNOWN,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
],
)
async def test_light_state_trigger_behavior_first(
hass: HomeAssistant,
service_calls: list[ServiceCall],
target_lights: list[str],
trigger_target_config: dict,
entity_id: str,
trigger: str,
initial_state: str,
states: list[tuple[str, int, list[str]]],
) -> None:
"""Test that the light state trigger fires when the first light changes to a specific state."""
await async_setup_component(hass, "light", {})
other_entity_ids = set(target_lights) - {entity_id}
# Set all lights, including the tested light, to the initial state
for eid in target_lights:
set_or_remove_state(hass, eid, initial_state)
await hass.async_block_till_done()
await setup_automation(hass, trigger, {"behavior": "first"}, trigger_target_config)
for state, expected_calls in states:
set_or_remove_state(hass, entity_id, state)
await hass.async_block_till_done()
assert len(service_calls) == expected_calls
for service_call in service_calls:
assert service_call.data[CONF_ENTITY_ID] == entity_id
service_calls.clear()
# Triggering other lights should not cause the trigger to fire again
for other_entity_id in other_entity_ids:
set_or_remove_state(hass, other_entity_id, state)
await hass.async_block_till_done()
assert len(service_calls) == 0
@pytest.mark.parametrize(
("trigger_target_config", "entity_id"),
[
({CONF_ENTITY_ID: "light.standalone_light"}, "light.standalone_light"),
({ATTR_LABEL_ID: "test_label"}, "light.label_light"),
({ATTR_AREA_ID: "test_area"}, "light.area_light"),
({ATTR_FLOOR_ID: "test_floor"}, "light.area_light"),
({ATTR_LABEL_ID: "test_label"}, "light.device_light"),
({ATTR_AREA_ID: "test_area"}, "light.device_light"),
({ATTR_FLOOR_ID: "test_floor"}, "light.device_light"),
({ATTR_DEVICE_ID: "test_device"}, "light.device_light"),
],
)
@pytest.mark.parametrize(
("trigger", "initial_state", "states"),
[
# Initial state None
("light.turned_on", None, [(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)]),
("light.turned_off", None, [(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)]),
# Initial state opposite of target state
("light.turned_on", STATE_OFF, [(STATE_ON, 1), (STATE_OFF, 0), (STATE_ON, 1)]),
("light.turned_off", STATE_ON, [(STATE_OFF, 1), (STATE_ON, 0), (STATE_OFF, 1)]),
# Initial state same as target state
("light.turned_on", STATE_ON, [(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)]),
(
"light.turned_off",
STATE_OFF,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
# Initial state unavailable / unknown
(
"light.turned_on",
STATE_UNAVAILABLE,
[(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)],
),
(
"light.turned_off",
STATE_UNAVAILABLE,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
(
"light.turned_on",
STATE_UNKNOWN,
[(STATE_ON, 0), (STATE_OFF, 0), (STATE_ON, 1)],
),
(
"light.turned_off",
STATE_UNKNOWN,
[(STATE_OFF, 0), (STATE_ON, 0), (STATE_OFF, 1)],
),
],
)
async def test_light_state_trigger_behavior_last(
hass: HomeAssistant,
service_calls: list[ServiceCall],
target_lights: list[str],
trigger_target_config: dict,
entity_id: str,
trigger: str,
initial_state: str,
states: list[tuple[str, int]],
) -> None:
"""Test that the light state trigger fires when the last light changes to a specific state."""
await async_setup_component(hass, "light", {})
other_entity_ids = set(target_lights) - {entity_id}
# Set all lights, including the tested light, to the initial state
for eid in target_lights:
set_or_remove_state(hass, eid, initial_state)
await hass.async_block_till_done()
await setup_automation(hass, trigger, {"behavior": "last"}, trigger_target_config)
for state, expected_calls in states:
for other_entity_id in other_entity_ids:
set_or_remove_state(hass, other_entity_id, state)
await hass.async_block_till_done()
assert len(service_calls) == 0
set_or_remove_state(hass, entity_id, state)
await hass.async_block_till_done()
assert len(service_calls) == expected_calls
for service_call in service_calls:
assert service_call.data[CONF_ENTITY_ID] == entity_id
service_calls.clear()
Reference in New Issue View Git Blame Copy Permalink