Source

beets / test / test_autotag.py

Full commit
  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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
# This file is part of beets.
# Copyright 2010, 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 autotagging functionality.
"""

import unittest
import sys
import os
import shutil
import re

import _common
from beets import autotag
from beets.library import Item

class PluralityTest(unittest.TestCase):
    def test_plurality_consensus(self):
        objs = [1, 1, 1, 1]
        obj, consensus = autotag._plurality(objs)
        self.assertEqual(obj, 1)
        self.assertTrue(consensus)

    def test_plurality_near_consensus(self):
        objs = [1, 1, 2, 1]
        obj, consensus = autotag._plurality(objs)
        self.assertEqual(obj, 1)
        self.assertFalse(consensus)

    def test_plurality_conflict(self):
        objs = [1, 1, 2, 2, 3]
        obj, consensus = autotag._plurality(objs)
        self.assert_(obj in (1, 2))
        self.assertFalse(consensus)

    def test_current_metadata_finds_pluralities(self):
        items = [Item({'artist': 'The Beetles', 'album': 'The White Album'}),
                 Item({'artist': 'The Beatles', 'album': 'The White Album'}),
                 Item({'artist': 'The Beatles', 'album': 'Teh White Album'})]
        l_artist, l_album, artist_consensus = autotag.current_metadata(items)
        self.assertEqual(l_artist, 'The Beatles')
        self.assertEqual(l_album, 'The White Album')
        self.assertFalse(artist_consensus)

    def test_current_metadata_artist_consensus(self):
        items = [Item({'artist': 'The Beatles', 'album': 'The White Album'}),
                 Item({'artist': 'The Beatles', 'album': 'The White Album'}),
                 Item({'artist': 'The Beatles', 'album': 'Teh White Album'})]
        l_artist, l_album, artist_consensus = autotag.current_metadata(items)
        self.assertEqual(l_artist, 'The Beatles')
        self.assertEqual(l_album, 'The White Album')
        self.assertTrue(artist_consensus)

class AlbumDistanceTest(unittest.TestCase):
    def item(self, title, track, artist='some artist'):
        return Item({
            'title': title, 'track': track,
            'artist': artist, 'album': 'some album',
            'length': 1,
            'mb_trackid': '', 'mb_albumid': '', 'mb_artistid': '',
        })

    def trackinfo(self):
        ti = []
        ti.append({'title': 'one', 'artist': 'some artist',
                   'track': 1, 'length': 1})
        ti.append({'title': 'two', 'artist': 'some artist', 
                   'track': 2, 'length': 1})
        ti.append({'title': 'three', 'artist': 'some artist',
                   'track': 3, 'length': 1})
        return ti
    
    def test_identical_albums(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('two', 2))
        items.append(self.item('three', 3))
        info = {
            'artist': 'some artist',
            'album': 'some album',
            'tracks': self.trackinfo(),
            'va': False,
        }
        self.assertEqual(autotag.distance(items, info), 0)

    def test_global_artists_differ(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('two', 2))
        items.append(self.item('three', 3))
        info = {
            'artist': 'someone else',
            'album': 'some album',
            'tracks': self.trackinfo(),
            'va': False,
        }
        self.assertNotEqual(autotag.distance(items, info), 0)

    def test_comp_track_artists_match(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('two', 2))
        items.append(self.item('three', 3))
        info = {
            'artist': 'should be ignored',
            'album': 'some album',
            'tracks': self.trackinfo(),
            'va': True,
        }
        self.assertEqual(autotag.distance(items, info), 0)

    def test_comp_no_track_artists(self):
        # Some VA releases don't have track artists (incomplete metadata).
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('two', 2))
        items.append(self.item('three', 3))
        info = {
            'artist': 'should be ignored',
            'album': 'some album',
            'tracks': self.trackinfo(),
            'va': True,
        }
        del info['tracks'][0]['artist']
        del info['tracks'][1]['artist']
        del info['tracks'][2]['artist']
        self.assertEqual(autotag.distance(items, info), 0)

    def test_comp_track_artists_do_not_match(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('two', 2, 'someone else'))
        items.append(self.item('three', 3))
        info = {
            'artist': 'some artist',
            'album': 'some album',
            'tracks': self.trackinfo(),
            'va': True,
        }
        self.assertNotEqual(autotag.distance(items, info), 0)

def _mkmp3(path):
    shutil.copyfile(os.path.join('rsrc', 'min.mp3'), path)
class AlbumsInDirTest(unittest.TestCase):
    def setUp(self):
        # create a directory structure for testing
        self.base = os.path.abspath(os.path.join('rsrc', 'temp_albumsindir'))
        os.mkdir(self.base)
        
        os.mkdir(os.path.join(self.base, 'album1'))
        os.mkdir(os.path.join(self.base, 'album2'))
        os.mkdir(os.path.join(self.base, 'more'))
        os.mkdir(os.path.join(self.base, 'more', 'album3'))
        os.mkdir(os.path.join(self.base, 'more', 'album4'))
        
        _mkmp3(os.path.join(self.base, 'album1', 'album1song1.mp3'))
        _mkmp3(os.path.join(self.base, 'album1', 'album1song2.mp3'))
        _mkmp3(os.path.join(self.base, 'album2', 'album2song.mp3'))
        _mkmp3(os.path.join(self.base, 'more', 'album3', 'album3song.mp3'))
        _mkmp3(os.path.join(self.base, 'more', 'album4', 'album4song.mp3'))
    def tearDown(self):
        shutil.rmtree(self.base)
    
    def test_finds_all_albums(self):
        albums = list(autotag.albums_in_dir(self.base))
        self.assertEqual(len(albums), 4)
    
    def test_separates_contents(self):
        found = []
        for _, album in autotag.albums_in_dir(self.base):
            found.append(re.search(r'album(.)song', album[0].path).group(1))
        self.assertTrue('1' in found)
        self.assertTrue('2' in found)
        self.assertTrue('3' in found)
        self.assertTrue('4' in found)
    
    def test_finds_multiple_songs(self):
        for _, album in autotag.albums_in_dir(self.base):
            n = re.search(r'album(.)song', album[0].path).group(1)
            if n == '1':
                self.assertEqual(len(album), 2)
            else:
                self.assertEqual(len(album), 1)

class OrderingTest(unittest.TestCase):
    def item(self, title, track):
        return Item({
            'title': title, 'track': track,
            'mb_trackid': '', 'mb_albumid': '', 'mb_artistid': '',
        })
    
    def test_order_corrects_metadata(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('three', 2))
        items.append(self.item('two', 3))
        trackinfo = []
        trackinfo.append({'title': 'one', 'track': 1})
        trackinfo.append({'title': 'two', 'track': 2})
        trackinfo.append({'title': 'three', 'track': 3})
        ordered = autotag.order_items(items, trackinfo)
        self.assertEqual(ordered[0].title, 'one')
        self.assertEqual(ordered[1].title, 'two')
        self.assertEqual(ordered[2].title, 'three')

    def test_order_works_with_incomplete_metadata(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('three', 1))
        items.append(self.item('two', 1))
        trackinfo = []
        trackinfo.append({'title': 'one', 'track': 1})
        trackinfo.append({'title': 'two', 'track': 2})
        trackinfo.append({'title': 'three', 'track': 3})
        ordered = autotag.order_items(items, trackinfo)
        self.assertEqual(ordered[0].title, 'one')
        self.assertEqual(ordered[1].title, 'two')
        self.assertEqual(ordered[2].title, 'three')

    def test_order_returns_none_for_length_mismatch(self):
        items = []
        items.append(self.item('one', 1))
        items.append(self.item('two', 2))
        trackinfo = []
        trackinfo.append({'title': 'one', 'track': 1})
        ordered = autotag.order_items(items, trackinfo)
        self.assertEqual(ordered, None)

    def test_order_corrects_when_track_names_are_entirely_wrong(self):
        # A real-world test case contributed by a user.
        def item(i, length):
            return Item({
                'artist': 'ben harper',
                'album': 'burn to shine',
                'title': 'ben harper - Burn to Shine ' + str(i),
                'track': i,
                'length': length,
                'mb_trackid': '', 'mb_albumid': '', 'mb_artistid': '',
            })
        items = []
        items.append(item(1, 241.37243007106997))
        items.append(item(2, 342.27781704375036))
        items.append(item(3, 245.95070222338137))
        items.append(item(4, 472.87662515485437))
        items.append(item(5, 279.1759535763187))
        items.append(item(6, 270.33333768012))
        items.append(item(7, 247.83435613222923))
        items.append(item(8, 216.54504531525072))
        items.append(item(9, 225.72775379800484))
        items.append(item(10, 317.7643606963552))
        items.append(item(11, 243.57001238834192))
        items.append(item(12, 186.45916150485752))

        def info(title, length):
            return {
                'title': title,
                'length': length,
            }
        trackinfo = []
        trackinfo.append(info('Alone', 238.893))
        trackinfo.append(info('The Woman in You', 341.44))
        trackinfo.append(info('Less', 245.59999999999999))
        trackinfo.append(info('Two Hands of a Prayer', 470.49299999999999))
        trackinfo.append(info('Please Bleed', 277.86599999999999))
        trackinfo.append(info('Suzie Blue', 269.30599999999998))
        trackinfo.append(info('Steal My Kisses', 245.36000000000001))
        trackinfo.append(info('Burn to Shine', 214.90600000000001))
        trackinfo.append(info('Show Me a Little Shame', 224.09299999999999))
        trackinfo.append(info('Forgiven', 317.19999999999999))
        trackinfo.append(info('Beloved One', 243.733))
        trackinfo.append(info('In the Lord\'s Arms', 186.13300000000001))

        ordered = autotag.order_items(items, trackinfo)
        for i, item in enumerate(ordered):
            self.assertEqual(i+1, item.track)

class ApplyTest(unittest.TestCase):
    def setUp(self):
        self.items = []
        self.items.append(Item({}))
        self.items.append(Item({}))
        trackinfo = []
        trackinfo.append({
            'title': 'oneNew',
            'id':    'dfa939ec-118c-4d0f-84a0-60f3d1e6522c',
        })
        trackinfo.append({
            'title':  'twoNew',
            'id':     '40130ed1-a27c-42fd-a328-1ebefb6caef4',
        })
        self.info = {
            'tracks': trackinfo,
            'artist': 'artistNew',
            'album':  'albumNew',
            'album_id': '7edb51cb-77d6-4416-a23c-3a8c2994a2c7',
            'artist_id': 'a6623d39-2d8e-4f70-8242-0a9553b91e50',
            'albumtype': 'album',
            'va': False,
        }
    
    def test_titles_applied(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].title, 'oneNew')
        self.assertEqual(self.items[1].title, 'twoNew')
    
    def test_album_and_artist_applied_to_all(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].album, 'albumNew')
        self.assertEqual(self.items[1].album, 'albumNew')
        self.assertEqual(self.items[0].artist, 'artistNew')
        self.assertEqual(self.items[1].artist, 'artistNew')
    
    def test_track_index_applied(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].track, 1)
        self.assertEqual(self.items[1].track, 2)
    
    def test_track_total_applied(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].tracktotal, 2)
        self.assertEqual(self.items[1].tracktotal, 2)
    
    def test_mb_trackid_applied(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].mb_trackid,
                        'dfa939ec-118c-4d0f-84a0-60f3d1e6522c')
        self.assertEqual(self.items[1].mb_trackid,
                         '40130ed1-a27c-42fd-a328-1ebefb6caef4')
    
    def test_mb_albumid_and_artistid_applied(self):
        autotag.apply_metadata(self.items, self.info)
        for item in self.items:
            self.assertEqual(item.mb_albumid,
                             '7edb51cb-77d6-4416-a23c-3a8c2994a2c7')
            self.assertEqual(item.mb_artistid,
                             'a6623d39-2d8e-4f70-8242-0a9553b91e50')

    def test_albumtype_applied(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].albumtype, 'album')
        self.assertEqual(self.items[1].albumtype, 'album')

    def test_album_artist_overrides_empty_track_artist(self):
        my_info = dict(self.info)
        my_info['tracks'] = [dict(t) for t in self.info['tracks']]
        autotag.apply_metadata(self.items, my_info)
        self.assertEqual(self.items[0].artist, 'artistNew')
        self.assertEqual(self.items[0].artist, 'artistNew')

    def test_album_artist_overriden_by_nonempty_track_artist(self):
        my_info = dict(self.info)
        my_info['tracks'] = [dict(t) for t in self.info['tracks']]
        my_info['tracks'][0]['artist'] = 'artist1!'
        my_info['tracks'][1]['artist'] = 'artist2!'
        autotag.apply_metadata(self.items, my_info)
        self.assertEqual(self.items[0].artist, 'artist1!')
        self.assertEqual(self.items[1].artist, 'artist2!')

class ApplyCompilationTest(unittest.TestCase):
    def setUp(self):
        self.items = []
        self.items.append(Item({}))
        self.items.append(Item({}))
        trackinfo = []
        trackinfo.append({
            'title': 'oneNew',
            'id':    'dfa939ec-118c-4d0f-84a0-60f3d1e6522c',
            'artist': 'artistOneNew',
            'artist_id': 'a05686fc-9db2-4c23-b99e-77f5db3e5282',
        })
        trackinfo.append({
            'title':  'twoNew',
            'id':     '40130ed1-a27c-42fd-a328-1ebefb6caef4',
            'artist': 'artistTwoNew',
            'artist_id': '80b3cf5e-18fe-4c59-98c7-e5bb87210710',
        })
        self.info = {
            'tracks': trackinfo,
            'artist': 'variousNew',
            'album':  'albumNew',
            'album_id': '3b69ea40-39b8-487f-8818-04b6eff8c21a',
            'artist_id': '89ad4ac3-39f7-470e-963a-56509c546377',
            'albumtype': 'compilation',
            'va': False,
        }

    def test_album_and_track_artists_separate(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].artist, 'artistOneNew')
        self.assertEqual(self.items[1].artist, 'artistTwoNew')
        self.assertEqual(self.items[0].albumartist, 'variousNew')
        self.assertEqual(self.items[1].albumartist, 'variousNew')

    def test_mb_albumartistid_applied(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertEqual(self.items[0].mb_albumartistid, '89ad4ac3-39f7-470e-963a-56509c546377')
        self.assertEqual(self.items[1].mb_albumartistid, '89ad4ac3-39f7-470e-963a-56509c546377')
        self.assertEqual(self.items[0].mb_artistid, 'a05686fc-9db2-4c23-b99e-77f5db3e5282')
        self.assertEqual(self.items[1].mb_artistid, '80b3cf5e-18fe-4c59-98c7-e5bb87210710')

    def test_va_flag_cleared_does_not_set_comp(self):
        autotag.apply_metadata(self.items, self.info)
        self.assertFalse(self.items[0].comp)
        self.assertFalse(self.items[1].comp)

    def test_va_flag_sets_comp(self):
        va_info = dict(self.info) # make a copy
        va_info['va'] = True
        autotag.apply_metadata(self.items, va_info)
        self.assertTrue(self.items[0].comp)
        self.assertTrue(self.items[1].comp)

class StringDistanceTest(unittest.TestCase):
    def test_equal_strings(self):
        dist = autotag.string_dist('Some String', 'Some String')
        self.assertEqual(dist, 0.0)
    
    def test_different_strings(self):
        dist = autotag.string_dist('Some String', 'Totally Different')
        self.assertNotEqual(dist, 0.0)
    
    def test_punctuation_ignored(self):
        dist = autotag.string_dist('Some String', 'Some.String!')
        self.assertEqual(dist, 0.0)
    
    def test_case_ignored(self):
        dist = autotag.string_dist('Some String', 'sOME sTring')
        self.assertEqual(dist, 0.0)
    
    def test_leading_the_has_lower_weight(self):    
        dist1 = autotag.string_dist('XXX Band Name', 'Band Name')
        dist2 = autotag.string_dist('The Band Name', 'Band Name')
        self.assert_(dist2 < dist1)
    
    def test_parens_have_lower_weight(self):    
        dist1 = autotag.string_dist('One .Two.', 'One')
        dist2 = autotag.string_dist('One (Two)', 'One')
        self.assert_(dist2 < dist1)
    
    def test_brackets_have_lower_weight(self):    
        dist1 = autotag.string_dist('One .Two.', 'One')
        dist2 = autotag.string_dist('One [Two]', 'One')
        self.assert_(dist2 < dist1)
    
    def test_ep_label_has_zero_weight(self):    
        dist = autotag.string_dist('My Song (EP)', 'My Song')
        self.assertEqual(dist, 0.0)
    
    def test_featured_has_lower_weight(self):    
        dist1 = autotag.string_dist('My Song blah Someone', 'My Song')
        dist2 = autotag.string_dist('My Song feat Someone', 'My Song')
        self.assert_(dist2 < dist1)
    
    def test_postfix_the(self):    
        dist = autotag.string_dist('The Song Title', 'Song Title, The')
        self.assertEqual(dist, 0.0)
    
    def test_postfix_a(self):    
        dist = autotag.string_dist('A Song Title', 'Song Title, A')
        self.assertEqual(dist, 0.0)
    
    def test_postfix_an(self):    
        dist = autotag.string_dist('An Album Title', 'Album Title, An')
        self.assertEqual(dist, 0.0)
    
    def test_empty_strings(self):
        dist = autotag.string_dist('', '')
        self.assertEqual(dist, 0.0)
    
    def test_solo_pattern(self):
        # Just make sure these don't crash.
        autotag.string_dist('The ', '')
        autotag.string_dist('(EP)', '(EP)')
        autotag.string_dist(', An', '')

    def test_heuristic_does_not_harm_distance(self):
        dist = autotag.string_dist('Untitled', '[Untitled]')
        self.assertEqual(dist, 0.0)

def suite():
    return unittest.TestLoader().loadTestsFromName(__name__)

if __name__ == '__main__':
    unittest.main(defaultTest='suite')