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
|
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
import io
import os
import shutil
from gi.repository import GdkPixbuf
from quodlibet.util.cover.http import ApiCoverSourcePlugin
from quodlibet.util.thread import Cancellable
from tests import TestCase, mkdtemp, mkstemp, get_data_path, run_gtk_loop
from quodlibet import config
from quodlibet.plugins import Plugin
from quodlibet.formats.mp3 import MP3File
from quodlibet.formats import AudioFile, EmbeddedImage
from quodlibet.plugins.cover import CoverSourcePlugin
from quodlibet.util.cover.manager import CoverPluginHandler, CoverManager
from quodlibet.util.path import path_equal
from .helper import get_temp_copy
DUMMY_COVER = io.StringIO()
class DummyCoverSource1(CoverSourcePlugin):
@staticmethod
def priority():
return 0.95
@property
def cover(self):
DummyCoverSource1.cover_call = True
return None
class DummyCoverSource2(CoverSourcePlugin):
@staticmethod
def priority():
return 0.5
@property
def cover(self):
DummyCoverSource2.cover_call = True
return DUMMY_COVER
def fetch_cover(self):
DummyCoverSource2.fetch_call = True
return self.emit('fetch-success', self.cover)
class DummyCoverSource3(ApiCoverSourcePlugin):
@staticmethod
def priority():
return 0.3
@property
def cover(self):
DummyCoverSource3.cover_call = True
return None
def search(self):
return self.emit('search-complete', [{'cover': DUMMY_COVER}])
def fetch_cover(self):
DummyCoverSource3.fetch_call = True
return self.emit('fetch-success', DUMMY_COVER)
dummy_sources = [Plugin(s) for s in
(DummyCoverSource1, DummyCoverSource2, DummyCoverSource3)]
class TCoverManager(TestCase):
built_in_count = 2
def setUp(self):
self.manager = CoverManager()
def test_has_builtin_covers(self):
self.assertEqual(len(list(self.manager.sources)), self.built_in_count)
manager = CoverPluginHandler(use_built_in=False)
self.assertEqual(len(list(manager.sources)), 0)
def test_only_enabled(self):
for source in dummy_sources:
self.manager.plugin_handler.plugin_handle(source)
self.assertEqual(len(list(self.manager.sources)), self.built_in_count)
for source in dummy_sources:
self.manager.plugin_handler.plugin_enable(source)
self.assertEqual(len(list(self.manager.sources)),
self.built_in_count + len(dummy_sources))
for k, source in enumerate(dummy_sources):
self.manager.plugin_handler.plugin_disable(source)
self.assertEqual(len(list(self.manager.sources)),
self.built_in_count + len(dummy_sources) - k - 1)
def test_sources_sorted(self):
for source in dummy_sources:
self.manager.plugin_handler.plugin_handle(source)
self.manager.plugin_handler.plugin_enable(source)
priorities = [p.priority() for p in self.manager.sources]
self.assertSequenceEqual(priorities, sorted(priorities, reverse=True))
# Test that sources are sorted even after removing some of the sources
for source in dummy_sources:
self.manager.plugin_handler.plugin_disable(source)
ps = [p.priority() for p in self.manager.sources]
self.assertSequenceEqual(ps, sorted(ps, reverse=True))
def test_acquire_cover_sync(self):
song = AudioFile({"~filename": "/dev/null"})
manager = CoverManager(use_built_in=False)
handler = manager.plugin_handler
for source in dummy_sources:
handler.plugin_handle(source)
handler.plugin_enable(dummy_sources[0])
self.assertIs(manager.acquire_cover_sync(song), None)
handler.plugin_enable(dummy_sources[1])
self.assertIs(manager.acquire_cover_sync(song), DUMMY_COVER)
handler.plugin_enable(dummy_sources[2])
self.assertIs(manager.acquire_cover_sync(song), DUMMY_COVER)
handler.plugin_disable(dummy_sources[1])
self.assertIs(manager.acquire_cover_sync(song), None)
def test_acquire_cover(self):
manager = CoverManager(use_built_in=False)
handler = manager.plugin_handler
for source in dummy_sources:
handler.plugin_handle(source)
handler.plugin_enable(dummy_sources[0])
found = []
result = []
def done(_found, _result):
found.append(_found)
result.append(_result)
manager.acquire_cover(done, None, None)
run_gtk_loop()
self.assertFalse(found[0])
handler.plugin_enable(dummy_sources[1])
manager.acquire_cover(done, None, None)
run_gtk_loop()
self.assertTrue(found[1])
self.assertIs(result[1], DUMMY_COVER)
handler.plugin_disable(dummy_sources[1])
handler.plugin_enable(dummy_sources[2])
manager.acquire_cover(done, None, None)
run_gtk_loop()
self.assertTrue(found[2])
self.assertIs(result[2], DUMMY_COVER)
def test_acquire_cover_calls(self):
# * fetch_cover shouldn't get called if source provides the cover
# synchronously
# * First cover source should fail providing the cover both
# synchronously and asynchronously and only then the next source
# should be used
manager = CoverManager(use_built_in=False)
handler = manager.plugin_handler
found = []
result = []
for source in dummy_sources:
handler.plugin_handle(source)
handler.plugin_enable(source)
source.cls.cover_call = False
source.cls.fetch_call = False
def done(_found, _result):
found.append(_found)
result.append(_result)
manager.acquire_cover(done, None, None)
run_gtk_loop()
self.assertTrue(found[0])
self.assertIs(result[0], DUMMY_COVER)
self.assertTrue(dummy_sources[0].cls.cover_call)
self.assertTrue(dummy_sources[1].cls.cover_call)
self.assertFalse(dummy_sources[2].cls.cover_call)
self.assertFalse(dummy_sources[0].cls.fetch_call)
self.assertFalse(dummy_sources[1].cls.fetch_call)
self.assertFalse(dummy_sources[2].cls.fetch_call)
for source in dummy_sources:
source.cls.cover_call = False
source.cls.fetch_call = False
handler.plugin_disable(dummy_sources[1])
manager.acquire_cover(done, None, None)
run_gtk_loop()
self.assertTrue(found[1])
self.assertIs(result[1], DUMMY_COVER)
self.assertTrue(dummy_sources[0].cls.cover_call)
self.assertFalse(dummy_sources[1].cls.cover_call)
self.assertTrue(dummy_sources[2].cls.cover_call)
self.assertFalse(dummy_sources[0].cls.fetch_call)
self.assertFalse(dummy_sources[1].cls.fetch_call)
self.assertTrue(dummy_sources[2].cls.fetch_call)
def test_search(self):
manager = CoverManager(use_built_in=False)
handler = manager.plugin_handler
for source in dummy_sources:
handler.plugin_handle(source)
handler.plugin_enable(source)
source.cls.cover_call = False
source.cls.fetch_call = False
song = AudioFile({
"~filename": os.path.join("/tmp/asong.ogg"),
"album": "Abbey Road",
"artist": "The Beatles"
})
songs = [song]
results = []
def done(manager, provider, result):
self.failUnless(result, msg="Shouldn't succeed with no results")
results.append(result)
def finished(manager, songs):
print("Finished!")
manager.connect('covers-found', done)
manager.search_cover(Cancellable(), songs)
manager.connect('searches-complete', finished)
run_gtk_loop()
self.failUnlessEqual(len(results), 1)
def tearDown(self):
pass
class TCoverManagerBuiltin(TestCase):
def setUp(self):
config.init()
self.main = mkdtemp()
self.dir1 = mkdtemp(dir=self.main)
self.dir2 = mkdtemp(dir=self.main)
h, self.cover1 = mkstemp(".png", dir=self.main)
os.close(h)
pb = GdkPixbuf.Pixbuf.new(GdkPixbuf.Colorspace.RGB, True, 8, 10, 10)
pb.savev(self.cover1, "png", [], [])
h, self.cover2 = mkstemp(".png", dir=self.main)
os.close(h)
pb = GdkPixbuf.Pixbuf.new(GdkPixbuf.Colorspace.RGB, True, 8, 20, 20)
pb.savev(self.cover2, "png", [], [])
self.file1 = get_temp_copy(get_data_path('silence-44-s.mp3'))
self.file2 = get_temp_copy(get_data_path('silence-44-s.mp3'))
self.manager = CoverManager()
def tearDown(self):
shutil.rmtree(self.main)
config.quit()
def test_connect_cover_changed(self):
called_with = []
def sig_handler(*args):
called_with.extend(args)
obj = object()
self.manager.connect("cover-changed", sig_handler)
self.manager.cover_changed([obj])
self.assertEqual(called_with, [self.manager, [obj]])
def test_get_primary_image(self):
self.assertFalse(MP3File(self.file1).has_images)
self.assertFalse(MP3File(self.file1).has_images)
def test_manager(self):
self.assertEqual(len(list(self.manager.sources)), 2)
def test_get_cover_many_prefer_embedded(self):
# embed one cover, move one to the other dir
MP3File(self.file1).set_image(EmbeddedImage.from_path(self.cover1))
os.unlink(self.cover1)
self.external_cover = os.path.join(self.dir2, "cover.png")
shutil.move(self.cover2, self.external_cover)
# move one audio file in each dir
shutil.move(self.file1, self.dir1)
self.file1 = os.path.join(self.dir1, os.path.basename(self.file1))
shutil.move(self.file2, self.dir2)
self.file2 = os.path.join(self.dir2, os.path.basename(self.file2))
song1 = MP3File(self.file1)
song2 = MP3File(self.file2)
# each should find a cover
self.failUnless(self.is_embedded(self.manager.get_cover(song1)))
self.failIf(self.is_embedded(self.manager.get_cover(song2)))
cover_for = self.manager.get_cover_many
# both settings should search both songs before giving up
config.set("albumart", "prefer_embedded", True)
self.failUnless(self.is_embedded(cover_for([song1, song2])))
self.failUnless(self.is_embedded(cover_for([song2, song1])))
config.set("albumart", "prefer_embedded", False)
self.failIf(self.is_embedded(cover_for([song1, song2])))
self.failIf(self.is_embedded(cover_for([song2, song1])))
def is_embedded(self, fileobj):
return not path_equal(fileobj.name, self.external_cover, True)
def test_acquire_prefer_embedded(self):
# embed one cover...
MP3File(self.file1).set_image(EmbeddedImage.from_path(self.cover1))
os.unlink(self.cover1)
self.external_cover = os.path.join(self.dir1, "cover.png")
# ...and save a different cover externally
shutil.copy(self.cover2, self.external_cover)
shutil.move(self.file1, self.dir1)
self.file1 = os.path.join(self.dir1, os.path.basename(self.file1))
both_song = MP3File(self.file1)
results = []
def acquire(song):
def cb(source, result):
results.append(result)
self.manager.acquire_cover(cb, None, song)
def result_was_embedded():
return self.is_embedded(results.pop())
config.set("albumart", "prefer_embedded", True)
acquire(both_song)
self.failUnless(result_was_embedded(),
"Embedded image expected due to prefs")
config.set("albumart", "prefer_embedded", False)
acquire(both_song)
self.failIf(result_was_embedded(),
"Got an embedded image despite prefs")
|