mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
bd29ab21e1
TemplateTest.album_fields_override_item_values() never ran because of its name (missing 'test_' prefix). When run it now fails for it targets outdated functionality.
1145 lines
39 KiB
Python
1145 lines
39 KiB
Python
# This file is part of beets.
|
|
# Copyright 2015, Adrian Sampson.
|
|
#
|
|
# 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.
|
|
|
|
"""Tests for non-query database functions of Item.
|
|
"""
|
|
import os
|
|
import os.path
|
|
import stat
|
|
import shutil
|
|
import re
|
|
import unicodedata
|
|
import sys
|
|
|
|
import _common
|
|
from _common import unittest
|
|
from _common import item
|
|
import beets.library
|
|
import beets.mediafile
|
|
from beets import util
|
|
from beets import plugins
|
|
from beets import config
|
|
from beets.mediafile import MediaFile
|
|
|
|
# Shortcut to path normalization.
|
|
np = util.normpath
|
|
|
|
|
|
class LoadTest(_common.LibTestCase):
|
|
def test_load_restores_data_from_db(self):
|
|
original_title = self.i.title
|
|
self.i.title = 'something'
|
|
self.i.load()
|
|
self.assertEqual(original_title, self.i.title)
|
|
|
|
def test_load_clears_dirty_flags(self):
|
|
self.i.artist = 'something'
|
|
self.assertTrue('artist' in self.i._dirty)
|
|
self.i.load()
|
|
self.assertTrue('artist' not in self.i._dirty)
|
|
|
|
|
|
class StoreTest(_common.LibTestCase):
|
|
def test_store_changes_database_value(self):
|
|
self.i.year = 1987
|
|
self.i.store()
|
|
new_year = self.lib._connection().execute(
|
|
'select year from items where '
|
|
'title="the title"').fetchone()['year']
|
|
self.assertEqual(new_year, 1987)
|
|
|
|
def test_store_only_writes_dirty_fields(self):
|
|
original_genre = self.i.genre
|
|
self.i._values_fixed['genre'] = 'beatboxing' # change w/o dirtying
|
|
self.i.store()
|
|
new_genre = self.lib._connection().execute(
|
|
'select genre from items where '
|
|
'title="the title"').fetchone()['genre']
|
|
self.assertEqual(new_genre, original_genre)
|
|
|
|
def test_store_clears_dirty_flags(self):
|
|
self.i.composer = 'tvp'
|
|
self.i.store()
|
|
self.assertTrue('composer' not in self.i._dirty)
|
|
|
|
|
|
class AddTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(AddTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.i = item()
|
|
|
|
def test_item_add_inserts_row(self):
|
|
self.lib.add(self.i)
|
|
new_grouping = self.lib._connection().execute(
|
|
'select grouping from items '
|
|
'where composer="the composer"').fetchone()['grouping']
|
|
self.assertEqual(new_grouping, self.i.grouping)
|
|
|
|
def test_library_add_path_inserts_row(self):
|
|
i = beets.library.Item.from_path(
|
|
os.path.join(_common.RSRC, 'full.mp3')
|
|
)
|
|
self.lib.add(i)
|
|
new_grouping = self.lib._connection().execute(
|
|
'select grouping from items '
|
|
'where composer="the composer"').fetchone()['grouping']
|
|
self.assertEqual(new_grouping, self.i.grouping)
|
|
|
|
|
|
class RemoveTest(_common.LibTestCase):
|
|
def test_remove_deletes_from_db(self):
|
|
self.i.remove()
|
|
c = self.lib._connection().execute('select * from items')
|
|
self.assertEqual(c.fetchone(), None)
|
|
|
|
|
|
class GetSetTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(GetSetTest, self).setUp()
|
|
self.i = item()
|
|
|
|
def test_set_changes_value(self):
|
|
self.i.bpm = 4915
|
|
self.assertEqual(self.i.bpm, 4915)
|
|
|
|
def test_set_sets_dirty_flag(self):
|
|
self.i.comp = not self.i.comp
|
|
self.assertTrue('comp' in self.i._dirty)
|
|
|
|
def test_set_does_not_dirty_if_value_unchanged(self):
|
|
self.i.title = self.i.title
|
|
self.assertTrue('title' not in self.i._dirty)
|
|
|
|
def test_invalid_field_raises_attributeerror(self):
|
|
self.assertRaises(AttributeError, getattr, self.i, 'xyzzy')
|
|
|
|
|
|
class DestinationTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(DestinationTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.i = item(self.lib)
|
|
|
|
def tearDown(self):
|
|
super(DestinationTest, self).tearDown()
|
|
self.lib._connection().close()
|
|
|
|
# Reset config if it was changed in test cases
|
|
config.clear()
|
|
config.read(user=False, defaults=True)
|
|
|
|
def test_directory_works_with_trailing_slash(self):
|
|
self.lib.directory = 'one/'
|
|
self.lib.path_formats = [('default', 'two')]
|
|
self.assertEqual(self.i.destination(), np('one/two'))
|
|
|
|
def test_directory_works_without_trailing_slash(self):
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [('default', 'two')]
|
|
self.assertEqual(self.i.destination(), np('one/two'))
|
|
|
|
def test_destination_substitues_metadata_values(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.path_formats = [('default', '$album/$artist $title')]
|
|
self.i.title = 'three'
|
|
self.i.artist = 'two'
|
|
self.i.album = 'one'
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/one/two three'))
|
|
|
|
def test_destination_preserves_extension(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.path_formats = [('default', '$title')]
|
|
self.i.path = 'hey.audioformat'
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/the title.audioformat'))
|
|
|
|
def test_lower_case_extension(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.path_formats = [('default', '$title')]
|
|
self.i.path = 'hey.MP3'
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/the title.mp3'))
|
|
|
|
def test_destination_pads_some_indices(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.path_formats = [('default',
|
|
'$track $tracktotal $disc $disctotal $bpm')]
|
|
self.i.track = 1
|
|
self.i.tracktotal = 2
|
|
self.i.disc = 3
|
|
self.i.disctotal = 4
|
|
self.i.bpm = 5
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/01 02 03 04 5'))
|
|
|
|
def test_destination_pads_date_values(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.path_formats = [('default', '$year-$month-$day')]
|
|
self.i.year = 1
|
|
self.i.month = 2
|
|
self.i.day = 3
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/0001-02-03'))
|
|
|
|
def test_destination_escapes_slashes(self):
|
|
self.i.album = 'one/two'
|
|
dest = self.i.destination()
|
|
self.assertTrue('one' in dest)
|
|
self.assertTrue('two' in dest)
|
|
self.assertFalse('one/two' in dest)
|
|
|
|
def test_destination_escapes_leading_dot(self):
|
|
self.i.album = '.something'
|
|
dest = self.i.destination()
|
|
self.assertTrue('something' in dest)
|
|
self.assertFalse('/.' in dest)
|
|
|
|
def test_destination_preserves_legitimate_slashes(self):
|
|
self.i.artist = 'one'
|
|
self.i.album = 'two'
|
|
dest = self.i.destination()
|
|
self.assertTrue(os.path.join('one', 'two') in dest)
|
|
|
|
def test_destination_long_names_truncated(self):
|
|
self.i.title = 'X' * 300
|
|
self.i.artist = 'Y' * 300
|
|
for c in self.i.destination().split(os.path.sep):
|
|
self.assertTrue(len(c) <= 255)
|
|
|
|
def test_destination_long_names_keep_extension(self):
|
|
self.i.title = 'X' * 300
|
|
self.i.path = 'something.extn'
|
|
dest = self.i.destination()
|
|
self.assertEqual(dest[-5:], '.extn')
|
|
|
|
def test_distination_windows_removes_both_separators(self):
|
|
self.i.title = 'one \\ two / three.mp3'
|
|
with _common.platform_windows():
|
|
p = self.i.destination()
|
|
self.assertFalse('one \\ two' in p)
|
|
self.assertFalse('one / two' in p)
|
|
self.assertFalse('two \\ three' in p)
|
|
self.assertFalse('two / three' in p)
|
|
|
|
def test_sanitize_unix_replaces_leading_dot(self):
|
|
with _common.platform_posix():
|
|
p = util.sanitize_path(u'one/.two/three')
|
|
self.assertFalse('.' in p)
|
|
|
|
def test_sanitize_windows_replaces_trailing_dot(self):
|
|
with _common.platform_windows():
|
|
p = util.sanitize_path(u'one/two./three')
|
|
self.assertFalse('.' in p)
|
|
|
|
def test_sanitize_windows_replaces_illegal_chars(self):
|
|
with _common.platform_windows():
|
|
p = util.sanitize_path(u':*?"<>|')
|
|
self.assertFalse(':' in p)
|
|
self.assertFalse('*' in p)
|
|
self.assertFalse('?' in p)
|
|
self.assertFalse('"' in p)
|
|
self.assertFalse('<' in p)
|
|
self.assertFalse('>' in p)
|
|
self.assertFalse('|' in p)
|
|
|
|
def test_path_with_format(self):
|
|
self.lib.path_formats = [('default', '$artist/$album ($format)')]
|
|
p = self.i.destination()
|
|
self.assert_('(FLAC)' in p)
|
|
|
|
def test_heterogeneous_album_gets_single_directory(self):
|
|
i1, i2 = item(), item()
|
|
self.lib.add_album([i1, i2])
|
|
i1.year, i2.year = 2009, 2010
|
|
self.lib.path_formats = [('default', '$album ($year)/$track $title')]
|
|
dest1, dest2 = i1.destination(), i2.destination()
|
|
self.assertEqual(os.path.dirname(dest1), os.path.dirname(dest2))
|
|
|
|
def test_default_path_for_non_compilations(self):
|
|
self.i.comp = False
|
|
self.lib.add_album([self.i])
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [('default', 'two'),
|
|
('comp:true', 'three')]
|
|
self.assertEqual(self.i.destination(), np('one/two'))
|
|
|
|
def test_singleton_path(self):
|
|
i = item(self.lib)
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [
|
|
('default', 'two'),
|
|
('singleton:true', 'four'),
|
|
('comp:true', 'three'),
|
|
]
|
|
self.assertEqual(i.destination(), np('one/four'))
|
|
|
|
def test_comp_before_singleton_path(self):
|
|
i = item(self.lib)
|
|
i.comp = True
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [
|
|
('default', 'two'),
|
|
('comp:true', 'three'),
|
|
('singleton:true', 'four'),
|
|
]
|
|
self.assertEqual(i.destination(), np('one/three'))
|
|
|
|
def test_comp_path(self):
|
|
self.i.comp = True
|
|
self.lib.add_album([self.i])
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [
|
|
('default', 'two'),
|
|
('comp:true', 'three'),
|
|
]
|
|
self.assertEqual(self.i.destination(), np('one/three'))
|
|
|
|
def test_albumtype_query_path(self):
|
|
self.i.comp = True
|
|
self.lib.add_album([self.i])
|
|
self.i.albumtype = 'sometype'
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [
|
|
('default', 'two'),
|
|
('albumtype:sometype', 'four'),
|
|
('comp:true', 'three'),
|
|
]
|
|
self.assertEqual(self.i.destination(), np('one/four'))
|
|
|
|
def test_albumtype_path_fallback_to_comp(self):
|
|
self.i.comp = True
|
|
self.lib.add_album([self.i])
|
|
self.i.albumtype = 'sometype'
|
|
self.lib.directory = 'one'
|
|
self.lib.path_formats = [
|
|
('default', 'two'),
|
|
('albumtype:anothertype', 'four'),
|
|
('comp:true', 'three'),
|
|
]
|
|
self.assertEqual(self.i.destination(), np('one/three'))
|
|
|
|
def test_sanitize_windows_replaces_trailing_space(self):
|
|
with _common.platform_windows():
|
|
p = util.sanitize_path(u'one/two /three')
|
|
self.assertFalse(' ' in p)
|
|
|
|
def test_get_formatted_does_not_replace_separators(self):
|
|
with _common.platform_posix():
|
|
name = os.path.join('a', 'b')
|
|
self.i.title = name
|
|
newname = self.i.formatted().get('title')
|
|
self.assertEqual(name, newname)
|
|
|
|
def test_get_formatted_pads_with_zero(self):
|
|
with _common.platform_posix():
|
|
self.i.track = 1
|
|
name = self.i.formatted().get('track')
|
|
self.assertTrue(name.startswith('0'))
|
|
|
|
def test_get_formatted_uses_kbps_bitrate(self):
|
|
with _common.platform_posix():
|
|
self.i.bitrate = 12345
|
|
val = self.i.formatted().get('bitrate')
|
|
self.assertEqual(val, u'12kbps')
|
|
|
|
def test_get_formatted_uses_khz_samplerate(self):
|
|
with _common.platform_posix():
|
|
self.i.samplerate = 12345
|
|
val = self.i.formatted().get('samplerate')
|
|
self.assertEqual(val, u'12kHz')
|
|
|
|
def test_get_formatted_datetime(self):
|
|
with _common.platform_posix():
|
|
self.i.added = 1368302461.210265
|
|
val = self.i.formatted().get('added')
|
|
self.assertTrue(val.startswith('2013'))
|
|
|
|
def test_get_formatted_none(self):
|
|
with _common.platform_posix():
|
|
self.i.some_other_field = None
|
|
val = self.i.formatted().get('some_other_field')
|
|
self.assertEqual(val, u'')
|
|
|
|
def test_artist_falls_back_to_albumartist(self):
|
|
self.i.artist = ''
|
|
self.i.albumartist = 'something'
|
|
self.lib.path_formats = [('default', '$artist')]
|
|
p = self.i.destination()
|
|
self.assertEqual(p.rsplit(os.path.sep, 1)[1], 'something')
|
|
|
|
def test_albumartist_falls_back_to_artist(self):
|
|
self.i.artist = 'trackartist'
|
|
self.i.albumartist = ''
|
|
self.lib.path_formats = [('default', '$albumartist')]
|
|
p = self.i.destination()
|
|
self.assertEqual(p.rsplit(os.path.sep, 1)[1], 'trackartist')
|
|
|
|
def test_artist_overrides_albumartist(self):
|
|
self.i.artist = 'theartist'
|
|
self.i.albumartist = 'something'
|
|
self.lib.path_formats = [('default', '$artist')]
|
|
p = self.i.destination()
|
|
self.assertEqual(p.rsplit(os.path.sep, 1)[1], 'theartist')
|
|
|
|
def test_albumartist_overrides_artist(self):
|
|
self.i.artist = 'theartist'
|
|
self.i.albumartist = 'something'
|
|
self.lib.path_formats = [('default', '$albumartist')]
|
|
p = self.i.destination()
|
|
self.assertEqual(p.rsplit(os.path.sep, 1)[1], 'something')
|
|
|
|
def test_sanitize_path_works_on_empty_string(self):
|
|
with _common.platform_posix():
|
|
p = util.sanitize_path(u'')
|
|
self.assertEqual(p, u'')
|
|
|
|
def test_sanitize_with_custom_replace_overrides_built_in_sub(self):
|
|
with _common.platform_posix():
|
|
p = util.sanitize_path(u'a/.?/b', [
|
|
(re.compile(ur'foo'), u'bar'),
|
|
])
|
|
self.assertEqual(p, u'a/.?/b')
|
|
|
|
def test_sanitize_with_custom_replace_adds_replacements(self):
|
|
with _common.platform_posix():
|
|
p = util.sanitize_path(u'foo/bar', [
|
|
(re.compile(ur'foo'), u'bar'),
|
|
])
|
|
self.assertEqual(p, u'bar/bar')
|
|
|
|
def test_unicode_normalized_nfd_on_mac(self):
|
|
instr = unicodedata.normalize('NFC', u'caf\xe9')
|
|
self.lib.path_formats = [('default', instr)]
|
|
dest = self.i.destination(platform='darwin', fragment=True)
|
|
self.assertEqual(dest, unicodedata.normalize('NFD', instr))
|
|
|
|
def test_unicode_normalized_nfc_on_linux(self):
|
|
instr = unicodedata.normalize('NFD', u'caf\xe9')
|
|
self.lib.path_formats = [('default', instr)]
|
|
dest = self.i.destination(platform='linux2', fragment=True)
|
|
self.assertEqual(dest, unicodedata.normalize('NFC', instr))
|
|
|
|
def test_non_mbcs_characters_on_windows(self):
|
|
oldfunc = sys.getfilesystemencoding
|
|
sys.getfilesystemencoding = lambda: 'mbcs'
|
|
try:
|
|
self.i.title = u'h\u0259d'
|
|
self.lib.path_formats = [('default', '$title')]
|
|
p = self.i.destination()
|
|
self.assertFalse('?' in p)
|
|
# We use UTF-8 to encode Windows paths now.
|
|
self.assertTrue(u'h\u0259d'.encode('utf8') in p)
|
|
finally:
|
|
sys.getfilesystemencoding = oldfunc
|
|
|
|
def test_unicode_extension_in_fragment(self):
|
|
self.lib.path_formats = [('default', u'foo')]
|
|
self.i.path = util.bytestring_path(u'bar.caf\xe9')
|
|
dest = self.i.destination(platform='linux2', fragment=True)
|
|
self.assertEqual(dest, u'foo.caf\xe9')
|
|
|
|
def test_asciify_and_replace(self):
|
|
config['asciify_paths'] = True
|
|
self.lib.replacements = [(re.compile(u'"'), u'q')]
|
|
self.lib.directory = 'lib'
|
|
self.lib.path_formats = [('default', '$title')]
|
|
self.i.title = u'\u201c\u00f6\u2014\u00cf\u201d'
|
|
self.assertEqual(self.i.destination(), np('lib/qo--Iq'))
|
|
|
|
def test_destination_with_replacements(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.replacements = [(re.compile(ur'a'), u'e')]
|
|
self.lib.path_formats = [('default', '$album/$title')]
|
|
self.i.title = 'foo'
|
|
self.i.album = 'bar'
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/ber/foo'))
|
|
|
|
@unittest.skip('unimplemented: #359')
|
|
def test_sanitize_empty_component(self):
|
|
with _common.platform_posix():
|
|
p = util.sanitize_path(u'foo//bar', [
|
|
(re.compile(ur'^$'), u'_'),
|
|
])
|
|
self.assertEqual(p, u'foo/_/bar')
|
|
|
|
@unittest.skip('unimplemented: #359')
|
|
def test_destination_with_empty_component(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.replacements = [(re.compile(ur'^$'), u'_')]
|
|
self.lib.path_formats = [('default', '$album/$artist/$title')]
|
|
self.i.title = 'three'
|
|
self.i.artist = ''
|
|
self.i.albumartist = ''
|
|
self.i.album = 'one'
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/one/_/three'))
|
|
|
|
@unittest.skip('unimplemented: #359')
|
|
def test_destination_with_empty_final_component(self):
|
|
self.lib.directory = 'base'
|
|
self.lib.replacements = [(re.compile(ur'^$'), u'_')]
|
|
self.lib.path_formats = [('default', '$album/$title')]
|
|
self.i.title = ''
|
|
self.i.album = 'one'
|
|
self.i.path = 'foo.mp3'
|
|
self.assertEqual(self.i.destination(),
|
|
np('base/one/_.mp3'))
|
|
|
|
|
|
class ItemFormattedMappingTest(_common.LibTestCase):
|
|
def test_formatted_item_value(self):
|
|
formatted = self.i.formatted()
|
|
self.assertEqual(formatted['artist'], 'the artist')
|
|
|
|
def test_get_unset_field(self):
|
|
formatted = self.i.formatted()
|
|
with self.assertRaises(KeyError):
|
|
formatted['other_field']
|
|
|
|
def test_get_method_with_default(self):
|
|
formatted = self.i.formatted()
|
|
self.assertEqual(formatted.get('other_field'), u'')
|
|
|
|
def test_get_method_with_specified_default(self):
|
|
formatted = self.i.formatted()
|
|
self.assertEqual(formatted.get('other_field', 'default'), 'default')
|
|
|
|
def test_item_precedence(self):
|
|
album = self.lib.add_album([self.i])
|
|
album['artist'] = 'foo'
|
|
album.store()
|
|
self.assertNotEqual('foo', self.i.formatted().get('artist'))
|
|
|
|
def test_album_flex_field(self):
|
|
album = self.lib.add_album([self.i])
|
|
album['flex'] = 'foo'
|
|
album.store()
|
|
self.assertEqual('foo', self.i.formatted().get('flex'))
|
|
|
|
def test_album_field_overrides_item_field_for_path(self):
|
|
# Make the album inconsistent with the item.
|
|
album = self.lib.add_album([self.i])
|
|
album.album = 'foo'
|
|
album.store()
|
|
self.i.album = 'bar'
|
|
self.i.store()
|
|
|
|
# Ensure the album takes precedence.
|
|
formatted = self.i.formatted(for_path=True)
|
|
self.assertEqual(formatted['album'], 'foo')
|
|
|
|
def test_artist_falls_back_to_albumartist(self):
|
|
self.i.artist = ''
|
|
formatted = self.i.formatted()
|
|
self.assertEqual(formatted['artist'], 'the album artist')
|
|
|
|
def test_albumartist_falls_back_to_artist(self):
|
|
self.i.albumartist = ''
|
|
formatted = self.i.formatted()
|
|
self.assertEqual(formatted['albumartist'], 'the artist')
|
|
|
|
def test_both_artist_and_albumartist_empty(self):
|
|
self.i.artist = ''
|
|
self.i.albumartist = ''
|
|
formatted = self.i.formatted()
|
|
self.assertEqual(formatted['albumartist'], '')
|
|
|
|
|
|
class PathFormattingMixin(object):
|
|
"""Utilities for testing path formatting."""
|
|
def _setf(self, fmt):
|
|
self.lib.path_formats.insert(0, ('default', fmt))
|
|
|
|
def _assert_dest(self, dest, i=None):
|
|
if i is None:
|
|
i = self.i
|
|
with _common.platform_posix():
|
|
actual = i.destination()
|
|
self.assertEqual(actual, dest)
|
|
|
|
|
|
class DestinationFunctionTest(_common.TestCase, PathFormattingMixin):
|
|
def setUp(self):
|
|
super(DestinationFunctionTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.lib.directory = '/base'
|
|
self.lib.path_formats = [('default', u'path')]
|
|
self.i = item(self.lib)
|
|
|
|
def tearDown(self):
|
|
super(DestinationFunctionTest, self).tearDown()
|
|
self.lib._connection().close()
|
|
|
|
def test_upper_case_literal(self):
|
|
self._setf(u'%upper{foo}')
|
|
self._assert_dest('/base/FOO')
|
|
|
|
def test_upper_case_variable(self):
|
|
self._setf(u'%upper{$title}')
|
|
self._assert_dest('/base/THE TITLE')
|
|
|
|
def test_title_case_variable(self):
|
|
self._setf(u'%title{$title}')
|
|
self._assert_dest('/base/The Title')
|
|
|
|
def test_left_variable(self):
|
|
self._setf(u'%left{$title, 3}')
|
|
self._assert_dest('/base/the')
|
|
|
|
def test_right_variable(self):
|
|
self._setf(u'%right{$title,3}')
|
|
self._assert_dest('/base/tle')
|
|
|
|
def test_if_false(self):
|
|
self._setf(u'x%if{,foo}')
|
|
self._assert_dest('/base/x')
|
|
|
|
def test_if_false_value(self):
|
|
self._setf(u'x%if{false,foo}')
|
|
self._assert_dest('/base/x')
|
|
|
|
def test_if_true(self):
|
|
self._setf(u'%if{bar,foo}')
|
|
self._assert_dest('/base/foo')
|
|
|
|
def test_if_else_false(self):
|
|
self._setf(u'%if{,foo,baz}')
|
|
self._assert_dest('/base/baz')
|
|
|
|
def test_if_else_false_value(self):
|
|
self._setf(u'%if{false,foo,baz}')
|
|
self._assert_dest('/base/baz')
|
|
|
|
def test_if_int_value(self):
|
|
self._setf(u'%if{0,foo,baz}')
|
|
self._assert_dest('/base/baz')
|
|
|
|
def test_nonexistent_function(self):
|
|
self._setf(u'%foo{bar}')
|
|
self._assert_dest('/base/%foo{bar}')
|
|
|
|
|
|
class DisambiguationTest(_common.TestCase, PathFormattingMixin):
|
|
def setUp(self):
|
|
super(DisambiguationTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.lib.directory = '/base'
|
|
self.lib.path_formats = [('default', u'path')]
|
|
|
|
self.i1 = item()
|
|
self.i1.year = 2001
|
|
self.lib.add_album([self.i1])
|
|
self.i2 = item()
|
|
self.i2.year = 2002
|
|
self.lib.add_album([self.i2])
|
|
self.lib._connection().commit()
|
|
|
|
self._setf(u'foo%aunique{albumartist album,year}/$title')
|
|
|
|
def tearDown(self):
|
|
super(DisambiguationTest, self).tearDown()
|
|
self.lib._connection().close()
|
|
|
|
def test_unique_expands_to_disambiguating_year(self):
|
|
self._assert_dest('/base/foo [2001]/the title', self.i1)
|
|
|
|
def test_unique_with_default_arguments_uses_albumtype(self):
|
|
album2 = self.lib.get_album(self.i1)
|
|
album2.albumtype = 'bar'
|
|
album2.store()
|
|
self._setf(u'foo%aunique{}/$title')
|
|
self._assert_dest('/base/foo [bar]/the title', self.i1)
|
|
|
|
def test_unique_expands_to_nothing_for_distinct_albums(self):
|
|
album2 = self.lib.get_album(self.i2)
|
|
album2.album = 'different album'
|
|
album2.store()
|
|
|
|
self._assert_dest('/base/foo/the title', self.i1)
|
|
|
|
def test_use_fallback_numbers_when_identical(self):
|
|
album2 = self.lib.get_album(self.i2)
|
|
album2.year = 2001
|
|
album2.store()
|
|
|
|
self._assert_dest('/base/foo 1/the title', self.i1)
|
|
self._assert_dest('/base/foo 2/the title', self.i2)
|
|
|
|
def test_unique_falls_back_to_second_distinguishing_field(self):
|
|
self._setf(u'foo%aunique{albumartist album,month year}/$title')
|
|
self._assert_dest('/base/foo [2001]/the title', self.i1)
|
|
|
|
def test_unique_sanitized(self):
|
|
album2 = self.lib.get_album(self.i2)
|
|
album2.year = 2001
|
|
album1 = self.lib.get_album(self.i1)
|
|
album1.albumtype = 'foo/bar'
|
|
album2.store()
|
|
album1.store()
|
|
self._setf(u'foo%aunique{albumartist album,albumtype}/$title')
|
|
self._assert_dest('/base/foo [foo_bar]/the title', self.i1)
|
|
|
|
|
|
class PathConversionTest(_common.TestCase):
|
|
def test_syspath_windows_format(self):
|
|
with _common.platform_windows():
|
|
path = os.path.join('a', 'b', 'c')
|
|
outpath = util.syspath(path)
|
|
self.assertTrue(isinstance(outpath, unicode))
|
|
self.assertTrue(outpath.startswith(u'\\\\?\\'))
|
|
|
|
def test_syspath_windows_format_unc_path(self):
|
|
# The \\?\ prefix on Windows behaves differently with UNC
|
|
# (network share) paths.
|
|
path = '\\\\server\\share\\file.mp3'
|
|
with _common.platform_windows():
|
|
outpath = util.syspath(path)
|
|
self.assertTrue(isinstance(outpath, unicode))
|
|
self.assertEqual(outpath, u'\\\\?\\UNC\\server\\share\\file.mp3')
|
|
|
|
def test_syspath_posix_unchanged(self):
|
|
with _common.platform_posix():
|
|
path = os.path.join('a', 'b', 'c')
|
|
outpath = util.syspath(path)
|
|
self.assertEqual(path, outpath)
|
|
|
|
def _windows_bytestring_path(self, path):
|
|
old_gfse = sys.getfilesystemencoding
|
|
sys.getfilesystemencoding = lambda: 'mbcs'
|
|
try:
|
|
with _common.platform_windows():
|
|
return util.bytestring_path(path)
|
|
finally:
|
|
sys.getfilesystemencoding = old_gfse
|
|
|
|
def test_bytestring_path_windows_encodes_utf8(self):
|
|
path = u'caf\xe9'
|
|
outpath = self._windows_bytestring_path(path)
|
|
self.assertEqual(path, outpath.decode('utf8'))
|
|
|
|
def test_bytesting_path_windows_removes_magic_prefix(self):
|
|
path = u'\\\\?\\C:\\caf\xe9'
|
|
outpath = self._windows_bytestring_path(path)
|
|
self.assertEqual(outpath, u'C:\\caf\xe9'.encode('utf8'))
|
|
|
|
|
|
class PluginDestinationTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(PluginDestinationTest, self).setUp()
|
|
|
|
# Mock beets.plugins.item_field_getters.
|
|
self._tv_map = {}
|
|
|
|
def field_getters():
|
|
getters = {}
|
|
for key, value in self._tv_map.items():
|
|
getters[key] = lambda _: value
|
|
return getters
|
|
|
|
self.old_field_getters = plugins.item_field_getters
|
|
plugins.item_field_getters = field_getters
|
|
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.lib.directory = '/base'
|
|
self.lib.path_formats = [('default', u'$artist $foo')]
|
|
self.i = item(self.lib)
|
|
|
|
def tearDown(self):
|
|
super(PluginDestinationTest, self).tearDown()
|
|
plugins.item_field_getters = self.old_field_getters
|
|
|
|
def _assert_dest(self, dest):
|
|
with _common.platform_posix():
|
|
the_dest = self.i.destination()
|
|
self.assertEqual(the_dest, '/base/' + dest)
|
|
|
|
def test_undefined_value_not_substituted(self):
|
|
self._assert_dest('the artist $foo')
|
|
|
|
def test_plugin_value_not_substituted(self):
|
|
self._tv_map = {
|
|
'foo': 'bar',
|
|
}
|
|
self._assert_dest('the artist bar')
|
|
|
|
def test_plugin_value_overrides_attribute(self):
|
|
self._tv_map = {
|
|
'artist': 'bar',
|
|
}
|
|
self._assert_dest('bar $foo')
|
|
|
|
def test_plugin_value_sanitized(self):
|
|
self._tv_map = {
|
|
'foo': 'bar/baz',
|
|
}
|
|
self._assert_dest('the artist bar_baz')
|
|
|
|
|
|
class AlbumInfoTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(AlbumInfoTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.i = item()
|
|
self.lib.add_album((self.i,))
|
|
|
|
def test_albuminfo_reflects_metadata(self):
|
|
ai = self.lib.get_album(self.i)
|
|
self.assertEqual(ai.mb_albumartistid, self.i.mb_albumartistid)
|
|
self.assertEqual(ai.albumartist, self.i.albumartist)
|
|
self.assertEqual(ai.album, self.i.album)
|
|
self.assertEqual(ai.year, self.i.year)
|
|
|
|
def test_albuminfo_stores_art(self):
|
|
ai = self.lib.get_album(self.i)
|
|
ai.artpath = '/my/great/art'
|
|
ai.store()
|
|
new_ai = self.lib.get_album(self.i)
|
|
self.assertEqual(new_ai.artpath, '/my/great/art')
|
|
|
|
def test_albuminfo_for_two_items_doesnt_duplicate_row(self):
|
|
i2 = item(self.lib)
|
|
self.lib.get_album(self.i)
|
|
self.lib.get_album(i2)
|
|
|
|
c = self.lib._connection().cursor()
|
|
c.execute('select * from albums where album=?', (self.i.album,))
|
|
# Cursor should only return one row.
|
|
self.assertNotEqual(c.fetchone(), None)
|
|
self.assertEqual(c.fetchone(), None)
|
|
|
|
def test_individual_tracks_have_no_albuminfo(self):
|
|
i2 = item()
|
|
i2.album = 'aTotallyDifferentAlbum'
|
|
self.lib.add(i2)
|
|
ai = self.lib.get_album(i2)
|
|
self.assertEqual(ai, None)
|
|
|
|
def test_get_album_by_id(self):
|
|
ai = self.lib.get_album(self.i)
|
|
ai = self.lib.get_album(self.i.id)
|
|
self.assertNotEqual(ai, None)
|
|
|
|
def test_album_items_consistent(self):
|
|
ai = self.lib.get_album(self.i)
|
|
for i in ai.items():
|
|
if i.id == self.i.id:
|
|
break
|
|
else:
|
|
self.fail("item not found")
|
|
|
|
def test_albuminfo_changes_affect_items(self):
|
|
ai = self.lib.get_album(self.i)
|
|
ai.album = 'myNewAlbum'
|
|
ai.store()
|
|
i = self.lib.items()[0]
|
|
self.assertEqual(i.album, 'myNewAlbum')
|
|
|
|
def test_albuminfo_change_albumartist_changes_items(self):
|
|
ai = self.lib.get_album(self.i)
|
|
ai.albumartist = 'myNewArtist'
|
|
ai.store()
|
|
i = self.lib.items()[0]
|
|
self.assertEqual(i.albumartist, 'myNewArtist')
|
|
self.assertNotEqual(i.artist, 'myNewArtist')
|
|
|
|
def test_albuminfo_change_artist_does_not_change_items(self):
|
|
ai = self.lib.get_album(self.i)
|
|
ai.artist = 'myNewArtist'
|
|
ai.store()
|
|
i = self.lib.items()[0]
|
|
self.assertNotEqual(i.artist, 'myNewArtist')
|
|
|
|
def test_albuminfo_remove_removes_items(self):
|
|
item_id = self.i.id
|
|
self.lib.get_album(self.i).remove()
|
|
c = self.lib._connection().execute(
|
|
'SELECT id FROM items WHERE id=?', (item_id,)
|
|
)
|
|
self.assertEqual(c.fetchone(), None)
|
|
|
|
def test_removing_last_item_removes_album(self):
|
|
self.assertEqual(len(self.lib.albums()), 1)
|
|
self.i.remove()
|
|
self.assertEqual(len(self.lib.albums()), 0)
|
|
|
|
def test_noop_albuminfo_changes_affect_items(self):
|
|
i = self.lib.items()[0]
|
|
i.album = 'foobar'
|
|
i.store()
|
|
ai = self.lib.get_album(self.i)
|
|
ai.album = ai.album
|
|
ai.store()
|
|
i = self.lib.items()[0]
|
|
self.assertEqual(i.album, ai.album)
|
|
|
|
|
|
class ArtDestinationTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(ArtDestinationTest, self).setUp()
|
|
config['art_filename'] = u'artimage'
|
|
config['replace'] = {u'X': u'Y'}
|
|
self.lib = beets.library.Library(
|
|
':memory:', replacements=[(re.compile(u'X'), u'Y')]
|
|
)
|
|
self.i = item(self.lib)
|
|
self.i.path = self.i.destination()
|
|
self.ai = self.lib.add_album((self.i,))
|
|
|
|
def test_art_filename_respects_setting(self):
|
|
art = self.ai.art_destination('something.jpg')
|
|
self.assert_('%sartimage.jpg' % os.path.sep in art)
|
|
|
|
def test_art_path_in_item_dir(self):
|
|
art = self.ai.art_destination('something.jpg')
|
|
track = self.i.destination()
|
|
self.assertEqual(os.path.dirname(art), os.path.dirname(track))
|
|
|
|
def test_art_path_sanitized(self):
|
|
config['art_filename'] = u'artXimage'
|
|
art = self.ai.art_destination('something.jpg')
|
|
self.assert_('artYimage' in art)
|
|
|
|
|
|
class PathStringTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(PathStringTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.i = item(self.lib)
|
|
|
|
def test_item_path_is_bytestring(self):
|
|
self.assert_(isinstance(self.i.path, str))
|
|
|
|
def test_fetched_item_path_is_bytestring(self):
|
|
i = list(self.lib.items())[0]
|
|
self.assert_(isinstance(i.path, str))
|
|
|
|
def test_unicode_path_becomes_bytestring(self):
|
|
self.i.path = u'unicodepath'
|
|
self.assert_(isinstance(self.i.path, str))
|
|
|
|
def test_unicode_in_database_becomes_bytestring(self):
|
|
self.lib._connection().execute("""
|
|
update items set path=? where id=?
|
|
""", (self.i.id, u'somepath'))
|
|
i = list(self.lib.items())[0]
|
|
self.assert_(isinstance(i.path, str))
|
|
|
|
def test_special_chars_preserved_in_database(self):
|
|
path = 'b\xe1r'
|
|
self.i.path = path
|
|
self.i.store()
|
|
i = list(self.lib.items())[0]
|
|
self.assertEqual(i.path, path)
|
|
|
|
def test_special_char_path_added_to_database(self):
|
|
self.i.remove()
|
|
path = 'b\xe1r'
|
|
i = item()
|
|
i.path = path
|
|
self.lib.add(i)
|
|
i = list(self.lib.items())[0]
|
|
self.assertEqual(i.path, path)
|
|
|
|
def test_destination_returns_bytestring(self):
|
|
self.i.artist = u'b\xe1r'
|
|
dest = self.i.destination()
|
|
self.assert_(isinstance(dest, str))
|
|
|
|
def test_art_destination_returns_bytestring(self):
|
|
self.i.artist = u'b\xe1r'
|
|
alb = self.lib.add_album([self.i])
|
|
dest = alb.art_destination(u'image.jpg')
|
|
self.assert_(isinstance(dest, str))
|
|
|
|
def test_artpath_stores_special_chars(self):
|
|
path = b'b\xe1r'
|
|
alb = self.lib.add_album([self.i])
|
|
alb.artpath = path
|
|
alb.store()
|
|
alb = self.lib.get_album(self.i)
|
|
self.assertEqual(path, alb.artpath)
|
|
|
|
def test_sanitize_path_with_special_chars(self):
|
|
path = u'b\xe1r?'
|
|
new_path = util.sanitize_path(path)
|
|
self.assert_(new_path.startswith(u'b\xe1r'))
|
|
|
|
def test_sanitize_path_returns_unicode(self):
|
|
path = u'b\xe1r?'
|
|
new_path = util.sanitize_path(path)
|
|
self.assert_(isinstance(new_path, unicode))
|
|
|
|
def test_unicode_artpath_becomes_bytestring(self):
|
|
alb = self.lib.add_album([self.i])
|
|
alb.artpath = u'somep\xe1th'
|
|
self.assert_(isinstance(alb.artpath, str))
|
|
|
|
def test_unicode_artpath_in_database_decoded(self):
|
|
alb = self.lib.add_album([self.i])
|
|
self.lib._connection().execute(
|
|
"update albums set artpath=? where id=?",
|
|
(u'somep\xe1th', alb.id)
|
|
)
|
|
alb = self.lib.get_album(alb.id)
|
|
self.assert_(isinstance(alb.artpath, str))
|
|
|
|
|
|
class PathTruncationTest(_common.TestCase):
|
|
def test_truncate_bytestring(self):
|
|
with _common.platform_posix():
|
|
p = util.truncate_path('abcde/fgh', 4)
|
|
self.assertEqual(p, 'abcd/fgh')
|
|
|
|
def test_truncate_unicode(self):
|
|
with _common.platform_posix():
|
|
p = util.truncate_path(u'abcde/fgh', 4)
|
|
self.assertEqual(p, u'abcd/fgh')
|
|
|
|
def test_truncate_preserves_extension(self):
|
|
with _common.platform_posix():
|
|
p = util.truncate_path(u'abcde/fgh.ext', 5)
|
|
self.assertEqual(p, u'abcde/f.ext')
|
|
|
|
|
|
class MtimeTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(MtimeTest, self).setUp()
|
|
self.ipath = os.path.join(self.temp_dir, 'testfile.mp3')
|
|
shutil.copy(os.path.join(_common.RSRC, 'full.mp3'), self.ipath)
|
|
self.i = beets.library.Item.from_path(self.ipath)
|
|
self.lib = beets.library.Library(':memory:')
|
|
self.lib.add(self.i)
|
|
|
|
def tearDown(self):
|
|
super(MtimeTest, self).tearDown()
|
|
if os.path.exists(self.ipath):
|
|
os.remove(self.ipath)
|
|
|
|
def _mtime(self):
|
|
return int(os.path.getmtime(self.ipath))
|
|
|
|
def test_mtime_initially_up_to_date(self):
|
|
self.assertGreaterEqual(self.i.mtime, self._mtime())
|
|
|
|
def test_mtime_reset_on_db_modify(self):
|
|
self.i.title = 'something else'
|
|
self.assertLess(self.i.mtime, self._mtime())
|
|
|
|
def test_mtime_up_to_date_after_write(self):
|
|
self.i.title = 'something else'
|
|
self.i.write()
|
|
self.assertGreaterEqual(self.i.mtime, self._mtime())
|
|
|
|
def test_mtime_up_to_date_after_read(self):
|
|
self.i.title = 'something else'
|
|
self.i.read()
|
|
self.assertGreaterEqual(self.i.mtime, self._mtime())
|
|
|
|
|
|
class ImportTimeTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(ImportTimeTest, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
|
|
def added(self):
|
|
self.track = item()
|
|
self.album = self.lib.add_album((self.track,))
|
|
self.assertGreater(self.album.added, 0)
|
|
self.assertGreater(self.track.added, 0)
|
|
|
|
def test_atime_for_singleton(self):
|
|
self.singleton = item(self.lib)
|
|
self.assertGreater(self.singleton.added, 0)
|
|
|
|
|
|
class TemplateTest(_common.LibTestCase):
|
|
def test_year_formatted_in_template(self):
|
|
self.i.year = 123
|
|
self.i.store()
|
|
self.assertEqual(self.i.evaluate_template('$year'), '0123')
|
|
|
|
def test_album_flexattr_appears_in_item_template(self):
|
|
self.album = self.lib.add_album([self.i])
|
|
self.album.foo = 'baz'
|
|
self.album.store()
|
|
self.assertEqual(self.i.evaluate_template('$foo'), 'baz')
|
|
|
|
|
|
class UnicodePathTest(_common.LibTestCase):
|
|
def test_unicode_path(self):
|
|
self.i.path = os.path.join(_common.RSRC, u'unicode\u2019d.mp3')
|
|
# If there are any problems with unicode paths, we will raise
|
|
# here and fail.
|
|
self.i.read()
|
|
self.i.write()
|
|
|
|
|
|
class WriteTest(_common.LibTestCase):
|
|
def test_write_nonexistant(self):
|
|
self.i.path = '/path/does/not/exist'
|
|
self.assertRaises(beets.library.ReadError, self.i.write)
|
|
|
|
def test_no_write_permission(self):
|
|
path = os.path.join(self.temp_dir, 'file.mp3')
|
|
shutil.copy(os.path.join(_common.RSRC, 'empty.mp3'), path)
|
|
os.chmod(path, stat.S_IRUSR)
|
|
|
|
try:
|
|
self.i.path = path
|
|
self.assertRaises(beets.library.WriteError, self.i.write)
|
|
|
|
finally:
|
|
# Restore write permissions so the file can be cleaned up.
|
|
os.chmod(path, stat.S_IRUSR | stat.S_IWUSR)
|
|
|
|
def test_write_with_custom_path(self):
|
|
custom_path = os.path.join(self.temp_dir, 'file.mp3')
|
|
self.i.path = os.path.join(self.temp_dir, 'item_file.mp3')
|
|
shutil.copy(os.path.join(_common.RSRC, 'empty.mp3'), custom_path)
|
|
shutil.copy(os.path.join(_common.RSRC, 'empty.mp3'), self.i.path)
|
|
|
|
self.i['artist'] = 'new artist'
|
|
self.assertNotEqual(MediaFile(custom_path).artist, 'new artist')
|
|
self.assertNotEqual(MediaFile(self.i.path).artist, 'new artist')
|
|
|
|
self.i.write(custom_path)
|
|
self.assertEqual(MediaFile(custom_path).artist, 'new artist')
|
|
self.assertNotEqual(MediaFile(self.i.path).artist, 'new artist')
|
|
|
|
|
|
class ItemReadTest(unittest.TestCase):
|
|
|
|
def test_unreadable_raise_read_error(self):
|
|
unreadable = os.path.join(_common.RSRC, 'image-2x3.png')
|
|
item = beets.library.Item()
|
|
with self.assertRaises(beets.library.ReadError) as cm:
|
|
item.read(unreadable)
|
|
self.assertIsInstance(cm.exception.reason,
|
|
beets.mediafile.UnreadableFileError)
|
|
|
|
def test_nonexistent_raise_read_error(self):
|
|
item = beets.library.Item()
|
|
with self.assertRaises(beets.library.ReadError):
|
|
item.read('/thisfiledoesnotexist')
|
|
|
|
|
|
def suite():
|
|
return unittest.TestLoader().loadTestsFromName(__name__)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main(defaultTest='suite')
|