Adjust language + sort

homeassistant/components/automation/__init__.py

@@ -127,6 +127,7 @@ _EXPERIMENTAL_CONDITION_PLATFORMS = {
     "assist_satellite",
     "fan",
     "light",
+    "lock",
     "siren",
 }
 

homeassistant/components/lock/condition.py

@@ -0,0 +1,18 @@
+"""Provides conditions for locks."""
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.condition import Condition, make_entity_state_condition
+
+from .const import DOMAIN, LockState
+
+CONDITIONS: dict[str, type[Condition]] = {
+    "is_jammed": make_entity_state_condition(DOMAIN, LockState.JAMMED),
+    "is_locked": make_entity_state_condition(DOMAIN, LockState.LOCKED),
+    "is_open": make_entity_state_condition(DOMAIN, LockState.OPEN),
+    "is_unlocked": make_entity_state_condition(DOMAIN, LockState.UNLOCKED),
+}
+
+
+async def async_get_conditions(hass: HomeAssistant) -> dict[str, type[Condition]]:
+    """Return the conditions for locks."""
+    return CONDITIONS

homeassistant/components/lock/conditions.yaml

@@ -0,0 +1,19 @@
+.condition_common: &condition_common
+  target:
+    entity:
+      domain: lock
+  fields:
+    behavior:
+      required: true
+      default: any
+      selector:
+        select:
+          translation_key: condition_behavior
+          options:
+            - all
+            - any
+
+is_jammed: *condition_common
+is_locked: *condition_common
+is_open: *condition_common
+is_unlocked: *condition_common

homeassistant/components/lock/icons.json

