diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index a648207bbea9..f667a878e01a 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -152,6 +152,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = { "text", "timer", "todo", + "update", "vacuum", "valve", "water_heater", diff --git a/homeassistant/components/update/condition.py b/homeassistant/components/update/condition.py new file mode 100644 index 000000000000..fd74562ec51e --- /dev/null +++ b/homeassistant/components/update/condition.py @@ -0,0 +1,17 @@ +"""Provides conditions for updates.""" + +from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.condition import Condition, make_entity_state_condition + +from .const import DOMAIN + +CONDITIONS: dict[str, type[Condition]] = { + "is_available": make_entity_state_condition(DOMAIN, STATE_ON), + "is_not_available": make_entity_state_condition(DOMAIN, STATE_OFF), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the update conditions.""" + return CONDITIONS diff --git a/homeassistant/components/update/conditions.yaml b/homeassistant/components/update/conditions.yaml new file mode 100644 index 000000000000..210ea2565d04 --- /dev/null +++ b/homeassistant/components/update/conditions.yaml @@ -0,0 +1,17 @@ +.condition_common: &condition_common + target: + entity: + domain: update + fields: + behavior: + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any + +is_available: *condition_common +is_not_available: *condition_common diff --git a/homeassistant/components/update/icons.json b/homeassistant/components/update/icons.json index 3ed26f4b6bd7..7c015da2478b 100644 --- a/homeassistant/components/update/icons.json +++ b/homeassistant/components/update/icons.json @@ -1,4 +1,12 @@ { + "conditions": { + "is_available": { + "condition": "mdi:package-up" + }, + "is_not_available": { + "condition": "mdi:package" + } + }, "entity_component": { "_": { "default": "mdi:package-up", diff --git a/homeassistant/components/update/strings.json b/homeassistant/components/update/strings.json index 7634d59a3c37..a067324eb8f6 100644 --- a/homeassistant/components/update/strings.json +++ b/homeassistant/components/update/strings.json @@ -1,7 +1,28 @@ { "common": { + "condition_behavior_name": "Condition passes if", "trigger_behavior_name": "Trigger when" }, + "conditions": { + "is_available": { + "description": "Tests if one or more updates are available.", + "fields": { + "behavior": { + "name": "[%key:component::update::common::condition_behavior_name%]" + } + }, + "name": "Update is available" + }, + "is_not_available": { + "description": "Tests if one or more updates are not available.", + "fields": { + "behavior": { + "name": "[%key:component::update::common::condition_behavior_name%]" + } + }, + "name": "Update is not available" + } + }, "device_automation": { "extra_fields": { "for": "[%key:common::device_automation::extra_fields::for%]" @@ -59,6 +80,12 @@ } }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "trigger_behavior": { "options": { "any": "Any", diff --git a/tests/components/update/test_condition.py b/tests/components/update/test_condition.py new file mode 100644 index 000000000000..e8e839d3a14e --- /dev/null +++ b/tests/components/update/test_condition.py @@ -0,0 +1,129 @@ +"""Test update conditions.""" + +from typing import Any + +import pytest + +from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant + +from tests.components.common import ( + ConditionStateDescription, + assert_condition_behavior_all, + assert_condition_behavior_any, + assert_condition_gated_by_labs_flag, + parametrize_condition_states_all, + parametrize_condition_states_any, + parametrize_target_entities, + target_entities, +) + + +@pytest.fixture +async def target_updates(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple update entities associated with different targets.""" + return await target_entities(hass, "update", domain_excluded="switch") + + +@pytest.mark.parametrize( + "condition", + [ + "update.is_available", + "update.is_not_available", + ], +) +async def test_update_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the update conditions are gated by the labs flag.""" + await assert_condition_gated_by_labs_flag(hass, caplog, condition) + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("update"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_any( + condition="update.is_available", + target_states=[STATE_ON], + other_states=[STATE_OFF], + excluded_entities_from_other_domain=True, + ), + *parametrize_condition_states_any( + condition="update.is_not_available", + target_states=[STATE_OFF], + other_states=[STATE_ON], + excluded_entities_from_other_domain=True, + ), + ], +) +async def test_update_state_condition_behavior_any( + hass: HomeAssistant, + target_updates: dict[str, list[str]], + condition_target_config: dict, + entity_id: str, + entities_in_target: int, + condition: str, + condition_options: dict[str, Any], + states: list[ConditionStateDescription], +) -> None: + """Test the update state condition with the 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_updates, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + ) + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("update"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_all( + condition="update.is_available", + target_states=[STATE_ON], + other_states=[STATE_OFF], + excluded_entities_from_other_domain=True, + ), + *parametrize_condition_states_all( + condition="update.is_not_available", + target_states=[STATE_OFF], + other_states=[STATE_ON], + excluded_entities_from_other_domain=True, + ), + ], +) +async def test_update_state_condition_behavior_all( + hass: HomeAssistant, + target_updates: dict[str, list[str]], + condition_target_config: dict, + entity_id: str, + entities_in_target: int, + condition: str, + condition_options: dict[str, Any], + states: list[ConditionStateDescription], +) -> None: + """Test the update state condition with the 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_updates, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + )