core/tests/components/configurator/test_init.py

"""The tests for the Configurator component."""

from datetime import timedelta

import pytest

from homeassistant.components import configurator
from homeassistant.const import EntityStateAttribute
from homeassistant.core import Context, HomeAssistant
from homeassistant.exceptions import Unauthorized
from homeassistant.util import dt as dt_util

from tests.common import MockUser, async_fire_time_changed


@pytest.mark.parametrize(
    "ignore_missing_translations", ["component.configurator.services.configure."]
)
async def test_request_least_info(hass: HomeAssistant) -> None:
    """Test request config with least amount of data."""
    request_id = configurator.async_request_config(hass, "Test Request", lambda _: None)

    assert len(hass.services.async_services().get(configurator.DOMAIN, [])) == 1, (
        "No new service registered"
    )

    states = hass.states.async_all()

    assert len(states) == 1, "Expected a new state registered"

    state = states[0]

    assert state.state == configurator.STATE_CONFIGURE
    assert state.attributes.get(configurator.ATTR_CONFIGURE_ID) == request_id


@pytest.mark.parametrize(
    "ignore_missing_translations", ["component.configurator.services.configure."]
)
async def test_request_all_info(hass: HomeAssistant) -> None:
    """Test request config with all possible info."""
    exp_attr = {
        EntityStateAttribute.FRIENDLY_NAME: "Test Request",
        configurator.ATTR_DESCRIPTION: """config description

[link name](link url)

![Description image](config image url)""",
        configurator.ATTR_SUBMIT_CAPTION: "config submit caption",
        configurator.ATTR_FIELDS: [],
        EntityStateAttribute.ENTITY_PICTURE: "config entity picture",
        configurator.ATTR_CONFIGURE_ID: configurator.async_request_config(
            hass,
            name="Test Request",
            callback=lambda _: None,
            description="config description",
            description_image="config image url",
            submit_caption="config submit caption",
            fields=None,
            link_name="link name",
            link_url="link url",
            entity_picture="config entity picture",
        ),
    }

    states = hass.states.async_all()
    assert len(states) == 1
    state = states[0]

    assert state.state == configurator.STATE_CONFIGURE
    assert state.attributes == exp_attr


@pytest.mark.parametrize(
    "ignore_missing_translations", ["component.configurator.services.configure."]
)
async def test_callback_called_on_configure(hass: HomeAssistant) -> None:
    """Test if our callback gets called when configure service called."""
    calls = []
    request_id = configurator.async_request_config(
        hass, "Test Request", lambda _: calls.append(1)
    )

    await hass.services.async_call(
        configurator.DOMAIN,
        configurator.SERVICE_CONFIGURE,
        {configurator.ATTR_CONFIGURE_ID: request_id},
    )

    await hass.async_block_till_done()
    assert len(calls) == 1, "Callback not called"


@pytest.mark.parametrize(
    "ignore_missing_translations", ["component.configurator.services.configure."]
)
async def test_state_change_on_notify_errors(hass: HomeAssistant) -> None:
    """Test state change on notify errors."""
    request_id = configurator.async_request_config(hass, "Test Request", lambda _: None)
    error = "Oh no bad bad bad"
    configurator.async_notify_errors(hass, request_id, error)

    states = hass.states.async_all()
    assert len(states) == 1
    state = states[0]
    assert state.attributes.get(configurator.ATTR_ERRORS) == error


async def test_notify_errors_fail_silently_on_bad_request_id(
    hass: HomeAssistant,
) -> None:
    """Test if notify errors fails silently with a bad request id."""
    configurator.async_notify_errors(hass, 2015, "Try this error")


@pytest.mark.parametrize(
    "ignore_missing_translations", ["component.configurator.services.configure."]
)
async def test_request_done_works(hass: HomeAssistant) -> None:
    """Test if calling request done works."""
    request_id = configurator.async_request_config(hass, "Test Request", lambda _: None)
    configurator.async_request_done(hass, request_id)
    assert len(hass.states.async_all()) == 1
    async_fire_time_changed(hass, dt_util.utcnow() + timedelta(seconds=1))
    await hass.async_block_till_done()
    assert len(hass.states.async_all()) == 0


async def test_request_done_fail_silently_on_bad_request_id(
    hass: HomeAssistant,
) -> None:
    """Test that request_done fails silently with a bad request id."""
    configurator.async_request_done(hass, 2016)


@pytest.mark.parametrize(
    "ignore_missing_translations", ["component.configurator.services.configure."]
)
async def test_configure_service_requires_admin(
    hass: HomeAssistant, hass_read_only_user: MockUser
) -> None:
    """Test the configure service requires admin."""
    request_id = configurator.async_request_config(hass, "Test Request", lambda _: None)

    with pytest.raises(Unauthorized):
        await hass.services.async_call(
            configurator.DOMAIN,
            configurator.SERVICE_CONFIGURE,
            {configurator.ATTR_CONFIGURE_ID: request_id},
            context=Context(user_id=hass_read_only_user.id),
            blocking=True,
        )