Move Plex->Sonos playback to built-in service (#45066)

* Move Plex->Sonos playback service from integration to platform * Test against 'native' Plex media_players * Add Plex to Sonos after_dependencies * Remove circular dependency * Raise exceptions in failed service calls * Add test to forward service call from Sonos * Additional Sonos->Plex tests * Fix docstring
2025-12-24 21:06:19 +00:00 · 2021-01-13 08:24:44 -06:00
parent 3364e945aa
commit 411cc6542c
13 changed files with 312 additions and 316 deletions
--- a/tests/components/plex/test_playback.py
+++ b/tests/components/plex/test_playback.py
@@ -1,219 +1,136 @@
 """Tests for Plex player playback methods/services."""
 from unittest.mock import patch

-from plexapi.exceptions import NotFound
-
 from homeassistant.components.media_player.const import (
    ATTR_MEDIA_CONTENT_ID,
    ATTR_MEDIA_CONTENT_TYPE,
+    DOMAIN as MP_DOMAIN,
+    MEDIA_TYPE_EPISODE,
+    MEDIA_TYPE_MOVIE,
    MEDIA_TYPE_MUSIC,
+    SERVICE_PLAY_MEDIA,
 )
-from homeassistant.components.plex.const import (
-    CONF_SERVER,
-    CONF_SERVER_IDENTIFIER,
-    DOMAIN,
-    PLEX_SERVER_CONFIG,
-    SERVERS,
-    SERVICE_PLAY_ON_SONOS,
-)
-from homeassistant.const import ATTR_ENTITY_ID, CONF_URL
-from homeassistant.exceptions import HomeAssistantError
-
-from .const import DEFAULT_OPTIONS, MOCK_SERVERS, SECONDARY_DATA
-
-from tests.common import MockConfigEntry
+from homeassistant.const import ATTR_ENTITY_ID


-async def test_sonos_playback(
-    hass, mock_plex_server, requests_mock, playqueue_created, sonos_resources
+async def test_media_player_playback(
+    hass, setup_plex_server, requests_mock, playqueue_created, player_plexweb_resources
 ):
-    """Test playing media on a Sonos speaker."""
-    server_id = mock_plex_server.machine_identifier
-    loaded_server = hass.data[DOMAIN][SERVERS][server_id]
-
-    # Test Sonos integration lookup failure
-    with patch.object(
-        hass.components.sonos, "get_coordinator_name", side_effect=HomeAssistantError
-    ):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: '{"library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
-            },
-            True,
-        )
-
-    # Test success with plex_key
-    requests_mock.get("https://sonos.plex.tv/resources", text=sonos_resources)
-    requests_mock.get(
-        "https://sonos.plex.tv/player/playback/playMedia", status_code=200
-    )
-    requests_mock.post("/playqueues", text=playqueue_created)
-    with patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: "100",
-            },
-            True,
-        )
-
-    # Test success with dict
-    with patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: '{"library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
-            },
-            True,
-        )
-
-    # Test media lookup failure
-    with patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ), patch("plexapi.server.PlexServer.fetchItem", side_effect=NotFound):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: "999",
-            },
-            True,
-        )
-
-    # Test invalid Plex server requested
-    with patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: '{"plex_server": "unknown_plex_server", "library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
-            },
-            True,
-        )
-
-    # Test no speakers available
-    with patch.object(
-        loaded_server.account, "sonos_speaker", return_value=None
-    ), patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ), patch(
-        "plexapi.playqueue.PlayQueue.create"
-    ):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: '{"library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
-            },
-            True,
-        )
-
-
-async def test_playback_multiple_servers(
-    hass,
-    setup_plex_server,
-    requests_mock,
-    caplog,
-    empty_payload,
-    playqueue_created,
-    plex_server_accounts,
-    plex_server_base,
-    sonos_resources,
-):
-    """Test playing media when multiple servers available."""
-    secondary_entry = MockConfigEntry(
-        domain=DOMAIN,
-        data=SECONDARY_DATA,
-        options=DEFAULT_OPTIONS,
-        unique_id=SECONDARY_DATA["server_id"],
-    )
-
-    secondary_url = SECONDARY_DATA[PLEX_SERVER_CONFIG][CONF_URL]
-    secondary_name = SECONDARY_DATA[CONF_SERVER]
-    secondary_id = SECONDARY_DATA[CONF_SERVER_IDENTIFIER]
-    requests_mock.get(
-        secondary_url,
-        text=plex_server_base.format(
-            name=secondary_name, machine_identifier=secondary_id
-        ),
-    )
-    requests_mock.get(f"{secondary_url}/accounts", text=plex_server_accounts)
-    requests_mock.get(f"{secondary_url}/clients", text=empty_payload)
-    requests_mock.get(f"{secondary_url}/status/sessions", text=empty_payload)
+    """Test playing media on a Plex media_player."""
+    requests_mock.get("http://1.2.3.5:32400/resources", text=player_plexweb_resources)

    await setup_plex_server()
