Add tests for theme mixin (#897)

* Add lockTheme and unlockTheme methods

* Change setTheme to raise NotImplementedError

* Add tests for theme mixins

Author: JonnyWong16

plexapi/mixins.py

@@ -244,12 +244,18 @@ def uploadTheme(self, url=None, filepath=None):
             self._server.query(key, method=self._server._session.post, data=data)
 
     def setTheme(self, theme):
-        """ Set the theme for a Plex object.
-
-            Parameters:
-                theme (:class:`~plexapi.media.Theme`): The theme object to select.
-        """
-        theme.select()
+        raise NotImplementedError(
+            'Themes cannot be set through the API. '
+            'Re-upload the theme using "uploadTheme" to set it.'
+        )
+
+    def lockTheme(self):
+        """ Lock the theme for a Plex object. """
+        self._edit(**{'theme.locked': 1})
+
+    def unlockTheme(self):
+        """ Unlock the theme for a Plex object. """
+        self._edit(**{'theme.locked': 0})
 
 
 class RatingMixin(object):

tests/test_audio.py

@@ -32,6 +32,7 @@ def test_audio_Artist_attr(artist):
     assert isinstance(artist.similar, list)
     if artist.summary:
         assert "Alias" in artist.summary
+    assert artist.theme is None
     if artist.thumb:
         assert utils.is_thumb(artist.thumb)
     assert artist.title == "Broke For Free"
@@ -95,6 +96,10 @@ def test_audio_Artist_mixins_images(artist):
     test_mixins.attr_posterUrl(artist)
 
 
+def test_audio_Artist_mixins_themes(artist):
+    test_mixins.edit_theme(artist)
+
+
 def test_audio_Artist_mixins_rating(artist):
     test_mixins.edit_rating(artist)
 
@@ -143,6 +148,7 @@ def test_audio_Album_attrs(album):
     assert utils.is_datetime(album.originallyAvailableAt)
     assert utils.is_metadata(album.parentKey)
     assert utils.is_int(album.parentRatingKey)
+    assert album.parentTheme is None or utils.is_metadata(album.parentTheme)
     if album.parentThumb:
         assert utils.is_thumb(album.parentThumb)
     assert album.parentTitle == "Broke For Free"
@@ -206,6 +212,10 @@ def test_audio_Album_mixins_images(album):
     test_mixins.attr_posterUrl(album)
 
 
+def test_audio_Album_mixins_themes(album):
+    test_mixins.attr_themeUrl(album)
+
+
 def test_audio_Album_mixins_rating(album):
     test_mixins.edit_rating(album)
 
@@ -246,6 +256,7 @@ def test_audio_Track_attrs(album):
         assert utils.is_art(track.grandparentArt)
     assert utils.is_metadata(track.grandparentKey)
     assert utils.is_int(track.grandparentRatingKey)
+    assert track.grandparentTheme is None or utils.is_metadata(track.grandparentTheme)
     if track.grandparentThumb:
         assert utils.is_thumb(track.grandparentThumb)
     assert track.grandparentTitle == "Broke For Free"
@@ -363,6 +374,10 @@ def test_audio_Track_mixins_images(track):
     test_mixins.attr_posterUrl(track)
 
 
+def test_audio_Track_mixins_themes(track):
+    test_mixins.attr_themeUrl(track)
+
+
 def test_audio_Track_mixins_rating(track):
     test_mixins.edit_rating(track)
 

tests/test_collection.py

@@ -33,6 +33,7 @@ def test_Collection_attrs(collection):
     assert collection.smart is False
     assert collection.subtype == "movie"
     assert collection.summary == ""
+    assert collection.theme is None
     assert collection.thumb.startswith("/library/collections/%s/composite" % collection.ratingKey)
     assert collection.thumbBlurHash is None
     assert collection.title == "Test Collection"
@@ -282,6 +283,10 @@ def test_Collection_mixins_images(collection):
     test_mixins.attr_posterUrl(collection)
 
 
+def test_Collection_mixins_themes(collection):
+    test_mixins.edit_theme(collection)
+
+
 def test_Collection_mixins_rating(collection):
     test_mixins.edit_rating(collection)
 

tests/test_mixins.py

@@ -7,6 +7,7 @@
 
 TEST_MIXIN_TAG = "Test Tag"
 CUTE_CAT_SHA1 = "9f7003fc401761d8e0b0364d428b2dab2f789dbb"
+AUDIO_STUB_SHA1 = "1abc20d5fdc904201bf8988ca6ef30f96bb73617"
 
 
 def _test_mixins_tag(obj, attr, tag_method):
@@ -180,6 +181,48 @@ def attr_posterUrl(obj):
     _test_mixins_imageUrl(obj, "thumb")
 
 
+def _test_mixins_edit_theme(obj):
+    _fields = lambda: [f.name for f in obj.fields]
+    # Test upload theme from file
+    obj.uploadTheme(filepath=utils.STUB_MP3_PATH)
+    themes = obj.themes()
+    file_theme = [
+        t for t in themes
+        if t.ratingKey.startswith("upload://") and t.ratingKey.endswith(AUDIO_STUB_SHA1)
+    ]
+    assert file_theme
+    obj.reload()
+    assert "theme" in _fields()
+    # Unlock the theme
+    obj.unlockTheme()
+    obj.reload()
+    assert "theme" not in _fields()
+    # Lock the theme
+    obj.lockTheme()
+    obj.reload()
+    assert "theme" in _fields()
+    with pytest.raises(NotImplementedError):
+        obj.setTheme(themes[0])
+
+
+def edit_theme(obj):
+    _test_mixins_edit_theme(obj)
+
+
+def _test_mixins_themeUrl(obj):
+    url = obj.themeUrl
+    if url:
+        assert url.startswith(utils.SERVER_BASEURL)
+        assert "/library/metadata/" in url
+        assert "theme" in url
+    else:
+        assert url is None
+
+
+def attr_themeUrl(obj):
+    _test_mixins_themeUrl(obj)
+
+
 def _test_mixins_editAdvanced(obj):
     for pref in obj.preferences():
         currentPref = obj.preference(pref.id)