mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 16:42:42 +01:00
c40ea4f22a
The regex «[\+-]?[0-9]*» possibly matches a single minus/plus, which would then be passed on to int(), raising a ValueError from within _safe_cast. The test suite covered this for float, but not for int. We now make sure we actually have a number after the sign by using a Kleene plus.
411 lines
14 KiB
Python
411 lines
14 KiB
Python
# -*- coding: utf-8 -*-
|
|
# This file is part of beets.
|
|
# Copyright 2016, 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.
|
|
|
|
"""Specific, edge-case tests for the MediaFile metadata layer.
|
|
"""
|
|
from __future__ import division, absolute_import, print_function
|
|
|
|
import os
|
|
import shutil
|
|
import unittest
|
|
import mutagen.id3
|
|
|
|
from test import _common
|
|
|
|
from beets import mediafile
|
|
import six
|
|
|
|
|
|
_sc = mediafile._safe_cast
|
|
|
|
|
|
class EdgeTest(unittest.TestCase):
|
|
def test_emptylist(self):
|
|
# Some files have an ID3 frame that has a list with no elements.
|
|
# This is very hard to produce, so this is just the first 8192
|
|
# bytes of a file found "in the wild".
|
|
emptylist = mediafile.MediaFile(
|
|
os.path.join(_common.RSRC, b'emptylist.mp3')
|
|
)
|
|
genre = emptylist.genre
|
|
self.assertEqual(genre, None)
|
|
|
|
def test_release_time_with_space(self):
|
|
# Ensures that release times delimited by spaces are ignored.
|
|
# Amie Street produces such files.
|
|
space_time = mediafile.MediaFile(
|
|
os.path.join(_common.RSRC, b'space_time.mp3')
|
|
)
|
|
self.assertEqual(space_time.year, 2009)
|
|
self.assertEqual(space_time.month, 9)
|
|
self.assertEqual(space_time.day, 4)
|
|
|
|
def test_release_time_with_t(self):
|
|
# Ensures that release times delimited by Ts are ignored.
|
|
# The iTunes Store produces such files.
|
|
t_time = mediafile.MediaFile(
|
|
os.path.join(_common.RSRC, b't_time.m4a')
|
|
)
|
|
self.assertEqual(t_time.year, 1987)
|
|
self.assertEqual(t_time.month, 3)
|
|
self.assertEqual(t_time.day, 31)
|
|
|
|
def test_tempo_with_bpm(self):
|
|
# Some files have a string like "128 BPM" in the tempo field
|
|
# rather than just a number.
|
|
f = mediafile.MediaFile(os.path.join(_common.RSRC, b'bpm.mp3'))
|
|
self.assertEqual(f.bpm, 128)
|
|
|
|
def test_discc_alternate_field(self):
|
|
# Different taggers use different vorbis comments to reflect
|
|
# the disc and disc count fields: ensure that the alternative
|
|
# style works.
|
|
f = mediafile.MediaFile(os.path.join(_common.RSRC, b'discc.ogg'))
|
|
self.assertEqual(f.disc, 4)
|
|
self.assertEqual(f.disctotal, 5)
|
|
|
|
def test_old_ape_version_bitrate(self):
|
|
media_file = os.path.join(_common.RSRC, b'oldape.ape')
|
|
f = mediafile.MediaFile(media_file)
|
|
self.assertEqual(f.bitrate, 0)
|
|
|
|
def test_only_magic_bytes_jpeg(self):
|
|
# Some jpeg files can only be recognized by their magic bytes and as
|
|
# such aren't recognized by imghdr. Ensure that this still works thanks
|
|
# to our own follow up mimetype detection based on
|
|
# https://github.com/file/file/blob/master/magic/Magdir/jpeg#L12
|
|
magic_bytes_file = os.path.join(_common.RSRC, b'only-magic-bytes.jpg')
|
|
with open(magic_bytes_file, 'rb') as f:
|
|
jpg_data = f.read()
|
|
self.assertEqual(
|
|
mediafile._imghdr_what_wrapper(jpg_data), 'jpeg')
|
|
|
|
def test_soundcheck_non_ascii(self):
|
|
# Make sure we don't crash when the iTunes SoundCheck field contains
|
|
# non-ASCII binary data.
|
|
f = mediafile.MediaFile(os.path.join(_common.RSRC,
|
|
b'soundcheck-nonascii.m4a'))
|
|
self.assertEqual(f.rg_track_gain, 0.0)
|
|
|
|
|
|
class InvalidValueToleranceTest(unittest.TestCase):
|
|
|
|
def test_safe_cast_string_to_int(self):
|
|
self.assertEqual(_sc(int, u'something'), 0)
|
|
|
|
def test_safe_cast_string_to_int_with_no_numbers(self):
|
|
self.assertEqual(_sc(int, u'-'), 0)
|
|
|
|
def test_safe_cast_int_string_to_int(self):
|
|
self.assertEqual(_sc(int, u'20'), 20)
|
|
|
|
def test_safe_cast_string_to_bool(self):
|
|
self.assertEqual(_sc(bool, u'whatever'), False)
|
|
|
|
def test_safe_cast_intstring_to_bool(self):
|
|
self.assertEqual(_sc(bool, u'5'), True)
|
|
|
|
def test_safe_cast_string_to_float(self):
|
|
self.assertAlmostEqual(_sc(float, u'1.234'), 1.234)
|
|
|
|
def test_safe_cast_int_to_float(self):
|
|
self.assertAlmostEqual(_sc(float, 2), 2.0)
|
|
|
|
def test_safe_cast_string_with_cruft_to_float(self):
|
|
self.assertAlmostEqual(_sc(float, u'1.234stuff'), 1.234)
|
|
|
|
def test_safe_cast_negative_string_to_float(self):
|
|
self.assertAlmostEqual(_sc(float, u'-1.234'), -1.234)
|
|
|
|
def test_safe_cast_special_chars_to_unicode(self):
|
|
us = _sc(six.text_type, 'caf\xc3\xa9')
|
|
self.assertTrue(isinstance(us, six.text_type))
|
|
self.assertTrue(us.startswith(u'caf'))
|
|
|
|
def test_safe_cast_float_with_no_numbers(self):
|
|
v = _sc(float, u'+')
|
|
self.assertEqual(v, 0.0)
|
|
|
|
def test_safe_cast_float_with_dot_only(self):
|
|
v = _sc(float, u'.')
|
|
self.assertEqual(v, 0.0)
|
|
|
|
def test_safe_cast_float_with_multiple_dots(self):
|
|
v = _sc(float, u'1.0.0')
|
|
self.assertEqual(v, 1.0)
|
|
|
|
|
|
class SafetyTest(unittest.TestCase, _common.TempDirMixin):
|
|
def setUp(self):
|
|
self.create_temp_dir()
|
|
|
|
def tearDown(self):
|
|
self.remove_temp_dir()
|
|
|
|
def _exccheck(self, fn, exc, data=''):
|
|
fn = os.path.join(self.temp_dir, fn)
|
|
with open(fn, 'w') as f:
|
|
f.write(data)
|
|
try:
|
|
self.assertRaises(exc, mediafile.MediaFile, fn)
|
|
finally:
|
|
os.unlink(fn) # delete the temporary file
|
|
|
|
def test_corrupt_mp3_raises_unreadablefileerror(self):
|
|
# Make sure we catch Mutagen reading errors appropriately.
|
|
self._exccheck(b'corrupt.mp3', mediafile.UnreadableFileError)
|
|
|
|
def test_corrupt_mp4_raises_unreadablefileerror(self):
|
|
self._exccheck(b'corrupt.m4a', mediafile.UnreadableFileError)
|
|
|
|
def test_corrupt_flac_raises_unreadablefileerror(self):
|
|
self._exccheck(b'corrupt.flac', mediafile.UnreadableFileError)
|
|
|
|
def test_corrupt_ogg_raises_unreadablefileerror(self):
|
|
self._exccheck(b'corrupt.ogg', mediafile.UnreadableFileError)
|
|
|
|
def test_invalid_ogg_header_raises_unreadablefileerror(self):
|
|
self._exccheck(b'corrupt.ogg', mediafile.UnreadableFileError,
|
|
'OggS\x01vorbis')
|
|
|
|
def test_corrupt_monkeys_raises_unreadablefileerror(self):
|
|
self._exccheck(b'corrupt.ape', mediafile.UnreadableFileError)
|
|
|
|
def test_invalid_extension_raises_filetypeerror(self):
|
|
self._exccheck(b'something.unknown', mediafile.FileTypeError)
|
|
|
|
def test_magic_xml_raises_unreadablefileerror(self):
|
|
self._exccheck(b'nothing.xml', mediafile.UnreadableFileError,
|
|
"ftyp")
|
|
|
|
@unittest.skipUnless(_common.HAVE_SYMLINK, u'platform lacks symlink')
|
|
def test_broken_symlink(self):
|
|
fn = os.path.join(_common.RSRC, b'brokenlink')
|
|
os.symlink('does_not_exist', fn)
|
|
try:
|
|
self.assertRaises(mediafile.UnreadableFileError,
|
|
mediafile.MediaFile, fn)
|
|
finally:
|
|
os.unlink(fn)
|
|
|
|
|
|
class SideEffectsTest(unittest.TestCase):
|
|
def setUp(self):
|
|
self.empty = os.path.join(_common.RSRC, b'empty.mp3')
|
|
|
|
def test_opening_tagless_file_leaves_untouched(self):
|
|
old_mtime = os.stat(self.empty).st_mtime
|
|
mediafile.MediaFile(self.empty)
|
|
new_mtime = os.stat(self.empty).st_mtime
|
|
self.assertEqual(old_mtime, new_mtime)
|
|
|
|
|
|
class MP4EncodingTest(unittest.TestCase, _common.TempDirMixin):
|
|
def setUp(self):
|
|
self.create_temp_dir()
|
|
src = os.path.join(_common.RSRC, b'full.m4a')
|
|
self.path = os.path.join(self.temp_dir, b'test.m4a')
|
|
shutil.copy(src, self.path)
|
|
|
|
self.mf = mediafile.MediaFile(self.path)
|
|
|
|
def tearDown(self):
|
|
self.remove_temp_dir()
|
|
|
|
def test_unicode_label_in_m4a(self):
|
|
self.mf.label = u'foo\xe8bar'
|
|
self.mf.save()
|
|
new_mf = mediafile.MediaFile(self.path)
|
|
self.assertEqual(new_mf.label, u'foo\xe8bar')
|
|
|
|
|
|
class MP3EncodingTest(unittest.TestCase, _common.TempDirMixin):
|
|
def setUp(self):
|
|
self.create_temp_dir()
|
|
src = os.path.join(_common.RSRC, b'full.mp3')
|
|
self.path = os.path.join(self.temp_dir, b'test.mp3')
|
|
shutil.copy(src, self.path)
|
|
|
|
self.mf = mediafile.MediaFile(self.path)
|
|
|
|
def test_comment_with_latin1_encoding(self):
|
|
# Set up the test file with a Latin1-encoded COMM frame. The encoding
|
|
# indices defined by MP3 are listed here:
|
|
# http://id3.org/id3v2.4.0-structure
|
|
self.mf.mgfile['COMM::eng'].encoding = 0
|
|
|
|
# Try to store non-Latin1 text.
|
|
self.mf.comments = u'\u2028'
|
|
self.mf.save()
|
|
|
|
|
|
class ZeroLengthMediaFile(mediafile.MediaFile):
|
|
@property
|
|
def length(self):
|
|
return 0.0
|
|
|
|
|
|
class MissingAudioDataTest(unittest.TestCase):
|
|
def setUp(self):
|
|
super(MissingAudioDataTest, self).setUp()
|
|
path = os.path.join(_common.RSRC, b'full.mp3')
|
|
self.mf = ZeroLengthMediaFile(path)
|
|
|
|
def test_bitrate_with_zero_length(self):
|
|
del self.mf.mgfile.info.bitrate # Not available directly.
|
|
self.assertEqual(self.mf.bitrate, 0)
|
|
|
|
|
|
class TypeTest(unittest.TestCase):
|
|
def setUp(self):
|
|
super(TypeTest, self).setUp()
|
|
path = os.path.join(_common.RSRC, b'full.mp3')
|
|
self.mf = mediafile.MediaFile(path)
|
|
|
|
def test_year_integer_in_string(self):
|
|
self.mf.year = u'2009'
|
|
self.assertEqual(self.mf.year, 2009)
|
|
|
|
def test_set_replaygain_gain_to_none(self):
|
|
self.mf.rg_track_gain = None
|
|
self.assertEqual(self.mf.rg_track_gain, 0.0)
|
|
|
|
def test_set_replaygain_peak_to_none(self):
|
|
self.mf.rg_track_peak = None
|
|
self.assertEqual(self.mf.rg_track_peak, 0.0)
|
|
|
|
def test_set_year_to_none(self):
|
|
self.mf.year = None
|
|
self.assertIsNone(self.mf.year)
|
|
|
|
def test_set_track_to_none(self):
|
|
self.mf.track = None
|
|
self.assertEqual(self.mf.track, 0)
|
|
|
|
def test_set_date_to_none(self):
|
|
self.mf.date = None
|
|
self.assertIsNone(self.mf.date)
|
|
self.assertIsNone(self.mf.year)
|
|
self.assertIsNone(self.mf.month)
|
|
self.assertIsNone(self.mf.day)
|
|
|
|
|
|
class SoundCheckTest(unittest.TestCase):
|
|
def test_round_trip(self):
|
|
data = mediafile._sc_encode(1.0, 1.0)
|
|
gain, peak = mediafile._sc_decode(data)
|
|
self.assertEqual(gain, 1.0)
|
|
self.assertEqual(peak, 1.0)
|
|
|
|
def test_decode_zero(self):
|
|
data = b' 80000000 80000000 00000000 00000000 00000000 00000000 ' \
|
|
b'00000000 00000000 00000000 00000000'
|
|
gain, peak = mediafile._sc_decode(data)
|
|
self.assertEqual(gain, 0.0)
|
|
self.assertEqual(peak, 0.0)
|
|
|
|
def test_malformatted(self):
|
|
gain, peak = mediafile._sc_decode(b'foo')
|
|
self.assertEqual(gain, 0.0)
|
|
self.assertEqual(peak, 0.0)
|
|
|
|
def test_special_characters(self):
|
|
gain, peak = mediafile._sc_decode(u'caf\xe9'.encode('utf-8'))
|
|
self.assertEqual(gain, 0.0)
|
|
self.assertEqual(peak, 0.0)
|
|
|
|
def test_decode_handles_unicode(self):
|
|
# Most of the time, we expect to decode the raw bytes. But some formats
|
|
# might give us text strings, which we need to handle.
|
|
gain, peak = mediafile._sc_decode(u'caf\xe9')
|
|
self.assertEqual(gain, 0.0)
|
|
self.assertEqual(peak, 0.0)
|
|
|
|
|
|
class ID3v23Test(unittest.TestCase, _common.TempDirMixin):
|
|
def _make_test(self, ext=b'mp3', id3v23=False):
|
|
self.create_temp_dir()
|
|
src = os.path.join(_common.RSRC,
|
|
b'full.' + ext)
|
|
self.path = os.path.join(self.temp_dir,
|
|
b'test.' + ext)
|
|
shutil.copy(src, self.path)
|
|
return mediafile.MediaFile(self.path, id3v23=id3v23)
|
|
|
|
def _delete_test(self):
|
|
self.remove_temp_dir()
|
|
|
|
def test_v24_year_tag(self):
|
|
mf = self._make_test(id3v23=False)
|
|
try:
|
|
mf.year = 2013
|
|
mf.save()
|
|
frame = mf.mgfile['TDRC']
|
|
self.assertTrue('2013' in six.text_type(frame))
|
|
self.assertTrue('TYER' not in mf.mgfile)
|
|
finally:
|
|
self._delete_test()
|
|
|
|
def test_v23_year_tag(self):
|
|
mf = self._make_test(id3v23=True)
|
|
try:
|
|
mf.year = 2013
|
|
mf.save()
|
|
frame = mf.mgfile['TYER']
|
|
self.assertTrue('2013' in six.text_type(frame))
|
|
self.assertTrue('TDRC' not in mf.mgfile)
|
|
finally:
|
|
self._delete_test()
|
|
|
|
def test_v23_on_non_mp3_is_noop(self):
|
|
mf = self._make_test(b'm4a', id3v23=True)
|
|
try:
|
|
mf.year = 2013
|
|
mf.save()
|
|
finally:
|
|
self._delete_test()
|
|
|
|
def test_image_encoding(self):
|
|
"""For compatibility with OS X/iTunes.
|
|
|
|
See https://github.com/beetbox/beets/issues/899#issuecomment-62437773
|
|
"""
|
|
|
|
for v23 in [True, False]:
|
|
mf = self._make_test(id3v23=v23)
|
|
try:
|
|
mf.images = [
|
|
mediafile.Image(b'data', desc=u""),
|
|
mediafile.Image(b'data', desc=u"foo"),
|
|
mediafile.Image(b'data', desc=u"\u0185"),
|
|
]
|
|
mf.save()
|
|
apic_frames = mf.mgfile.tags.getall('APIC')
|
|
encodings = dict([(f.desc, f.encoding) for f in apic_frames])
|
|
self.assertEqual(encodings, {
|
|
u"": mutagen.id3.Encoding.LATIN1,
|
|
u"foo": mutagen.id3.Encoding.LATIN1,
|
|
u"\u0185": mutagen.id3.Encoding.UTF16,
|
|
})
|
|
finally:
|
|
self._delete_test()
|
|
|
|
|
|
def suite():
|
|
return unittest.TestLoader().loadTestsFromName(__name__)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main(defaultTest='suite')
|