beets/test/test_sort.py
Adrian Sampson a88682e7bb Undo from _common import unittest indirection
This was a vestige from when we used to need the unittest2 library for pre-2.7
compatibility. Now that we require Python 2.7, we aren't using that library
and this indirection wasn't doing any good.
2016-11-26 18:46:44 -05:00

540 lines
20 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.
"""Various tests for querying the library database.
"""
from __future__ import division, absolute_import, print_function
import unittest
from test import _common
import beets.library
from beets import dbcore
from beets import config
# A test case class providing a library with some dummy data and some
# assertions involving that data.
class DummyDataTestCase(_common.TestCase):
def setUp(self):
super(DummyDataTestCase, self).setUp()
self.lib = beets.library.Library(':memory:')
albums = [_common.album() for _ in range(3)]
albums[0].album = u"Album A"
albums[0].genre = u"Rock"
albums[0].year = 2001
albums[0].flex1 = u"Flex1-1"
albums[0].flex2 = u"Flex2-A"
albums[0].albumartist = u"Foo"
albums[0].albumartist_sort = None
albums[1].album = u"Album B"
albums[1].genre = u"Rock"
albums[1].year = 2001
albums[1].flex1 = u"Flex1-2"
albums[1].flex2 = u"Flex2-A"
albums[1].albumartist = u"Bar"
albums[1].albumartist_sort = None
albums[2].album = u"Album C"
albums[2].genre = u"Jazz"
albums[2].year = 2005
albums[2].flex1 = u"Flex1-1"
albums[2].flex2 = u"Flex2-B"
albums[2].albumartist = u"Baz"
albums[2].albumartist_sort = None
for album in albums:
self.lib.add(album)
items = [_common.item() for _ in range(4)]
items[0].title = u'Foo bar'
items[0].artist = u'One'
items[0].album = u'Baz'
items[0].year = 2001
items[0].comp = True
items[0].flex1 = u"Flex1-0"
items[0].flex2 = u"Flex2-A"
items[0].album_id = albums[0].id
items[0].artist_sort = None
items[0].path = "/path0.mp3"
items[0].track = 1
items[1].title = u'Baz qux'
items[1].artist = u'Two'
items[1].album = u'Baz'
items[1].year = 2002
items[1].comp = True
items[1].flex1 = u"Flex1-1"
items[1].flex2 = u"Flex2-A"
items[1].album_id = albums[0].id
items[1].artist_sort = None
items[1].path = "/patH1.mp3"
items[1].track = 2
items[2].title = u'Beets 4 eva'
items[2].artist = u'Three'
items[2].album = u'Foo'
items[2].year = 2003
items[2].comp = False
items[2].flex1 = u"Flex1-2"
items[2].flex2 = u"Flex1-B"
items[2].album_id = albums[1].id
items[2].artist_sort = None
items[2].path = "/paTH2.mp3"
items[2].track = 3
items[3].title = u'Beets 4 eva'
items[3].artist = u'Three'
items[3].album = u'Foo2'
items[3].year = 2004
items[3].comp = False
items[3].flex1 = u"Flex1-2"
items[3].flex2 = u"Flex1-C"
items[3].album_id = albums[2].id
items[3].artist_sort = None
items[3].path = "/PATH3.mp3"
items[3].track = 4
for item in items:
self.lib.add(item)
class SortFixedFieldTest(DummyDataTestCase):
def test_sort_asc(self):
q = u''
sort = dbcore.query.FixedFieldSort(u"year", True)
results = self.lib.items(q, sort)
self.assertLessEqual(results[0]['year'], results[1]['year'])
self.assertEqual(results[0]['year'], 2001)
# same thing with query string
q = u'year+'
results2 = self.lib.items(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_desc(self):
q = u''
sort = dbcore.query.FixedFieldSort(u"year", False)
results = self.lib.items(q, sort)
self.assertGreaterEqual(results[0]['year'], results[1]['year'])
self.assertEqual(results[0]['year'], 2004)
# same thing with query string
q = u'year-'
results2 = self.lib.items(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_two_field_asc(self):
q = u''
s1 = dbcore.query.FixedFieldSort(u"album", True)
s2 = dbcore.query.FixedFieldSort(u"year", True)
sort = dbcore.query.MultipleSort()
sort.add_sort(s1)
sort.add_sort(s2)
results = self.lib.items(q, sort)
self.assertLessEqual(results[0]['album'], results[1]['album'])
self.assertLessEqual(results[1]['album'], results[2]['album'])
self.assertEqual(results[0]['album'], u'Baz')
self.assertEqual(results[1]['album'], u'Baz')
self.assertLessEqual(results[0]['year'], results[1]['year'])
# same thing with query string
q = u'album+ year+'
results2 = self.lib.items(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_path_field(self):
q = u''
sort = dbcore.query.FixedFieldSort('path', True)
results = self.lib.items(q, sort)
self.assertEqual(results[0]['path'], b'/path0.mp3')
self.assertEqual(results[1]['path'], b'/patH1.mp3')
self.assertEqual(results[2]['path'], b'/paTH2.mp3')
self.assertEqual(results[3]['path'], b'/PATH3.mp3')
class SortFlexFieldTest(DummyDataTestCase):
def test_sort_asc(self):
q = u''
sort = dbcore.query.SlowFieldSort(u"flex1", True)
results = self.lib.items(q, sort)
self.assertLessEqual(results[0]['flex1'], results[1]['flex1'])
self.assertEqual(results[0]['flex1'], u'Flex1-0')
# same thing with query string
q = u'flex1+'
results2 = self.lib.items(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_desc(self):
q = u''
sort = dbcore.query.SlowFieldSort(u"flex1", False)
results = self.lib.items(q, sort)
self.assertGreaterEqual(results[0]['flex1'], results[1]['flex1'])
self.assertGreaterEqual(results[1]['flex1'], results[2]['flex1'])
self.assertGreaterEqual(results[2]['flex1'], results[3]['flex1'])
self.assertEqual(results[0]['flex1'], u'Flex1-2')
# same thing with query string
q = u'flex1-'
results2 = self.lib.items(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_two_field(self):
q = u''
s1 = dbcore.query.SlowFieldSort(u"flex2", False)
s2 = dbcore.query.SlowFieldSort(u"flex1", True)
sort = dbcore.query.MultipleSort()
sort.add_sort(s1)
sort.add_sort(s2)
results = self.lib.items(q, sort)
self.assertGreaterEqual(results[0]['flex2'], results[1]['flex2'])
self.assertGreaterEqual(results[1]['flex2'], results[2]['flex2'])
self.assertEqual(results[0]['flex2'], u'Flex2-A')
self.assertEqual(results[1]['flex2'], u'Flex2-A')
self.assertLessEqual(results[0]['flex1'], results[1]['flex1'])
# same thing with query string
q = u'flex2- flex1+'
results2 = self.lib.items(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
class SortAlbumFixedFieldTest(DummyDataTestCase):
def test_sort_asc(self):
q = u''
sort = dbcore.query.FixedFieldSort(u"year", True)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['year'], results[1]['year'])
self.assertEqual(results[0]['year'], 2001)
# same thing with query string
q = u'year+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_desc(self):
q = u''
sort = dbcore.query.FixedFieldSort(u"year", False)
results = self.lib.albums(q, sort)
self.assertGreaterEqual(results[0]['year'], results[1]['year'])
self.assertEqual(results[0]['year'], 2005)
# same thing with query string
q = u'year-'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_two_field_asc(self):
q = u''
s1 = dbcore.query.FixedFieldSort(u"genre", True)
s2 = dbcore.query.FixedFieldSort(u"album", True)
sort = dbcore.query.MultipleSort()
sort.add_sort(s1)
sort.add_sort(s2)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['genre'], results[1]['genre'])
self.assertLessEqual(results[1]['genre'], results[2]['genre'])
self.assertEqual(results[1]['genre'], u'Rock')
self.assertEqual(results[2]['genre'], u'Rock')
self.assertLessEqual(results[1]['album'], results[2]['album'])
# same thing with query string
q = u'genre+ album+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
class SortAlbumFlexFieldTest(DummyDataTestCase):
def test_sort_asc(self):
q = u''
sort = dbcore.query.SlowFieldSort(u"flex1", True)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['flex1'], results[1]['flex1'])
self.assertLessEqual(results[1]['flex1'], results[2]['flex1'])
# same thing with query string
q = u'flex1+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_desc(self):
q = u''
sort = dbcore.query.SlowFieldSort(u"flex1", False)
results = self.lib.albums(q, sort)
self.assertGreaterEqual(results[0]['flex1'], results[1]['flex1'])
self.assertGreaterEqual(results[1]['flex1'], results[2]['flex1'])
# same thing with query string
q = u'flex1-'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_two_field_asc(self):
q = u''
s1 = dbcore.query.SlowFieldSort(u"flex2", True)
s2 = dbcore.query.SlowFieldSort(u"flex1", True)
sort = dbcore.query.MultipleSort()
sort.add_sort(s1)
sort.add_sort(s2)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['flex2'], results[1]['flex2'])
self.assertLessEqual(results[1]['flex2'], results[2]['flex2'])
self.assertEqual(results[0]['flex2'], u'Flex2-A')
self.assertEqual(results[1]['flex2'], u'Flex2-A')
self.assertLessEqual(results[0]['flex1'], results[1]['flex1'])
# same thing with query string
q = u'flex2+ flex1+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
class SortAlbumComputedFieldTest(DummyDataTestCase):
def test_sort_asc(self):
q = u''
sort = dbcore.query.SlowFieldSort(u"path", True)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['path'], results[1]['path'])
self.assertLessEqual(results[1]['path'], results[2]['path'])
# same thing with query string
q = u'path+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_sort_desc(self):
q = u''
sort = dbcore.query.SlowFieldSort(u"path", False)
results = self.lib.albums(q, sort)
self.assertGreaterEqual(results[0]['path'], results[1]['path'])
self.assertGreaterEqual(results[1]['path'], results[2]['path'])
# same thing with query string
q = u'path-'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
class SortCombinedFieldTest(DummyDataTestCase):
def test_computed_first(self):
q = u''
s1 = dbcore.query.SlowFieldSort(u"path", True)
s2 = dbcore.query.FixedFieldSort(u"year", True)
sort = dbcore.query.MultipleSort()
sort.add_sort(s1)
sort.add_sort(s2)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['path'], results[1]['path'])
self.assertLessEqual(results[1]['path'], results[2]['path'])
q = u'path+ year+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
def test_computed_second(self):
q = u''
s1 = dbcore.query.FixedFieldSort(u"year", True)
s2 = dbcore.query.SlowFieldSort(u"path", True)
sort = dbcore.query.MultipleSort()
sort.add_sort(s1)
sort.add_sort(s2)
results = self.lib.albums(q, sort)
self.assertLessEqual(results[0]['year'], results[1]['year'])
self.assertLessEqual(results[1]['year'], results[2]['year'])
self.assertLessEqual(results[0]['path'], results[1]['path'])
q = u'year+ path+'
results2 = self.lib.albums(q)
for r1, r2 in zip(results, results2):
self.assertEqual(r1.id, r2.id)
class ConfigSortTest(DummyDataTestCase):
def test_default_sort_item(self):
results = list(self.lib.items())
self.assertLess(results[0].artist, results[1].artist)
def test_config_opposite_sort_item(self):
config['sort_item'] = 'artist-'
results = list(self.lib.items())
self.assertGreater(results[0].artist, results[1].artist)
def test_default_sort_album(self):
results = list(self.lib.albums())
self.assertLess(results[0].albumartist, results[1].albumartist)
def test_config_opposite_sort_album(self):
config['sort_album'] = 'albumartist-'
results = list(self.lib.albums())
self.assertGreater(results[0].albumartist, results[1].albumartist)
class CaseSensitivityTest(DummyDataTestCase, _common.TestCase):
"""If case_insensitive is false, lower-case values should be placed
after all upper-case values. E.g., `Foo Qux bar`
"""
def setUp(self):
super(CaseSensitivityTest, self).setUp()
album = _common.album()
album.album = u"album"
album.genre = u"alternative"
album.year = u"2001"
album.flex1 = u"flex1"
album.flex2 = u"flex2-A"
album.albumartist = u"bar"
album.albumartist_sort = None
self.lib.add(album)
item = _common.item()
item.title = u'another'
item.artist = u'lowercase'
item.album = u'album'
item.year = 2001
item.comp = True
item.flex1 = u"flex1"
item.flex2 = u"flex2-A"
item.album_id = album.id
item.artist_sort = None
item.track = 10
self.lib.add(item)
self.new_album = album
self.new_item = item
def tearDown(self):
self.new_item.remove(delete=True)
self.new_album.remove(delete=True)
super(CaseSensitivityTest, self).tearDown()
def test_smart_artist_case_insensitive(self):
config['sort_case_insensitive'] = True
q = u'artist+'
results = list(self.lib.items(q))
self.assertEqual(results[0].artist, u'lowercase')
self.assertEqual(results[1].artist, u'One')
def test_smart_artist_case_sensitive(self):
config['sort_case_insensitive'] = False
q = u'artist+'
results = list(self.lib.items(q))
self.assertEqual(results[0].artist, u'One')
self.assertEqual(results[-1].artist, u'lowercase')
def test_fixed_field_case_insensitive(self):
config['sort_case_insensitive'] = True
q = u'album+'
results = list(self.lib.albums(q))
self.assertEqual(results[0].album, u'album')
self.assertEqual(results[1].album, u'Album A')
def test_fixed_field_case_sensitive(self):
config['sort_case_insensitive'] = False
q = u'album+'
results = list(self.lib.albums(q))
self.assertEqual(results[0].album, u'Album A')
self.assertEqual(results[-1].album, u'album')
def test_flex_field_case_insensitive(self):
config['sort_case_insensitive'] = True
q = u'flex1+'
results = list(self.lib.items(q))
self.assertEqual(results[0].flex1, u'flex1')
self.assertEqual(results[1].flex1, u'Flex1-0')
def test_flex_field_case_sensitive(self):
config['sort_case_insensitive'] = False
q = u'flex1+'
results = list(self.lib.items(q))
self.assertEqual(results[0].flex1, u'Flex1-0')
self.assertEqual(results[-1].flex1, u'flex1')
def test_case_sensitive_only_affects_text(self):
config['sort_case_insensitive'] = True
q = u'track+'
results = list(self.lib.items(q))
# If the numerical values were sorted as strings,
# then ['1', '10', '2'] would be valid.
print([r.track for r in results])
self.assertEqual(results[0].track, 1)
self.assertEqual(results[1].track, 2)
self.assertEqual(results[-1].track, 10)
class NonExistingFieldTest(DummyDataTestCase):
"""Test sorting by non-existing fields"""
def test_non_existing_fields_not_fail(self):
qs = [u'foo+', u'foo-', u'--', u'-+', u'+-',
u'++', u'-foo-', u'-foo+', u'---']
q0 = u'foo+'
results0 = list(self.lib.items(q0))
for q1 in qs:
results1 = list(self.lib.items(q1))
for r1, r2 in zip(results0, results1):
self.assertEqual(r1.id, r2.id)
def test_combined_non_existing_field_asc(self):
all_results = list(self.lib.items(u'id+'))
q = u'foo+ id+'
results = list(self.lib.items(q))
self.assertEqual(len(all_results), len(results))
for r1, r2 in zip(all_results, results):
self.assertEqual(r1.id, r2.id)
def test_combined_non_existing_field_desc(self):
all_results = list(self.lib.items(u'id+'))
q = u'foo- id+'
results = list(self.lib.items(q))
self.assertEqual(len(all_results), len(results))
for r1, r2 in zip(all_results, results):
self.assertEqual(r1.id, r2.id)
def test_field_present_in_some_items(self):
"""Test ordering by a field not present on all items."""
# append 'foo' to two to items (1,2)
items = self.lib.items(u'id+')
ids = [i.id for i in items]
items[1].foo = u'bar1'
items[2].foo = u'bar2'
items[1].store()
items[2].store()
results_asc = list(self.lib.items(u'foo+ id+'))
self.assertEqual([i.id for i in results_asc],
# items without field first
[ids[0], ids[3], ids[1], ids[2]])
results_desc = list(self.lib.items(u'foo- id+'))
self.assertEqual([i.id for i in results_desc],
# items without field last
[ids[2], ids[1], ids[0], ids[3]])
def test_negation_interaction(self):
"""Test the handling of negation and sorting together.
If a string ends with a sorting suffix, it takes precedence over the
NotQuery parsing.
"""
query, sort = beets.library.parse_query_string(u'-bar+',
beets.library.Item)
self.assertEqual(len(query.subqueries), 1)
self.assertTrue(isinstance(query.subqueries[0],
dbcore.query.TrueQuery))
self.assertTrue(isinstance(sort, dbcore.query.SlowFieldSort))
self.assertEqual(sort.field, u'-bar')
def suite():
return unittest.TestLoader().loadTestsFromName(__name__)
if __name__ == '__main__':
unittest.main(defaultTest='suite')