jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-04-23 00:37:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add more Spotify tests for the media player (#127999)

Browse Source 
* Add more Spotify tests for the media player

* Fix comments

* Rename test
This commit is contained in:
Joost Lekkerkerker 2024-10-11 14:06:52 +02:00 committed by GitHub
parent e682d3461f
commit 00f7bdbfaa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 254 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

254
tests/components/spotify/test_media_player.py
View File

@ -7,10 +7,33 @@ from spotipy import SpotifyException
from syrupy import SnapshotAssertion
from homeassistant.components.media_player import (
ATTR_MEDIA_CONTENT_ID,
ATTR_MEDIA_CONTENT_TYPE,
ATTR_MEDIA_ENQUEUE,
ATTR_MEDIA_REPEAT,
ATTR_MEDIA_SEEK_POSITION,
ATTR_MEDIA_SHUFFLE,
ATTR_MEDIA_VOLUME_LEVEL,
DOMAIN as MEDIA_PLAYER_DOMAIN,
SERVICE_PLAY_MEDIA,
MediaPlayerEnqueue,
MediaPlayerEntityFeature,
MediaPlayerState,
MediaType,
RepeatMode,
)
from homeassistant.components.spotify import DOMAIN
from homeassistant.const import (
ATTR_ENTITY_ID,
SERVICE_MEDIA_NEXT_TRACK,
SERVICE_MEDIA_PAUSE,
SERVICE_MEDIA_PLAY,
SERVICE_MEDIA_PREVIOUS_TRACK,
SERVICE_MEDIA_SEEK,
SERVICE_REPEAT_SET,
SERVICE_SHUFFLE_SET,
SERVICE_VOLUME_SET,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
@ -137,3 +160,234 @@ async def test_idle(
assert (
state.attributes["supported_features"] == MediaPlayerEntityFeature.SELECT_SOURCE
)
@pytest.mark.usefixtures("setup_credentials")
@pytest.mark.parametrize(
("service", "method"),
[
(SERVICE_MEDIA_PLAY, "start_playback"),
(SERVICE_MEDIA_PAUSE, "pause_playback"),
(SERVICE_MEDIA_PREVIOUS_TRACK, "previous_track"),
(SERVICE_MEDIA_NEXT_TRACK, "next_track"),
],
)
async def test_simple_actions(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
service: str,
method: str,
) -> None:
"""Test the Spotify media player."""
await setup_integration(hass, mock_config_entry)
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
service,
{ATTR_ENTITY_ID: "media_player.spotify_spotify_1"},
blocking=True,
)
getattr(mock_spotify.return_value, method).assert_called_once_with()
@pytest.mark.usefixtures("setup_credentials")
async def test_repeat_mode(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test the Spotify media player repeat mode."""
await setup_integration(hass, mock_config_entry)
for mode, spotify_mode in (
(RepeatMode.ALL, "context"),
(RepeatMode.ONE, "track"),
(RepeatMode.OFF, "off"),
):
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_REPEAT_SET,
{ATTR_ENTITY_ID: "media_player.spotify_spotify_1", ATTR_MEDIA_REPEAT: mode},
blocking=True,
)
mock_spotify.return_value.repeat.assert_called_once_with(spotify_mode)
mock_spotify.return_value.repeat.reset_mock()
@pytest.mark.usefixtures("setup_credentials")
async def test_shuffle(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test the Spotify media player shuffle."""
await setup_integration(hass, mock_config_entry)
for shuffle in (True, False):
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_SHUFFLE_SET,
{
ATTR_ENTITY_ID: "media_player.spotify_spotify_1",
ATTR_MEDIA_SHUFFLE: shuffle,
},
blocking=True,
)
mock_spotify.return_value.shuffle.assert_called_once_with(shuffle)
mock_spotify.return_value.shuffle.reset_mock()
@pytest.mark.usefixtures("setup_credentials")
async def test_volume_level(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test the Spotify media player volume level."""
await setup_integration(hass, mock_config_entry)
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_VOLUME_SET,
{
ATTR_ENTITY_ID: "media_player.spotify_spotify_1",
ATTR_MEDIA_VOLUME_LEVEL: 0.5,
},
blocking=True,
)
mock_spotify.return_value.volume.assert_called_with(50)
@pytest.mark.usefixtures("setup_credentials")
async def test_seek(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test the Spotify media player seeking."""
await setup_integration(hass, mock_config_entry)
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_MEDIA_SEEK,
{
ATTR_ENTITY_ID: "media_player.spotify_spotify_1",
ATTR_MEDIA_SEEK_POSITION: 100,
},
blocking=True,
)
mock_spotify.return_value.seek_track.assert_called_with(100000)
@pytest.mark.usefixtures("setup_credentials")
@pytest.mark.parametrize(
("media_type", "media_id"),
[
("spotify://track", "spotify:track:3oRoMXsP2NRzm51lldj1RO"),
("spotify://episode", "spotify:episode:3oRoMXsP2NRzm51lldj1RO"),
(MediaType.MUSIC, "spotify:track:3oRoMXsP2NRzm51lldj1RO"),
],
)
async def test_play_media_in_queue(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
media_type: str,
media_id: str,
) -> None:
"""Test the Spotify media player play media."""
await setup_integration(hass, mock_config_entry)
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_PLAY_MEDIA,
{
ATTR_ENTITY_ID: "media_player.spotify_spotify_1",
ATTR_MEDIA_CONTENT_TYPE: media_type,
ATTR_MEDIA_CONTENT_ID: media_id,
ATTR_MEDIA_ENQUEUE: MediaPlayerEnqueue.ADD,
},
blocking=True,
)
mock_spotify.return_value.add_to_queue.assert_called_with(media_id, None)
@pytest.mark.usefixtures("setup_credentials")
@pytest.mark.parametrize(
("media_type", "media_id", "called_with"),
[
(
"spotify://artist",
"spotify:artist:74Yus6IHfa3tWZzXXAYtS2",
{"context_uri": "spotify:artist:74Yus6IHfa3tWZzXXAYtS2"},
),
(
"spotify://playlist",
"spotify:playlist:74Yus6IHfa3tWZzXXAYtS2",
{"context_uri": "spotify:playlist:74Yus6IHfa3tWZzXXAYtS2"},
),
(
"spotify://album",
"spotify:album:74Yus6IHfa3tWZzXXAYtS2",
{"context_uri": "spotify:album:74Yus6IHfa3tWZzXXAYtS2"},
),
(
"spotify://show",
"spotify:show:74Yus6IHfa3tWZzXXAYtS2",
{"context_uri": "spotify:show:74Yus6IHfa3tWZzXXAYtS2"},
),
(
MediaType.MUSIC,
"spotify:track:3oRoMXsP2NRzm51lldj1RO",
{"uris": ["spotify:track:3oRoMXsP2NRzm51lldj1RO"]},
),
(
"spotify://track",
"spotify:track:3oRoMXsP2NRzm51lldj1RO",
{"uris": ["spotify:track:3oRoMXsP2NRzm51lldj1RO"]},
),
(
"spotify://episode",
"spotify:episode:3oRoMXsP2NRzm51lldj1RO",
{"uris": ["spotify:episode:3oRoMXsP2NRzm51lldj1RO"]},
),
],
)
async def test_play_media(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
media_type: str,
media_id: str,
called_with: dict,
) -> None:
"""Test the Spotify media player play media."""
await setup_integration(hass, mock_config_entry)
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_PLAY_MEDIA,
{
ATTR_ENTITY_ID: "media_player.spotify_spotify_1",
ATTR_MEDIA_CONTENT_TYPE: media_type,
ATTR_MEDIA_CONTENT_ID: media_id,
},
blocking=True,
)
mock_spotify.return_value.start_playback.assert_called_with(**called_with)
@pytest.mark.usefixtures("setup_credentials")
async def test_play_unsupported_media(
hass: HomeAssistant,
mock_spotify: MagicMock,
mock_config_entry: MockConfigEntry,
) -> None:
"""Test the Spotify media player play media."""
await setup_integration(hass, mock_config_entry)
await hass.services.async_call(
MEDIA_PLAYER_DOMAIN,
SERVICE_PLAY_MEDIA,
{
ATTR_ENTITY_ID: "media_player.spotify_spotify_1",
ATTR_MEDIA_CONTENT_TYPE: MediaType.COMPOSER,
ATTR_MEDIA_CONTENT_ID: "spotify:track:3oRoMXsP2NRzm51lldj1RO",
},
blocking=True,
)
assert mock_spotify.return_value.start_playback.call_count == 0
assert mock_spotify.return_value.add_to_queue.call_count == 0