core/tests/components/media_player/test_blackbird.py

"""The tests for the Monoprice Blackbird media player platform."""
import unittest
from unittest import mock
import voluptuous as vol

from collections import defaultdict
from homeassistant.components.media_player import (
    DOMAIN, SUPPORT_TURN_ON, SUPPORT_TURN_OFF, SUPPORT_SELECT_SOURCE)
from homeassistant.const import STATE_ON, STATE_OFF

import tests.common
from homeassistant.components.media_player.blackbird import (
    DATA_BLACKBIRD, PLATFORM_SCHEMA, SERVICE_SETALLZONES, setup_platform)


class AttrDict(dict):
    """Helper class for mocking attributes."""

    def __setattr__(self, name, value):
        """Set attribute."""
        self[name] = value

    def __getattr__(self, item):
        """Get attribute."""
        return self[item]


class MockBlackbird:
    """Mock for pyblackbird object."""

    def __init__(self):
        """Init mock object."""
        self.zones = defaultdict(lambda: AttrDict(power=True,
                                                  av=1))

    def zone_status(self, zone_id):
        """Get zone status."""
        status = self.zones[zone_id]
        status.zone = zone_id
        return AttrDict(status)

    def set_zone_source(self, zone_id, source_idx):
        """Set source for zone."""
        self.zones[zone_id].av = source_idx

    def set_zone_power(self, zone_id, power):
        """Turn zone on/off."""
        self.zones[zone_id].power = power

    def set_all_zone_source(self, source_idx):
        """Set source for all zones."""
        self.zones[3].av = source_idx


class TestBlackbirdSchema(unittest.TestCase):
    """Test Blackbird schema."""

    def test_valid_serial_schema(self):
        """Test valid schema."""
        valid_schema = {
            'platform': 'blackbird',
            'port': '/dev/ttyUSB0',
            'zones': {1: {'name': 'a'},
                      2: {'name': 'a'},
                      3: {'name': 'a'},
                      4: {'name': 'a'},
                      5: {'name': 'a'},
                      6: {'name': 'a'},
                      7: {'name': 'a'},
                      8: {'name': 'a'},
                      },
            'sources': {
                1: {'name': 'a'},
                2: {'name': 'a'},
                3: {'name': 'a'},
                4: {'name': 'a'},
                5: {'name': 'a'},
                6: {'name': 'a'},
                7: {'name': 'a'},
                8: {'name': 'a'},
            }
        }
        PLATFORM_SCHEMA(valid_schema)

    def test_valid_socket_schema(self):
        """Test valid schema."""
        valid_schema = {
            'platform': 'blackbird',
            'host': '192.168.1.50',
            'zones': {1: {'name': 'a'},
                      2: {'name': 'a'},
                      3: {'name': 'a'},
                      4: {'name': 'a'},
                      5: {'name': 'a'},
                      },
            'sources': {
                1: {'name': 'a'},
                2: {'name': 'a'},
                3: {'name': 'a'},
                4: {'name': 'a'},
            }
        }
        PLATFORM_SCHEMA(valid_schema)

    def test_invalid_schemas(self):
        """Test invalid schemas."""
        schemas = (
            {},  # Empty
            None,  # None
            # Port and host used concurrently
            {
                'platform': 'blackbird',
                'port': '/dev/ttyUSB0',
                'host': '192.168.1.50',
                'name': 'Name',
                'zones': {1: {'name': 'a'}},
                'sources': {1: {'name': 'b'}},
            },
            # Port or host missing
            {
                'platform': 'blackbird',
                'name': 'Name',
                'zones': {1: {'name': 'a'}},
                'sources': {1: {'name': 'b'}},
            },
            # Invalid zone number
            {
                'platform': 'blackbird',
                'port': '/dev/ttyUSB0',
                'name': 'Name',
                'zones': {11: {'name': 'a'}},
                'sources': {1: {'name': 'b'}},
            },
            # Invalid source number
            {
                'platform': 'blackbird',
                'port': '/dev/ttyUSB0',
                'name': 'Name',
                'zones': {1: {'name': 'a'}},
                'sources': {9: {'name': 'b'}},
            },
            # Zone missing name
            {
                'platform': 'blackbird',
                'port': '/dev/ttyUSB0',
                'name': 'Name',
                'zones': {1: {}},
                'sources': {1: {'name': 'b'}},
            },
            # Source missing name
            {
                'platform': 'blackbird',
                'port': '/dev/ttyUSB0',
                'name': 'Name',
                'zones': {1: {'name': 'a'}},
                'sources': {1: {}},
            },
        )
        for value in schemas:
            with self.assertRaises(vol.MultipleInvalid):
                PLATFORM_SCHEMA(value)


