beets/test/test_playlist.py

# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Thomas Scholtes.
#
# 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.

from __future__ import division, absolute_import, print_function
from six.moves import shlex_quote

import os
import shutil
import tempfile
import unittest

from test import _common
from test import helper

import beets


class PlaylistTestHelper(helper.TestHelper):
    def setUp(self):
        self.setup_beets()
        self.lib = beets.library.Library(':memory:')

        self.music_dir = os.path.expanduser('~/Music')

        i1 = _common.item()
        i1.path = beets.util.normpath(os.path.join(
            self.music_dir,
            'a', 'b', 'c.mp3',
        ))
        i1.title = u'some item'
        i1.album = u'some album'
        self.lib.add(i1)
        self.lib.add_album([i1])

        i2 = _common.item()
        i2.path = beets.util.normpath(os.path.join(
            self.music_dir,
            'd', 'e', 'f.mp3',
        ))
        i2.title = 'another item'
        i2.album = 'another album'
        self.lib.add(i2)
        self.lib.add_album([i2])

        i3 = _common.item()
        i3.path = beets.util.normpath(os.path.join(
            self.music_dir,
            'x', 'y', 'z.mp3',
        ))
        i3.title = 'yet another item'
        i3.album = 'yet another album'
        self.lib.add(i3)
        self.lib.add_album([i3])

        self.playlist_dir = tempfile.mkdtemp()
        self.config['directory'] = self.music_dir
        self.config['playlist']['playlist_dir'] = self.playlist_dir

        self.setup_test()
        self.load_plugins('playlist')

    def setup_test(self):
        raise NotImplementedError

    def tearDown(self):
        self.unload_plugins()
        shutil.rmtree(self.playlist_dir)
        self.teardown_beets()

    def test_name_query_with_absolute_paths_in_playlist(self):
        q = u'playlist:absolute'
        results = self.lib.items(q)
        self.assertEqual(set([i.title for i in results]), set([
            u'some item',
            u'another item',
        ]))

    def test_path_query_with_absolute_paths_in_playlist(self):
        q = u'playlist:{0}'.format(shlex_quote(os.path.join(
            self.playlist_dir,
            'absolute.m3u',
        )))
        results = self.lib.items(q)
        self.assertEqual(set([i.title for i in results]), set([
            u'some item',
            u'another item',
        ]))

    def test_name_query_with_relative_paths_in_playlist(self):
        q = u'playlist:relative'
        results = self.lib.items(q)
        self.assertEqual(set([i.title for i in results]), set([
            u'some item',
            u'another item',
        ]))

    def test_path_query_with_relative_paths_in_playlist(self):
        q = u'playlist:{0}'.format(shlex_quote(os.path.join(
            self.playlist_dir,
            'relative.m3u',
        )))
        results = self.lib.items(q)
        self.assertEqual(set([i.title for i in results]), set([
            u'some item',
            u'another item',
        ]))

    def test_name_query_with_nonexisting_playlist(self):
        q = u'playlist:nonexisting'.format(self.playlist_dir)
        results = self.lib.items(q)
        self.assertEqual(set(results), set())

    def test_path_query_with_nonexisting_playlist(self):
        q = u'playlist:{0}'.format(shlex_quote(os.path.join(
            self.playlist_dir,
            self.playlist_dir,
            'nonexisting.m3u',
        )))
        results = self.lib.items(q)
        self.assertEqual(set(results), set())


class PlaylistTestRelativeToLib(PlaylistTestHelper, unittest.TestCase):
    def setup_test(self):
        with open(os.path.join(self.playlist_dir, 'absolute.m3u'), 'w') as f:
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'a', 'b', 'c.mp3')))
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'd', 'e', 'f.mp3')))
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'nonexisting.mp3')))

        with open(os.path.join(self.playlist_dir, 'relative.m3u'), 'w') as f:
            f.write('{0}\n'.format(os.path.join('a', 'b', 'c.mp3')))
            f.write('{0}\n'.format(os.path.join('d', 'e', 'f.mp3')))
            f.write('{0}\n'.format('nonexisting.mp3'))

        self.config['playlist']['relative_to'] = 'library'


class PlaylistTestRelativeToDir(PlaylistTestHelper, unittest.TestCase):
    def setup_test(self):
        with open(os.path.join(self.playlist_dir, 'absolute.m3u'), 'w') as f:
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'a', 'b', 'c.mp3')))
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'd', 'e', 'f.mp3')))
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'nonexisting.mp3')))

        with open(os.path.join(self.playlist_dir, 'relative.m3u'), 'w') as f:
            f.write('{0}\n'.format(os.path.join('a', 'b', 'c.mp3')))
            f.write('{0}\n'.format(os.path.join('d', 'e', 'f.mp3')))
            f.write('{0}\n'.format('nonexisting.mp3'))

        self.config['playlist']['relative_to'] = self.music_dir


class PlaylistTestRelativeToPls(PlaylistTestHelper, unittest.TestCase):
    def setup_test(self):
        with open(os.path.join(self.playlist_dir, 'absolute.m3u'), 'w') as f:
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'a', 'b', 'c.mp3')))
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'd', 'e', 'f.mp3')))
            f.write('{0}\n'.format(os.path.join(
                self.music_dir, 'nonexisting.mp3')))

        with open(os.path.join(self.playlist_dir, 'relative.m3u'), 'w') as f:
            f.write('{0}\n'.format(os.path.relpath(
                os.path.join(self.music_dir, 'a', 'b', 'c.mp3'),
                start=self.playlist_dir,
            )))
            f.write('{0}\n'.format(os.path.relpath(
                os.path.join(self.music_dir, 'd', 'e', 'f.mp3'),
                start=self.playlist_dir,
            )))
            f.write('{0}\n'.format(os.path.relpath(
                os.path.join(self.music_dir, 'nonexisting.mp3'),
                start=self.playlist_dir,
            )))

        self.config['playlist']['relative_to'] = 'playlist'
        self.config['playlist']['playlist_dir'] = self.playlist_dir


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

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