mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
54887e7655
Replace previous InvalidQueryError with InvalidQueryArgumentTypeError which extends the former as TypeError. However they lack context: the query that caused the error. Raise an InvalidQueryError when a shell-like expression cannot be parsed by shlex. Improve #1290.
603 lines
20 KiB
Python
603 lines
20 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.
|
|
|
|
"""Various tests for querying the library database.
|
|
"""
|
|
from __future__ import (division, absolute_import, print_function,
|
|
unicode_literals)
|
|
|
|
from test import _common
|
|
from test._common import unittest
|
|
from test import helper
|
|
|
|
import beets.library
|
|
from beets import dbcore
|
|
from beets.dbcore import types, InvalidQueryError
|
|
from beets.dbcore.query import NoneQuery, InvalidQueryArgumentTypeError
|
|
from beets.library import Library, Item
|
|
|
|
|
|
class TestHelper(helper.TestHelper):
|
|
|
|
def assertInResult(self, item, results):
|
|
result_ids = map(lambda i: i.id, results)
|
|
self.assertIn(item.id, result_ids)
|
|
|
|
def assertNotInResult(self, item, results):
|
|
result_ids = map(lambda i: i.id, results)
|
|
self.assertNotIn(item.id, result_ids)
|
|
|
|
|
|
class AnyFieldQueryTest(_common.LibTestCase):
|
|
def test_no_restriction(self):
|
|
q = dbcore.query.AnyFieldQuery(
|
|
'title', beets.library.Item._fields.keys(),
|
|
dbcore.query.SubstringQuery
|
|
)
|
|
self.assertEqual(self.lib.items(q).get().title, 'the title')
|
|
|
|
def test_restriction_completeness(self):
|
|
q = dbcore.query.AnyFieldQuery('title', ['title'],
|
|
dbcore.query.SubstringQuery)
|
|
self.assertEqual(self.lib.items(q).get().title, 'the title')
|
|
|
|
def test_restriction_soundness(self):
|
|
q = dbcore.query.AnyFieldQuery('title', ['artist'],
|
|
dbcore.query.SubstringQuery)
|
|
self.assertEqual(self.lib.items(q).get(), None)
|
|
|
|
|
|
class AssertsMixin(object):
|
|
def assert_items_matched(self, results, titles):
|
|
self.assertEqual([i.title for i in results], titles)
|
|
|
|
def assert_albums_matched(self, results, albums):
|
|
self.assertEqual([a.album for a in results], albums)
|
|
|
|
|
|
# A test case class providing a library with some dummy data and some
|
|
# assertions involving that data.
|
|
class DummyDataTestCase(_common.TestCase, AssertsMixin):
|
|
def setUp(self):
|
|
super(DummyDataTestCase, self).setUp()
|
|
self.lib = beets.library.Library(':memory:')
|
|
items = [_common.item() for _ in range(3)]
|
|
items[0].title = 'foo bar'
|
|
items[0].artist = 'one'
|
|
items[0].album = 'baz'
|
|
items[0].year = 2001
|
|
items[0].comp = True
|
|
items[1].title = 'baz qux'
|
|
items[1].artist = 'two'
|
|
items[1].album = 'baz'
|
|
items[1].year = 2002
|
|
items[1].comp = True
|
|
items[2].title = 'beets 4 eva'
|
|
items[2].artist = 'three'
|
|
items[2].album = 'foo'
|
|
items[2].year = 2003
|
|
items[2].comp = False
|
|
for item in items:
|
|
self.lib.add(item)
|
|
self.lib.add_album(items[:2])
|
|
|
|
def assert_items_matched_all(self, results):
|
|
self.assert_items_matched(results, [
|
|
'foo bar',
|
|
'baz qux',
|
|
'beets 4 eva',
|
|
])
|
|
|
|
|
|
class GetTest(DummyDataTestCase):
|
|
def test_get_empty(self):
|
|
q = ''
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched_all(results)
|
|
|
|
def test_get_none(self):
|
|
q = None
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched_all(results)
|
|
|
|
def test_get_one_keyed_term(self):
|
|
q = 'title:qux'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['baz qux'])
|
|
|
|
def test_get_one_keyed_regexp(self):
|
|
q = r'artist::t.+r'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['beets 4 eva'])
|
|
|
|
def test_get_one_unkeyed_term(self):
|
|
q = 'three'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['beets 4 eva'])
|
|
|
|
def test_get_one_unkeyed_regexp(self):
|
|
q = r':x$'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['baz qux'])
|
|
|
|
def test_get_no_matches(self):
|
|
q = 'popebear'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [])
|
|
|
|
def test_invalid_key(self):
|
|
q = 'pope:bear'
|
|
results = self.lib.items(q)
|
|
# Matches nothing since the flexattr is not present on the
|
|
# objects.
|
|
self.assert_items_matched(results, [])
|
|
|
|
def test_term_case_insensitive(self):
|
|
q = 'oNE'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['foo bar'])
|
|
|
|
def test_regexp_case_sensitive(self):
|
|
q = r':oNE'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [])
|
|
q = r':one'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['foo bar'])
|
|
|
|
def test_term_case_insensitive_with_key(self):
|
|
q = 'artist:thrEE'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['beets 4 eva'])
|
|
|
|
def test_key_case_insensitive(self):
|
|
q = 'ArTiST:three'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['beets 4 eva'])
|
|
|
|
def test_unkeyed_term_matches_multiple_columns(self):
|
|
q = 'baz'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [
|
|
'foo bar',
|
|
'baz qux',
|
|
])
|
|
|
|
def test_unkeyed_regexp_matches_multiple_columns(self):
|
|
q = r':z$'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [
|
|
'foo bar',
|
|
'baz qux',
|
|
])
|
|
|
|
def test_keyed_term_matches_only_one_column(self):
|
|
q = 'title:baz'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['baz qux'])
|
|
|
|
def test_keyed_regexp_matches_only_one_column(self):
|
|
q = r'title::baz'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [
|
|
'baz qux',
|
|
])
|
|
|
|
def test_multiple_terms_narrow_search(self):
|
|
q = 'qux baz'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [
|
|
'baz qux',
|
|
])
|
|
|
|
def test_multiple_regexps_narrow_search(self):
|
|
q = r':baz :qux'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['baz qux'])
|
|
|
|
def test_mixed_terms_regexps_narrow_search(self):
|
|
q = r':baz qux'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['baz qux'])
|
|
|
|
def test_single_year(self):
|
|
q = 'year:2001'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['foo bar'])
|
|
|
|
def test_year_range(self):
|
|
q = 'year:2000..2002'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [
|
|
'foo bar',
|
|
'baz qux',
|
|
])
|
|
|
|
def test_singleton_true(self):
|
|
q = 'singleton:true'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['beets 4 eva'])
|
|
|
|
def test_singleton_false(self):
|
|
q = 'singleton:false'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['foo bar', 'baz qux'])
|
|
|
|
def test_compilation_true(self):
|
|
q = 'comp:true'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['foo bar', 'baz qux'])
|
|
|
|
def test_compilation_false(self):
|
|
q = 'comp:false'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['beets 4 eva'])
|
|
|
|
def test_unknown_field_name_no_results(self):
|
|
q = 'xyzzy:nonsense'
|
|
results = self.lib.items(q)
|
|
titles = [i.title for i in results]
|
|
self.assertEqual(titles, [])
|
|
|
|
def test_unknown_field_name_no_results_in_album_query(self):
|
|
q = 'xyzzy:nonsense'
|
|
results = self.lib.albums(q)
|
|
names = [a.album for a in results]
|
|
self.assertEqual(names, [])
|
|
|
|
def test_item_field_name_matches_nothing_in_album_query(self):
|
|
q = 'format:nonsense'
|
|
results = self.lib.albums(q)
|
|
names = [a.album for a in results]
|
|
self.assertEqual(names, [])
|
|
|
|
def test_unicode_query(self):
|
|
item = self.lib.items().get()
|
|
item.title = u'caf\xe9'
|
|
item.store()
|
|
|
|
q = u'title:caf\xe9'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [u'caf\xe9'])
|
|
|
|
def test_numeric_search_positive(self):
|
|
q = dbcore.query.NumericQuery('year', '2001')
|
|
results = self.lib.items(q)
|
|
self.assertTrue(results)
|
|
|
|
def test_numeric_search_negative(self):
|
|
q = dbcore.query.NumericQuery('year', '1999')
|
|
results = self.lib.items(q)
|
|
self.assertFalse(results)
|
|
|
|
def test_invalid_query(self):
|
|
with self.assertRaises(InvalidQueryArgumentTypeError) as raised:
|
|
dbcore.query.NumericQuery('year', '199a')
|
|
self.assertIn('not an int', unicode(raised.exception))
|
|
|
|
with self.assertRaises(InvalidQueryArgumentTypeError) as raised:
|
|
dbcore.query.RegexpQuery('year', '199(')
|
|
self.assertIn('not a regular expression', unicode(raised.exception))
|
|
self.assertIn('unbalanced parenthesis', unicode(raised.exception))
|
|
self.assertIsInstance(raised.exception, (InvalidQueryError, TypeError))
|
|
|
|
|
|
class MatchTest(_common.TestCase):
|
|
def setUp(self):
|
|
super(MatchTest, self).setUp()
|
|
self.item = _common.item()
|
|
|
|
def test_regex_match_positive(self):
|
|
q = dbcore.query.RegexpQuery('album', '^the album$')
|
|
self.assertTrue(q.match(self.item))
|
|
|
|
def test_regex_match_negative(self):
|
|
q = dbcore.query.RegexpQuery('album', '^album$')
|
|
self.assertFalse(q.match(self.item))
|
|
|
|
def test_regex_match_non_string_value(self):
|
|
q = dbcore.query.RegexpQuery('disc', '^6$')
|
|
self.assertTrue(q.match(self.item))
|
|
|
|
def test_substring_match_positive(self):
|
|
q = dbcore.query.SubstringQuery('album', 'album')
|
|
self.assertTrue(q.match(self.item))
|
|
|
|
def test_substring_match_negative(self):
|
|
q = dbcore.query.SubstringQuery('album', 'ablum')
|
|
self.assertFalse(q.match(self.item))
|
|
|
|
def test_substring_match_non_string_value(self):
|
|
q = dbcore.query.SubstringQuery('disc', '6')
|
|
self.assertTrue(q.match(self.item))
|
|
|
|
def test_year_match_positive(self):
|
|
q = dbcore.query.NumericQuery('year', '1')
|
|
self.assertTrue(q.match(self.item))
|
|
|
|
def test_year_match_negative(self):
|
|
q = dbcore.query.NumericQuery('year', '10')
|
|
self.assertFalse(q.match(self.item))
|
|
|
|
def test_bitrate_range_positive(self):
|
|
q = dbcore.query.NumericQuery('bitrate', '100000..200000')
|
|
self.assertTrue(q.match(self.item))
|
|
|
|
def test_bitrate_range_negative(self):
|
|
q = dbcore.query.NumericQuery('bitrate', '200000..300000')
|
|
self.assertFalse(q.match(self.item))
|
|
|
|
def test_open_range(self):
|
|
dbcore.query.NumericQuery('bitrate', '100000..')
|
|
|
|
|
|
class PathQueryTest(_common.LibTestCase, TestHelper, AssertsMixin):
|
|
def setUp(self):
|
|
super(PathQueryTest, self).setUp()
|
|
self.i.path = '/a/b/c.mp3'
|
|
self.i.title = 'path item'
|
|
self.i.album = 'path album'
|
|
self.i.store()
|
|
self.lib.add_album([self.i])
|
|
|
|
def test_path_exact_match(self):
|
|
q = 'path:/a/b/c.mp3'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['path item'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, [])
|
|
|
|
def test_parent_directory_no_slash(self):
|
|
q = 'path:/a'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['path item'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['path album'])
|
|
|
|
def test_parent_directory_with_slash(self):
|
|
q = 'path:/a/'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['path item'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['path album'])
|
|
|
|
def test_no_match(self):
|
|
q = 'path:/xyzzy/'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, [])
|
|
|
|
def test_fragment_no_match(self):
|
|
q = 'path:/b/'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, [])
|
|
|
|
def test_nonnorm_path(self):
|
|
q = 'path:/x/../a/b'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['path item'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['path album'])
|
|
|
|
def test_slashed_query_matches_path(self):
|
|
q = '/a/b'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['path item'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['path album'])
|
|
|
|
def test_non_slashed_does_not_match_path(self):
|
|
q = 'c.mp3'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, [])
|
|
|
|
def test_slashes_in_explicit_field_does_not_match_path(self):
|
|
q = 'title:/a/b'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, [])
|
|
|
|
def test_path_item_regex(self):
|
|
q = 'path::\\.mp3$'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['path item'])
|
|
|
|
def test_path_album_regex(self):
|
|
q = 'path::b'
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['path album'])
|
|
|
|
def test_escape_underscore(self):
|
|
self.add_album(path='/a/_/title.mp3', title='with underscore',
|
|
album='album with underscore')
|
|
q = 'path:/a/_'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['with underscore'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['album with underscore'])
|
|
|
|
def test_escape_percent(self):
|
|
self.add_album(path='/a/%/title.mp3', title='with percent',
|
|
album='album with percent')
|
|
q = 'path:/a/%'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['with percent'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['album with percent'])
|
|
|
|
def test_escape_backslash(self):
|
|
self.add_album(path=r'/a/\x/title.mp3', title='with backslash',
|
|
album='album with backslash')
|
|
q = r'path:/a/\\x'
|
|
results = self.lib.items(q)
|
|
self.assert_items_matched(results, ['with backslash'])
|
|
|
|
results = self.lib.albums(q)
|
|
self.assert_albums_matched(results, ['album with backslash'])
|
|
|
|
|
|
class IntQueryTest(unittest.TestCase, TestHelper):
|
|
|
|
def setUp(self):
|
|
self.lib = Library(':memory:')
|
|
|
|
def tearDown(self):
|
|
Item._types = {}
|
|
|
|
def test_exact_value_match(self):
|
|
item = self.add_item(bpm=120)
|
|
matched = self.lib.items('bpm:120').get()
|
|
self.assertEqual(item.id, matched.id)
|
|
|
|
def test_range_match(self):
|
|
item = self.add_item(bpm=120)
|
|
self.add_item(bpm=130)
|
|
|
|
matched = self.lib.items('bpm:110..125')
|
|
self.assertEqual(1, len(matched))
|
|
self.assertEqual(item.id, matched.get().id)
|
|
|
|
def test_flex_range_match(self):
|
|
Item._types = {'myint': types.Integer()}
|
|
item = self.add_item(myint=2)
|
|
matched = self.lib.items('myint:2').get()
|
|
self.assertEqual(item.id, matched.id)
|
|
|
|
def test_flex_dont_match_missing(self):
|
|
Item._types = {'myint': types.Integer()}
|
|
self.add_item()
|
|
matched = self.lib.items('myint:2').get()
|
|
self.assertIsNone(matched)
|
|
|
|
def test_no_substring_match(self):
|
|
self.add_item(bpm=120)
|
|
matched = self.lib.items('bpm:12').get()
|
|
self.assertIsNone(matched)
|
|
|
|
|
|
class BoolQueryTest(unittest.TestCase, TestHelper):
|
|
|
|
def setUp(self):
|
|
self.lib = Library(':memory:')
|
|
Item._types = {'flexbool': types.Boolean()}
|
|
|
|
def tearDown(self):
|
|
Item._types = {}
|
|
|
|
def test_parse_true(self):
|
|
item_true = self.add_item(comp=True)
|
|
item_false = self.add_item(comp=False)
|
|
matched = self.lib.items('comp:true')
|
|
self.assertInResult(item_true, matched)
|
|
self.assertNotInResult(item_false, matched)
|
|
|
|
def test_flex_parse_true(self):
|
|
item_true = self.add_item(flexbool=True)
|
|
item_false = self.add_item(flexbool=False)
|
|
matched = self.lib.items('flexbool:true')
|
|
self.assertInResult(item_true, matched)
|
|
self.assertNotInResult(item_false, matched)
|
|
|
|
def test_flex_parse_false(self):
|
|
item_true = self.add_item(flexbool=True)
|
|
item_false = self.add_item(flexbool=False)
|
|
matched = self.lib.items('flexbool:false')
|
|
self.assertInResult(item_false, matched)
|
|
self.assertNotInResult(item_true, matched)
|
|
|
|
def test_flex_parse_1(self):
|
|
item_true = self.add_item(flexbool=True)
|
|
item_false = self.add_item(flexbool=False)
|
|
matched = self.lib.items('flexbool:1')
|
|
self.assertInResult(item_true, matched)
|
|
self.assertNotInResult(item_false, matched)
|
|
|
|
def test_flex_parse_0(self):
|
|
item_true = self.add_item(flexbool=True)
|
|
item_false = self.add_item(flexbool=False)
|
|
matched = self.lib.items('flexbool:0')
|
|
self.assertInResult(item_false, matched)
|
|
self.assertNotInResult(item_true, matched)
|
|
|
|
def test_flex_parse_any_string(self):
|
|
# TODO this should be the other way around
|
|
item_true = self.add_item(flexbool=True)
|
|
item_false = self.add_item(flexbool=False)
|
|
matched = self.lib.items('flexbool:something')
|
|
self.assertInResult(item_false, matched)
|
|
self.assertNotInResult(item_true, matched)
|
|
|
|
|
|
class DefaultSearchFieldsTest(DummyDataTestCase):
|
|
def test_albums_matches_album(self):
|
|
albums = list(self.lib.albums('baz'))
|
|
self.assertEqual(len(albums), 1)
|
|
|
|
def test_albums_matches_albumartist(self):
|
|
albums = list(self.lib.albums(['album artist']))
|
|
self.assertEqual(len(albums), 1)
|
|
|
|
def test_items_matches_title(self):
|
|
items = self.lib.items('beets')
|
|
self.assert_items_matched(items, ['beets 4 eva'])
|
|
|
|
def test_items_does_not_match_year(self):
|
|
items = self.lib.items('2001')
|
|
self.assert_items_matched(items, [])
|
|
|
|
|
|
class NoneQueryTest(unittest.TestCase, TestHelper):
|
|
|
|
def setUp(self):
|
|
self.lib = Library(':memory:')
|
|
|
|
def test_match_singletons(self):
|
|
singleton = self.add_item()
|
|
album_item = self.add_album().items().get()
|
|
|
|
matched = self.lib.items(NoneQuery('album_id'))
|
|
self.assertInResult(singleton, matched)
|
|
self.assertNotInResult(album_item, matched)
|
|
|
|
def test_match_after_set_none(self):
|
|
item = self.add_item(rg_track_gain=0)
|
|
matched = self.lib.items(NoneQuery('rg_track_gain'))
|
|
self.assertNotInResult(item, matched)
|
|
|
|
item['rg_track_gain'] = None
|
|
item.store()
|
|
matched = self.lib.items(NoneQuery('rg_track_gain'))
|
|
self.assertInResult(item, matched)
|
|
|
|
|
|
def suite():
|
|
return unittest.TestLoader().loadTestsFromName(__name__)
|
|
|
|
|
|
if __name__ == b'__main__':
|
|
unittest.main(defaultTest='suite')
|