core/tests/components/select/test_trigger.py

"""Test select trigger."""

import pytest

from homeassistant.const import CONF_ENTITY_ID, STATE_UNAVAILABLE, STATE_UNKNOWN
from homeassistant.core import HomeAssistant

from tests.components.common import (
    TriggerStateDescription,
    arm_trigger,
    assert_trigger_gated_by_labs_flag,
    parametrize_target_entities,
    set_or_remove_state,
    target_entities,
)


@pytest.fixture
async def target_selects(hass: HomeAssistant) -> dict[str, list[str]]:
    """Create multiple select entities associated with different targets."""
    return await target_entities(hass, "select")


@pytest.fixture
async def target_input_selects(hass: HomeAssistant) -> dict[str, list[str]]:
    """Create multiple input_select entities associated with different targets."""
    return await target_entities(hass, "input_select")


@pytest.mark.parametrize("trigger_key", ["select.selection_changed"])
async def test_select_triggers_gated_by_labs_flag(
    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str
) -> None:
    """Test the select triggers are gated by the labs flag."""
    await assert_trigger_gated_by_labs_flag(hass, caplog, trigger_key)


STATE_SEQUENCE = [
    (
        "select.selection_changed",
        [
            {"included_state": {"state": None, "attributes": {}}, "count": 0},
            {"included_state": {"state": "option_a", "attributes": {}}, "count": 0},
            {"included_state": {"state": "option_b", "attributes": {}}, "count": 1},
        ],
    ),
    (
        "select.selection_changed",
        [
            {"included_state": {"state": "option_a", "attributes": {}}, "count": 0},
            {"included_state": {"state": "option_b", "attributes": {}}, "count": 1},
            {"included_state": {"state": "option_c", "attributes": {}}, "count": 1},
        ],
    ),
    (
        "select.selection_changed",
        [
            {
                "included_state": {"state": STATE_UNAVAILABLE, "attributes": {}},
                "count": 0,
            },
            {"included_state": {"state": "option_a", "attributes": {}}, "count": 0},
            {"included_state": {"state": "option_b", "attributes": {}}, "count": 1},
            {
                "included_state": {"state": STATE_UNAVAILABLE, "attributes": {}},
                "count": 0,
            },
        ],
    ),
    (
        "select.selection_changed",
        [
            {
                "included_state": {"state": STATE_UNKNOWN, "attributes": {}},
                "count": 0,
            },
            {"included_state": {"state": "option_a", "attributes": {}}, "count": 0},
            {"included_state": {"state": "option_b", "attributes": {}}, "count": 1},
            {
                "included_state": {"state": STATE_UNKNOWN, "attributes": {}},
                "count": 0,
            },
        ],
    ),
]


@pytest.mark.usefixtures("enable_labs_preview_features")
@pytest.mark.parametrize(
    ("trigger_target_config", "entity_id", "entities_in_target"),
    parametrize_target_entities("select"),
)
@pytest.mark.parametrize(("trigger", "states"), STATE_SEQUENCE)
async def test_select_state_trigger(
    hass: HomeAssistant,
    target_selects: dict[str, list[str]],
    trigger_target_config: dict,
    entity_id: str,
    entities_in_target: int,
    trigger: str,
    states: list[TriggerStateDescription],
) -> None:
    """Test that the select trigger fires when targeted select state changes."""
    await _assert_select_trigger_fires(
        hass,
        target_entities=target_selects,
        trigger_target_config=trigger_target_config,
        entity_id=entity_id,
        entities_in_target=entities_in_target,
        trigger=trigger,
        states=states,
    )


@pytest.mark.usefixtures("enable_labs_preview_features")
@pytest.mark.parametrize(
    ("trigger_target_config", "entity_id", "entities_in_target"),
    parametrize_target_entities("input_select"),
)
@pytest.mark.parametrize(("trigger", "states"), STATE_SEQUENCE)
async def test_input_select_state_trigger(
    hass: HomeAssistant,
    target_input_selects: dict[str, list[str]],
    trigger_target_config: dict,
    entity_id: str,
    entities_in_target: int,
    trigger: str,
    states: list[TriggerStateDescription],
) -> None:
    """Test that the select trigger fires when targeted input_select state changes."""
    await _assert_select_trigger_fires(
        hass,
        target_entities=target_input_selects,
        trigger_target_config=trigger_target_config,
        entity_id=entity_id,
        entities_in_target=entities_in_target,
        trigger=trigger,
        states=states,
    )


async def _assert_select_trigger_fires(
    hass: HomeAssistant,
    target_entities: dict[str, list[str]],
    trigger_target_config: dict,
    entity_id: str,
    entities_in_target: int,
    trigger: str,
    states: list[TriggerStateDescription],
) -> None:
    """Test that the select trigger fires when targeted state changes."""
    calls: list[str] = []
    other_entity_ids = set(target_entities["included_entities"]) - {entity_id}

    # Set all entities to the initial state
    for eid in target_entities["included_entities"]:
        set_or_remove_state(hass, eid, states[0]["included_state"])
        await hass.async_block_till_done()

    await arm_trigger(hass, trigger, None, trigger_target_config, calls)

    for state in states[1:]:
        included_state = state["included_state"]
        set_or_remove_state(hass, entity_id, included_state)
        await hass.async_block_till_done()
        assert len(calls) == state["count"]
        for call in calls:
            assert call == entity_id
        calls.clear()

        # Check if changing other targeted entities 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(calls) == (entities_in_target - 1) * state["count"]
        calls.clear()


# --- Cross-domain test ---


@pytest.mark.usefixtures("enable_labs_preview_features")
async def test_select_trigger_fires_for_both_domains(
    hass: HomeAssistant,
) -> None:
    """Test that the select trigger fires for both select and input_select entities."""
    calls: list[str] = []
    entity_id_select = "select.test_select"
    entity_id_input_select = "input_select.test_input_select"

    hass.states.async_set(entity_id_select, "option_a")
    hass.states.async_set(entity_id_input_select, "option_a")
    await hass.async_block_till_done()

    await arm_trigger(
        hass,
        "select.selection_changed",
        None,
        {CONF_ENTITY_ID: [entity_id_select, entity_id_input_select]},
        calls,
    )

    # select entity changes - should trigger
    hass.states.async_set(entity_id_select, "option_b")
    await hass.async_block_till_done()
    assert len(calls) == 1
    assert calls[0] == entity_id_select
    calls.clear()

    # input_select entity changes - should also trigger
    hass.states.async_set(entity_id_input_select, "option_b")
    await hass.async_block_till_done()
    assert len(calls) == 1
    assert calls[0] == entity_id_input_select
    calls.clear()