"""Test climate trigger.""" import pytest from homeassistant.components.climate.const import ( ATTR_HVAC_ACTION, HVACAction, HVACMode, ) from homeassistant.const import CONF_ENTITY_ID from homeassistant.core import HomeAssistant, ServiceCall from homeassistant.setup import async_setup_component from tests.components import ( arm_trigger, parametrize_attribute_trigger_states, parametrize_target_entities, parametrize_trigger_states, target_entities, ) @pytest.fixture(autouse=True, name="stub_blueprint_populate") def stub_blueprint_populate_autouse(stub_blueprint_populate: None) -> None: """Stub copying the blueprints to the config folder.""" @pytest.fixture async def target_climates(hass: HomeAssistant) -> None: """Create multiple climate entities associated with different targets.""" return await target_entities(hass, "climate") def set_or_remove_state( hass: HomeAssistant, entity_id: str, state: str | None, attributes: dict | None = None, ) -> None: """Set or clear the state of an entity.""" if state is None: hass.states.async_remove(entity_id) else: hass.states.async_set(entity_id, state, attributes, force_update=True) @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("climate"), ) @pytest.mark.parametrize( ("trigger", "states"), [ *parametrize_trigger_states( "climate.turned_off", (HVACMode.OFF,), (HVACMode.HEAT,) ), ], ) async def test_climate_state_trigger_behavior_any( hass: HomeAssistant, service_calls: list[ServiceCall], target_climates: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, states: list[tuple[str, int]], ) -> None: """Test that the climate state trigger fires when any climate state changes to a specific state.""" await async_setup_component(hass, "climate", {}) other_entity_ids = set(target_climates) - {entity_id} # Set all climates, including the tested climate, to the initial state for eid in target_climates: set_or_remove_state(hass, eid, states[0][0]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {}, trigger_target_config) for state, expected_calls in states[1:]: set_or_remove_state(hass, entity_id, state) await hass.async_block_till_done() assert len(service_calls) == expected_calls for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() # Check if changing other climates also triggers for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, state) await hass.async_block_till_done() assert len(service_calls) == (entities_in_target - 1) * expected_calls service_calls.clear() @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("climate"), ) @pytest.mark.parametrize( ("trigger", "initial_state", "states"), [ *parametrize_attribute_trigger_states( "climate.started_heating", HVACMode.OFF, ATTR_HVAC_ACTION, HVACAction.HEATING, HVACAction.IDLE, ) ], ) async def test_climate_state_attribute_trigger_behavior_any( hass: HomeAssistant, service_calls: list[ServiceCall], target_climates: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, initial_state: tuple[str | None, dict], states: list[tuple[tuple[str, dict], int]], ) -> None: """Test that the climate state trigger fires when any climate state changes to a specific state.""" await async_setup_component(hass, "climate", {}) other_entity_ids = set(target_climates) - {entity_id} # Set all climates, including the tested climate, to the initial state for eid in target_climates: set_or_remove_state(hass, eid, *initial_state) await hass.async_block_till_done() await arm_trigger(hass, trigger, {}, trigger_target_config) for state, expected_calls in states: set_or_remove_state(hass, entity_id, *state) await hass.async_block_till_done() assert len(service_calls) == expected_calls for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() # Check if changing other climates also triggers for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, *state) await hass.async_block_till_done() assert len(service_calls) == (entities_in_target - 1) * expected_calls service_calls.clear() @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("climate"), ) @pytest.mark.parametrize( ("trigger", "states"), [ *parametrize_trigger_states( "climate.turned_off", (HVACMode.OFF,), (HVACMode.HEAT,) ), ], ) async def test_climate_state_trigger_behavior_first( hass: HomeAssistant, service_calls: list[ServiceCall], target_climates: list[str], trigger_target_config: dict, entities_in_target: int, entity_id: str, trigger: str, states: list[tuple[str, int, list[str]]], ) -> None: """Test that the climate state trigger fires when the first climate changes to a specific state.""" await async_setup_component(hass, "climate", {}) other_entity_ids = set(target_climates) - {entity_id} # Set all climates, including the tested climate, to the initial state for eid in target_climates: set_or_remove_state(hass, eid, states[0][0]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "first"}, trigger_target_config) for state, expected_calls in states[1:]: set_or_remove_state(hass, entity_id, state) await hass.async_block_till_done() assert len(service_calls) == expected_calls for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() # Triggering other climates should not cause the trigger to fire again for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, state) await hass.async_block_till_done() assert len(service_calls) == 0 @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("climate"), ) @pytest.mark.parametrize( ("trigger", "initial_state", "states"), [ *parametrize_attribute_trigger_states( "climate.started_heating", HVACMode.OFF, ATTR_HVAC_ACTION, HVACAction.HEATING, HVACAction.IDLE, ) ], ) async def test_climate_state_attribute_trigger_behavior_first( hass: HomeAssistant, service_calls: list[ServiceCall], target_climates: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, initial_state: tuple[str | None, dict], states: list[tuple[tuple[str, dict], int]], ) -> None: """Test that the climate state trigger fires when any climate state changes to a specific state.""" await async_setup_component(hass, "climate", {}) other_entity_ids = set(target_climates) - {entity_id} # Set all climates, including the tested climate, to the initial state for eid in target_climates: set_or_remove_state(hass, eid, *initial_state) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "first"}, trigger_target_config) for state, expected_calls in states: set_or_remove_state(hass, entity_id, *state) await hass.async_block_till_done() assert len(service_calls) == expected_calls for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() # Triggering other climates should not cause the trigger to fire again for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, *state) await hass.async_block_till_done() assert len(service_calls) == 0 @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("climate"), ) @pytest.mark.parametrize( ("trigger", "states"), [ *parametrize_trigger_states( "climate.turned_off", (HVACMode.OFF,), (HVACMode.HEAT,) ), ], ) async def test_climate_state_trigger_behavior_last( hass: HomeAssistant, service_calls: list[ServiceCall], target_climates: list[str], trigger_target_config: dict, entities_in_target: int, entity_id: str, trigger: str, states: list[tuple[str, int]], ) -> None: """Test that the climate state trigger fires when the last climate changes to a specific state.""" await async_setup_component(hass, "climate", {}) other_entity_ids = set(target_climates) - {entity_id} # Set all climates, including the tested climate, to the initial state for eid in target_climates: set_or_remove_state(hass, eid, states[0][0]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "last"}, trigger_target_config) for state, expected_calls in states[1:]: for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, state) await hass.async_block_till_done() assert len(service_calls) == 0 set_or_remove_state(hass, entity_id, state) await hass.async_block_till_done() assert len(service_calls) == expected_calls for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("climate"), ) @pytest.mark.parametrize( ("trigger", "initial_state", "states"), [ *parametrize_attribute_trigger_states( "climate.started_heating", HVACMode.OFF, ATTR_HVAC_ACTION, HVACAction.HEATING, HVACAction.IDLE, ) ], ) async def test_climate_state_attribute_trigger_behavior_last( hass: HomeAssistant, service_calls: list[ServiceCall], target_climates: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, initial_state: tuple[str | None, dict], states: list[tuple[tuple[str, dict], int]], ) -> None: """Test that the climate state trigger fires when any climate state changes to a specific state.""" await async_setup_component(hass, "climate", {}) other_entity_ids = set(target_climates) - {entity_id} # Set all climates, including the tested climate, to the initial state for eid in target_climates: set_or_remove_state(hass, eid, *initial_state) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "last"}, trigger_target_config) for state, expected_calls in states: for other_entity_id in other_entity_ids: set_or_remove_state(hass, other_entity_id, *state) await hass.async_block_till_done() assert len(service_calls) == 0 set_or_remove_state(hass, entity_id, *state) await hass.async_block_till_done() assert len(service_calls) == expected_calls for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear()