core/tests/components/remote/test_init.py

"""The tests for the Remote component, adapted from Light Test."""
# pylint: disable=protected-access

import unittest

import homeassistant.components.remote as remote
from homeassistant.const import (
    ATTR_ENTITY_ID,
    CONF_PLATFORM,
    SERVICE_TURN_OFF,
    SERVICE_TURN_ON,
    STATE_OFF,
    STATE_ON,
)

from tests.common import get_test_home_assistant, mock_service
from tests.components.remote import common

TEST_PLATFORM = {remote.DOMAIN: {CONF_PLATFORM: "test"}}
SERVICE_SEND_COMMAND = "send_command"
SERVICE_LEARN_COMMAND = "learn_command"


class TestRemote(unittest.TestCase):
    """Test the remote module."""

    # pylint: disable=invalid-name
    def setUp(self):
        """Set up things to be run when tests are started."""
        self.hass = get_test_home_assistant()
        self.addCleanup(self.hass.stop)

    def test_is_on(self):
        """Test is_on."""
        self.hass.states.set("remote.test", STATE_ON)
        assert remote.is_on(self.hass, "remote.test")

        self.hass.states.set("remote.test", STATE_OFF)
        assert not remote.is_on(self.hass, "remote.test")

    def test_turn_on(self):
        """Test turn_on."""
        turn_on_calls = mock_service(self.hass, remote.DOMAIN, SERVICE_TURN_ON)

        common.turn_on(self.hass, entity_id="entity_id_val")

        self.hass.block_till_done()

        assert len(turn_on_calls) == 1
        call = turn_on_calls[-1]

        assert remote.DOMAIN == call.domain

    def test_turn_off(self):
        """Test turn_off."""
        turn_off_calls = mock_service(self.hass, remote.DOMAIN, SERVICE_TURN_OFF)

        common.turn_off(self.hass, entity_id="entity_id_val")

        self.hass.block_till_done()

        assert len(turn_off_calls) == 1
        call = turn_off_calls[-1]

        assert call.domain == remote.DOMAIN
        assert call.service == SERVICE_TURN_OFF
        assert call.data[ATTR_ENTITY_ID] == "entity_id_val"

    def test_send_command(self):
        """Test send_command."""
        send_command_calls = mock_service(
            self.hass, remote.DOMAIN, SERVICE_SEND_COMMAND
        )

        common.send_command(
            self.hass,
            entity_id="entity_id_val",
            device="test_device",
            command=["test_command"],
            num_repeats="4",
            delay_secs="0.6",
        )

        self.hass.block_till_done()

        assert len(send_command_calls) == 1
        call = send_command_calls[-1]

        assert call.domain == remote.DOMAIN
        assert call.service == SERVICE_SEND_COMMAND
        assert call.data[ATTR_ENTITY_ID] == "entity_id_val"

    def test_learn_command(self):
        """Test learn_command."""
        learn_command_calls = mock_service(
            self.hass, remote.DOMAIN, SERVICE_LEARN_COMMAND
        )

        common.learn_command(
            self.hass,
            entity_id="entity_id_val",
            device="test_device",
            command=["test_command"],
            alternative=True,
            timeout=20,
        )

        self.hass.block_till_done()

        assert len(learn_command_calls) == 1
        call = learn_command_calls[-1]

        assert call.domain == remote.DOMAIN
        assert call.service == SERVICE_LEARN_COMMAND
        assert call.data[ATTR_ENTITY_ID] == "entity_id_val"


def test_deprecated_base_class(caplog):
    """Test deprecated base class."""

    class CustomRemote(remote.RemoteDevice):
        pass

    CustomRemote()
    assert "RemoteDevice is deprecated, modify CustomRemote" in caplog.text