From 9526701e578b6babeac851315c46268fbabb7c12 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Tue, 30 Mar 2021 13:49:23 +0200 Subject: [PATCH] Add 'for' to alarm device triggers (#48503) --- .../alarm_control_panel/device_trigger.py | 13 +++ .../test_device_trigger.py | 88 ++++++++++++++++++- 2 files changed, 100 insertions(+), 1 deletion(-) diff --git a/homeassistant/components/alarm_control_panel/device_trigger.py b/homeassistant/components/alarm_control_panel/device_trigger.py index c5d2cdd2e37f..fb93429998bd 100644 --- a/homeassistant/components/alarm_control_panel/device_trigger.py +++ b/homeassistant/components/alarm_control_panel/device_trigger.py @@ -16,6 +16,7 @@ from homeassistant.const import ( CONF_DEVICE_ID, CONF_DOMAIN, CONF_ENTITY_ID, + CONF_FOR, CONF_PLATFORM, CONF_TYPE, STATE_ALARM_ARMED_AWAY, @@ -44,6 +45,7 @@ TRIGGER_SCHEMA = TRIGGER_BASE_SCHEMA.extend( { vol.Required(CONF_ENTITY_ID): cv.entity_id, vol.Required(CONF_TYPE): vol.In(TRIGGER_TYPES), + vol.Optional(CONF_FOR): cv.positive_time_period_dict, } ) @@ -124,6 +126,15 @@ async def async_get_triggers(hass: HomeAssistant, device_id: str) -> list[dict]: return triggers +async def async_get_trigger_capabilities(hass: HomeAssistant, config: dict) -> dict: + """List trigger capabilities.""" + return { + "extra_fields": vol.Schema( + {vol.Optional(CONF_FOR): cv.positive_time_period_dict} + ) + } + + async def async_attach_trigger( hass: HomeAssistant, config: ConfigType, @@ -149,6 +160,8 @@ async def async_attach_trigger( CONF_ENTITY_ID: config[CONF_ENTITY_ID], state_trigger.CONF_TO: to_state, } + if CONF_FOR in config: + state_config[CONF_FOR] = config[CONF_FOR] state_config = state_trigger.TRIGGER_SCHEMA(state_config) return await state_trigger.async_attach_trigger( hass, state_config, action, automation_info, platform_type="device" diff --git a/tests/components/alarm_control_panel/test_device_trigger.py b/tests/components/alarm_control_panel/test_device_trigger.py index ca6260863f10..3380cdd9654a 100644 --- a/tests/components/alarm_control_panel/test_device_trigger.py +++ b/tests/components/alarm_control_panel/test_device_trigger.py @@ -1,4 +1,6 @@ """The tests for Alarm control panel device triggers.""" +from datetime import timedelta + import pytest from homeassistant.components.alarm_control_panel import DOMAIN @@ -13,10 +15,13 @@ from homeassistant.const import ( ) from homeassistant.helpers import device_registry from homeassistant.setup import async_setup_component +import homeassistant.util.dt as dt_util from tests.common import ( MockConfigEntry, assert_lists_same, + async_fire_time_changed, + async_get_device_automation_capabilities, async_get_device_automations, async_mock_service, mock_device_registry, @@ -44,7 +49,7 @@ def calls(hass): async def test_get_triggers(hass, device_reg, entity_reg): - """Test we get the expected triggers from a alarm_control_panel.""" + """Test we get the expected triggers from an alarm_control_panel.""" config_entry = MockConfigEntry(domain="test", data={}) config_entry.add_to_hass(hass) device_entry = device_reg.async_get_or_create( @@ -103,6 +108,32 @@ async def test_get_triggers(hass, device_reg, entity_reg): assert_lists_same(triggers, expected_triggers) +async def test_get_trigger_capabilities(hass, device_reg, entity_reg): + """Test we get the expected capabilities from an alarm_control_panel.""" + config_entry = MockConfigEntry(domain="test", data={}) + config_entry.add_to_hass(hass) + device_entry = device_reg.async_get_or_create( + config_entry_id=config_entry.entry_id, + connections={(device_registry.CONNECTION_NETWORK_MAC, "12:34:56:AB:CD:EF")}, + ) + entity_reg.async_get_or_create(DOMAIN, "test", "5678", device_id=device_entry.id) + hass.states.async_set( + "alarm_control_panel.test_5678", "attributes", {"supported_features": 15} + ) + + triggers = await async_get_device_automations(hass, "trigger", device_entry.id) + assert len(triggers) == 6 + for trigger in triggers: + capabilities = await async_get_device_automation_capabilities( + hass, "trigger", trigger + ) + assert capabilities == { + "extra_fields": [ + {"name": "for", "optional": True, "type": "positive_time_period_dict"} + ] + } + + async def test_if_fires_on_state_change(hass, calls): """Test for turn_on and turn_off triggers firing.""" hass.states.async_set("alarm_control_panel.entity", STATE_ALARM_PENDING) @@ -255,3 +286,58 @@ async def test_if_fires_on_state_change(hass, calls): calls[4].data["some"] == "armed_night - device - alarm_control_panel.entity - armed_away - armed_night - None" ) + + +async def test_if_fires_on_state_change_with_for(hass, calls): + """Test for triggers firing with delay.""" + entity_id = f"{DOMAIN}.entity" + hass.states.async_set(entity_id, STATE_ALARM_DISARMED) + + assert await async_setup_component( + hass, + automation.DOMAIN, + { + automation.DOMAIN: [ + { + "trigger": { + "platform": "device", + "domain": DOMAIN, + "device_id": "", + "entity_id": entity_id, + "type": "triggered", + "for": {"seconds": 5}, + }, + "action": { + "service": "test.automation", + "data_template": { + "some": "turn_off {{ trigger.%s }}" + % "}} - {{ trigger.".join( + ( + "platform", + "entity_id", + "from_state.state", + "to_state.state", + "for", + ) + ) + }, + }, + } + ] + }, + ) + await hass.async_block_till_done() + assert hass.states.get(entity_id).state == STATE_ALARM_DISARMED + assert len(calls) == 0 + + hass.states.async_set(entity_id, STATE_ALARM_TRIGGERED) + await hass.async_block_till_done() + assert len(calls) == 0 + async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=10)) + await hass.async_block_till_done() + assert len(calls) == 1 + await hass.async_block_till_done() + assert ( + calls[0].data["some"] + == f"turn_off device - {entity_id} - disarmed - triggered - 0:00:05" + )