1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
import pathlib
import platform
import shutil
import tempfile
import unittest
import pykka
from mopidy import core
from mopidy.m3u.backend import M3UBackend
from mopidy.models import Playlist, Track
from tests import dummy_audio, path_to_data_dir
from tests.m3u import generate_song
class M3UPlaylistsProviderTest(unittest.TestCase):
backend_class = M3UBackend
config = {
"m3u": {
"enabled": True,
"base_dir": None,
"default_encoding": "latin-1",
"default_extension": ".m3u",
"playlists_dir": path_to_data_dir(""),
}
}
def setUp(self): # noqa: N802
self.config["m3u"]["playlists_dir"] = pathlib.Path(tempfile.mkdtemp())
self.playlists_dir = self.config["m3u"]["playlists_dir"]
self.base_dir = self.config["m3u"]["base_dir"] or self.playlists_dir
audio = dummy_audio.create_proxy()
backend = M3UBackend.start(config=self.config, audio=audio).proxy()
self.core = core.Core(backends=[backend])
def tearDown(self): # noqa: N802
pykka.ActorRegistry.stop_all()
if self.playlists_dir.exists():
shutil.rmtree(str(self.playlists_dir))
def test_created_playlist_is_persisted(self):
uri = "m3u:test.m3u"
path = self.playlists_dir / "test.m3u"
assert not path.exists()
playlist = self.core.playlists.create("test")
assert "test" == playlist.name
assert uri == playlist.uri
assert path.exists()
def test_create_sanitizes_playlist_name(self):
playlist = self.core.playlists.create(" ../../test FOO baR ")
assert "..|..|test FOO baR" == playlist.name
path = self.playlists_dir / "..|..|test FOO baR.m3u"
assert self.playlists_dir == path.parent
assert path.exists()
def test_saved_playlist_is_persisted(self):
uri1 = "m3u:test1.m3u"
uri2 = "m3u:test2.m3u"
path1 = self.playlists_dir / "test1.m3u"
path2 = self.playlists_dir / "test2.m3u"
playlist = self.core.playlists.create("test1")
assert "test1" == playlist.name
assert uri1 == playlist.uri
assert path1.exists()
assert not path2.exists()
playlist = self.core.playlists.save(playlist.replace(name="test2"))
assert "test2" == playlist.name
assert uri2 == playlist.uri
assert not path1.exists()
assert path2.exists()
def test_deleted_playlist_is_removed(self):
uri = "m3u:test.m3u"
path = self.playlists_dir / "test.m3u"
assert not path.exists()
playlist = self.core.playlists.create("test")
assert "test" == playlist.name
assert uri == playlist.uri
assert path.exists()
success = self.core.playlists.delete(playlist.uri)
assert success
assert not path.exists()
def test_delete_on_path_outside_playlist_dir_returns_none(self):
success = self.core.playlists.delete("m3u:///etc/passwd")
assert not success
def test_playlist_contents_is_written_to_disk(self):
track = Track(uri=generate_song(1))
playlist = self.core.playlists.create("test")
playlist = self.core.playlists.save(playlist.replace(tracks=[track]))
path = self.playlists_dir / "test.m3u"
contents = path.read_text()
assert track.uri == contents.strip()
def test_extended_playlist_contents_is_written_to_disk(self):
track = Track(uri=generate_song(1), name="Test", length=60000)
playlist = self.core.playlists.create("test")
playlist = self.core.playlists.save(playlist.replace(tracks=[track]))
path = self.playlists_dir / "test.m3u"
m3u = path.read_text().splitlines()
assert ["#EXTM3U", "#EXTINF:-1,Test", track.uri] == m3u
def test_latin1_playlist_contents_is_written_to_disk(self):
track = Track(uri=generate_song(1), name="Test\x9f", length=60000)
playlist = self.core.playlists.create("test")
playlist = self.core.playlists.save(playlist.replace(tracks=[track]))
path = self.playlists_dir / "test.m3u"
m3u = path.read_bytes().splitlines()
track_uri = track.uri
if not isinstance(track_uri, bytes):
track_uri = track.uri.encode()
assert [b"#EXTM3U", b"#EXTINF:-1,Test\x9f", track_uri] == m3u
def test_utf8_playlist_contents_is_replaced_and_written_to_disk(self):
track = Track(uri=generate_song(1), name="Test\u07b4", length=60000)
playlist = self.core.playlists.create("test")
playlist = self.core.playlists.save(playlist.replace(tracks=[track]))
path = self.playlists_dir / "test.m3u"
m3u = path.read_bytes().splitlines()
track_uri = track.uri
if not isinstance(track_uri, bytes):
track_uri = track.uri.encode()
assert [b"#EXTM3U", b"#EXTINF:-1,Test?", track_uri] == m3u
def test_playlists_are_loaded_at_startup(self):
track = Track(uri="dummy:track:path2")
playlist = self.core.playlists.create("test")
playlist = playlist.replace(tracks=[track])
playlist = self.core.playlists.save(playlist)
assert len(self.core.playlists.as_list()) == 1
result = self.core.playlists.lookup(playlist.uri)
assert playlist.uri == result.uri
assert playlist.name == result.name
assert track.uri == result.tracks[0].uri
@unittest.skipIf(
platform.system() == "Darwin",
'macOS 10.13 raises IOError "Illegal byte sequence" on open.',
)
def test_load_playlist_with_nonfilesystem_encoding_of_filename(self):
playlist_name = "øæå.m3u".encode("latin-1")
playlist_name = playlist_name.decode(errors="surrogateescape")
path = self.playlists_dir / playlist_name
path.write_bytes(b"#EXTM3U\n")
self.core.playlists.refresh()
assert len(self.core.playlists.as_list()) == 1
result = self.core.playlists.as_list()
assert "���" == result[0].name
@unittest.SkipTest
def test_playlists_dir_is_created(self):
pass
def test_create_returns_playlist_with_name_set(self):
playlist = self.core.playlists.create("test")
assert playlist.name == "test"
def test_create_returns_playlist_with_uri_set(self):
playlist = self.core.playlists.create("test")
assert playlist.uri
def test_create_adds_playlist_to_playlists_collection(self):
playlist = self.core.playlists.create("test")
playlists = self.core.playlists.as_list()
assert playlist.uri in [ref.uri for ref in playlists]
def test_as_list_empty_to_start_with(self):
assert len(self.core.playlists.as_list()) == 0
def test_as_list_ignores_non_playlists(self):
path = self.playlists_dir / "test.foo"
path.touch()
assert path.exists()
self.core.playlists.refresh()
assert len(self.core.playlists.as_list()) == 0
def test_delete_non_existant_playlist(self):
self.core.playlists.delete("m3u:unknown")
def test_delete_playlist_removes_it_from_the_collection(self):
playlist = self.core.playlists.create("test")
assert playlist == self.core.playlists.lookup(playlist.uri)
self.core.playlists.delete(playlist.uri)
assert self.core.playlists.lookup(playlist.uri) is None
def test_delete_playlist_without_file(self):
playlist = self.core.playlists.create("test")
assert playlist == self.core.playlists.lookup(playlist.uri)
path = self.playlists_dir / "test.m3u"
assert path.exists()
path.unlink()
assert not path.exists()
self.core.playlists.delete(playlist.uri)
assert self.core.playlists.lookup(playlist.uri) is None
def test_lookup_finds_playlist_by_uri(self):
original_playlist = self.core.playlists.create("test")
looked_up_playlist = self.core.playlists.lookup(original_playlist.uri)
assert original_playlist == looked_up_playlist
def test_lookup_on_path_outside_playlist_dir_returns_none(self):
result = self.core.playlists.lookup("m3u:///etc/passwd")
assert result is None
def test_refresh(self):
playlist = self.core.playlists.create("test")
assert playlist == self.core.playlists.lookup(playlist.uri)
self.core.playlists.refresh()
assert playlist == self.core.playlists.lookup(playlist.uri)
def test_save_replaces_existing_playlist_with_updated_playlist(self):
playlist1 = self.core.playlists.create("test1")
assert playlist1 == self.core.playlists.lookup(playlist1.uri)
playlist2 = playlist1.replace(name="test2")
playlist2 = self.core.playlists.save(playlist2)
assert self.core.playlists.lookup(playlist1.uri) is None
assert playlist2 == self.core.playlists.lookup(playlist2.uri)
def test_create_replaces_existing_playlist_with_updated_playlist(self):
track = Track(uri=generate_song(1))
playlist1 = self.core.playlists.create("test")
playlist1 = self.core.playlists.save(playlist1.replace(tracks=[track]))
assert playlist1 == self.core.playlists.lookup(playlist1.uri)
playlist2 = self.core.playlists.create("test")
assert playlist1.uri == playlist2.uri
assert playlist1 != self.core.playlists.lookup(playlist1.uri)
assert playlist2 == self.core.playlists.lookup(playlist1.uri)
def test_save_playlist_with_new_uri(self):
uri = "m3u:test.m3u"
self.core.playlists.save(Playlist(uri=uri))
path = self.playlists_dir / "test.m3u"
assert path.exists()
def test_save_on_path_outside_playlist_dir_returns_none(self):
result = self.core.playlists.save(Playlist(uri="m3u:///tmp/test.m3u"))
assert result is None
def test_playlist_with_unknown_track(self):
track = Track(uri="file:///dev/null")
playlist = self.core.playlists.create("test")
playlist = playlist.replace(tracks=[track])
playlist = self.core.playlists.save(playlist)
assert len(self.core.playlists.as_list()) == 1
result = self.core.playlists.lookup("m3u:test.m3u")
assert "m3u:test.m3u" == result.uri
assert playlist.name == result.name
assert track.uri == result.tracks[0].uri
def test_playlist_with_absolute_path(self):
track = Track(uri="/tmp/test.mp3")
filepath = pathlib.Path("/tmp/test.mp3")
playlist = self.core.playlists.create("test")
playlist = playlist.replace(tracks=[track])
playlist = self.core.playlists.save(playlist)
assert len(self.core.playlists.as_list()) == 1
result = self.core.playlists.lookup("m3u:test.m3u")
assert "m3u:test.m3u" == result.uri
assert playlist.name == result.name
assert filepath.as_uri() == result.tracks[0].uri
def test_playlist_with_relative_path(self):
track = Track(uri="test.mp3")
filepath = self.base_dir / "test.mp3"
playlist = self.core.playlists.create("test")
playlist = playlist.replace(tracks=[track])
playlist = self.core.playlists.save(playlist)
assert len(self.core.playlists.as_list()) == 1
result = self.core.playlists.lookup("m3u:test.m3u")
assert "m3u:test.m3u" == result.uri
assert playlist.name == result.name
assert filepath.resolve().as_uri() == result.tracks[0].uri
def test_playlist_sort_order(self):
def check_order(playlists, names):
assert names == [playlist.name for playlist in playlists]
self.core.playlists.create("c")
self.core.playlists.create("a")
self.core.playlists.create("b")
check_order(self.core.playlists.as_list(), ["a", "b", "c"])
self.core.playlists.refresh()
check_order(self.core.playlists.as_list(), ["a", "b", "c"])
playlist = self.core.playlists.lookup("m3u:a.m3u")
playlist = playlist.replace(name="d")
playlist = self.core.playlists.save(playlist)
check_order(self.core.playlists.as_list(), ["b", "c", "d"])
self.core.playlists.delete("m3u:c.m3u")
check_order(self.core.playlists.as_list(), ["b", "d"])
def test_get_items_returns_item_refs(self):
track = Track(uri="dummy:a", name="A", length=60000)
playlist = self.core.playlists.create("test")
playlist = self.core.playlists.save(playlist.replace(tracks=[track]))
item_refs = self.core.playlists.get_items(playlist.uri)
assert len(item_refs) == 1
assert item_refs[0].type == "track"
assert item_refs[0].uri == "dummy:a"
assert item_refs[0].name == "A"
def test_get_items_of_unknown_playlist_returns_none(self):
item_refs = self.core.playlists.get_items("dummy:unknown")
assert item_refs is None
def test_get_items_from_file_outside_playlist_dir_returns_none(self):
item_refs = self.core.playlists.get_items("m3u:///etc/passwd")
assert item_refs is None
class M3UPlaylistsProviderBaseDirectoryTest(M3UPlaylistsProviderTest):
def setUp(self): # noqa: N802
self.config["m3u"]["base_dir"] = pathlib.Path(tempfile.mkdtemp())
super().setUp()
|
