Merge branch 'dev' into device_tracker_triggers

homeassistant/components/automation/__init__.py

@@ -127,6 +127,7 @@ _EXPERIMENTAL_TRIGGER_PLATFORMS = {
     "binary_sensor",
     "climate",
     "cover",
+    "device_tracker",
     "fan",
     "lawn_mower",
     "light",

homeassistant/components/device_tracker/icons.json

@@ -11,5 +11,13 @@
     "see": {
       "service": "mdi:account-eye"
     }
+  },
+  "triggers": {
+    "entered_home": {
+      "trigger": "mdi:account-arrow-left"
+    },
+    "left_home": {
+      "trigger": "mdi:account-arrow-right"
+    }
   }
 }

homeassistant/components/device_tracker/strings.json

@@ -1,4 +1,8 @@
 {
+  "common": {
+    "trigger_behavior_description": "The behavior of the targeted device trackers to trigger on.",
+    "trigger_behavior_name": "Behavior"
+  },
   "device_automation": {
     "condition_type": {
       "is_home": "{entity_name} is home",
@@ -44,6 +48,15 @@
       }
     }
   },
+  "selector": {
+    "trigger_behavior": {
+      "options": {
+        "any": "Any",
+        "first": "First",
+        "last": "Last"
+      }
+    }
+  },
   "services": {
     "see": {
       "description": "Manually update the records of a seen legacy device tracker in the known_devices.yaml file.",
@@ -80,5 +93,27 @@
       "name": "See"
     }
   },
-  "title": "Device tracker"
+  "title": "Device tracker",
+  "triggers": {
+    "entered_home": {
+      "description": "Triggers when one or more device trackers enter home.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::device_tracker::common::trigger_behavior_description%]",
+          "name": "[%key:component::device_tracker::common::trigger_behavior_name%]"
+        }
+      },
+      "name": "Entered home"
+    },
+    "left_home": {
+      "description": "Triggers when one or more device trackers leave home.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::device_tracker::common::trigger_behavior_description%]",
+          "name": "[%key:component::device_tracker::common::trigger_behavior_name%]"
+        }
+      },
+      "name": "Left home"
+    }
+  }
 }

homeassistant/components/device_tracker/trigger.py

@@ -0,0 +1,21 @@
+"""Provides triggers for device_trackers."""
+
+from homeassistant.const import STATE_HOME
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.trigger import (
+    Trigger,
+    make_entity_state_trigger,
+    make_from_entity_state_trigger,
+)
+
+from .const import DOMAIN
+
+TRIGGERS: dict[str, type[Trigger]] = {
+    "entered_home": make_entity_state_trigger(DOMAIN, STATE_HOME),
+    "left_home": make_from_entity_state_trigger(DOMAIN, from_state=STATE_HOME),
+}
+
+
+async def async_get_triggers(hass: HomeAssistant) -> dict[str, type[Trigger]]:
+    """Return the triggers for device trackers."""
+    return TRIGGERS

homeassistant/components/device_tracker/triggers.yaml

@@ -0,0 +1,18 @@
+.trigger_common: &trigger_common
+  target:
+    entity:
+      domain: device_tracker
+  fields:
+    behavior:
+      required: true
+      default: any
+      selector:
+        select:
+          options:
+            - first
+            - last
+            - any
+          translation_key: trigger_behavior
+
+entered_home: *trigger_common
+left_home: *trigger_common

homeassistant/helpers/trigger.py

@@ -453,6 +453,22 @@ class ConditionalEntityStateTriggerBase(EntityTriggerBase):
         return state.state in self._to_states
 
 
+class EntityFromStateTriggerBase(EntityTriggerBase):
+    """Class for entity state changes from a specific state."""
+
+    _from_state: str
+
+    def is_valid_transition(self, from_state: State, to_state: State) -> bool:
+        """Check if the origin state matches the expected one and that the state changed."""
+        return (
+            from_state.state == self._from_state and to_state.state != self._from_state
+        )
+
+    def is_valid_state(self, state: State) -> bool:
+        """Check if the new state is not the same as the expected origin state."""
+        return state.state != self._from_state
+
+
 class EntityStateAttributeTriggerBase(EntityTriggerBase):
     """Trigger for entity state attribute changes."""
 
