fix/ocp_playlist

allow initing Playlist object as a regular list

ovos_utils/ocp.py

@@ -264,6 +264,10 @@ class Playlist(list):
     skill_id: str = OCP_ID
     skill_icon: str = ""
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(**kwargs)
+        list.__init__(self, *args)
+
     @property
     def infocard(self) -> dict:
         """

test/unittests/test_ocp_media.py

@@ -0,0 +1,173 @@
+import unittest
+
+from ovos_utils.ocp import MediaEntry, Playlist, MediaType, PlaybackType, TrackState
+
+valid_search_results = [
+    {'media_type': MediaType.MUSIC,
+     'playback': PlaybackType.AUDIO,
+     'image': 'https://freemusicarchive.org/legacy/fma-smaller.jpg',
+     'skill_icon': 'https://freemusicarchive.org/legacy/fma-smaller.jpg',
+     'uri': 'https://freemusicarchive.org/track/07_-_Quantum_Jazz_-_Orbiting_A_Distant_Planet/stream/',
+     'title': 'Orbiting A Distant Planet',
+     'artist': 'Quantum Jazz',
+     'skill_id': 'skill-free_music_archive.neongeckocom',
+     'match_confidence': 65},
+    {'media_type': MediaType.MUSIC,
+     'playback': PlaybackType.AUDIO,
+     'image': 'https://freemusicarchive.org/legacy/fma-smaller.jpg',
+     'skill_icon': 'https://freemusicarchive.org/legacy/fma-smaller.jpg',
+     'uri': 'https://freemusicarchive.org/track/05_-_Quantum_Jazz_-_Passing_Fields/stream/',
+     'title': 'Passing Fields',
+     'artist': 'Quantum Jazz',
+     'match_confidence': 65},
+    {'media_type': MediaType.MUSIC,
+     'playback': PlaybackType.AUDIO,
+     'image': 'https://freemusicarchive.org/legacy/fma-smaller.jpg',
+     'skill_icon': 'https://freemusicarchive.org/legacy/fma-smaller.jpg',
+     'uri': 'https://freemusicarchive.org/track/04_-_Quantum_Jazz_-_All_About_The_Sun/stream/',
+     'title': 'All About The Sun',
+     'artist': 'Quantum Jazz',
+     'match_confidence': 65}
+]
+
+
+class TestMediaEntry(unittest.TestCase):
+    def test_init(self):
+        data = valid_search_results[0]
+
+        # Test MediaEntry init
+        entry = MediaEntry(**data)
+        self.assertEqual(entry.title, data['title'])
+        self.assertEqual(entry.uri, data['uri'])
+        self.assertEqual(entry.artist, data['artist'])
+        self.assertEqual(entry.skill_id, data['skill_id'])
+        self.assertEqual(entry.status, TrackState.DISAMBIGUATION)
+        self.assertEqual(entry.playback, data['playback'])
+        self.assertEqual(entry.image, data['image'])
+        self.assertEqual(entry.skill_icon, data['skill_icon'])
+        self.assertEqual(entry.javascript, "")
+
+        # Test playback passed as int
+        data['playback'] = int(data['playback'])
+        new_entry = MediaEntry(**data)
+        self.assertEqual(entry, new_entry)
+
+    def test_from_dict(self):
+        dict_data = valid_search_results[1]
+        from_dict = MediaEntry.from_dict(dict_data)
+        self.assertIsInstance(from_dict, MediaEntry)
+        from_init = MediaEntry(dict_data["uri"], dict_data["title"],
+                               image=dict_data["image"],
+                               match_confidence=dict_data["match_confidence"],
+                               playback=PlaybackType.AUDIO,
+                               skill_icon=dict_data["skill_icon"],
+                               media_type=dict_data["media_type"],
+                               artist=dict_data["artist"])
+        self.assertEqual(from_init, from_dict)
+
+        # Test int playback
+        dict_data['playback'] = int(dict_data['playback'])
+        new_entry = MediaEntry.from_dict(dict_data)
+        self.assertEqual(from_dict, new_entry)
+
+        self.assertIsInstance(MediaEntry.from_dict({}), MediaEntry)
+
+
+class TestPlaylist(unittest.TestCase):
+    def test_properties(self):
+        # Empty Playlist
+        pl = Playlist()
+        self.assertEqual(pl.position, 0)
+        self.assertEqual(pl.entries, [])
+        self.assertIsNone(pl.current_track)
+        self.assertTrue(pl.is_first_track)
+        self.assertTrue(pl.is_last_track)
+
+        # Playlist of dicts
+        pl = Playlist(valid_search_results)
+        self.assertEqual(pl.position, 0)
+        self.assertEqual(len(pl), len(valid_search_results))
+        self.assertEqual(len(pl.entries), len(valid_search_results))
+        for entry in pl.entries:
+            self.assertIsInstance(entry, MediaEntry)
+        self.assertIsInstance(pl.current_track, MediaEntry)
+        self.assertTrue(pl.is_first_track)
+        self.assertFalse(pl.is_last_track)
+
+    def test_goto_start(self):
+        # TODO
+        pass
+
+    def test_clear(self):
+        # TODO
+        pass
+
+    def test_sort_by_conf(self):
+        # TODO
+        pass
+
+    def test_add_entry(self):
+        # TODO
+        pass
+
+    def test_remove_entry(self):
+        # TODO
+        pass
+
+    def test_replace(self):
+        # TODO
+        pass
+
+    def test_set_position(self):
+        # TODO
+        pass
+
+    def test_goto_track(self):
+        # TODO
+        pass
+
+    def test_next_track(self):
+        # TODO
+        pass
+
+    def test_prev_track(self):
+        # TODO
+        pass
+
+    def test_validate_position(self):
+        # Test empty playlist
+        pl = Playlist()
+        pl.position = 0
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+        pl.position = -1
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+        pl.position = 1
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+
+        # Test playlist of len 1
+        pl = Playlist([valid_search_results[0]])
+        pl.position = 0
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+        pl.position = 1
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+
+        # Test playlist of len>1
+        pl = Playlist(valid_search_results)
+        pl.position = 0
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+        pl.position = 1
+        pl._validate_position()
+        self.assertEqual(pl.position, 1)
+        pl.position = 10
+        pl._validate_position()
+        self.assertEqual(pl.position, 0)
+
+
+if __name__ == "__main__":
+    unittest.main()