"""Test media player trigger.""" from typing import Any import pytest from homeassistant.components.media_player import MediaPlayerState from homeassistant.const import ATTR_LABEL_ID, CONF_ENTITY_ID from homeassistant.core import HomeAssistant, ServiceCall from tests.components import ( TriggerStateDescription, arm_trigger, parametrize_target_entities, parametrize_trigger_states, set_or_remove_state, target_entities, ) @pytest.fixture async def target_media_players(hass: HomeAssistant) -> list[str]: """Create multiple media player entities associated with different targets.""" return (await target_entities(hass, "media_player"))["included"] @pytest.mark.parametrize( "trigger_key", [ "media_player.stopped_playing", ], ) async def test_media_player_triggers_gated_by_labs_flag( hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str ) -> None: """Test the media player triggers are gated by the labs flag.""" await arm_trigger(hass, trigger_key, None, {ATTR_LABEL_ID: "test_label"}) assert ( "Unnamed automation failed to setup triggers and has been disabled: Trigger " f"'{trigger_key}' requires the experimental 'New triggers and conditions' " "feature to be enabled in Home Assistant Labs settings (feature flag: " "'new_triggers_conditions')" ) in caplog.text @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("media_player"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_trigger_states( trigger="media_player.stopped_playing", target_states=[ MediaPlayerState.IDLE, MediaPlayerState.OFF, MediaPlayerState.ON, ], other_states=[ MediaPlayerState.BUFFERING, MediaPlayerState.PAUSED, MediaPlayerState.PLAYING, ], ), ], ) async def test_media_player_state_trigger_behavior_any( hass: HomeAssistant, service_calls: list[ServiceCall], target_media_players: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the media player state trigger fires when any media player state changes to a specific state.""" other_entity_ids = set(target_media_players) - {entity_id} # Set all media players, including the tested media player, to the initial state for eid in target_media_players: set_or_remove_state(hass, eid, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {}, trigger_target_config) for state in states[1:]: included_state = state["included"] set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() # Check if changing other media players also triggers 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 len(service_calls) == (entities_in_target - 1) * state["count"] service_calls.clear() @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("media_player"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_trigger_states( trigger="media_player.stopped_playing", target_states=[ MediaPlayerState.IDLE, MediaPlayerState.OFF, MediaPlayerState.ON, ], other_states=[ MediaPlayerState.BUFFERING, MediaPlayerState.PAUSED, MediaPlayerState.PLAYING, ], ), ], ) async def test_media_player_state_trigger_behavior_first( hass: HomeAssistant, service_calls: list[ServiceCall], target_media_players: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the media player state trigger fires when the first media player changes to a specific state.""" other_entity_ids = set(target_media_players) - {entity_id} # Set all media players, including the tested media player, to the initial state for eid in target_media_players: set_or_remove_state(hass, eid, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "first"}, trigger_target_config) for state in states[1:]: included_state = state["included"] set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear() # Triggering other media players should not cause the trigger to fire again 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 len(service_calls) == 0 @pytest.mark.usefixtures("enable_labs_preview_features") @pytest.mark.parametrize( ("trigger_target_config", "entity_id", "entities_in_target"), parametrize_target_entities("media_player"), ) @pytest.mark.parametrize( ("trigger", "trigger_options", "states"), [ *parametrize_trigger_states( trigger="media_player.stopped_playing", target_states=[ MediaPlayerState.IDLE, MediaPlayerState.OFF, MediaPlayerState.ON, ], other_states=[ MediaPlayerState.BUFFERING, MediaPlayerState.PAUSED, MediaPlayerState.PLAYING, ], ), ], ) async def test_media_player_state_trigger_behavior_last( hass: HomeAssistant, service_calls: list[ServiceCall], target_media_players: list[str], trigger_target_config: dict, entity_id: str, entities_in_target: int, trigger: str, trigger_options: dict[str, Any], states: list[TriggerStateDescription], ) -> None: """Test that the media player state trigger fires when the last media player changes to a specific state.""" other_entity_ids = set(target_media_players) - {entity_id} # Set all media players, including the tested media player, to the initial state for eid in target_media_players: set_or_remove_state(hass, eid, states[0]["included"]) await hass.async_block_till_done() await arm_trigger(hass, trigger, {"behavior": "last"}, trigger_target_config) for state in states[1:]: included_state = state["included"] 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 len(service_calls) == 0 set_or_remove_state(hass, entity_id, included_state) await hass.async_block_till_done() assert len(service_calls) == state["count"] for service_call in service_calls: assert service_call.data[CONF_ENTITY_ID] == entity_id service_calls.clear()