@@ -1,4 +1,18 @@
 {
+  "conditions": {
+    "is_jammed": {
+      "condition": "mdi:lock-alert"
+    },
+    "is_locked": {
+      "condition": "mdi:lock"
+    },
+    "is_open": {
+      "condition": "mdi:lock-open-variant"
+    },
+    "is_unlocked": {
+      "condition": "mdi:lock-open-variant"
+    }
+  },
   "entity_component": {
     "_": {
       "default": "mdi:lock",

homeassistant/components/lock/strings.json

@@ -1,8 +1,52 @@
 {
   "common": {
+    "condition_behavior_description": "How the state should match on the targeted locks.",
+    "condition_behavior_name": "Behavior",
     "trigger_behavior_description": "The behavior of the targeted locks to trigger on.",
     "trigger_behavior_name": "Behavior"
   },
+  "conditions": {
+    "is_jammed": {
+      "description": "Tests if one or more locks are jammed.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lock::common::condition_behavior_description%]",
+          "name": "[%key:component::lock::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lock is jammed"
+    },
+    "is_locked": {
+      "description": "Tests if one or more locks are locked.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lock::common::condition_behavior_description%]",
+          "name": "[%key:component::lock::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lock is locked"
+    },
+    "is_open": {
+      "description": "Tests if one or more locks are open.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lock::common::condition_behavior_description%]",
+          "name": "[%key:component::lock::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lock is open"
+    },
+    "is_unlocked": {
+      "description": "Tests if one or more locks are unlocked.",
+      "fields": {
+        "behavior": {
+          "description": "[%key:component::lock::common::condition_behavior_description%]",
+          "name": "[%key:component::lock::common::condition_behavior_name%]"
+        }
+      },
+      "name": "Lock is unlocked"
+    }
+  },
   "device_automation": {
     "action_type": {
       "lock": "Lock {entity_name}",
@@ -55,6 +99,12 @@
     }
   },
   "selector": {
+    "condition_behavior": {
+      "options": {
+        "all": "All",
+        "any": "Any"
+      }
+    },
     "trigger_behavior": {
       "options": {
         "any": "Any",

tests/components/lock/test_condition.py

@@ -0,0 +1,179 @@
+"""Test lock conditions."""
+
+from typing import Any
+
+import pytest
+
+from homeassistant.components.lock.const import LockState
+from homeassistant.core import HomeAssistant
+
+from tests.components import (
+    ConditionStateDescription,
+    assert_condition_gated_by_labs_flag,
+    create_target_condition,
+    other_states,
+    parametrize_condition_states_all,
+    parametrize_condition_states_any,
+    parametrize_target_entities,
+    set_or_remove_state,
+    target_entities,
+)
+
+
+@pytest.fixture
+async def target_locks(hass: HomeAssistant) -> list[str]:
+    """Create multiple lock entities associated with different targets."""
+    return (await target_entities(hass, "lock"))["included"]
+
+
+@pytest.mark.parametrize(
+    "condition",
+    [
+        "lock.is_jammed",
+        "lock.is_locked",
+        "lock.is_open",
+        "lock.is_unlocked",
+    ],
+)
+async def test_lock_conditions_gated_by_labs_flag(
+    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, condition: str
+) -> None:
+    """Test the lock 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("lock"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_any(
+            condition="lock.is_jammed",
+            target_states=[LockState.JAMMED],
+            other_states=other_states(LockState.JAMMED),
+        ),
+        *parametrize_condition_states_any(
+            condition="lock.is_locked",
+            target_states=[LockState.LOCKED],
+            other_states=other_states(LockState.LOCKED),
+        ),
+        *parametrize_condition_states_any(
+            condition="lock.is_open",
+            target_states=[LockState.OPEN],
+            other_states=other_states(LockState.OPEN),
+        ),
+        *parametrize_condition_states_any(
+            condition="lock.is_unlocked",
+            target_states=[LockState.UNLOCKED],
+            other_states=other_states(LockState.UNLOCKED),
+        ),
+    ],
+)
+async def test_lock_state_condition_behavior_any(
+    hass: HomeAssistant,
+    target_locks: 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 the lock state condition with the 'any' behavior."""
+    other_entity_ids = set(target_locks) - {entity_id}
+
+    # Set all locks, including the tested lock, to the initial state
+    for eid in target_locks:
+        set_or_remove_state(hass, eid, states[0]["included"])
+        await hass.async_block_till_done()
+
+    condition = await create_target_condition(
+        hass,
+        condition=condition,
+        target=condition_target_config,
+        behavior="any",
+    )
+
+    for state in states:
+        included_state = state["included"]
+        set_or_remove_state(hass, entity_id, included_state)
+        await hass.async_block_till_done()
+        assert condition(hass) == state["condition_true"]
+
+        # Check if changing other locks also passes the condition
+        for other_entity_id in other_entity_ids:
+            set_or_remove_state(hass, other_entity_id, included_state)
+            await hass.async_block_till_done()
+        assert condition(hass) == state["condition_true"]
+
+
+@pytest.mark.usefixtures("enable_labs_preview_features")
+@pytest.mark.parametrize(
+    ("condition_target_config", "entity_id", "entities_in_target"),
+    parametrize_target_entities("lock"),
+)
+@pytest.mark.parametrize(
+    ("condition", "condition_options", "states"),
+    [
+        *parametrize_condition_states_all(
+            condition="lock.is_jammed",
+            target_states=[LockState.JAMMED],
+            other_states=other_states(LockState.JAMMED),
+        ),
+        *parametrize_condition_states_all(
+            condition="lock.is_locked",
+            target_states=[LockState.LOCKED],
+            other_states=other_states(LockState.LOCKED),
+        ),
+        *parametrize_condition_states_all(
+            condition="lock.is_open",
+            target_states=[LockState.OPEN],
+            other_states=other_states(LockState.OPEN),
+        ),
+        *parametrize_condition_states_all(
+            condition="lock.is_unlocked",
+            target_states=[LockState.UNLOCKED],
+            other_states=other_states(LockState.UNLOCKED),
+        ),
+    ],
+)
+async def test_lock_state_condition_behavior_all(
+    hass: HomeAssistant,
+    target_locks: 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 the lock state condition with the 'all' behavior."""
+    other_entity_ids = set(target_locks) - {entity_id}
+
+    # Set all locks, including the tested lock, to the initial state
+    for eid in target_locks:
+        set_or_remove_state(hass, eid, states[0]["included"])
+        await hass.async_block_till_done()
+
+    condition = await create_target_condition(
+        hass,
+        condition=condition,
+        target=condition_target_config,
+        behavior="all",
+    )
+
+    for state in states:
+        included_state = state["included"]
+
+        set_or_remove_state(hass, entity_id, included_state)
+        await hass.async_block_till_done()
+        assert condition(hass) == state["condition_true_first_entity"]
+
+        for other_entity_id in other_entity_ids:
+            set_or_remove_state(hass, other_entity_id, included_state)
+            await hass.async_block_till_done()
+
+        assert condition(hass) == state["condition_true"]