@@ -493,6 +509,20 @@ def make_conditional_entity_state_trigger(
     return CustomTrigger
 
 
+def make_from_entity_state_trigger(
+    domain: str, *, from_state: str
+) -> type[EntityFromStateTriggerBase]:
+    """Create a "from" entity state trigger class."""
+
+    class CustomTrigger(EntityFromStateTriggerBase):
+        """Trigger for "from" entity state changes."""
+
+        _domain = domain
+        _from_state = from_state
+
+    return CustomTrigger
+
+
 def make_entity_state_attribute_trigger(
     domain: str, attribute: str, to_state: str
 ) -> type[EntityStateAttributeTriggerBase]:

tests/components/device_tracker/test_trigger.py

@@ -0,0 +1,231 @@
+"""Test device_tracker trigger."""
+
+from collections.abc import Generator
+from unittest.mock import patch
+
+import pytest
+
+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_device_trackers(hass: HomeAssistant) -> list[str]:
+    """Create multiple device_trackers entities associated with different targets."""
+    return (await target_entities(hass, "device_tracker"))["included"]
+
+
+@pytest.mark.parametrize(
+    "trigger_key",
+    ["device_tracker.entered_home", "device_tracker.left_home"],
+)
+async def test_device_tracker_triggers_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str
+) -> None:
+    """Test the device_tracker 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("device_tracker"),
+)
+@pytest.mark.parametrize(
+    ("trigger", "states"),
+    [
+        *parametrize_trigger_states(
+            trigger="device_tracker.entered_home",
+            target_states=[STATE_HOME],
+            other_states=[STATE_NOT_HOME, STATE_WORK_ZONE],
+        ),
+        *parametrize_trigger_states(
+            trigger="device_tracker.left_home",
+            target_states=[STATE_NOT_HOME, STATE_WORK_ZONE],
+            other_states=[STATE_HOME],
+        ),
+    ],
+)
+async def test_device_tracker_home_trigger_behavior_any(
+    hass: HomeAssistant,
+    service_calls: list[ServiceCall],
+    target_device_trackers: list[str],
+    trigger_target_config: dict,
+    entity_id: str,
+    entities_in_target: int,
+    trigger: str,
+    states: list[StateDescription],
+) -> None:
+    """Test that the device_tracker home triggers when any device_tracker changes to a specific state."""
+    other_entity_ids = set(target_device_trackers) - {entity_id}
+
+    # Set all device_trackers, including the tested device_tracker, to the initial state
+    for eid in target_device_trackers:
+        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 device_trackers 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("device_tracker"),
+)
+@pytest.mark.parametrize(
+    ("trigger", "states"),
+    [
+        *parametrize_trigger_states(
+            trigger="device_tracker.entered_home",
+            target_states=[STATE_HOME],
+            other_states=[STATE_NOT_HOME, STATE_WORK_ZONE],
+        ),
+        *parametrize_trigger_states(
+            trigger="device_tracker.left_home",
+            target_states=[STATE_NOT_HOME, STATE_WORK_ZONE],
+            other_states=[STATE_HOME],
+        ),
+    ],
+)
+async def test_device_tracker_state_trigger_behavior_first(
+    hass: HomeAssistant,
+    service_calls: list[ServiceCall],
+    target_device_trackers: list[str],
+    trigger_target_config: dict,
+    entity_id: str,
+    entities_in_target: int,
+    trigger: str,
+    states: list[StateDescription],
+) -> None:
+    """Test that the device_tracker home triggers when the first device_tracker changes to a specific state."""
+    other_entity_ids = set(target_device_trackers) - {entity_id}
+
+    # Set all device_trackers, including the tested device_tracker, to the initial state
+    for eid in target_device_trackers:
+        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 device_trackers 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("device_tracker"),
+)
+@pytest.mark.parametrize(
+    ("trigger", "states"),
+    [
+        *parametrize_trigger_states(
+            trigger="device_tracker.entered_home",
+            target_states=[STATE_HOME],
+            other_states=[STATE_NOT_HOME, STATE_WORK_ZONE],
+        ),
+        *parametrize_trigger_states(
+            trigger="device_tracker.left_home",
+            target_states=[STATE_NOT_HOME, STATE_WORK_ZONE],
+            other_states=[STATE_HOME],
+        ),
+    ],
+)
+async def test_device_tracker_state_trigger_behavior_last(
+    hass: HomeAssistant,
+    service_calls: list[ServiceCall],
+    target_device_trackers: list[str],
+    trigger_target_config: dict,
+    entity_id: str,
+    entities_in_target: int,
+    trigger: str,
+    states: list[StateDescription],
+) -> None:
+    """Test that the device_tracker home triggers when the last device_tracker changes to a specific state."""
+    other_entity_ids = set(target_device_trackers) - {entity_id}
+
+    # Set all device_trackers, including the tested device_tracker, to the initial state
+    for eid in target_device_trackers:
+        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()