diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 277ca28451e..4822387d407 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -134,6 +134,7 @@ _EXPERIMENTAL_TRIGGER_PLATFORMS = { "humidifier", "lawn_mower", "light", + "lock", "media_player", "siren", "switch", diff --git a/homeassistant/components/lock/icons.json b/homeassistant/components/lock/icons.json index 0b1befde9ff..90aab49311f 100644 --- a/homeassistant/components/lock/icons.json +++ b/homeassistant/components/lock/icons.json @@ -22,5 +22,19 @@ "unlock": { "service": "mdi:lock-open-variant" } + }, + "triggers": { + "jammed": { + "trigger": "mdi:lock-alert" + }, + "locked": { + "trigger": "mdi:lock" + }, + "opened": { + "trigger": "mdi:lock-open-variant" + }, + "unlocked": { + "trigger": "mdi:lock-open-variant" + } } } diff --git a/homeassistant/components/lock/strings.json b/homeassistant/components/lock/strings.json index 763d3668695..1a0b12fa281 100644 --- a/homeassistant/components/lock/strings.json +++ b/homeassistant/components/lock/strings.json @@ -1,4 +1,8 @@ { + "common": { + "trigger_behavior_description": "The behavior of the targeted locks to trigger on.", + "trigger_behavior_name": "Behavior" + }, "device_automation": { "action_type": { "lock": "Lock {entity_name}", @@ -50,6 +54,15 @@ "message": "The code for {entity_id} doesn't match pattern {code_format}." } }, + "selector": { + "trigger_behavior": { + "options": { + "any": "Any", + "first": "First", + "last": "Last" + } + } + }, "services": { "lock": { "description": "Locks a lock.", @@ -82,5 +95,47 @@ "name": "Unlock" } }, - "title": "Lock" + "title": "Lock", + "triggers": { + "jammed": { + "description": "Triggers after one or more locks jam.", + "fields": { + "behavior": { + "description": "[%key:component::lock::common::trigger_behavior_description%]", + "name": "[%key:component::lock::common::trigger_behavior_name%]" + } + }, + "name": "Lock jammed" + }, + "locked": { + "description": "Triggers after one or more locks lock.", + "fields": { + "behavior": { + "description": "[%key:component::lock::common::trigger_behavior_description%]", + "name": "[%key:component::lock::common::trigger_behavior_name%]" + } + }, + "name": "Lock locked" + }, + "opened": { + "description": "Triggers after one or more locks open.", + "fields": { + "behavior": { + "description": "[%key:component::lock::common::trigger_behavior_description%]", + "name": "[%key:component::lock::common::trigger_behavior_name%]" + } + }, + "name": "Lock opened" + }, + "unlocked": { + "description": "Triggers after one or more locks unlock.", + "fields": { + "behavior": { + "description": "[%key:component::lock::common::trigger_behavior_description%]", + "name": "[%key:component::lock::common::trigger_behavior_name%]" + } + }, + "name": "Lock unlocked" + } + } } diff --git a/homeassistant/components/lock/trigger.py b/homeassistant/components/lock/trigger.py new file mode 100644 index 00000000000..de6cd472027 --- /dev/null +++ b/homeassistant/components/lock/trigger.py @@ -0,0 +1,18 @@ +"""Provides triggers for locks.""" + +from homeassistant.core import HomeAssistant +from homeassistant.helpers.trigger import Trigger, make_entity_target_state_trigger + +from .const import DOMAIN, LockState + +TRIGGERS: dict[str, type[Trigger]] = { + "jammed": make_entity_target_state_trigger(DOMAIN, LockState.JAMMED), + "locked": make_entity_target_state_trigger(DOMAIN, LockState.LOCKED), + "opened": make_entity_target_state_trigger(DOMAIN, LockState.OPEN), + "unlocked": make_entity_target_state_trigger(DOMAIN, LockState.UNLOCKED), +} + + +async def async_get_triggers(hass: HomeAssistant) -> dict[str, type[Trigger]]: + """Return the triggers for locks.""" + return TRIGGERS diff --git a/homeassistant/components/lock/triggers.yaml b/homeassistant/components/lock/triggers.yaml new file mode 100644 index 00000000000..72b0fc5f476 --- /dev/null +++ b/homeassistant/components/lock/triggers.yaml @@ -0,0 +1,20 @@ +.trigger_common: &trigger_common + target: + entity: + domain: lock + fields: + behavior: + required: true + default: any + selector: + select: + options: + - first + - last + - any + translation_key: trigger_behavior + +jammed: *trigger_common +locked: *trigger_common +opened: *trigger_common +unlocked: *trigger_common diff --git a/tests/components/lock/test_trigger.py b/tests/components/lock/test_trigger.py new file mode 100644 index 00000000000..9fb44dcdd66 --- /dev/null +++ b/tests/components/lock/test_trigger.py @@ -0,0 +1,261 @@ +"""Test lock triggers.""" + +from collections.abc import Generator +from unittest.mock import patch + +import pytest + +from homeassistant.components.lock import DOMAIN, LockState +from homeassistant.const import ATTR_LABEL_ID, CONF_ENTITY_ID +from homeassistant.core import HomeAssistant, ServiceCall + +from tests.components import ( + StateDescription, + arm_trigger, + other_states, + parametrize_target_entities, + parametrize_trigger_states, + set_or_remove_state, + target_entities, +) + + +@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(name="enable_experimental_triggers_conditions") +def enable_experimental_triggers_conditions() -> Generator[None]: + """Enable experimental triggers and conditions.""" + with patch( + "homeassistant.components.labs.async_is_preview_feature_enabled", + return_value=True, + ): + yield + + +@pytest.fixture +async def target_locks(hass: HomeAssistant) -> list[str]: + """Create multiple lock entities associated with different targets.""" + return (await target_entities(hass, DOMAIN))["included"] + + +@pytest.mark.parametrize( + "trigger_key", + [ + "lock.jammed", + "lock.locked", + "lock.opened", + "lock.unlocked", + ], +) +async def test_lock_triggers_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str +) -> None: + """Test the lock 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_experimental_triggers_conditions") +@pytest.mark.parametrize( + ("trigger_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities(DOMAIN), +) +@pytest.mark.parametrize( + ("trigger", "states"), + [ + *parametrize_trigger_states( + trigger="lock.jammed", + target_states=[LockState.JAMMED], + other_states=other_states(LockState.JAMMED), + ), + *parametrize_trigger_states( + trigger="lock.locked", + target_states=[LockState.LOCKED], + other_states=other_states(LockState.LOCKED), + ), + *parametrize_trigger_states( + trigger="lock.opened", + target_states=[LockState.OPEN], + other_states=other_states(LockState.OPEN), + ), + *parametrize_trigger_states( + trigger="lock.unlocked", + target_states=[LockState.UNLOCKED], + other_states=other_states(LockState.UNLOCKED), + ), + ], +) +async def test_lock_state_trigger_behavior_any( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_locks: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the lock state trigger fires when any lock state changes to a specific state.""" + other_entity_ids = set(target_locks) - {entity_id} + + # Set all locks, including the tested one, to the initial state + for eid in target_locks: + 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 locks 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_experimental_triggers_conditions") +@pytest.mark.parametrize( + ("trigger_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities(DOMAIN), +) +@pytest.mark.parametrize( + ("trigger", "states"), + [ + *parametrize_trigger_states( + trigger="lock.jammed", + target_states=[LockState.JAMMED], + other_states=other_states(LockState.JAMMED), + ), + *parametrize_trigger_states( + trigger="lock.locked", + target_states=[LockState.LOCKED], + other_states=other_states(LockState.LOCKED), + ), + *parametrize_trigger_states( + trigger="lock.opened", + target_states=[LockState.OPEN], + other_states=other_states(LockState.OPEN), + ), + *parametrize_trigger_states( + trigger="lock.unlocked", + target_states=[LockState.UNLOCKED], + other_states=other_states(LockState.UNLOCKED), + ), + ], +) +async def test_lock_state_trigger_behavior_first( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_locks: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the lock state trigger fires when the first lock changes to a specific state.""" + other_entity_ids = set(target_locks) - {entity_id} + + # Set all locks, including the tested one, to the initial state + for eid in target_locks: + 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 locks 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_experimental_triggers_conditions") +@pytest.mark.parametrize( + ("trigger_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities(DOMAIN), +) +@pytest.mark.parametrize( + ("trigger", "states"), + [ + *parametrize_trigger_states( + trigger="lock.jammed", + target_states=[LockState.JAMMED], + other_states=other_states(LockState.JAMMED), + ), + *parametrize_trigger_states( + trigger="lock.locked", + target_states=[LockState.LOCKED], + other_states=other_states(LockState.LOCKED), + ), + *parametrize_trigger_states( + trigger="lock.opened", + target_states=[LockState.OPEN], + other_states=other_states(LockState.OPEN), + ), + *parametrize_trigger_states( + trigger="lock.unlocked", + target_states=[LockState.UNLOCKED], + other_states=other_states(LockState.UNLOCKED), + ), + ], +) +async def test_lock_state_trigger_behavior_last( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_locks: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the lock state trigger fires when the last lock changes to a specific state.""" + other_entity_ids = set(target_locks) - {entity_id} + + # Set all locks, including the tested one, to the initial state + for eid in target_locks: + 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()