mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
385c05f98e
The boolean flags `--extm3u` and `--no-extm3u` are replaced with a string option `--output=m3u|m3u8`. This reduces the amount of options and allows to evolve the CLI to support more playlist output formats in the future (e.g. JSON) without polluting the CLI at that point.
290 lines
9.9 KiB
Python
290 lines
9.9 KiB
Python
# This file is part of beets.
|
|
# Copyright 2016, Bruno Cauet.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
|
|
import unittest
|
|
from os import path, remove
|
|
from shutil import rmtree
|
|
from tempfile import mkdtemp
|
|
from test import _common
|
|
from test.helper import TestHelper
|
|
from unittest.mock import MagicMock, Mock, PropertyMock
|
|
|
|
from beets import config
|
|
from beets.dbcore import OrQuery
|
|
from beets.dbcore.query import FixedFieldSort, MultipleSort, NullSort
|
|
from beets.library import Album, Item, parse_query_string
|
|
from beets.ui import UserError
|
|
from beets.util import CHAR_REPLACE, bytestring_path, py3_path, syspath
|
|
from beetsplug.smartplaylist import SmartPlaylistPlugin
|
|
|
|
|
|
class SmartPlaylistTest(_common.TestCase):
|
|
def test_build_queries(self):
|
|
spl = SmartPlaylistPlugin()
|
|
self.assertEqual(spl._matched_playlists, None)
|
|
self.assertEqual(spl._unmatched_playlists, None)
|
|
|
|
config["smartplaylist"]["playlists"].set([])
|
|
spl.build_queries()
|
|
self.assertEqual(spl._matched_playlists, set())
|
|
self.assertEqual(spl._unmatched_playlists, set())
|
|
|
|
config["smartplaylist"]["playlists"].set(
|
|
[
|
|
{"name": "foo", "query": "FOO foo"},
|
|
{"name": "bar", "album_query": ["BAR bar1", "BAR bar2"]},
|
|
{"name": "baz", "query": "BAZ baz", "album_query": "BAZ baz"},
|
|
]
|
|
)
|
|
spl.build_queries()
|
|
self.assertEqual(spl._matched_playlists, set())
|
|
foo_foo = parse_query_string("FOO foo", Item)
|
|
baz_baz = parse_query_string("BAZ baz", Item)
|
|
baz_baz2 = parse_query_string("BAZ baz", Album)
|
|
bar_bar = OrQuery(
|
|
(
|
|
parse_query_string("BAR bar1", Album)[0],
|
|
parse_query_string("BAR bar2", Album)[0],
|
|
)
|
|
)
|
|
self.assertEqual(
|
|
spl._unmatched_playlists,
|
|
{
|
|
("foo", foo_foo, (None, None)),
|
|
("baz", baz_baz, baz_baz2),
|
|
("bar", (None, None), (bar_bar, None)),
|
|
},
|
|
)
|
|
|
|
def test_build_queries_with_sorts(self):
|
|
spl = SmartPlaylistPlugin()
|
|
config["smartplaylist"]["playlists"].set(
|
|
[
|
|
{"name": "no_sort", "query": "foo"},
|
|
{"name": "one_sort", "query": "foo year+"},
|
|
{"name": "only_empty_sorts", "query": ["foo", "bar"]},
|
|
{"name": "one_non_empty_sort", "query": ["foo year+", "bar"]},
|
|
{
|
|
"name": "multiple_sorts",
|
|
"query": ["foo year+", "bar genre-"],
|
|
},
|
|
{
|
|
"name": "mixed",
|
|
"query": ["foo year+", "bar", "baz genre+ id-"],
|
|
},
|
|
]
|
|
)
|
|
|
|
spl.build_queries()
|
|
sorts = {name: sort for name, (_, sort), _ in spl._unmatched_playlists}
|
|
|
|
asseq = self.assertEqual # less cluttered code
|
|
sort = FixedFieldSort # short cut since we're only dealing with this
|
|
asseq(sorts["no_sort"], NullSort())
|
|
asseq(sorts["one_sort"], sort("year"))
|
|
asseq(sorts["only_empty_sorts"], None)
|
|
asseq(sorts["one_non_empty_sort"], sort("year"))
|
|
asseq(
|
|
sorts["multiple_sorts"],
|
|
MultipleSort([sort("year"), sort("genre", False)]),
|
|
)
|
|
asseq(
|
|
sorts["mixed"],
|
|
MultipleSort([sort("year"), sort("genre"), sort("id", False)]),
|
|
)
|
|
|
|
def test_matches(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
a = MagicMock(Album)
|
|
i = MagicMock(Item)
|
|
|
|
self.assertFalse(spl.matches(i, None, None))
|
|
self.assertFalse(spl.matches(a, None, None))
|
|
|
|
query = Mock()
|
|
query.match.side_effect = {i: True}.__getitem__
|
|
self.assertTrue(spl.matches(i, query, None))
|
|
self.assertFalse(spl.matches(a, query, None))
|
|
|
|
a_query = Mock()
|
|
a_query.match.side_effect = {a: True}.__getitem__
|
|
self.assertFalse(spl.matches(i, None, a_query))
|
|
self.assertTrue(spl.matches(a, None, a_query))
|
|
|
|
self.assertTrue(spl.matches(i, query, a_query))
|
|
self.assertTrue(spl.matches(a, query, a_query))
|
|
|
|
def test_db_changes(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
nones = None, None
|
|
pl1 = "1", ("q1", None), nones
|
|
pl2 = "2", ("q2", None), nones
|
|
pl3 = "3", ("q3", None), nones
|
|
|
|
spl._unmatched_playlists = {pl1, pl2, pl3}
|
|
spl._matched_playlists = set()
|
|
|
|
spl.matches = Mock(return_value=False)
|
|
spl.db_change(None, "nothing")
|
|
self.assertEqual(spl._unmatched_playlists, {pl1, pl2, pl3})
|
|
self.assertEqual(spl._matched_playlists, set())
|
|
|
|
spl.matches.side_effect = lambda _, q, __: q == "q3"
|
|
spl.db_change(None, "matches 3")
|
|
self.assertEqual(spl._unmatched_playlists, {pl1, pl2})
|
|
self.assertEqual(spl._matched_playlists, {pl3})
|
|
|
|
spl.matches.side_effect = lambda _, q, __: q == "q1"
|
|
spl.db_change(None, "matches 3")
|
|
self.assertEqual(spl._matched_playlists, {pl1, pl3})
|
|
self.assertEqual(spl._unmatched_playlists, {pl2})
|
|
|
|
def test_playlist_update(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
i = Mock(path=b"/tagada.mp3")
|
|
i.evaluate_template.side_effect = lambda pl, _: pl.replace(
|
|
b"$title", b"ta:ga:da"
|
|
).decode()
|
|
|
|
lib = Mock()
|
|
lib.replacements = CHAR_REPLACE
|
|
lib.items.return_value = [i]
|
|
lib.albums.return_value = []
|
|
|
|
q = Mock()
|
|
a_q = Mock()
|
|
pl = b"$title-my<playlist>.m3u", (q, None), (a_q, None)
|
|
spl._matched_playlists = [pl]
|
|
|
|
dir = bytestring_path(mkdtemp())
|
|
config["smartplaylist"]["relative_to"] = False
|
|
config["smartplaylist"]["playlist_dir"] = py3_path(dir)
|
|
try:
|
|
spl.update_playlists(lib)
|
|
except Exception:
|
|
rmtree(syspath(dir))
|
|
raise
|
|
|
|
lib.items.assert_called_once_with(q, None)
|
|
lib.albums.assert_called_once_with(a_q, None)
|
|
|
|
m3u_filepath = path.join(dir, b"ta_ga_da-my_playlist_.m3u")
|
|
self.assertExists(m3u_filepath)
|
|
with open(syspath(m3u_filepath), "rb") as f:
|
|
content = f.read()
|
|
rmtree(syspath(dir))
|
|
|
|
self.assertEqual(content, b"/tagada.mp3\n")
|
|
|
|
def test_playlist_update_output_m3u8(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
i = MagicMock()
|
|
type(i).artist = PropertyMock(return_value="fake artist")
|
|
type(i).title = PropertyMock(return_value="fake title")
|
|
type(i).length = PropertyMock(return_value=300.123)
|
|
type(i).path = PropertyMock(return_value=b"/tagada.mp3")
|
|
i.evaluate_template.side_effect = lambda pl, _: pl.replace(
|
|
b"$title",
|
|
b"ta:ga:da",
|
|
).decode()
|
|
|
|
lib = Mock()
|
|
lib.replacements = CHAR_REPLACE
|
|
lib.items.return_value = [i]
|
|
lib.albums.return_value = []
|
|
|
|
q = Mock()
|
|
a_q = Mock()
|
|
pl = b"$title-my<playlist>.m3u", (q, None), (a_q, None)
|
|
spl._matched_playlists = [pl]
|
|
|
|
dir = bytestring_path(mkdtemp())
|
|
config["smartplaylist"]["output"] = "m3u8"
|
|
config["smartplaylist"]["prefix"] = "http://beets:8337/files"
|
|
config["smartplaylist"]["relative_to"] = False
|
|
config["smartplaylist"]["playlist_dir"] = py3_path(dir)
|
|
try:
|
|
spl.update_playlists(lib)
|
|
except Exception:
|
|
rmtree(syspath(dir))
|
|
raise
|
|
|
|
lib.items.assert_called_once_with(q, None)
|
|
lib.albums.assert_called_once_with(a_q, None)
|
|
|
|
m3u_filepath = path.join(dir, b"ta_ga_da-my_playlist_.m3u")
|
|
self.assertExists(m3u_filepath)
|
|
with open(syspath(m3u_filepath), "rb") as f:
|
|
content = f.read()
|
|
rmtree(syspath(dir))
|
|
|
|
self.assertEqual(
|
|
content,
|
|
b"#EXTM3U\n"
|
|
+ b"#EXTINF:300,fake artist - fake title\n"
|
|
+ b"http://beets:8337/files/tagada.mp3\n",
|
|
)
|
|
|
|
|
|
class SmartPlaylistCLITest(_common.TestCase, TestHelper):
|
|
def setUp(self):
|
|
self.setup_beets()
|
|
|
|
self.item = self.add_item()
|
|
config["smartplaylist"]["playlists"].set(
|
|
[
|
|
{"name": "my_playlist.m3u", "query": self.item.title},
|
|
{"name": "all.m3u", "query": ""},
|
|
]
|
|
)
|
|
config["smartplaylist"]["playlist_dir"].set(py3_path(self.temp_dir))
|
|
self.load_plugins("smartplaylist")
|
|
|
|
def tearDown(self):
|
|
self.unload_plugins()
|
|
self.teardown_beets()
|
|
|
|
def test_splupdate(self):
|
|
with self.assertRaises(UserError):
|
|
self.run_with_output("splupdate", "tagada")
|
|
|
|
self.run_with_output("splupdate", "my_playlist")
|
|
m3u_path = path.join(self.temp_dir, b"my_playlist.m3u")
|
|
self.assertExists(m3u_path)
|
|
with open(syspath(m3u_path), "rb") as f:
|
|
self.assertEqual(f.read(), self.item.path + b"\n")
|
|
remove(syspath(m3u_path))
|
|
|
|
self.run_with_output("splupdate", "my_playlist.m3u")
|
|
with open(syspath(m3u_path), "rb") as f:
|
|
self.assertEqual(f.read(), self.item.path + b"\n")
|
|
remove(syspath(m3u_path))
|
|
|
|
self.run_with_output("splupdate")
|
|
for name in (b"my_playlist.m3u", b"all.m3u"):
|
|
with open(path.join(self.temp_dir, name), "rb") as f:
|
|
self.assertEqual(f.read(), self.item.path + b"\n")
|
|
|
|
|
|
def suite():
|
|
return unittest.TestLoader().loadTestsFromName(__name__)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main(defaultTest="suite")
|