core/tests/components/scene/test_trigger.py

"""Test scene trigger."""

import pytest

from homeassistant.const import 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_scenes(hass: HomeAssistant) -> dict[str, list[str]]:
    """Create multiple scene entities associated with different targets."""
    return await target_entities(hass, "scene")


@pytest.mark.parametrize("trigger_key", ["scene.activated"])
async def test_scene_triggers_gated_by_labs_flag(
    hass: HomeAssistant, caplog: pytest.LogCaptureFixture, trigger_key: str
) -> None:
    """Test the scene 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_target_config", "entity_id", "entities_in_target"),
    parametrize_target_entities("scene"),
)
@pytest.mark.parametrize(
    ("trigger", "states"),
    [
        (
            "scene.activated",
            [
                {
                    "included_state": {"state": None, "attributes": {}},
                    "count": 0,
                },
                {
                    "included_state": {
                        "state": "2021-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 0,
                },
                {
                    "included_state": {
                        "state": "2022-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 1,
                },
            ],
        ),
        (
            "scene.activated",
            [
                {
                    "included_state": {"state": "foo", "attributes": {}},
                    "count": 0,
                },
                {
                    "included_state": {
                        "state": "2021-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 1,
                },
                {
                    "included_state": {
                        "state": "2022-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 1,
                },
            ],
        ),
        (
            "scene.activated",
            [
                {
                    "included_state": {
                        "state": STATE_UNAVAILABLE,
                        "attributes": {},
                    },
                    "count": 0,
                },
                {
                    "included_state": {
                        "state": "2021-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 0,
                },
                {
                    "included_state": {
                        "state": "2022-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 1,
                },
                {
                    "included_state": {
                        "state": STATE_UNAVAILABLE,
                        "attributes": {},
                    },
                    "count": 0,
                },
            ],
        ),
        (
            "scene.activated",
            [
                {
                    "included_state": {"state": STATE_UNKNOWN, "attributes": {}},
                    "count": 0,
                },
                {
                    "included_state": {
                        "state": "2021-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 1,
                },
                {
                    "included_state": {
                        "state": "2022-01-01T23:59:59+00:00",
                        "attributes": {},
                    },
                    "count": 1,
                },
                {
                    "included_state": {"state": STATE_UNKNOWN, "attributes": {}},
                    "count": 0,
                },
            ],
        ),
    ],
)
async def test_scene_state_trigger(
    hass: HomeAssistant,
    target_scenes: dict[str, list[str]],
    trigger_target_config: dict,
    entity_id: str,
    entities_in_target: int,
    trigger: str,
    states: list[TriggerStateDescription],
) -> None:
    """Test that the scene state trigger fires when targeted scene state changes."""
    calls: list[str] = []
    other_entity_ids = set(target_scenes["included_entities"]) - {entity_id}

    # Set all scenes, including the tested scene, to the initial state
    for eid in target_scenes["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 scenes 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()