class TestBlackbirdMediaPlayer(unittest.TestCase):
    """Test the media_player module."""

    def setUp(self):
        """Set up the test case."""
        self.blackbird = MockBlackbird()
        self.hass = tests.common.get_test_home_assistant()
        self.hass.start()
        # Note, source dictionary is unsorted!
        with mock.patch('pyblackbird.get_blackbird',
                        new=lambda *a: self.blackbird):
            setup_platform(self.hass, {
                'platform': 'blackbird',
                'port': '/dev/ttyUSB0',
                'zones': {3: {'name': 'Zone name'}},
                'sources': {1: {'name': 'one'},
                            3: {'name': 'three'},
                            2: {'name': 'two'}},
            }, lambda *args, **kwargs: None, {})
            self.hass.block_till_done()
        self.media_player = self.hass.data[DATA_BLACKBIRD]['/dev/ttyUSB0-3']
        self.media_player.hass = self.hass
        self.media_player.entity_id = 'media_player.zone_3'

    def tearDown(self):
        """Tear down the test case."""
        self.hass.stop()

    def test_setup_platform(self, *args):
        """Test setting up platform."""
        # One service must be registered
        self.assertTrue(self.hass.services.has_service(DOMAIN,
                                                       SERVICE_SETALLZONES))
        self.assertEqual(len(self.hass.data[DATA_BLACKBIRD]), 1)
        self.assertEqual(self.hass.data[DATA_BLACKBIRD]['/dev/ttyUSB0-3'].name,
                         'Zone name')

    def test_setallzones_service_call_with_entity_id(self):
        """Test set all zone source service call with entity id."""
        self.media_player.update()
        self.assertEqual('Zone name', self.media_player.name)
        self.assertEqual(STATE_ON, self.media_player.state)
        self.assertEqual('one', self.media_player.source)

        # Call set all zones service
        self.hass.services.call(DOMAIN, SERVICE_SETALLZONES,
                                {'entity_id': 'media_player.zone_3',
                                 'source': 'three'},
                                blocking=True)

        # Check that source was changed
        self.assertEqual(3, self.blackbird.zones[3].av)
        self.media_player.update()
        self.assertEqual('three', self.media_player.source)

    def test_setallzones_service_call_without_entity_id(self):
        """Test set all zone source service call without entity id."""
        self.media_player.update()
        self.assertEqual('Zone name', self.media_player.name)
        self.assertEqual(STATE_ON, self.media_player.state)
        self.assertEqual('one', self.media_player.source)

        # Call set all zones service
        self.hass.services.call(DOMAIN, SERVICE_SETALLZONES,
                                {'source': 'three'}, blocking=True)

        # Check that source was changed
        self.assertEqual(3, self.blackbird.zones[3].av)
        self.media_player.update()
        self.assertEqual('three', self.media_player.source)

    def test_update(self):
        """Test updating values from blackbird."""
        self.assertIsNone(self.media_player.state)
        self.assertIsNone(self.media_player.source)

        self.media_player.update()

        self.assertEqual(STATE_ON, self.media_player.state)
        self.assertEqual('one', self.media_player.source)

    def test_name(self):
        """Test name property."""
        self.assertEqual('Zone name', self.media_player.name)

    def test_state(self):
        """Test state property."""
        self.assertIsNone(self.media_player.state)

        self.media_player.update()
        self.assertEqual(STATE_ON, self.media_player.state)

        self.blackbird.zones[3].power = False
        self.media_player.update()
        self.assertEqual(STATE_OFF, self.media_player.state)

    def test_supported_features(self):
        """Test supported features property."""
        self.assertEqual(SUPPORT_TURN_ON | SUPPORT_TURN_OFF |
                         SUPPORT_SELECT_SOURCE,
                         self.media_player.supported_features)

    def test_source(self):
        """Test source property."""
        self.assertIsNone(self.media_player.source)
        self.media_player.update()
        self.assertEqual('one', self.media_player.source)

    def test_media_title(self):
        """Test media title property."""
        self.assertIsNone(self.media_player.media_title)
        self.media_player.update()
        self.assertEqual('one', self.media_player.media_title)

    def test_source_list(self):
        """Test source list property."""
        # Note, the list is sorted!
        self.assertEqual(['one', 'two', 'three'],
                         self.media_player.source_list)

    def test_select_source(self):
        """Test source selection methods."""
        self.media_player.update()

        self.assertEqual('one', self.media_player.source)

        self.media_player.select_source('two')
        self.assertEqual(2, self.blackbird.zones[3].av)
        self.media_player.update()
        self.assertEqual('two', self.media_player.source)

        # Trying to set unknown source.
        self.media_player.select_source('no name')
        self.assertEqual(2, self.blackbird.zones[3].av)
        self.media_player.update()
        self.assertEqual('two', self.media_player.source)

    def test_turn_on(self):
        """Testing turning on the zone."""
        self.blackbird.zones[3].power = False
        self.media_player.update()
        self.assertEqual(STATE_OFF, self.media_player.state)

        self.media_player.turn_on()
        self.assertTrue(self.blackbird.zones[3].power)
        self.media_player.update()
        self.assertEqual(STATE_ON, self.media_player.state)

    def test_turn_off(self):
        """Testing turning off the zone."""
        self.blackbird.zones[3].power = True
        self.media_player.update()
        self.assertEqual(STATE_ON, self.media_player.state)

        self.media_player.turn_off()
        self.assertFalse(self.blackbird.zones[3].power)
        self.media_player.update()
        self.assertEqual(STATE_OFF, self.media_player.state)