"""Test light trigger.""" from typing import Any import pytest from homeassistant.components.light import ATTR_BRIGHTNESS from homeassistant.const import ( ATTR_LABEL_ID, CONF_ABOVE, CONF_BELOW, CONF_ENTITY_ID, STATE_OFF, STATE_ON, ) from homeassistant.core import HomeAssistant, ServiceCall from homeassistant.helpers.trigger import ( CONF_LOWER_LIMIT, CONF_THRESHOLD_TYPE, CONF_UPPER_LIMIT, ThresholdType, ) from tests.components import ( TriggerStateDescription, arm_trigger, parametrize_target_entities, parametrize_trigger_states, set_or_remove_state, target_entities, ) @pytest.fixture async def target_lights(hass: HomeAssistant) -> list[str]: """Create multiple light entities associated with different targets.""" return (await target_entities(hass, "light"))["included"] def parametrize_brightness_changed_trigger_states( trigger: str, state: str, attribute: str ) -> list[tuple[str, dict[str, Any], list[TriggerStateDescription]]]: """Parametrize states and expected service call counts for brightness changed triggers. Note: The brightness in the trigger configuration is in percentage (0-100) scale, the underlying attribute in the state is in uint8 (0-255) scale. """ return [ *parametrize_trigger_states( trigger=trigger, trigger_options={}, target_states=[ (state, {attribute: 0}), (state, {attribute: 128}), (state, {attribute: 255}), ], other_states=[(state, {attribute: None})], retrigger_on_target_state=True, ), *parametrize_trigger_states( trigger=trigger, trigger_options={CONF_ABOVE: 10}, target_states=[ (state, {attribute: 128}), (state, {attribute: 255}), ], other_states=[ (state, {attribute: None}), (state, {attribute: 0}), ], retrigger_on_target_state=True, ), *parametrize_trigger_states( trigger=trigger, trigger_options={CONF_BELOW: 90}, target_states=[ (state, {attribute: 0}), (state, {attribute: 128}), ], other_states=[ (state, {attribute: None}), (state, {attribute: 255}), ], retrigger_on_target_state=True, ), ] def parametrize_brightness_crossed_threshold_trigger_states( trigger: str, state: str, attribute: str ) -> list[tuple[str, dict[str, Any], list[TriggerStateDescription]]]: """Parametrize states and expected service call counts for brightness crossed threshold triggers. Note: The brightness in the trigger configuration is in percentage (0-100) scale, the underlying attribute in the state is in uint8 (0-255) scale. """ return [ *parametrize_trigger_states( trigger=trigger, trigger_options={ CONF_THRESHOLD_TYPE: ThresholdType.BETWEEN, CONF_LOWER_LIMIT: 10, CONF_UPPER_LIMIT: 90, }, target_states=[ (state, {attribute: 128}), (state, {attribute: 153}), ], other_states=[ (state, {attribute: None}), (state, {attribute: 0}), (state, {attribute: 255}), ], ), *parametrize_trigger_states( trigger=trigger, trigger_options={ CONF_THRESHOLD_TYPE: ThresholdType.OUTSIDE, CONF_LOWER_LIMIT: 10, CONF_UPPER_LIMIT: 90, }, target_states=[ (state, {attribute: 0}), (state, {attribute: 255}), ], other_states=[ (state, {attribute: None}), (state, {attribute: 128}), (state, {attribute: 153}), ], ), *parametrize_trigger_states( trigger=trigger, trigger_options={ CONF_THRESHOLD_TYPE: ThresholdType.ABOVE, CONF_LOWER_LIMIT: 10, }, target_states=[ (state, {attribute: 128}), (state, {attribute: 255}), ], other_states=[ (state, {attribute: None}), (state, {attribute: 0}), ], ), *parametrize_trigger_states( trigger=trigger, trigger_options={ CONF_THRESHOLD_TYPE: ThresholdType.BELOW, CONF_UPPER_LIMIT: 90, }, target_states=[ (state, {attribute: 0}), (state, {attribute: 128}), ], other_states=[ (state, {attribute: None}), (state, {attribute: 255}), ], ), ] @pytest.mark.parametrize( "trigger_key", [ "light.brightness_changed", "light.brightness_crossed_threshold", "light.turned_off", "light.turned_on", ], ) async def test_light_triggers_gated_by_labs_flag( hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str ) -> None: """Test the light triggers are gated by the labs flag.""" await arm_trigger(hass, trigger_key, None, {ATTR_LABEL_ID: "test_label"}) assert ( "Unnamed automation failed to setup triggers and has been disabled: Trigger " f"'{trigger_key}' requires the experimental 'New triggers and conditions' " "feature to be enabled in Home Assistant Labs settings (feature flag: " "'new_triggers_conditions')" ) in caplog.text @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("light"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_trigger_states( trigger="light.turned_on", target_states=[STATE_ON], other_states=[STATE_OFF], ), *parametrize_trigger_states( trigger="light.turned_off", target_states=[STATE_OFF], other_states=[STATE_ON], ), ], ) 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, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the light state trigger fires when any light state changes to a specific state.""" 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, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {}, trigger_target_config) for state in states[1:]: included_state = state["included"] set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] 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, included_state) await hass.async_block_till_done() assert len(service_calls) == (entities_in_target - 1) * state["count"] service_calls.clear() @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("light"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_brightness_changed_trigger_states( "light.brightness_changed", STATE_ON, ATTR_BRIGHTNESS ), *parametrize_brightness_crossed_threshold_trigger_states( "light.brightness_crossed_threshold", STATE_ON, ATTR_BRIGHTNESS ), ], ) async def test_light_state_attribute_trigger_behavior_any( hass: HomeAssistant, service_calls: list[ServiceCall], target_lights: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the light state trigger fires when any light state changes to a specific state.""" 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, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, trigger_options, trigger_target_config) for state in states[1:]: included_state = state["included"] set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] 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, included_state) await hass.async_block_till_done() assert len(service_calls) == (entities_in_target - 1) * state["count"] service_calls.clear() @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("light"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_trigger_states( trigger="light.turned_on", target_states=[STATE_ON], other_states=[STATE_OFF], ), *parametrize_trigger_states( trigger="light.turned_off", target_states=[STATE_OFF], other_states=[STATE_ON], ), ], ) 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, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the light state trigger fires when the first light changes to a specific state.""" 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, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "first"}, trigger_target_config) for state in states[1:]: included_state = state["included"] set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] 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, included_state) await hass.async_block_till_done() assert len(service_calls) == 0 @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("light"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_brightness_crossed_threshold_trigger_states( "light.brightness_crossed_threshold", STATE_ON, ATTR_BRIGHTNESS ), ], ) async def test_light_state_attribute_trigger_behavior_first( hass: HomeAssistant, service_calls: list[ServiceCall], target_lights: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[tuple[tuple[str, dict], int]], ) -> None: """Test that the light state trigger fires when the first light state changes to a specific state.""" 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, states[0]["included"]) await hass.async_block_till_done() await arm_trigger( hass, trigger, {"behavior": "first"} | trigger_options, trigger_target_config ) for state in states[1:]: included_state = state["included"] set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] 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, included_state) await hass.async_block_till_done() assert len(service_calls) == 0 @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("light"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_trigger_states( trigger="light.turned_on", target_states=[STATE_ON], other_states=[STATE_OFF], ), *parametrize_trigger_states( trigger="light.turned_off", target_states=[STATE_OFF], other_states=[STATE_ON], ), ], ) 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, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the light state trigger fires when the last light changes to a specific state.""" 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, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "last"}, trigger_target_config) for state in states[1:]: included_state = state["included"] for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == 0 set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("light"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_brightness_crossed_threshold_trigger_states( "light.brightness_crossed_threshold", STATE_ON, ATTR_BRIGHTNESS ), ], ) async def test_light_state_attribute_trigger_behavior_last( hass: HomeAssistant, service_calls: list[ServiceCall], target_lights: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[tuple[tuple[str, dict], int]], ) -> None: """Test that the light state trigger fires when the last light state changes to a specific state.""" 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, states[0]["included"]) await hass.async_block_till_done() await arm_trigger( hass, trigger, {"behavior": "last"} | trigger_options, trigger_target_config ) for state in states[1:]: included_state = state["included"] for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == 0 set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear()