From af0554374462e2ce6d7c42e8ebb559021c3638e2 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Mon, 14 Jun 2021 14:12:42 +0200 Subject: [PATCH] Improve editing of device conditions referencing non-added humidifier (#51834) --- .../components/humidifier/device_condition.py | 18 +- .../humidifier/test_device_condition.py | 369 +++++++++++------- 2 files changed, 244 insertions(+), 143 deletions(-) diff --git a/homeassistant/components/humidifier/device_condition.py b/homeassistant/components/humidifier/device_condition.py index 02a667f2f68..f2bf032b195 100644 --- a/homeassistant/components/humidifier/device_condition.py +++ b/homeassistant/components/humidifier/device_condition.py @@ -7,16 +7,16 @@ from homeassistant.components.device_automation import toggle_entity from homeassistant.const import ( ATTR_ENTITY_ID, ATTR_MODE, - ATTR_SUPPORTED_FEATURES, CONF_CONDITION, CONF_DEVICE_ID, CONF_DOMAIN, CONF_ENTITY_ID, CONF_TYPE, ) -from homeassistant.core import HomeAssistant, callback +from homeassistant.core import HomeAssistant, HomeAssistantError, 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.entity import get_capability, get_supported_features from homeassistant.helpers.typing import ConfigType, TemplateVarsType from . import DOMAIN, const @@ -48,9 +48,9 @@ async def async_get_conditions( if entry.domain != DOMAIN: continue - state = hass.states.get(entry.entity_id) + supported_features = get_supported_features(hass, entry.entity_id) - if state and state.attributes[ATTR_SUPPORTED_FEATURES] & const.SUPPORT_MODES: + if supported_features & const.SUPPORT_MODES: conditions.append( { CONF_CONDITION: "device", @@ -87,15 +87,17 @@ def async_condition_from_config( async def async_get_condition_capabilities(hass, config): """List condition capabilities.""" - state = hass.states.get(config[CONF_ENTITY_ID]) condition_type = config[CONF_TYPE] fields = {} if condition_type == "is_mode": - if state: - modes = state.attributes.get(const.ATTR_AVAILABLE_MODES, []) - else: + try: + modes = ( + get_capability(hass, config[ATTR_ENTITY_ID], const.ATTR_AVAILABLE_MODES) + or [] + ) + except HomeAssistantError: modes = [] fields[vol.Required(ATTR_MODE)] = vol.In(modes) diff --git a/tests/components/humidifier/test_device_condition.py b/tests/components/humidifier/test_device_condition.py index 59887f65a33..0d0f65d2c97 100644 --- a/tests/components/humidifier/test_device_condition.py +++ b/tests/components/humidifier/test_device_condition.py @@ -11,7 +11,6 @@ from homeassistant.setup import async_setup_component from tests.common import ( MockConfigEntry, assert_lists_same, - async_get_device_automation_capabilities, async_get_device_automations, async_mock_service, mock_device_registry, @@ -38,7 +37,24 @@ def calls(hass): return async_mock_service(hass, "test", "automation") -async def test_get_conditions(hass, device_reg, entity_reg): +@pytest.mark.parametrize( + "set_state,features_reg,features_state,expected_condition_types", + [ + (False, 0, 0, []), + (False, const.SUPPORT_MODES, 0, ["is_mode"]), + (True, 0, 0, []), + (True, 0, const.SUPPORT_MODES, ["is_mode"]), + ], +) +async def test_get_conditions( + hass, + device_reg, + entity_reg, + set_state, + features_reg, + features_state, + expected_condition_types, +): """Test we get the expected conditions from a humidifier.""" config_entry = MockConfigEntry(domain="test", data={}) config_entry.add_to_hass(hass) @@ -46,80 +62,38 @@ async def test_get_conditions(hass, device_reg, entity_reg): 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( - f"{DOMAIN}.test_5678", - STATE_ON, - { - ATTR_MODE: const.MODE_AWAY, - const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY], - }, + entity_reg.async_get_or_create( + DOMAIN, + "test", + "5678", + device_id=device_entry.id, + supported_features=features_reg, ) - hass.states.async_set( - "humidifier.test_5678", "attributes", {"supported_features": 1} - ) - expected_conditions = [ + if set_state: + hass.states.async_set( + f"{DOMAIN}.test_5678", "attributes", {"supported_features": features_state} + ) + expected_conditions = [] + basic_condition_types = ["is_on", "is_off"] + expected_conditions += [ { "condition": "device", "domain": DOMAIN, - "type": "is_off", + "type": condition, "device_id": device_entry.id, "entity_id": f"{DOMAIN}.test_5678", - }, - { - "condition": "device", - "domain": DOMAIN, - "type": "is_on", - "device_id": device_entry.id, - "entity_id": f"{DOMAIN}.test_5678", - }, - { - "condition": "device", - "domain": DOMAIN, - "type": "is_mode", - "device_id": device_entry.id, - "entity_id": f"{DOMAIN}.test_5678", - }, + } + for condition in basic_condition_types ] - conditions = await async_get_device_automations(hass, "condition", device_entry.id) - assert_lists_same(conditions, expected_conditions) - - -async def test_get_conditions_toggle_only(hass, device_reg, entity_reg): - """Test we get the expected conditions from a humidifier.""" - 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( - f"{DOMAIN}.test_5678", - STATE_ON, - { - ATTR_MODE: const.MODE_AWAY, - const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY], - }, - ) - hass.states.async_set( - "humidifier.test_5678", "attributes", {"supported_features": 0} - ) - expected_conditions = [ + expected_conditions += [ { "condition": "device", "domain": DOMAIN, - "type": "is_off", + "type": condition, "device_id": device_entry.id, "entity_id": f"{DOMAIN}.test_5678", - }, - { - "condition": "device", - "domain": DOMAIN, - "type": "is_on", - "device_id": device_entry.id, - "entity_id": f"{DOMAIN}.test_5678", - }, + } + for condition in expected_condition_types ] conditions = await async_get_device_automations(hass, "condition", device_entry.id) assert_lists_same(conditions, expected_conditions) @@ -227,81 +201,206 @@ async def test_if_state(hass, calls): assert len(calls) == 3 -async def test_capabilities(hass): - """Test capabilities.""" - hass.states.async_set( - "humidifier.entity", - STATE_ON, - { - ATTR_MODE: const.MODE_AWAY, - const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY], - }, - ) - - # Test mode - capabilities = await device_condition.async_get_condition_capabilities( - hass, - { - "condition": "device", - "domain": DOMAIN, - "device_id": "", - "entity_id": "humidifier.entity", - "type": "is_mode", - }, - ) - - assert capabilities and "extra_fields" in capabilities - - assert voluptuous_serialize.convert( - capabilities["extra_fields"], custom_serializer=cv.custom_serializer - ) == [ - { - "name": "mode", - "options": [("home", "home"), ("away", "away")], - "required": True, - "type": "select", - } - ] - - -async def test_capabilities_no_state(hass): - """Test capabilities while state not available.""" - # Test mode - capabilities = await device_condition.async_get_condition_capabilities( - hass, - { - "condition": "device", - "domain": DOMAIN, - "device_id": "", - "entity_id": "humidifier.entity", - "type": "is_mode", - }, - ) - - assert capabilities and "extra_fields" in capabilities - - assert voluptuous_serialize.convert( - capabilities["extra_fields"], custom_serializer=cv.custom_serializer - ) == [{"name": "mode", "options": [], "required": True, "type": "select"}] - - -async def test_get_condition_capabilities(hass, device_reg, entity_reg): - """Test we get the expected toggle capabilities.""" +@pytest.mark.parametrize( + "set_state,capabilities_reg,capabilities_state,condition,expected_capabilities", + [ + ( + False, + {}, + {}, + "is_mode", + [ + { + "name": "mode", + "options": [], + "required": True, + "type": "select", + } + ], + ), + ( + False, + {const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY]}, + {}, + "is_mode", + [ + { + "name": "mode", + "options": [("home", "home"), ("away", "away")], + "required": True, + "type": "select", + } + ], + ), + ( + False, + {}, + {}, + "is_off", + [ + { + "name": "for", + "optional": True, + "type": "positive_time_period_dict", + } + ], + ), + ( + False, + {}, + {}, + "is_on", + [ + { + "name": "for", + "optional": True, + "type": "positive_time_period_dict", + } + ], + ), + ( + True, + {}, + {}, + "is_mode", + [ + { + "name": "mode", + "options": [], + "required": True, + "type": "select", + } + ], + ), + ( + True, + {}, + {const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY]}, + "is_mode", + [ + { + "name": "mode", + "options": [("home", "home"), ("away", "away")], + "required": True, + "type": "select", + } + ], + ), + ( + True, + {}, + {}, + "is_off", + [ + { + "name": "for", + "optional": True, + "type": "positive_time_period_dict", + } + ], + ), + ( + True, + {}, + {}, + "is_on", + [ + { + "name": "for", + "optional": True, + "type": "positive_time_period_dict", + } + ], + ), + ], +) +async def test_capabilities( + hass, + device_reg, + entity_reg, + set_state, + capabilities_reg, + capabilities_state, + condition, + expected_capabilities, +): + """Test getting capabilities.""" 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_capabilities = { - "extra_fields": [ - {"name": "for", "optional": True, "type": "positive_time_period_dict"} - ] - } - conditions = await async_get_device_automations(hass, "condition", device_entry.id) - for condition in conditions: - capabilities = await async_get_device_automation_capabilities( - hass, "condition", condition + entity_reg.async_get_or_create( + DOMAIN, + "test", + "5678", + device_id=device_entry.id, + capabilities=capabilities_reg, + ) + if set_state: + hass.states.async_set( + f"{DOMAIN}.test_5678", + STATE_ON, + capabilities_state, ) - assert capabilities == expected_capabilities + + capabilities = await device_condition.async_get_condition_capabilities( + hass, + { + "domain": DOMAIN, + "device_id": "abcdefgh", + "entity_id": f"{DOMAIN}.test_5678", + "type": condition, + }, + ) + + assert capabilities and "extra_fields" in capabilities + + assert ( + voluptuous_serialize.convert( + capabilities["extra_fields"], custom_serializer=cv.custom_serializer + ) + == expected_capabilities + ) + + +@pytest.mark.parametrize( + "condition,capability_name,extra", + [ + ("is_mode", "mode", {"type": "select", "options": []}), + ], +) +async def test_capabilities_missing_entity( + hass, device_reg, entity_reg, condition, capability_name, extra +): + """Test getting capabilities.""" + config_entry = MockConfigEntry(domain="test", data={}) + config_entry.add_to_hass(hass) + + capabilities = await device_condition.async_get_condition_capabilities( + hass, + { + "domain": DOMAIN, + "device_id": "abcdefgh", + "entity_id": f"{DOMAIN}.test_5678", + "type": condition, + }, + ) + + expected_capabilities = [ + { + "name": capability_name, + "required": True, + **extra, + } + ] + + assert capabilities and "extra_fields" in capabilities + + assert ( + voluptuous_serialize.convert( + capabilities["extra_fields"], custom_serializer=cv.custom_serializer + ) + == expected_capabilities + )