core/tests/components/lcn/test_light.py

"""Test for the LCN light platform."""

from unittest.mock import patch

from pypck.inputs import ModStatusOutput, ModStatusRelays
from pypck.lcn_addr import LcnAddr
from pypck.lcn_defs import RelayStateModifier
from syrupy.assertion import SnapshotAssertion

from homeassistant.components.lcn.helpers import get_device_connection
from homeassistant.components.light import (
    ATTR_BRIGHTNESS,
    ATTR_TRANSITION,
    DOMAIN as DOMAIN_LIGHT,
)
from homeassistant.const import (
    ATTR_ENTITY_ID,
    SERVICE_TURN_OFF,
    SERVICE_TURN_ON,
    STATE_OFF,
    STATE_ON,
    STATE_UNAVAILABLE,
    Platform,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er

from .conftest import MockConfigEntry, MockModuleConnection, init_integration

from tests.common import snapshot_platform

LIGHT_OUTPUT1 = "light.light_output1"
LIGHT_OUTPUT2 = "light.light_output2"
LIGHT_RELAY1 = "light.light_relay1"


async def test_setup_lcn_light(
    hass: HomeAssistant,
    entity_registry: er.EntityRegistry,
    entry: MockConfigEntry,
    snapshot: SnapshotAssertion,
) -> None:
    """Test the setup of light."""
    with patch("homeassistant.components.lcn.PLATFORMS", [Platform.LIGHT]):
        await init_integration(hass, entry)

    await snapshot_platform(hass, entity_registry, snapshot, entry.entry_id)


async def test_output_turn_on(hass: HomeAssistant, entry: MockConfigEntry) -> None:
    """Test the output light turns on."""
    await init_integration(hass, entry)

    with patch.object(MockModuleConnection, "dim_output") as dim_output:
        # command failed
        dim_output.return_value = False

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_ON,
            {ATTR_ENTITY_ID: LIGHT_OUTPUT1},
            blocking=True,
        )

        dim_output.assert_awaited_with(0, 100, 9)

        state = hass.states.get(LIGHT_OUTPUT1)
        assert state is not None
        assert state.state != STATE_ON

        # command success
        dim_output.reset_mock(return_value=True)
        dim_output.return_value = True

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_ON,
            {ATTR_ENTITY_ID: LIGHT_OUTPUT1},
            blocking=True,
        )

        dim_output.assert_awaited_with(0, 100, 9)

        state = hass.states.get(LIGHT_OUTPUT1)
        assert state is not None
        assert state.state == STATE_ON


async def test_output_turn_on_with_attributes(
    hass: HomeAssistant, entry: MockConfigEntry
) -> None:
    """Test the output light turns on."""
    await init_integration(hass, entry)

    with patch.object(MockModuleConnection, "dim_output") as dim_output:
        dim_output.return_value = True

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_ON,
            {
                ATTR_ENTITY_ID: LIGHT_OUTPUT1,
                ATTR_BRIGHTNESS: 50,
                ATTR_TRANSITION: 2,
            },
            blocking=True,
        )

        dim_output.assert_awaited_with(0, 19, 6)

        state = hass.states.get(LIGHT_OUTPUT1)
        assert state is not None
        assert state.state == STATE_ON


async def test_output_turn_off(hass: HomeAssistant, entry: MockConfigEntry) -> None:
    """Test the output light turns off."""
    await init_integration(hass, entry)

    with patch.object(MockModuleConnection, "dim_output") as dim_output:
        state = hass.states.get(LIGHT_OUTPUT1)
        state.state = STATE_ON

        # command failed
        dim_output.return_value = False

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_OFF,
            {ATTR_ENTITY_ID: LIGHT_OUTPUT1},
            blocking=True,
        )

        dim_output.assert_awaited_with(0, 0, 9)

        state = hass.states.get(LIGHT_OUTPUT1)
        assert state is not None
        assert state.state != STATE_OFF

        # command success
        dim_output.reset_mock(return_value=True)
        dim_output.return_value = True

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_OFF,
            {ATTR_ENTITY_ID: LIGHT_OUTPUT1},
            blocking=True,
        )

        dim_output.assert_awaited_with(0, 0, 9)

        state = hass.states.get(LIGHT_OUTPUT1)
        assert state is not None
        assert state.state == STATE_OFF


async def test_output_turn_off_with_attributes(
    hass: HomeAssistant, entry: MockConfigEntry
) -> None:
    """Test the output light turns off."""
    await init_integration(hass, entry)

    with patch.object(MockModuleConnection, "dim_output") as dim_output:
        dim_output.return_value = True

        state = hass.states.get(LIGHT_OUTPUT1)
        state.state = STATE_ON

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_OFF,
            {
                ATTR_ENTITY_ID: LIGHT_OUTPUT1,
                ATTR_TRANSITION: 2,
            },
            blocking=True,
        )

        dim_output.assert_awaited_with(0, 0, 6)

        state = hass.states.get(LIGHT_OUTPUT1)
        assert state is not None
        assert state.state == STATE_OFF


