From 78f1b434b397ef7c56eb1598e56e04bf049bdc39 Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Mon, 15 Dec 2025 18:31:51 +0100 Subject: [PATCH] Add update became available trigger (#158984) --- .../components/automation/__init__.py | 1 + homeassistant/components/update/icons.json | 5 + homeassistant/components/update/strings.json | 27 ++- homeassistant/components/update/trigger.py | 16 ++ homeassistant/components/update/triggers.yaml | 17 ++ tests/components/update/test_trigger.py | 212 ++++++++++++++++++ 6 files changed, 277 insertions(+), 1 deletion(-) create mode 100644 homeassistant/components/update/trigger.py create mode 100644 homeassistant/components/update/triggers.yaml create mode 100644 tests/components/update/test_trigger.py diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 05e294ca812..de09aa2c3c7 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -133,6 +133,7 @@ _EXPERIMENTAL_TRIGGER_PLATFORMS = { "media_player", "switch", "text", + "update", "vacuum", } diff --git a/homeassistant/components/update/icons.json b/homeassistant/components/update/icons.json index 89af07de67f..3ed26f4b6bd 100644 --- a/homeassistant/components/update/icons.json +++ b/homeassistant/components/update/icons.json @@ -17,5 +17,10 @@ "skip": { "service": "mdi:package-check" } + }, + "triggers": { + "update_became_available": { + "trigger": "mdi:package-up" + } } } diff --git a/homeassistant/components/update/strings.json b/homeassistant/components/update/strings.json index 13639a164ea..fa226ec1408 100644 --- a/homeassistant/components/update/strings.json +++ b/homeassistant/components/update/strings.json @@ -1,4 +1,8 @@ { + "common": { + "trigger_behavior_description": "The behavior of the targeted updates to become available.", + "trigger_behavior_name": "Behavior" + }, "device_automation": { "extra_fields": { "for": "[%key:common::device_automation::extra_fields::for%]" @@ -55,6 +59,15 @@ "name": "Firmware" } }, + "selector": { + "trigger_behavior": { + "options": { + "any": "Any", + "first": "First", + "last": "Last" + } + } + }, "services": { "clear_skipped": { "description": "Removes the skipped version marker from an update.", @@ -79,5 +92,17 @@ "name": "Skip update" } }, - "title": "Update" + "title": "Update", + "triggers": { + "update_became_available": { + "description": "Triggers after one or more updates become available.", + "fields": { + "behavior": { + "description": "[%key:component::update::common::trigger_behavior_description%]", + "name": "[%key:component::update::common::trigger_behavior_name%]" + } + }, + "name": "Update became available" + } + } } diff --git a/homeassistant/components/update/trigger.py b/homeassistant/components/update/trigger.py new file mode 100644 index 00000000000..6320d17b948 --- /dev/null +++ b/homeassistant/components/update/trigger.py @@ -0,0 +1,16 @@ +"""Provides triggers for update platform.""" + +from homeassistant.const import STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.trigger import Trigger, make_entity_state_trigger + +from .const import DOMAIN + +TRIGGERS: dict[str, type[Trigger]] = { + "update_became_available": make_entity_state_trigger(DOMAIN, STATE_ON), +} + + +async def async_get_triggers(hass: HomeAssistant) -> dict[str, type[Trigger]]: + """Return the triggers for update platform.""" + return TRIGGERS diff --git a/homeassistant/components/update/triggers.yaml b/homeassistant/components/update/triggers.yaml new file mode 100644 index 00000000000..e4a276dd38e --- /dev/null +++ b/homeassistant/components/update/triggers.yaml @@ -0,0 +1,17 @@ +.trigger_common: &trigger_common + target: + entity: + domain: update + fields: + behavior: + required: true + default: any + selector: + select: + options: + - first + - last + - any + translation_key: trigger_behavior + +update_became_available: *trigger_common diff --git a/tests/components/update/test_trigger.py b/tests/components/update/test_trigger.py new file mode 100644 index 00000000000..d7a4da25605 --- /dev/null +++ b/tests/components/update/test_trigger.py @@ -0,0 +1,212 @@ +"""Test update triggers.""" + +from collections.abc import Generator +from unittest.mock import patch + +import pytest + +from homeassistant.components.update import DOMAIN +from homeassistant.const import ATTR_LABEL_ID, CONF_ENTITY_ID, STATE_OFF, STATE_ON +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, +) + + +@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_updates(hass: HomeAssistant) -> list[str]: + """Create multiple update entities associated with different targets.""" + return (await target_entities(hass, DOMAIN))["included"] + + +@pytest.mark.parametrize( + "trigger_key", + [ + "update.update_became_available", + ], +) +async def test_update_triggers_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str +) -> None: + """Test the update 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="update.update_became_available", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + ], +) +async def test_update_state_trigger_behavior_any( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_updates: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the update state trigger fires when any update state changes to a specific state.""" + other_entity_ids = set(target_updates) - {entity_id} + + # Set all updates, including the tested one, to the initial state + for eid in target_updates: + 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 updates 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="update.update_became_available", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + ], +) +async def test_update_state_trigger_behavior_first( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_updates: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the update state trigger fires when the first update changes to a specific state.""" + other_entity_ids = set(target_updates) - {entity_id} + + # Set all updates, including the tested one, to the initial state + for eid in target_updates: + 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 updates 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="update.update_became_available", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + ], +) +async def test_update_state_trigger_behavior_last( + hass: HomeAssistant, + service_calls: list[ServiceCall], + target_updates: list[str], + trigger_target_config: dict, + entity_id: str, + entities_in_target: int, + trigger: str, + states: list[StateDescription], +) -> None: + """Test that the update state trigger fires when the last update changes to a specific state.""" + other_entity_ids = set(target_updates) - {entity_id} + + # Set all updates, including the tested one, to the initial state + for eid in target_updates: + 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()