"""Test valve trigger.""" from typing import Any import pytest from homeassistant.components.valve import ATTR_IS_CLOSED, DOMAIN, ValveState from homeassistant.core import HomeAssistant from tests.components.common import ( TriggerStateDescription, assert_trigger_behavior_any, assert_trigger_behavior_first, assert_trigger_behavior_last, assert_trigger_gated_by_labs_flag, assert_trigger_options_supported, parametrize_target_entities, parametrize_trigger_states, target_entities, ) TRIGGER_STATES = [ *parametrize_trigger_states( trigger="valve.closed", target_states=[ (ValveState.CLOSED, {ATTR_IS_CLOSED: True}), (ValveState.CLOSING, {ATTR_IS_CLOSED: True}), (ValveState.OPENING, {ATTR_IS_CLOSED: True}), ], other_states=[ (ValveState.CLOSING, {ATTR_IS_CLOSED: False}), (ValveState.OPEN, {ATTR_IS_CLOSED: False}), (ValveState.OPENING, {ATTR_IS_CLOSED: False}), ], extra_invalid_states=[ (ValveState.OPEN, {ATTR_IS_CLOSED: None}), (ValveState.OPEN, {}), ], ), *parametrize_trigger_states( trigger="valve.opened", target_states=[ (ValveState.OPEN, {ATTR_IS_CLOSED: False}), (ValveState.OPENING, {ATTR_IS_CLOSED: False}), (ValveState.CLOSING, {ATTR_IS_CLOSED: False}), ], other_states=[ (ValveState.CLOSED, {ATTR_IS_CLOSED: True}), ], extra_invalid_states=[ (ValveState.CLOSED, {ATTR_IS_CLOSED: None}), (ValveState.CLOSED, {}), ], ), ] @pytest.fixture async def target_valves(hass: HomeAssistant) -> dict[str, list[str]]: """Create multiple valve entities associated with different targets.""" return await target_entities(hass, DOMAIN) @pytest.mark.parametrize( "trigger_key", [ "valve.closed", "valve.opened", ], ) async def test_valve_triggers_gated_by_labs_flag( hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str ) -> None: """Test the valve triggers are gated by the labs flag.""" await assert_trigger_gated_by_labs_flag(hass, caplog, trigger_key) @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_key", "base_options", "supports_behavior", "supports_duration"), [ ("valve.closed", {}, True, True), ("valve.opened", {}, True, True), ], ) async def test_valve_trigger_options_validation( hass: HomeAssistant, trigger_key: str, base_options: dict[str, Any] | None, supports_behavior: bool, supports_duration: bool, ) -> None: """Test that valve triggers support the expected options.""" await assert_trigger_options_supported( hass, trigger_key, base_options, supports_behavior=supports_behavior, supports_duration=supports_duration, ) @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities(DOMAIN), ) @pytest.mark.parametrize(("trigger", "trigger_options", "states"), TRIGGER_STATES) async def test_valve_state_trigger_behavior_any( hass: HomeAssistant, target_valves: dict[str, list[str]], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any] | None, states: list[TriggerStateDescription], ) -> None: """Test that the valve state trigger fires when any valve state changes to a specific state.""" await assert_trigger_behavior_any( hass, target_entities=target_valves, trigger_target_config=trigger_target_config, entity_id=entity_id, entities_in_target=entities_in_target, trigger=trigger, trigger_options=trigger_options, states=states, ) @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities(DOMAIN), ) @pytest.mark.parametrize(("trigger", "trigger_options", "states"), TRIGGER_STATES) async def test_valve_state_trigger_behavior_first( hass: HomeAssistant, target_valves: dict[str, list[str]], trigger_target_config: dict, entities_in_target: int, entity_id: str, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the valve state trigger fires when the first valve changes to a specific state.""" await assert_trigger_behavior_first( hass, target_entities=target_valves, trigger_target_config=trigger_target_config, entity_id=entity_id, entities_in_target=entities_in_target, trigger=trigger, trigger_options=trigger_options, states=states, ) @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities(DOMAIN), ) @pytest.mark.parametrize(("trigger", "trigger_options", "states"), TRIGGER_STATES) async def test_valve_state_trigger_behavior_last( hass: HomeAssistant, target_valves: dict[str, list[str]], trigger_target_config: dict, entities_in_target: int, entity_id: str, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the valve state trigger fires when the last valve changes to a specific state.""" await assert_trigger_behavior_last( hass, target_entities=target_valves, trigger_target_config=trigger_target_config, entity_id=entity_id, entities_in_target=entities_in_target, trigger=trigger, trigger_options=trigger_options, states=states, )