diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 4835d9149d43..6b4cac866e78 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -127,6 +127,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = { "assist_satellite", "fan", "light", + "siren", } _EXPERIMENTAL_TRIGGER_PLATFORMS = { diff --git a/homeassistant/components/siren/condition.py b/homeassistant/components/siren/condition.py new file mode 100644 index 000000000000..2593b00428d9 --- /dev/null +++ b/homeassistant/components/siren/condition.py @@ -0,0 +1,17 @@ +"""Provides conditions for sirens.""" + +from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.condition import Condition, make_entity_state_condition + +from . import DOMAIN + +CONDITIONS: dict[str, type[Condition]] = { + "is_off": make_entity_state_condition(DOMAIN, STATE_OFF), + "is_on": make_entity_state_condition(DOMAIN, STATE_ON), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the siren conditions.""" + return CONDITIONS diff --git a/homeassistant/components/siren/conditions.yaml b/homeassistant/components/siren/conditions.yaml new file mode 100644 index 000000000000..41145760d92e --- /dev/null +++ b/homeassistant/components/siren/conditions.yaml @@ -0,0 +1,17 @@ +.condition_common: &condition_common + target: + entity: + domain: siren + fields: + behavior: + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any + +is_off: *condition_common +is_on: *condition_common diff --git a/homeassistant/components/siren/icons.json b/homeassistant/components/siren/icons.json index e43289ffcf04..fa13d2857675 100644 --- a/homeassistant/components/siren/icons.json +++ b/homeassistant/components/siren/icons.json @@ -1,4 +1,12 @@ { + "conditions": { + "is_off": { + "condition": "mdi:bullhorn-outline" + }, + "is_on": { + "condition": "mdi:bullhorn" + } + }, "entity_component": { "_": { "default": "mdi:bullhorn" diff --git a/homeassistant/components/siren/strings.json b/homeassistant/components/siren/strings.json index ff78a9a48d87..4c4b186d58dd 100644 --- a/homeassistant/components/siren/strings.json +++ b/homeassistant/components/siren/strings.json @@ -1,8 +1,32 @@ { "common": { + "condition_behavior_description": "How the state should match on the targeted sirens.", + "condition_behavior_name": "Behavior", "trigger_behavior_description": "The behavior of the targeted sirens to trigger on.", "trigger_behavior_name": "Behavior" }, + "conditions": { + "is_off": { + "description": "Tests if one or more sirens are off.", + "fields": { + "behavior": { + "description": "[%key:component::siren::common::condition_behavior_description%]", + "name": "[%key:component::siren::common::condition_behavior_name%]" + } + }, + "name": "If a siren is off" + }, + "is_on": { + "description": "Tests if one or more sirens are on.", + "fields": { + "behavior": { + "description": "[%key:component::siren::common::condition_behavior_description%]", + "name": "[%key:component::siren::common::condition_behavior_name%]" + } + }, + "name": "If a siren is on" + } + }, "entity_component": { "_": { "name": "[%key:component::siren::title%]", @@ -18,6 +42,12 @@ } }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "trigger_behavior": { "options": { "any": "Any", diff --git a/tests/components/siren/test_condition.py b/tests/components/siren/test_condition.py new file mode 100644 index 000000000000..dd9eb6876cb2 --- /dev/null +++ b/tests/components/siren/test_condition.py @@ -0,0 +1,178 @@ +"""Test siren conditions.""" + +from typing import Any + +import pytest + +from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant + +from tests.components import ( + ConditionStateDescription, + assert_condition_gated_by_labs_flag, + create_target_condition, + parametrize_condition_states_all, + parametrize_condition_states_any, + parametrize_target_entities, + 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 +async def target_sirens(hass: HomeAssistant) -> list[str]: + """Create multiple siren entities associated with different targets.""" + return (await target_entities(hass, "siren"))["included"] + + +@pytest.fixture +async def target_switches(hass: HomeAssistant) -> list[str]: + """Create multiple switch entities associated with different targets.""" + return (await target_entities(hass, "switch"))["included"] + + +@pytest.mark.parametrize( + "condition", + [ + "siren.is_off", + "siren.is_on", + ], +) +async def test_siren_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the siren 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("siren"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_any( + condition="siren.is_on", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + *parametrize_condition_states_any( + condition="siren.is_off", + target_states=[STATE_OFF], + other_states=[STATE_ON], + ), + ], +) +async def test_siren_state_condition_behavior_any( + hass: HomeAssistant, + target_sirens: list[str], + target_switches: 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 siren state condition with the 'any' behavior.""" + other_entity_ids = set(target_sirens) - {entity_id} + + # Set all sirens, including the tested siren, to the initial state + for eid in target_sirens: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + condition = await create_target_condition( + hass, + condition=condition, + target=condition_target_config, + behavior="any", + ) + + # Set state for switches to ensure that they don't impact the condition + for state in states: + for eid in target_switches: + set_or_remove_state(hass, eid, state["included"]) + await hass.async_block_till_done() + assert condition(hass) is False + + for state in states: + included_state = state["included"] + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + assert condition(hass) == state["condition_true"] + + # Check if changing other sirens also passes the condition + 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 condition(hass) == state["condition_true"] + + +@pytest.mark.usefixtures("enable_labs_preview_features") +@pytest.mark.parametrize( + ("condition_target_config", "entity_id", "entities_in_target"), + parametrize_target_entities("siren"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_all( + condition="siren.is_on", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + *parametrize_condition_states_all( + condition="siren.is_off", + target_states=[STATE_OFF], + other_states=[STATE_ON], + ), + ], +) +async def test_siren_state_condition_behavior_all( + hass: HomeAssistant, + target_sirens: 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 siren state condition with the 'all' behavior.""" + # Set state for two switches to ensure that they don't impact the condition + hass.states.async_set("switch.label_switch_1", STATE_OFF) + hass.states.async_set("switch.label_switch_2", STATE_ON) + other_entity_ids = set(target_sirens) - {entity_id} + + # Set all sirens, including the tested siren, to the initial state + for eid in target_sirens: + set_or_remove_state(hass, eid, states[0]["included"]) + await hass.async_block_till_done() + + condition = await create_target_condition( + hass, + condition=condition, + target=condition_target_config, + behavior="all", + ) + + for state in states: + included_state = state["included"] + + set_or_remove_state(hass, entity_id, included_state) + await hass.async_block_till_done() + assert condition(hass) == state["condition_true_first_entity"] + + 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 condition(hass) == state["condition_true"]