diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 03cfe6065b5..04cc393f288 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -136,6 +136,7 @@ _EXPERIMENTAL_TRIGGER_PLATFORMS = { "light", "lock", "media_player", + "person", "scene", "siren", "switch", diff --git a/homeassistant/components/person/icons.json b/homeassistant/components/person/icons.json index f645d9c2090..39b34a1648f 100644 --- a/homeassistant/components/person/icons.json +++ b/homeassistant/components/person/icons.json @@ -11,5 +11,13 @@ "reload": { "service": "mdi:reload" } + }, + "triggers": { + "entered_home": { + "trigger": "mdi:account-arrow-left" + }, + "left_home": { + "trigger": "mdi:account-arrow-right" + } } } diff --git a/homeassistant/components/person/strings.json b/homeassistant/components/person/strings.json index 93483069a39..32b562a0b90 100644 --- a/homeassistant/components/person/strings.json +++ b/homeassistant/components/person/strings.json @@ -1,4 +1,8 @@ { + "common": { + "trigger_behavior_description": "The behavior of the targeted persons to trigger on.", + "trigger_behavior_name": "Behavior" + }, "entity_component": { "_": { "name": "[%key:component::person::title%]", @@ -25,11 +29,42 @@ } } }, + "selector": { + "trigger_behavior": { + "options": { + "any": "Any", + "first": "First", + "last": "Last" + } + } + }, "services": { "reload": { "description": "Reloads persons from the YAML-configuration.", "name": "[%key:common::action::reload%]" } }, - "title": "Person" + "title": "Person", + "triggers": { + "entered_home": { + "description": "Triggers when one or more persons enter home.", + "fields": { + "behavior": { + "description": "[%key:component::person::common::trigger_behavior_description%]", + "name": "[%key:component::person::common::trigger_behavior_name%]" + } + }, + "name": "Entered home" + }, + "left_home": { + "description": "Triggers when one or more persons leave home.", + "fields": { + "behavior": { + "description": "[%key:component::person::common::trigger_behavior_description%]", + "name": "[%key:component::person::common::trigger_behavior_name%]" + } + }, + "name": "Left home" + } + } } diff --git a/homeassistant/components/person/trigger.py b/homeassistant/components/person/trigger.py new file mode 100644 index 00000000000..0ca46a6cd43 --- /dev/null +++ b/homeassistant/components/person/trigger.py @@ -0,0 +1,21 @@ +"""Provides triggers for persons.""" + +from homeassistant.const import STATE_HOME +from homeassistant.core import HomeAssistant +from homeassistant.helpers.trigger import ( + Trigger, + make_entity_origin_state_trigger, + make_entity_target_state_trigger, +) + +from .const import DOMAIN + +TRIGGERS: dict[str, type[Trigger]] = { + "entered_home": make_entity_target_state_trigger(DOMAIN, STATE_HOME), + "left_home": make_entity_origin_state_trigger(DOMAIN, from_state=STATE_HOME), +} + + +async def async_get_triggers(hass: HomeAssistant) -> dict[str, type[Trigger]]: + """Return the triggers for persons.""" + return TRIGGERS diff --git a/homeassistant/components/person/triggers.yaml b/homeassistant/components/person/triggers.yaml new file mode 100644 index 00000000000..31208321b54 --- /dev/null +++ b/homeassistant/components/person/triggers.yaml @@ -0,0 +1,18 @@ +.trigger_common: &trigger_common + target: + entity: + domain: person + fields: + behavior: + required: true + default: any + selector: + select: + options: + - first + - last + - any + translation_key: trigger_behavior + +entered_home: *trigger_common +left_home: *trigger_common diff --git a/tests/components/person/test_trigger.py b/tests/components/person/test_trigger.py new file mode 100644 index 00000000000..6435e0b7529 --- /dev/null +++ b/tests/components/person/test_trigger.py @@ -0,0 +1,232 @@ +"""Test person trigger.""" + +from collections.abc import Generator +from unittest.mock import patch + +import pytest + +from homeassistant.components.person.const import DOMAIN +from homeassistant.const import ( + ATTR_LABEL_ID, + CONF_ENTITY_ID, + STATE_HOME, + STATE_NOT_HOME, +) +from homeassistant.core import HomeAssistant, ServiceCall + +from tests.components import ( + StateDescription, + arm_trigger, + parametrize_target_entities, + parametrize_trigger_states, + set_or_remove_state, + target_entities, +) + +STATE_WORK_ZONE = "work" + + +@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_persons(hass: HomeAssistant) -> list[str]: + """Create multiple persons entities associated with different targets.""" + return (await target_entities(hass, DOMAIN))["included"] + + +@pytest.mark.parametrize( + "trigger_key", + ["person.entered_home", "person.left_home"], +) +async def test_person_triggers_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str +) -> None: + """Test the person 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="person.entered_home", + target_states=[STATE_HOME], + other_states=[STATE_NOT_HOME, STATE_WORK_ZONE], + ), + *parametrize_trigger_states( + trigger="person.left_home", + target_states=[STATE_NOT_HOME, STATE_WORK_ZONE], + other_states=[STATE_HOME], + ), + ], +) +async def test_person_home_trigger_behavior_any( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_persons: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the person home triggers when any person changes to a specific state.""" + other_entity_ids = set(target_persons) - {entity_id} + + # Set all persons, including the tested person, to the initial state + for eid in target_persons: + 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 that changing other persons 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="person.entered_home", + target_states=[STATE_HOME], + other_states=[STATE_NOT_HOME, STATE_WORK_ZONE], + ), + *parametrize_trigger_states( + trigger="person.left_home", + target_states=[STATE_NOT_HOME, STATE_WORK_ZONE], + other_states=[STATE_HOME], + ), + ], +) +async def test_person_state_trigger_behavior_first( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_persons: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the person home triggers when the first person changes to a specific state.""" + other_entity_ids = set(target_persons) - {entity_id} + + # Set all persons, including the tested person, to the initial state + for eid in target_persons: + 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 persons 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="person.entered_home", + target_states=[STATE_HOME], + other_states=[STATE_NOT_HOME, STATE_WORK_ZONE], + ), + *parametrize_trigger_states( + trigger="person.left_home", + target_states=[STATE_NOT_HOME, STATE_WORK_ZONE], + other_states=[STATE_HOME], + ), + ], +) +async def test_person_state_trigger_behavior_last( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_persons: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the person home triggers when the last person changes to a specific state.""" + other_entity_ids = set(target_persons) - {entity_id} + + # Set all persons, including the tested person, to the initial state + for eid in target_persons: + 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()