core/tests/components/smlight/test_services.py

"""Tests for SMLIGHT services."""

from unittest.mock import MagicMock

from pysmlight.exceptions import SmlightError
from pysmlight.models import BuzzerPayload
import pytest

from homeassistant.components.smlight.const import DOMAIN
from homeassistant.components.smlight.services import (
    ATTR_BPM,
    ATTR_DURATION,
    ATTR_NOTES,
    ATTR_OCTAVE,
    SERVICE_PLAY_RTTTL,
)
from homeassistant.const import ATTR_DEVICE_ID
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
from homeassistant.helpers import device_registry as dr

from .conftest import setup_integration

from tests.common import MockConfigEntry

TEST_NOTES = "16e6,16e6"
TEST_BPM = 100
TEST_OCTAVE = 5
TEST_DURATION = 4
TEST_RTTTL = "S:d=4,o=5,b=100:16e6,16e6"
TEST_RTTTL_NO_DURATION = "S:o=5,b=100:16e6,16e6"
TEST_RTTTL_NO_BPM = "S:o=5:16e6,16e6"


@pytest.mark.parametrize(
    ("service_data", "expected_rtttl"),
    [
        (
            {
                ATTR_BPM: TEST_BPM,
                ATTR_OCTAVE: TEST_OCTAVE,
                ATTR_DURATION: TEST_DURATION,
                ATTR_NOTES: TEST_NOTES,
            },
            TEST_RTTTL,
        ),
        (
            {
                ATTR_BPM: TEST_BPM,
                ATTR_OCTAVE: TEST_OCTAVE,
                ATTR_NOTES: TEST_NOTES,
            },
            TEST_RTTTL_NO_DURATION,
        ),
        (
            {
                ATTR_OCTAVE: TEST_OCTAVE,
                ATTR_NOTES: TEST_NOTES,
            },
            TEST_RTTTL_NO_BPM,
        ),
    ],
    ids=["all_fields", "no_duration", "no_bpm"],
)
async def test_play_rtttl_service(
    hass: HomeAssistant,
    mock_config_entry: MockConfigEntry,
    mock_ultima_client: MagicMock,
    device_registry: dr.DeviceRegistry,
    service_data: dict[str, int | str],
    expected_rtttl: str,
) -> None:
    """Test play_rtttl service constructs correct RTTTL string."""
    await setup_integration(hass, mock_config_entry)

    devices = dr.async_entries_for_config_entry(
        device_registry, mock_config_entry.entry_id
    )
    assert len(devices) == 1
    device_id = devices[0].id

    await hass.services.async_call(
        DOMAIN,
        SERVICE_PLAY_RTTTL,
        {ATTR_DEVICE_ID: [device_id], **service_data},
        blocking=True,
    )

    mock_ultima_client.actions.buzzer.assert_called_once_with(
        BuzzerPayload(code=expected_rtttl)
    )


async def test_play_rtttl_service_not_supported(
    hass: HomeAssistant,
    mock_config_entry: MockConfigEntry,
    mock_smlight_client: MagicMock,
    device_registry: dr.DeviceRegistry,
) -> None:
    """Test play_rtttl service on unsupported model."""
    await setup_integration(hass, mock_config_entry)

    devices = dr.async_entries_for_config_entry(
        device_registry, mock_config_entry.entry_id
    )
    assert len(devices) == 1
    device_id = devices[0].id

    with pytest.raises(ServiceValidationError) as exc_info:
        await hass.services.async_call(
            DOMAIN,
            SERVICE_PLAY_RTTTL,
            {
                ATTR_DEVICE_ID: [device_id],
                ATTR_BPM: TEST_BPM,
                ATTR_OCTAVE: TEST_OCTAVE,
                ATTR_NOTES: TEST_NOTES,
            },
            blocking=True,
        )

    assert exc_info.value.translation_domain == DOMAIN
    assert exc_info.value.translation_key == "not_supported_buzzer"

    mock_smlight_client.actions.buzzer.assert_not_called()


@pytest.mark.usefixtures("mock_smlight_client")
async def test_play_rtttl_service_no_device(
    hass: HomeAssistant,
    mock_config_entry: MockConfigEntry,
) -> None:
    """Test play_rtttl service raises for unknown device."""
    await setup_integration(hass, mock_config_entry)

    with pytest.raises(ServiceValidationError) as exc_info:
        await hass.services.async_call(
            DOMAIN,
            SERVICE_PLAY_RTTTL,
            {
                ATTR_DEVICE_ID: ["non_existent_device_id"],
                ATTR_BPM: TEST_BPM,
                ATTR_OCTAVE: TEST_OCTAVE,
                ATTR_NOTES: TEST_NOTES,
            },
            blocking=True,
        )

    assert exc_info.value.translation_domain == DOMAIN
    assert exc_info.value.translation_key == "no_device_found"


async def test_play_rtttl_service_error(
    hass: HomeAssistant,
    mock_config_entry: MockConfigEntry,
    mock_ultima_client: MagicMock,
    device_registry: dr.DeviceRegistry,
) -> None:
    """Test play_rtttl service handles api error."""
    mock_ultima_client.actions.buzzer.side_effect = SmlightError("API fail")

    await setup_integration(hass, mock_config_entry)

    devices = dr.async_entries_for_config_entry(
        device_registry, mock_config_entry.entry_id
    )
    assert len(devices) == 1
    device_id = devices[0].id

    with pytest.raises(HomeAssistantError) as exc_info:
        await hass.services.async_call(
            DOMAIN,
            SERVICE_PLAY_RTTTL,
            {
                ATTR_DEVICE_ID: [device_id],
                ATTR_BPM: TEST_BPM,
                ATTR_OCTAVE: TEST_OCTAVE,
                ATTR_NOTES: TEST_NOTES,
            },
            blocking=True,
        )

    assert exc_info.value.translation_domain == DOMAIN
    assert exc_info.value.translation_key == "play_tone_failed"
    assert exc_info.value.translation_placeholders == {
        "device_name": mock_config_entry.title,
        "error": "API fail",
    }