-    await setup_plex_server(config_entry=secondary_entry)

-    requests_mock.get("https://sonos.plex.tv/resources", text=sonos_resources)
-    requests_mock.get(
-        "https://sonos.plex.tv/player/playback/playMedia", status_code=200
-    )
+    media_player = "media_player.plex_plex_web_chrome"
    requests_mock.post("/playqueues", text=playqueue_created)
+    requests_mock.get("/player/playback/playMedia", status_code=200)

-    with patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ):
-        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
-            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: '{"library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
-            },
-            True,
-        )
-
-    assert (
-        "Multiple Plex servers configured, choose with 'plex_server' key" in caplog.text
+    # Test movie success
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MOVIE,
+            ATTR_MEDIA_CONTENT_ID: '{"library_name": "Movies", "title": "Movie 1" }',
+        },
+        True,
    )

-    with patch.object(
-        hass.components.sonos,
-        "get_coordinator_name",
-        return_value="Speaker 2",
-    ):
+    # Test movie incomplete dict
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MOVIE,
+            ATTR_MEDIA_CONTENT_ID: '{"library_name": "Movies"}',
+        },
+        True,
+    )
+
+    # Test movie failure with options
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MOVIE,
+            ATTR_MEDIA_CONTENT_ID: '{"library_name": "Movies", "title": "Does not exist" }',
+        },
+        True,
+    )
+
+    # Test movie failure with nothing found
+    with patch("plexapi.library.LibrarySection.search", return_value=None):
        assert await hass.services.async_call(
-            DOMAIN,
-            SERVICE_PLAY_ON_SONOS,
+            MP_DOMAIN,
+            SERVICE_PLAY_MEDIA,
            {
-                ATTR_ENTITY_ID: "media_player.sonos_kitchen",
-                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
-                ATTR_MEDIA_CONTENT_ID: f'{{"plex_server": "{MOCK_SERVERS[0][CONF_SERVER]}", "library_name": "Music", "artist_name": "Artist", "album_name": "Album"}}',
+                ATTR_ENTITY_ID: media_player,
+                ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MOVIE,
+                ATTR_MEDIA_CONTENT_ID: '{"library_name": "Movies", "title": "Does not exist" }',
            },
            True,
        )
+
+    # Test movie success with dict
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
+            ATTR_MEDIA_CONTENT_ID: '{"library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
+        },
+        True,
+    )
+
+    # Test TV show episoe lookup failure
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_EPISODE,
+            ATTR_MEDIA_CONTENT_ID: '{"library_name": "TV Shows", "show_name": "TV Show", "season_number": 1, "episode_number": 99}',
+        },
+        True,
+    )
+
+    # Test track name lookup failure
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
+            ATTR_MEDIA_CONTENT_ID: '{"library_name": "Music", "artist_name": "Artist", "album_name": "Album", "track_name": "Not a track"}',
+        },
+        True,
+    )
+
+    # Test media lookup failure by key
+    requests_mock.get("/library/metadata/999", status_code=404)
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
+            ATTR_MEDIA_CONTENT_ID: "999",
+        },
+        True,
+    )
+
+    # Test invalid Plex server requested
+    assert await hass.services.async_call(
+        MP_DOMAIN,
+        SERVICE_PLAY_MEDIA,
+        {
+            ATTR_ENTITY_ID: media_player,
+            ATTR_MEDIA_CONTENT_TYPE: MEDIA_TYPE_MUSIC,
+            ATTR_MEDIA_CONTENT_ID: '{"plex_server": "unknown_plex_server", "library_name": "Music", "artist_name": "Artist", "album_name": "Album"}',
+        },
+        True,
+    )