diff --git a/homeassistant/components/select/device_condition.py b/homeassistant/components/select/device_condition.py new file mode 100644 index 00000000000..444105075b1 --- /dev/null +++ b/homeassistant/components/select/device_condition.py @@ -0,0 +1,88 @@ +"""Provide the device conditions for Select.""" +from __future__ import annotations + +from typing import Any + +import voluptuous as vol + +from homeassistant.const import ( + CONF_CONDITION, + CONF_DEVICE_ID, + CONF_DOMAIN, + CONF_ENTITY_ID, + CONF_FOR, + CONF_TYPE, +) +from homeassistant.core import HomeAssistant, callback +from homeassistant.helpers import condition, config_validation as cv, entity_registry +from homeassistant.helpers.config_validation import DEVICE_CONDITION_BASE_SCHEMA +from homeassistant.helpers.typing import ConfigType, TemplateVarsType + +from .const import ATTR_OPTIONS, CONF_OPTION, DOMAIN + +CONDITION_TYPES = {"selected_option"} + +CONDITION_SCHEMA = DEVICE_CONDITION_BASE_SCHEMA.extend( + { + vol.Required(CONF_ENTITY_ID): cv.entity_id, + vol.Required(CONF_TYPE): vol.In(CONDITION_TYPES), + vol.Required(CONF_OPTION): str, + vol.Optional(CONF_FOR): cv.positive_time_period_dict, + } +) + + +async def async_get_conditions( + hass: HomeAssistant, device_id: str +) -> list[dict[str, str]]: + """List device conditions for Select devices.""" + registry = await entity_registry.async_get_registry(hass) + return [ + { + CONF_CONDITION: "device", + CONF_DEVICE_ID: device_id, + CONF_DOMAIN: DOMAIN, + CONF_ENTITY_ID: entry.entity_id, + CONF_TYPE: "selected_option", + } + for entry in entity_registry.async_entries_for_device(registry, device_id) + if entry.domain == DOMAIN + ] + + +@callback +def async_condition_from_config( + config: ConfigType, config_validation: bool +) -> condition.ConditionCheckerType: + """Create a function to test a device condition.""" + if config_validation: + config = CONDITION_SCHEMA(config) + + @callback + def test_is_state(hass: HomeAssistant, variables: TemplateVarsType) -> bool: + """Test if an entity is a certain state.""" + return condition.state( + hass, config[CONF_ENTITY_ID], config[CONF_OPTION], config.get(CONF_FOR) + ) + + return test_is_state + + +async def async_get_condition_capabilities( + hass: HomeAssistant, config: ConfigType +) -> dict[str, Any]: + """List condition capabilities.""" + state = hass.states.get(config[CONF_ENTITY_ID]) + if state is None: + return {} + + return { + "extra_fields": vol.Schema( + { + vol.Required(CONF_OPTION): vol.In( + state.attributes.get(ATTR_OPTIONS, []) + ), + vol.Optional(CONF_FOR): cv.positive_time_period_dict, + } + ) + } diff --git a/homeassistant/components/select/strings.json b/homeassistant/components/select/strings.json index 3a5424a559b..5724ff67a14 100644 --- a/homeassistant/components/select/strings.json +++ b/homeassistant/components/select/strings.json @@ -6,6 +6,9 @@ }, "action_type": { "select_option": "Change {entity_name} option" + }, + "condition_type": { + "selected_option": "Current {entity_name} selected option" } } } diff --git a/homeassistant/components/select/translations/en.json b/homeassistant/components/select/translations/en.json index ff836198b96..7f126ef36e8 100644 --- a/homeassistant/components/select/translations/en.json +++ b/homeassistant/components/select/translations/en.json @@ -3,6 +3,9 @@ "action_type": { "select_option": "Change {entity_name} option" }, + "condition_type": { + "selected_option": "Current {entity_name} selected option" + }, "trigger_type": { "current_option_changed": "{entity_name} option changed" } diff --git a/tests/components/select/test_device_condition.py b/tests/components/select/test_device_condition.py new file mode 100644 index 00000000000..fa2d2736e0f --- /dev/null +++ b/tests/components/select/test_device_condition.py @@ -0,0 +1,185 @@ +"""The tests for Select device conditions.""" +from __future__ import annotations + +import pytest +import voluptuous_serialize + +from homeassistant.components import automation +from homeassistant.components.select import DOMAIN +from homeassistant.components.select.device_condition import ( + async_get_condition_capabilities, +) +from homeassistant.core import HomeAssistant, ServiceCall +from homeassistant.helpers import ( + config_validation as cv, + device_registry, + entity_registry, +) +from homeassistant.setup import async_setup_component + +from tests.common import ( + MockConfigEntry, + assert_lists_same, + async_get_device_automations, + async_mock_service, + mock_device_registry, + mock_registry, +) + + +@pytest.fixture +def device_reg(hass: HomeAssistant) -> device_registry.DeviceRegistry: + """Return an empty, loaded, registry.""" + return mock_device_registry(hass) + + +@pytest.fixture +def entity_reg(hass: HomeAssistant) -> entity_registry.EntityRegistry: + """Return an empty, loaded, registry.""" + return mock_registry(hass) + + +@pytest.fixture +def calls(hass: HomeAssistant) -> list[ServiceCall]: + """Track calls to a mock service.""" + return async_mock_service(hass, "test", "automation") + + +async def test_get_conditions( + hass: HomeAssistant, + device_reg: device_registry.DeviceRegistry, + entity_reg: entity_registry.EntityRegistry, +) -> None: + """Test we get the expected conditions from a select.""" + 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) + expected_conditions = [ + { + "condition": "device", + "domain": DOMAIN, + "type": "selected_option", + "device_id": device_entry.id, + "entity_id": f"{DOMAIN}.test_5678", + } + ] + conditions = await async_get_device_automations(hass, "condition", device_entry.id) + assert_lists_same(conditions, expected_conditions) + + +async def test_if_selected_option( + hass: HomeAssistant, calls: list[ServiceCall] +) -> None: + """Test for selected_option conditions.""" + assert await async_setup_component( + hass, + automation.DOMAIN, + { + automation.DOMAIN: [ + { + "trigger": {"platform": "event", "event_type": "test_event1"}, + "condition": [ + { + "condition": "device", + "domain": DOMAIN, + "device_id": "", + "entity_id": "select.entity", + "type": "selected_option", + "option": "option1", + } + ], + "action": { + "service": "test.automation", + "data": { + "result": "option1 - {{ trigger.platform }} - {{ trigger.event.event_type }}" + }, + }, + }, + { + "trigger": {"platform": "event", "event_type": "test_event2"}, + "condition": [ + { + "condition": "device", + "domain": DOMAIN, + "device_id": "", + "entity_id": "select.entity", + "type": "selected_option", + "option": "option2", + } + ], + "action": { + "service": "test.automation", + "data": { + "result": "option2 - {{ trigger.platform }} - {{ trigger.event.event_type }}" + }, + }, + }, + ] + }, + ) + + # Test with non existing entity + hass.bus.async_fire("test_event1") + hass.bus.async_fire("test_event2") + await hass.async_block_till_done() + assert len(calls) == 0 + + hass.states.async_set( + "select.entity", "option1", {"options": ["option1", "option2"]} + ) + hass.bus.async_fire("test_event1") + hass.bus.async_fire("test_event2") + await hass.async_block_till_done() + assert len(calls) == 1 + assert calls[0].data["result"] == "option1 - event - test_event1" + + hass.states.async_set( + "select.entity", "option2", {"options": ["option1", "option2"]} + ) + hass.bus.async_fire("test_event1") + hass.bus.async_fire("test_event2") + await hass.async_block_till_done() + assert len(calls) == 2 + assert calls[1].data["result"] == "option2 - event - test_event2" + + +async def test_get_condition_capabilities(hass: HomeAssistant) -> None: + """Test we get the expected capabilities from a select condition.""" + config = { + "platform": "device", + "domain": DOMAIN, + "type": "selected_option", + "entity_id": "select.test", + "option": "option1", + } + + # Test when entity doesn't exists + capabilities = await async_get_condition_capabilities(hass, config) + assert capabilities == {} + + # Mock an entity + hass.states.async_set("select.test", "option1", {"options": ["option1", "option2"]}) + + # Test if we get the right capabilities now + capabilities = await async_get_condition_capabilities(hass, config) + assert capabilities + assert "extra_fields" in capabilities + assert voluptuous_serialize.convert( + capabilities["extra_fields"], custom_serializer=cv.custom_serializer + ) == [ + { + "name": "option", + "required": True, + "type": "select", + "options": [("option1", "option1"), ("option2", "option2")], + }, + { + "name": "for", + "optional": True, + "type": "positive_time_period_dict", + }, + ]