From 96b7210bca3396f764fe85ffc6afd212c3339735 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Fri, 27 Mar 2026 14:15:41 +0100 Subject: [PATCH] Add calendar conditions (#166643) --- .../components/automation/__init__.py | 1 + .../components/calendar/condition.py | 16 +++ .../components/calendar/conditions.yaml | 14 +++ homeassistant/components/calendar/icons.json | 5 + .../components/calendar/strings.json | 22 ++++ tests/components/calendar/test_condition.py | 114 ++++++++++++++++++ 6 files changed, 172 insertions(+) create mode 100644 homeassistant/components/calendar/condition.py create mode 100644 homeassistant/components/calendar/conditions.yaml create mode 100644 tests/components/calendar/test_condition.py diff --git a/homeassistant/components/automation/__init__.py b/homeassistant/components/automation/__init__.py index 608a13e6ce9..7fa8c5afb6d 100644 --- a/homeassistant/components/automation/__init__.py +++ b/homeassistant/components/automation/__init__.py @@ -122,6 +122,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = { "alarm_control_panel", "assist_satellite", "battery", + "calendar", "climate", "cover", "device_tracker", diff --git a/homeassistant/components/calendar/condition.py b/homeassistant/components/calendar/condition.py new file mode 100644 index 00000000000..3055cb1d754 --- /dev/null +++ b/homeassistant/components/calendar/condition.py @@ -0,0 +1,16 @@ +"""Provides conditions for calendars.""" + +from homeassistant.const import 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_event_active": make_entity_state_condition(DOMAIN, STATE_ON), +} + + +async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]: + """Return the calendar conditions.""" + return CONDITIONS diff --git a/homeassistant/components/calendar/conditions.yaml b/homeassistant/components/calendar/conditions.yaml new file mode 100644 index 00000000000..7452e7ec7fe --- /dev/null +++ b/homeassistant/components/calendar/conditions.yaml @@ -0,0 +1,14 @@ +is_event_active: + target: + entity: + - domain: calendar + fields: + behavior: + required: true + default: any + selector: + select: + translation_key: condition_behavior + options: + - all + - any diff --git a/homeassistant/components/calendar/icons.json b/homeassistant/components/calendar/icons.json index e2faf13658c..f9ae830d300 100644 --- a/homeassistant/components/calendar/icons.json +++ b/homeassistant/components/calendar/icons.json @@ -1,4 +1,9 @@ { + "conditions": { + "is_event_active": { + "condition": "mdi:calendar-check" + } + }, "entity_component": { "_": { "default": "mdi:calendar", diff --git a/homeassistant/components/calendar/strings.json b/homeassistant/components/calendar/strings.json index 0da24e4b97e..8cac1016e80 100644 --- a/homeassistant/components/calendar/strings.json +++ b/homeassistant/components/calendar/strings.json @@ -1,4 +1,20 @@ { + "common": { + "condition_behavior_description": "How the state should match on the targeted calendars.", + "condition_behavior_name": "Behavior" + }, + "conditions": { + "is_event_active": { + "description": "Tests if one or more calendars have an active event.", + "fields": { + "behavior": { + "description": "[%key:component::calendar::common::condition_behavior_description%]", + "name": "[%key:component::calendar::common::condition_behavior_name%]" + } + }, + "name": "Calendar event is active" + } + }, "entity_component": { "_": { "name": "[%key:component::calendar::title%]", @@ -46,6 +62,12 @@ } }, "selector": { + "condition_behavior": { + "options": { + "all": "All", + "any": "Any" + } + }, "trigger_offset_type": { "options": { "after": "After", diff --git a/tests/components/calendar/test_condition.py b/tests/components/calendar/test_condition.py new file mode 100644 index 00000000000..05b7c711314 --- /dev/null +++ b/tests/components/calendar/test_condition.py @@ -0,0 +1,114 @@ +"""Test calendar 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_calendars(hass: HomeAssistant) -> dict[str, list[str]]: + """Create multiple calendar entities associated with different targets.""" + return await target_entities(hass, "calendar") + + +@pytest.mark.parametrize( + "condition", + [ + "calendar.is_event_active", + ], +) +async def test_calendar_conditions_gated_by_labs_flag( + hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str +) -> None: + """Test the calendar 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("calendar"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_any( + condition="calendar.is_event_active", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + ], +) +async def test_calendar_condition_behavior_any( + hass: HomeAssistant, + target_calendars: 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 calendar condition with 'any' behavior.""" + await assert_condition_behavior_any( + hass, + target_entities=target_calendars, + 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("calendar"), +) +@pytest.mark.parametrize( + ("condition", "condition_options", "states"), + [ + *parametrize_condition_states_all( + condition="calendar.is_event_active", + target_states=[STATE_ON], + other_states=[STATE_OFF], + ), + ], +) +async def test_calendar_condition_behavior_all( + hass: HomeAssistant, + target_calendars: 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 calendar condition with 'all' behavior.""" + await assert_condition_behavior_all( + hass, + target_entities=target_calendars, + condition_target_config=condition_target_config, + entity_id=entity_id, + entities_in_target=entities_in_target, + condition=condition, + condition_options=condition_options, + states=states, + )