Improve editing of device actions referencing non-added humidifier (#51749)

homeassistant/components/humidifier/device_action.py

@@ -7,15 +7,15 @@ from homeassistant.components.device_automation import toggle_entity
 from homeassistant.const import (
     ATTR_ENTITY_ID,
     ATTR_MODE,
-    ATTR_SUPPORTED_FEATURES,
     CONF_DEVICE_ID,
     CONF_DOMAIN,
     CONF_ENTITY_ID,
     CONF_TYPE,
 )
-from homeassistant.core import Context, HomeAssistant
+from homeassistant.core import Context, HomeAssistant, HomeAssistantError
 from homeassistant.helpers import entity_registry
 import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.entity import get_capability, get_supported_features
 
 from . import DOMAIN, const
 
@@ -50,7 +50,7 @@ async def async_get_actions(hass: HomeAssistant, device_id: str) -> list[dict]:
         if entry.domain != DOMAIN:
             continue
 
-        state = hass.states.get(entry.entity_id)
+        supported_features = get_supported_features(hass, entry.entity_id)
 
         base_action = {
             CONF_DEVICE_ID: device_id,
@@ -59,11 +59,7 @@ async def async_get_actions(hass: HomeAssistant, device_id: str) -> list[dict]:
         }
         actions.append({**base_action, CONF_TYPE: "set_humidity"})
 
-        # We need a state or else we can't populate the available modes.
+        if supported_features & const.SUPPORT_MODES:
-        if state is None:
-            continue
-
-        if state.attributes[ATTR_SUPPORTED_FEATURES] & const.SUPPORT_MODES:
             actions.append({**base_action, CONF_TYPE: "set_mode"})
 
     return actions
@@ -93,7 +89,6 @@ async def async_call_action_from_config(
 
 async def async_get_action_capabilities(hass, config):
     """List action capabilities."""
-    state = hass.states.get(config[CONF_ENTITY_ID])
     action_type = config[CONF_TYPE]
 
     fields = {}
@@ -101,9 +96,12 @@ async def async_get_action_capabilities(hass, config):
     if action_type == "set_humidity":
         fields[vol.Required(const.ATTR_HUMIDITY)] = vol.Coerce(int)
     elif action_type == "set_mode":
-        if state:
+        try:
-            available_modes = state.attributes.get(const.ATTR_AVAILABLE_MODES, [])
+            available_modes = (
-        else:
+                get_capability(hass, config[ATTR_ENTITY_ID], const.ATTR_AVAILABLE_MODES)
+                or []
+            )
+        except HomeAssistantError:
             available_modes = []
         fields[vol.Required(ATTR_MODE)] = vol.In(available_modes)
     else:

tests/components/humidifier/test_device_action.py

@@ -31,7 +31,24 @@ def entity_reg(hass):
     return mock_registry(hass)
 
 
-async def test_get_actions(hass, device_reg, entity_reg):
+@pytest.mark.parametrize(
+    "set_state,features_reg,features_state,expected_action_types",
+    [
+        (False, 0, 0, []),
+        (False, const.SUPPORT_MODES, 0, ["set_mode"]),
+        (True, 0, 0, []),
+        (True, 0, const.SUPPORT_MODES, ["set_mode"]),
+    ],
+)
+async def test_get_actions(
+    hass,
+    device_reg,
+    entity_reg,
+    set_state,
+    features_reg,
+    features_state,
+    expected_action_types,
+):
     """Test we get the expected actions from a humidifier."""
     config_entry = MockConfigEntry(domain="test", data={})
     config_entry.add_to_hass(hass)
@@ -39,124 +56,36 @@ async def test_get_actions(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)
+    entity_reg.async_get_or_create(
-    hass.states.async_set("humidifier.test_5678", STATE_ON, {})
+        DOMAIN,
+        "test",
+        "5678",
+        device_id=device_entry.id,
+        supported_features=features_reg,
+    )
+    if set_state:
         hass.states.async_set(
-        "humidifier.test_5678", "attributes", {"supported_features": 1}
+            f"{DOMAIN}.test_5678", "attributes", {"supported_features": features_state}
         )
-    expected_actions = [
+    expected_actions = []
+    basic_action_types = ["turn_on", "turn_off", "toggle", "set_humidity"]
+    expected_actions += [
         {
             "domain": DOMAIN,
-            "type": "turn_on",
+            "type": action,
             "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
+            "entity_id": f"{DOMAIN}.test_5678",
-        },
+        }
-        {
+        for action in basic_action_types
-            "domain": DOMAIN,
-            "type": "turn_off",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "toggle",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "set_humidity",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "set_mode",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
     ]
-    actions = await async_get_device_automations(hass, "action", device_entry.id)
+    expected_actions += [
-    assert_lists_same(actions, expected_actions)
-
-
-async def test_get_action_no_modes(hass, device_reg, entity_reg):
-    """Test we get the expected actions 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("humidifier.test_5678", STATE_ON, {})
-    hass.states.async_set(
-        "humidifier.test_5678", "attributes", {"supported_features": 0}
-    )
-    expected_actions = [
         {
             "domain": DOMAIN,
-            "type": "turn_on",
+            "type": action,
             "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
+            "entity_id": f"{DOMAIN}.test_5678",
-        },
+        }
-        {
+        for action in expected_action_types
-            "domain": DOMAIN,
-            "type": "turn_off",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "toggle",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "set_humidity",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-    ]
-    actions = await async_get_device_automations(hass, "action", device_entry.id)
-    assert_lists_same(actions, expected_actions)
-
-
-async def test_get_action_no_state(hass, device_reg, entity_reg):
-    """Test we get the expected actions 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)
-    expected_actions = [
-        {
-            "domain": DOMAIN,
-            "type": "turn_on",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "turn_off",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "toggle",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
-        {
-            "domain": DOMAIN,
-            "type": "set_humidity",
-            "device_id": device_entry.id,
-            "entity_id": "humidifier.test_5678",
-        },
     ]
     actions = await async_get_device_automations(hass, "action", device_entry.id)
     assert_lists_same(actions, expected_actions)
@@ -291,69 +220,181 @@ async def test_action(hass):
     assert len(toggle_calls) == 1
 
 
-async def test_capabilities(hass):
+@pytest.mark.parametrize(
-    """Test getting capabilities."""
+    "set_state,capabilities_reg,capabilities_state,action,expected_capabilities",
-    # Test capabililities without state
+    [
-    capabilities = await device_action.async_get_action_capabilities(
+        (
-        hass,
+            False,
+            {},
+            {},
+            "set_humidity",
+            [
                 {
-            "domain": DOMAIN,
+                    "name": "humidity",
-            "device_id": "abcdefgh",
+                    "required": True,
-            "entity_id": "humidifier.entity",
+                    "type": "integer",
-            "type": "set_mode",
+                }
-        },
+            ],
-    )
+        ),
-
+        (
-    assert capabilities and "extra_fields" in capabilities
+            False,
-
+            {},
-    assert voluptuous_serialize.convert(
+            {},
-        capabilities["extra_fields"], custom_serializer=cv.custom_serializer
+            "set_mode",
-    ) == [{"name": "mode", "options": [], "required": True, "type": "select"}]
+            [
-
+                {
-    # Set state
+                    "name": "mode",
-    hass.states.async_set(
+                    "options": [],
-        "humidifier.entity",
+                    "required": True,
-        STATE_ON,
+                    "type": "select",
+                }
+            ],
+        ),
+        (
+            False,
             {const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY]},
-    )
+            {},
-
+            "set_mode",
-    # Set humidity
+            [
-    capabilities = await device_action.async_get_action_capabilities(
-        hass,
-        {
-            "domain": DOMAIN,
-            "device_id": "abcdefgh",
-            "entity_id": "humidifier.entity",
-            "type": "set_humidity",
-        },
-    )
-
-    assert capabilities and "extra_fields" in capabilities
-
-    assert voluptuous_serialize.convert(
-        capabilities["extra_fields"], custom_serializer=cv.custom_serializer
-    ) == [{"name": "humidity", "required": True, "type": "integer"}]
-
-    # Set mode
-    capabilities = await device_action.async_get_action_capabilities(
-        hass,
-        {
-            "domain": DOMAIN,
-            "device_id": "abcdefgh",
-            "entity_id": "humidifier.entity",
-            "type": "set_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",
                 }
+            ],
+        ),
+        (
+            True,
+            {},
+            {},
+            "set_humidity",
+            [
+                {
+                    "name": "humidity",
+                    "required": True,
+                    "type": "integer",
+                }
+            ],
+        ),
+        (
+            True,
+            {},
+            {},
+            "set_mode",
+            [
+                {
+                    "name": "mode",
+                    "options": [],
+                    "required": True,
+                    "type": "select",
+                }
+            ],
+        ),
+        (
+            True,
+            {},
+            {const.ATTR_AVAILABLE_MODES: [const.MODE_HOME, const.MODE_AWAY]},
+            "set_mode",
+            [
+                {
+                    "name": "mode",
+                    "options": [("home", "home"), ("away", "away")],
+                    "required": True,
+                    "type": "select",
+                }
+            ],
+        ),
+    ],
+)
+async def test_capabilities(
+    hass,
+    device_reg,
+    entity_reg,
+    set_state,
+    capabilities_reg,
+    capabilities_state,
+    action,
+    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,
+        capabilities=capabilities_reg,
+    )
+    if set_state:
+        hass.states.async_set(
+            f"{DOMAIN}.test_5678",
+            STATE_ON,
+            capabilities_state,
+        )
+
+    capabilities = await device_action.async_get_action_capabilities(
+        hass,
+        {
+            "domain": DOMAIN,
+            "device_id": "abcdefgh",
+            "entity_id": f"{DOMAIN}.test_5678",
+            "type": action,
+        },
+    )
+
+    assert capabilities and "extra_fields" in capabilities
+
+    assert (
+        voluptuous_serialize.convert(
+            capabilities["extra_fields"], custom_serializer=cv.custom_serializer
+        )
+        == expected_capabilities
+    )
+
+
+@pytest.mark.parametrize(
+    "action,capability_name,extra",
+    [
+        ("set_humidity", "humidity", {"type": "integer"}),
+        ("set_mode", "mode", {"type": "select", "options": []}),
+    ],
+)
+async def test_capabilities_missing_entity(
+    hass, device_reg, entity_reg, action, capability_name, extra
+):
+    """Test getting capabilities."""
+    config_entry = MockConfigEntry(domain="test", data={})
+    config_entry.add_to_hass(hass)
+
+    capabilities = await device_action.async_get_action_capabilities(
+        hass,
+        {
+            "domain": DOMAIN,
+            "device_id": "abcdefgh",
+            "entity_id": f"{DOMAIN}.test_5678",
+            "type": action,
+        },
+    )
+
+    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
+    )