Add source selection to Heos component (#22592)
* Add select source support * Review feedback changes * Removed unused import * Ignore 'umused' import used in typing * Only include trace back on useful errors * Remove return from play_source
This commit is contained in:
1 parent
a5b03541e9
commit
9f2c5b7231
8 files changed
+365
-48
No files matched your search
@@ -1,6 +1,8 @@
|
||||
"""Configuration for HEOS tests."""
|
||||
from typing import Dict, Sequence
|
||||
|
||||
from asynctest.mock import Mock, patch as patch
|
||||
from pyheos import Dispatcher, HeosPlayer, const
|
||||
from pyheos import Dispatcher, HeosPlayer, HeosSource, InputSource, const
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.heos import DOMAIN
|
||||
@@ -17,12 +19,15 @@ def config_entry_fixture():
|
||||
|
||||
|
||||
@pytest.fixture(name="controller")
|
||||
def controller_fixture(players):
|
||||
def controller_fixture(players, favorites, input_sources, dispatcher):
|
||||
"""Create a mock Heos controller fixture."""
|
||||
with patch("pyheos.Heos", autospec=True) as mock:
|
||||
mock_heos = mock.return_value
|
||||
mock_heos.dispatcher = dispatcher
|
||||
mock_heos.get_players.return_value = players
|
||||
mock_heos.players = players
|
||||
mock_heos.get_favorites.return_value = favorites
|
||||
mock_heos.get_input_sources.return_value = input_sources
|
||||
yield mock_heos
|
||||
|
||||
|
||||
@@ -35,10 +40,10 @@ def config_fixture():
|
||||
|
||||
|
||||
@pytest.fixture(name="players")
|
||||
def player_fixture():
|
||||
def player_fixture(dispatcher):
|
||||
"""Create a mock HeosPlayer."""
|
||||
player = Mock(HeosPlayer, autospec=True)
|
||||
player.heos.dispatcher = Dispatcher()
|
||||
player.heos.dispatcher = dispatcher
|
||||
player.player_id = 1
|
||||
player.name = "Test Player"
|
||||
player.model = "Test Model"
|
||||
@@ -65,3 +70,36 @@ def player_fixture():
|
||||
player.now_playing_media.image_url = "http://"
|
||||
player.now_playing_media.song = "Song"
|
||||
return {player.player_id: player}
|
||||
|
||||
|
||||
@pytest.fixture(name="favorites")
|
||||
def favorites_fixture() -> Dict[int, HeosSource]:
|
||||
"""Create favorites fixture."""
|
||||
station = Mock(HeosSource, autospec=True)
|
||||
station.type = const.TYPE_STATION
|
||||
station.name = "Today's Hits Radio"
|
||||
station.media_id = '123456789'
|
||||
radio = Mock(HeosSource, autospec=True)
|
||||
radio.type = const.TYPE_STATION
|
||||
radio.name = "Classical MPR (Classical Music)"
|
||||
radio.media_id = 's1234'
|
||||
return {
|
||||
1: station,
|
||||
2: radio
|
||||
}
|
||||
|
||||
|
||||
@pytest.fixture(name="input_sources")
|
||||
def input_sources_fixture() -> Sequence[InputSource]:
|
||||
"""Create a set of input sources for testing."""
|
||||
source = Mock(InputSource, autospec=True)
|
||||
source.player_id = 1
|
||||
source.input_name = const.INPUT_AUX_IN_1
|
||||
source.name = "HEOS Drive - Line In 1"
|
||||
return [source]
|
||||
|
||||
|
||||
@pytest.fixture(name="dispatcher")
|
||||
def dispatcher_fixture() -> Dispatcher:
|
||||
"""Create a dispatcher for testing."""
|
||||
return Dispatcher()
|
||||
@@ -2,12 +2,17 @@
|
||||
import asyncio
|
||||
|
||||
from asynctest import patch
|
||||
from pyheos import CommandError, const
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.heos import async_setup_entry, async_unload_entry
|
||||
from homeassistant.components.heos.const import DATA_CONTROLLER, DOMAIN
|
||||
from homeassistant.components.heos import (
|
||||
SourceManager, async_setup_entry, async_unload_entry)
|
||||
from homeassistant.components.heos.const import (
|
||||
DATA_CONTROLLER, DATA_SOURCE_MANAGER, DOMAIN)
|
||||
from homeassistant.components.media_player.const import (
|
||||
DOMAIN as MEDIA_PLAYER_DOMAIN)
|
||||
from homeassistant.const import CONF_HOST
|
||||
from homeassistant.exceptions import ConfigEntryNotReady
|
||||
from homeassistant.setup import async_setup_component
|
||||
|
||||
|
||||
@@ -36,7 +41,7 @@ async def test_async_setup_updates_entry(hass, config_entry, config):
|
||||
|
||||
|
||||
async def test_async_setup_returns_true(hass, config_entry, config):
|
||||
"""Test component setup updates entry from config."""
|
||||
"""Test component setup from config."""
|
||||
config_entry.add_to_hass(hass)
|
||||
assert await async_setup_component(hass, DOMAIN, config)
|
||||
await hass.async_block_till_done()
|
||||
@@ -46,7 +51,7 @@ async def test_async_setup_returns_true(hass, config_entry, config):
|
||||
|
||||
|
||||
async def test_async_setup_no_config_returns_true(hass, config_entry):
|
||||
"""Test component setup updates entry from entry only."""
|
||||
"""Test component setup from entry only."""
|
||||
config_entry.add_to_hass(hass)
|
||||
assert await async_setup_component(hass, DOMAIN, {})
|
||||
await hass.async_block_till_done()
|
||||
@@ -67,21 +72,21 @@ async def test_async_setup_entry_loads_platforms(
|
||||
assert forward_mock.call_count == 1
|
||||
assert controller.connect.call_count == 1
|
||||
controller.disconnect.assert_not_called()
|
||||
assert hass.data[DOMAIN] == {
|
||||
DATA_CONTROLLER: controller,
|
||||
MEDIA_PLAYER_DOMAIN: controller.players
|
||||
}
|
||||
assert hass.data[DOMAIN][DATA_CONTROLLER] == controller
|
||||
assert hass.data[DOMAIN][MEDIA_PLAYER_DOMAIN] == controller.players
|
||||
assert isinstance(hass.data[DOMAIN][DATA_SOURCE_MANAGER], SourceManager)
|
||||
|
||||
|
||||
async def test_async_setup_entry_connect_failure(
|
||||
hass, config_entry, controller):
|
||||
"""Test failure to connect does not load entry."""
|
||||
"""Connection failure raises ConfigEntryNotReady."""
|
||||
config_entry.add_to_hass(hass)
|
||||
errors = [ConnectionError, asyncio.TimeoutError]
|
||||
for error in errors:
|
||||
controller.connect.side_effect = error
|
||||
assert not await async_setup_entry(hass, config_entry)
|
||||
await hass.async_block_till_done()
|
||||
with pytest.raises(ConfigEntryNotReady):
|
||||
await async_setup_entry(hass, config_entry)
|
||||
await hass.async_block_till_done()
|
||||
assert controller.connect.call_count == 1
|
||||
assert controller.disconnect.call_count == 1
|
||||
controller.connect.reset_mock()
|
||||
@@ -90,13 +95,14 @@ async def test_async_setup_entry_connect_failure(
|
||||
|
||||
async def test_async_setup_entry_player_failure(
|
||||
hass, config_entry, controller):
|
||||
"""Test failure to retrieve players does not load entry."""
|
||||
"""Failure to retrieve players/sources raises ConfigEntryNotReady."""
|
||||
config_entry.add_to_hass(hass)
|
||||
errors = [ConnectionError, asyncio.TimeoutError]
|
||||
for error in errors:
|
||||
controller.get_players.side_effect = error
|
||||
assert not await async_setup_entry(hass, config_entry)
|
||||
await hass.async_block_till_done()
|
||||
with pytest.raises(ConfigEntryNotReady):
|
||||
await async_setup_entry(hass, config_entry)
|
||||
await hass.async_block_till_done()
|
||||
assert controller.connect.call_count == 1
|
||||
assert controller.disconnect.call_count == 1
|
||||
controller.connect.reset_mock()
|
||||
@@ -112,3 +118,24 @@ async def test_unload_entry(hass, config_entry, controller):
|
||||
await hass.async_block_till_done()
|
||||
assert controller.disconnect.call_count == 1
|
||||
assert unload.call_count == 1
|
||||
assert DOMAIN not in hass.data
|
||||
|
||||
|
||||
async def test_update_sources_retry(hass, config_entry, config, controller,
|
||||
caplog):
|
||||
"""Test update sources retries on failures to max attempts."""
|
||||
config_entry.add_to_hass(hass)
|
||||
assert await async_setup_component(hass, DOMAIN, config)
|
||||
controller.get_favorites.reset_mock()
|
||||
controller.get_input_sources.reset_mock()
|
||||
source_manager = hass.data[DOMAIN][DATA_SOURCE_MANAGER]
|
||||
source_manager.retry_delay = 0
|
||||
source_manager.max_retry_attempts = 1
|
||||
controller.get_favorites.side_effect = CommandError("Test", "test", 0)
|
||||
controller.dispatcher.send(
|
||||
const.SIGNAL_CONTROLLER_EVENT, const.EVENT_SOURCES_CHANGED)
|
||||
# Wait until it's finished
|
||||
while "Unable to update sources" not in caplog.text:
|
||||
await asyncio.sleep(0.1)
|
||||
assert controller.get_favorites.call_count == 2
|
||||
assert controller.get_input_sources.call_count == 2
|
||||
@@ -1,16 +1,19 @@
|
||||
"""Tests for the Heos Media Player platform."""
|
||||
import asyncio
|
||||
|
||||
from pyheos import const
|
||||
|
||||
from homeassistant.components.heos import media_player
|
||||
from homeassistant.components.heos.const import DOMAIN
|
||||
from homeassistant.components.heos.const import (
|
||||
DATA_SOURCE_MANAGER, DOMAIN, SIGNAL_HEOS_SOURCES_UPDATED)
|
||||
from homeassistant.components.media_player.const import (
|
||||
ATTR_MEDIA_ALBUM_NAME, ATTR_MEDIA_ARTIST, ATTR_MEDIA_CONTENT_ID,
|
||||
ATTR_MEDIA_CONTENT_TYPE, ATTR_MEDIA_DURATION, ATTR_MEDIA_POSITION,
|
||||
ATTR_MEDIA_POSITION_UPDATED_AT, ATTR_MEDIA_SHUFFLE, ATTR_MEDIA_TITLE,
|
||||
ATTR_MEDIA_VOLUME_LEVEL, ATTR_MEDIA_VOLUME_MUTED,
|
||||
DOMAIN as MEDIA_PLAYER_DOMAIN, MEDIA_TYPE_MUSIC, SERVICE_CLEAR_PLAYLIST,
|
||||
SUPPORT_NEXT_TRACK, SUPPORT_PAUSE, SUPPORT_PLAY, SUPPORT_PREVIOUS_TRACK,
|
||||
SUPPORT_STOP)
|
||||
ATTR_INPUT_SOURCE, ATTR_INPUT_SOURCE_LIST, ATTR_MEDIA_ALBUM_NAME,
|
||||
ATTR_MEDIA_ARTIST, ATTR_MEDIA_CONTENT_ID, ATTR_MEDIA_CONTENT_TYPE,
|
||||
ATTR_MEDIA_DURATION, ATTR_MEDIA_POSITION, ATTR_MEDIA_POSITION_UPDATED_AT,
|
||||
ATTR_MEDIA_SHUFFLE, ATTR_MEDIA_TITLE, ATTR_MEDIA_VOLUME_LEVEL,
|
||||
ATTR_MEDIA_VOLUME_MUTED, DOMAIN as MEDIA_PLAYER_DOMAIN, MEDIA_TYPE_MUSIC,
|
||||
SERVICE_CLEAR_PLAYLIST, SERVICE_SELECT_SOURCE, SUPPORT_NEXT_TRACK,
|
||||
SUPPORT_PAUSE, SUPPORT_PLAY, SUPPORT_PREVIOUS_TRACK, SUPPORT_STOP)
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID, ATTR_FRIENDLY_NAME, ATTR_SUPPORTED_FEATURES,
|
||||
SERVICE_MEDIA_NEXT_TRACK, SERVICE_MEDIA_PAUSE, SERVICE_MEDIA_PLAY,
|
||||
@@ -56,10 +59,13 @@ async def test_state_attributes(hass, config_entry, config, controller):
|
||||
assert state.attributes[ATTR_SUPPORTED_FEATURES] == \
|
||||
SUPPORT_PLAY | SUPPORT_PAUSE | SUPPORT_STOP | SUPPORT_NEXT_TRACK | \
|
||||
SUPPORT_PREVIOUS_TRACK | media_player.BASE_SUPPORTED_FEATURES
|
||||
assert ATTR_INPUT_SOURCE not in state.attributes
|
||||
assert state.attributes[ATTR_INPUT_SOURCE_LIST] == \
|
||||
hass.data[DOMAIN][DATA_SOURCE_MANAGER].source_list
|
||||
|
||||
|
||||
async def test_updates_start_from_signals(
|
||||
hass, config_entry, config, controller):
|
||||
hass, config_entry, config, controller, favorites):
|
||||
"""Tests dispatched signals update player."""
|
||||
await setup_platform(hass, config_entry, config)
|
||||
player = controller.players[1]
|
||||
@@ -110,6 +116,23 @@ async def test_updates_start_from_signals(
|
||||
state = hass.states.get('media_player.test_player')
|
||||
assert state.state == STATE_PLAYING
|
||||
|
||||
# Test sources event update
|
||||
event = asyncio.Event()
|
||||
|
||||
async def set_signal():
|
||||
event.set()
|
||||
hass.helpers.dispatcher.async_dispatcher_connect(
|
||||
SIGNAL_HEOS_SOURCES_UPDATED, set_signal)
|
||||
|
||||
favorites.clear()
|
||||
player.heos.dispatcher.send(
|
||||
const.SIGNAL_CONTROLLER_EVENT, const.EVENT_SOURCES_CHANGED)
|
||||
await event.wait()
|
||||
source_list = hass.data[DOMAIN][DATA_SOURCE_MANAGER].source_list
|
||||
assert len(source_list) == 1
|
||||
state = hass.states.get('media_player.test_player')
|
||||
assert state.attributes[ATTR_INPUT_SOURCE_LIST] == source_list
|
||||
|
||||
|
||||
async def test_services(hass, config_entry, config, controller):
|
||||
"""Tests player commands."""
|
||||
@@ -173,6 +196,85 @@ async def test_services(hass, config_entry, config, controller):
|
||||
player.set_volume.assert_called_once_with(100)
|
||||
|
||||
|
||||
async def test_select_favorite(
|
||||
hass, config_entry, config, controller, favorites):
|
||||
"""Tests selecting a music service favorite and state."""
|
||||
await setup_platform(hass, config_entry, config)
|
||||
player = controller.players[1]
|
||||
# Test set music service preset
|
||||
favorite = favorites[1]
|
||||
await hass.services.async_call(
|
||||
MEDIA_PLAYER_DOMAIN, SERVICE_SELECT_SOURCE,
|
||||
{ATTR_ENTITY_ID: 'media_player.test_player',
|
||||
ATTR_INPUT_SOURCE: favorite.name}, blocking=True)
|
||||
player.play_favorite.assert_called_once_with(1)
|
||||
# Test state is matched by station name
|
||||
player.now_playing_media.station = favorite.name
|
||||
player.heos.dispatcher.send(
|
||||
const.SIGNAL_PLAYER_EVENT, player.player_id,
|
||||
const.EVENT_PLAYER_STATE_CHANGED)
|
||||
await hass.async_block_till_done()
|
||||
state = hass.states.get('media_player.test_player')
|
||||
assert state.attributes[ATTR_INPUT_SOURCE] == favorite.name
|
||||
|
||||
|
||||
async def test_select_radio_favorite(
|
||||
hass, config_entry, config, controller, favorites):
|
||||
"""Tests selecting a radio favorite and state."""
|
||||
await setup_platform(hass, config_entry, config)
|
||||
player = controller.players[1]
|
||||
# Test set radio preset
|
||||
favorite = favorites[2]
|
||||
await hass.services.async_call(
|
||||
MEDIA_PLAYER_DOMAIN, SERVICE_SELECT_SOURCE,
|
||||
{ATTR_ENTITY_ID: 'media_player.test_player',
|
||||
ATTR_INPUT_SOURCE: favorite.name}, blocking=True)
|
||||
player.play_favorite.assert_called_once_with(2)
|
||||
# Test state is matched by album id
|
||||
player.now_playing_media.station = "Classical"
|
||||
player.now_playing_media.album_id = favorite.media_id
|
||||
player.heos.dispatcher.send(
|
||||
const.SIGNAL_PLAYER_EVENT, player.player_id,
|
||||
const.EVENT_PLAYER_STATE_CHANGED)
|
||||
await hass.async_block_till_done()
|
||||
state = hass.states.get('media_player.test_player')
|
||||
assert state.attributes[ATTR_INPUT_SOURCE] == favorite.name
|
||||
|
||||
|
||||
async def test_select_input_source(
|
||||
hass, config_entry, config, controller, input_sources):
|
||||
"""Tests selecting input source and state."""
|
||||
await setup_platform(hass, config_entry, config)
|
||||
player = controller.players[1]
|
||||
# Test proper service called
|
||||
input_source = input_sources[0]
|
||||
await hass.services.async_call(
|
||||
MEDIA_PLAYER_DOMAIN, SERVICE_SELECT_SOURCE,
|
||||
{ATTR_ENTITY_ID: 'media_player.test_player',
|
||||
ATTR_INPUT_SOURCE: input_source.name}, blocking=True)
|
||||
player.play_input_source.assert_called_once_with(input_source)
|
||||
# Test state is matched by media id
|
||||
player.now_playing_media.source_id = const.MUSIC_SOURCE_AUX_INPUT
|
||||
player.now_playing_media.media_id = const.INPUT_AUX_IN_1
|
||||
player.heos.dispatcher.send(
|
||||
const.SIGNAL_PLAYER_EVENT, player.player_id,
|
||||
const.EVENT_PLAYER_STATE_CHANGED)
|
||||
await hass.async_block_till_done()
|
||||
state = hass.states.get('media_player.test_player')
|
||||
assert state.attributes[ATTR_INPUT_SOURCE] == input_source.name
|
||||
|
||||
|
||||
async def test_select_input_unknown(
|
||||
hass, config_entry, config, controller, caplog):
|
||||
"""Tests selecting an unknown input."""
|
||||
await setup_platform(hass, config_entry, config)
|
||||
await hass.services.async_call(
|
||||
MEDIA_PLAYER_DOMAIN, SERVICE_SELECT_SOURCE,
|
||||
{ATTR_ENTITY_ID: 'media_player.test_player',
|
||||
ATTR_INPUT_SOURCE: "Unknown"}, blocking=True)
|
||||
assert "Unknown source: Unknown" in caplog.text
|
||||
|
||||
|
||||
async def test_unload_config_entry(hass, config_entry, config, controller):
|
||||
"""Test the player is removed when the config entry is unloaded."""
|
||||
await setup_platform(hass, config_entry, config)
|
||||
|
||||
Reference in new issue
Block a user