core/tests/components/config/test_scene.py

"""Test Automation config panel."""

from http import HTTPStatus
import json
from typing import Any
from unittest.mock import ANY, patch

import pytest

from homeassistant.components import config
from homeassistant.components.config import scene
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from homeassistant.setup import async_setup_component

from tests.typing import ClientSessionGenerator


@pytest.fixture
async def setup_scene(hass: HomeAssistant, scene_config: dict[str, Any]) -> None:
    """Set up scene integration."""
    assert await async_setup_component(hass, "scene", {"scene": scene_config})
    await hass.async_block_till_done()


@pytest.mark.parametrize("scene_config", [{}])
@pytest.mark.usefixtures("setup_scene")
async def test_create_scene(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hass_config_store: dict[str, Any],
) -> None:
    """Test creating a scene."""
    with patch.object(config, "SECTIONS", [scene]):
        await async_setup_component(hass, "config", {})

    assert sorted(hass.states.async_entity_ids("scene")) == []

    client = await hass_client()

    orig_data = {}
    hass_config_store["scenes.yaml"] = orig_data

    resp = await client.post(
        "/api/config/scene/config/light_off",
        data=json.dumps(
            {
                # "id": "light_off",  # The id should be added when writing
                "name": "Lights off",
                "entities": {"light.bedroom": {"state": "off"}},
            }
        ),
    )
    await hass.async_block_till_done()

    assert sorted(hass.states.async_entity_ids("scene")) == [
        "scene.lights_off",
    ]

    assert resp.status == HTTPStatus.OK
    result = await resp.json()
    assert result == {"result": "ok"}

    assert hass_config_store["scenes.yaml"] == [
        {
            "id": "light_off",
            "name": "Lights off",
            "entities": {"light.bedroom": {"state": "off"}},
        }
    ]


@pytest.mark.parametrize("scene_config", [{}])
@pytest.mark.usefixtures("setup_scene")
async def test_update_scene(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hass_config_store: dict[str, Any],
) -> None:
    """Test updating a scene."""
    with patch.object(config, "SECTIONS", [scene]):
        await async_setup_component(hass, "config", {})

    assert sorted(hass.states.async_entity_ids("scene")) == []

    client = await hass_client()

    orig_data = [{"id": "light_on"}, {"id": "light_off"}]
    hass_config_store["scenes.yaml"] = orig_data

    resp = await client.post(
        "/api/config/scene/config/light_off",
        data=json.dumps(
            {
                "id": "light_off",
                "name": "Lights off",
                "entities": {"light.bedroom": {"state": "off"}},
            }
        ),
    )
    await hass.async_block_till_done()

    assert sorted(hass.states.async_entity_ids("scene")) == [
        "scene.lights_off",
    ]

    assert resp.status == HTTPStatus.OK
    result = await resp.json()
    assert result == {"result": "ok"}

    assert hass_config_store["scenes.yaml"] == [
        {"id": "light_on"},
        {
            "id": "light_off",
            "name": "Lights off",
            "entities": {"light.bedroom": {"state": "off"}},
        },
    ]


@pytest.mark.parametrize("scene_config", [{}])
@pytest.mark.usefixtures("setup_scene")
async def test_bad_formatted_scene(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hass_config_store: dict[str, Any],
) -> None:
    """Test that we handle scene without ID."""
    with patch.object(config, "SECTIONS", [scene]):
        await async_setup_component(hass, "config", {})

    assert sorted(hass.states.async_entity_ids("scene")) == []

    client = await hass_client()

    orig_data = [
        {
            # No ID
            "entities": {"light.bedroom": "on"}
        },
        {"id": "light_off"},
    ]
    hass_config_store["scenes.yaml"] = orig_data

    resp = await client.post(
        "/api/config/scene/config/light_off",
        data=json.dumps(
            {
                "id": "light_off",
                "name": "Lights off",
                "entities": {"light.bedroom": {"state": "off"}},
            }
        ),
    )
    await hass.async_block_till_done()

    assert sorted(hass.states.async_entity_ids("scene")) == [
        "scene.lights_off",
    ]

    assert resp.status == HTTPStatus.OK
    result = await resp.json()
    assert result == {"result": "ok"}

    # Verify ID added to orig_data
    assert hass_config_store["scenes.yaml"] == [
        {
            "id": ANY,
            "entities": {"light.bedroom": "on"},
        },
        {
            "id": "light_off",
            "name": "Lights off",
            "entities": {"light.bedroom": {"state": "off"}},
        },
    ]


@pytest.mark.parametrize(
    "scene_config",
    [
        [
            {"id": "light_on", "name": "Light on", "entities": {}},
            {"id": "light_off", "name": "Light off", "entities": {}},
        ],
    ],
)
@pytest.mark.usefixtures("setup_scene")
async def test_delete_scene(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    entity_registry: er.EntityRegistry,
    hass_config_store: dict[str, Any],
) -> None:
    """Test deleting a scene."""

    assert len(entity_registry.entities) == 2

    with patch.object(config, "SECTIONS", [scene]):
        assert await async_setup_component(hass, "config", {})

    assert sorted(hass.states.async_entity_ids("scene")) == [
        "scene.light_off",
        "scene.light_on",
    ]

    client = await hass_client()

    orig_data = [{"id": "light_on"}, {"id": "light_off"}]
    hass_config_store["scenes.yaml"] = orig_data

    resp = await client.delete("/api/config/scene/config/light_on")
    await hass.async_block_till_done()

    assert sorted(hass.states.async_entity_ids("scene")) == [
        "scene.light_off",
    ]

    assert resp.status == HTTPStatus.OK
    result = await resp.json()
    assert result == {"result": "ok"}

    assert hass_config_store["scenes.yaml"] == [
        {"id": "light_off"},
    ]

    assert len(entity_registry.entities) == 1


@pytest.mark.parametrize("scene_config", [{}])
@pytest.mark.usefixtures("setup_scene")
async def test_api_calls_require_admin(
    hass: HomeAssistant,
    hass_client: ClientSessionGenerator,
    hass_read_only_access_token: str,
    hass_config_store: dict[str, Any],
) -> None:
    """Test scene APIs endpoints do not work as a normal user."""
    with patch.object(config, "SECTIONS", [scene]):
        await async_setup_component(hass, "config", {})

    hass_config_store["scenes.yaml"] = [
        {
            "id": "light_off",
            "name": "Lights off",
            "entities": {"light.bedroom": {"state": "off"}},
        }
    ]

    client = await hass_client(hass_read_only_access_token)

    # Get
    resp = await client.get("/api/config/scene/config/light_off")
    assert resp.status == HTTPStatus.UNAUTHORIZED

    # Update
    resp = await client.post(
        "/api/config/scene/config/light_off",
        data=json.dumps(
            {
                "id": "light_off",
                "name": "Lights off",
                "entities": {"light.bedroom": {"state": "off"}},
            }
        ),
    )
    assert resp.status == HTTPStatus.UNAUTHORIZED

    # Delete
    resp = await client.delete("/api/config/scene/config/light_on")
    assert resp.status == HTTPStatus.UNAUTHORIZED