async def test_relay_turn_on(hass: HomeAssistant, entry: MockConfigEntry) -> None:
    """Test the relay light turns on."""
    await init_integration(hass, entry)

    with patch.object(MockModuleConnection, "control_relays") as control_relays:
        states = [RelayStateModifier.NOCHANGE] * 8
        states[0] = RelayStateModifier.ON

        # command failed
        control_relays.return_value = False

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_ON,
            {ATTR_ENTITY_ID: LIGHT_RELAY1},
            blocking=True,
        )

        control_relays.assert_awaited_with(states)

        state = hass.states.get(LIGHT_RELAY1)
        assert state is not None
        assert state.state != STATE_ON

        # command success
        control_relays.reset_mock(return_value=True)
        control_relays.return_value = True

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_ON,
            {ATTR_ENTITY_ID: LIGHT_RELAY1},
            blocking=True,
        )

        control_relays.assert_awaited_with(states)

        state = hass.states.get(LIGHT_RELAY1)
        assert state is not None
        assert state.state == STATE_ON


async def test_relay_turn_off(hass: HomeAssistant, entry: MockConfigEntry) -> None:
    """Test the relay light turns off."""
    await init_integration(hass, entry)

    with patch.object(MockModuleConnection, "control_relays") as control_relays:
        states = [RelayStateModifier.NOCHANGE] * 8
        states[0] = RelayStateModifier.OFF

        state = hass.states.get(LIGHT_RELAY1)
        state.state = STATE_ON

        # command failed
        control_relays.return_value = False

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_OFF,
            {ATTR_ENTITY_ID: LIGHT_RELAY1},
            blocking=True,
        )

        control_relays.assert_awaited_with(states)

        state = hass.states.get(LIGHT_RELAY1)
        assert state is not None
        assert state.state != STATE_OFF

        # command success
        control_relays.reset_mock(return_value=True)
        control_relays.return_value = True

        await hass.services.async_call(
            DOMAIN_LIGHT,
            SERVICE_TURN_OFF,
            {ATTR_ENTITY_ID: LIGHT_RELAY1},
            blocking=True,
        )

        control_relays.assert_awaited_with(states)

        state = hass.states.get(LIGHT_RELAY1)
        assert state is not None
        assert state.state == STATE_OFF


async def test_pushed_output_status_change(
    hass: HomeAssistant, entry: MockConfigEntry
) -> None:
    """Test the output light changes its state on status received."""
    await init_integration(hass, entry)

    device_connection = get_device_connection(hass, (0, 7, False), entry)
    address = LcnAddr(0, 7, False)

    # push status "on"
    inp = ModStatusOutput(address, 0, 50)
    await device_connection.async_process_input(inp)
    await hass.async_block_till_done()

    state = hass.states.get(LIGHT_OUTPUT1)
    assert state is not None
    assert state.state == STATE_ON
    assert state.attributes[ATTR_BRIGHTNESS] == 127

    # push status "off"
    inp = ModStatusOutput(address, 0, 0)
    await device_connection.async_process_input(inp)
    await hass.async_block_till_done()

    state = hass.states.get(LIGHT_OUTPUT1)
    assert state is not None
    assert state.state == STATE_OFF


async def test_pushed_relay_status_change(
    hass: HomeAssistant, entry: MockConfigEntry
) -> None:
    """Test the relay light changes its state on status received."""
    await init_integration(hass, entry)

    device_connection = get_device_connection(hass, (0, 7, False), entry)
    address = LcnAddr(0, 7, False)
    states = [False] * 8

    # push status "on"
    states[0] = True
    inp = ModStatusRelays(address, states)
    await device_connection.async_process_input(inp)
    await hass.async_block_till_done()

    state = hass.states.get(LIGHT_RELAY1)
    assert state is not None
    assert state.state == STATE_ON

    # push status "off"
    states[0] = False
    inp = ModStatusRelays(address, states)
    await device_connection.async_process_input(inp)
    await hass.async_block_till_done()

    state = hass.states.get(LIGHT_RELAY1)
    assert state is not None
    assert state.state == STATE_OFF


async def test_unload_config_entry(hass: HomeAssistant, entry: MockConfigEntry) -> None:
    """Test the light is removed when the config entry is unloaded."""
    await init_integration(hass, entry)

    await hass.config_entries.async_unload(entry.entry_id)
    assert hass.states.get(LIGHT_OUTPUT1).state == STATE_UNAVAILABLE