mirror of
https://github.com/beetbox/beets.git
synced 2026-07-20 23:17:03 -04:00
504 lines
16 KiB
Python
504 lines
16 KiB
Python
"""Test file manipulation functionality of Item."""
|
|
|
|
import os
|
|
import shutil
|
|
import stat
|
|
import unittest
|
|
from os.path import join
|
|
from pathlib import Path
|
|
|
|
import beets.library
|
|
from beets import util
|
|
from beets.test import _common
|
|
from beets.test._common import item, touch
|
|
from beets.test.helper import NEEDS_REFLINK, BeetsTestCase
|
|
from beets.util import MoveOperation, syspath
|
|
|
|
|
|
class MoveTest(BeetsTestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
# make a temporary file
|
|
self.temp_music_file_name = "temp.mp3"
|
|
self.path = self.temp_dir_path / self.temp_music_file_name
|
|
shutil.copy(self.resource_path, self.path)
|
|
|
|
# add it to a temporary library
|
|
self.i = beets.library.Item.from_path(self.path)
|
|
self.lib.add(self.i)
|
|
|
|
# set up the destination
|
|
self.lib.path_formats = [
|
|
("default", join("$artist", "$album", "$title"))
|
|
]
|
|
self.i.artist = "one"
|
|
self.i.album = "two"
|
|
self.i.title = "three"
|
|
self.dest = self.lib_path / "one" / "two" / "three.mp3"
|
|
|
|
self.otherdir = self.temp_dir_path / "testotherdir"
|
|
|
|
def test_move_arrives(self):
|
|
self.i.move()
|
|
assert self.dest.exists()
|
|
|
|
def test_move_to_custom_dir(self):
|
|
self.i.move(basedir=os.fsencode(self.otherdir))
|
|
assert (self.otherdir / "one" / "two" / "three.mp3").exists()
|
|
|
|
def test_move_departs(self):
|
|
self.i.move()
|
|
assert not self.path.exists()
|
|
|
|
def test_move_in_lib_prunes_empty_dir(self):
|
|
self.i.move()
|
|
old_path = self.i.filepath
|
|
assert old_path.exists()
|
|
|
|
self.i.artist = "newArtist"
|
|
self.i.move()
|
|
assert not old_path.exists()
|
|
assert not old_path.parent.exists()
|
|
|
|
def test_copy_arrives(self):
|
|
self.i.move(operation=MoveOperation.COPY)
|
|
assert self.dest.exists()
|
|
|
|
def test_copy_does_not_depart(self):
|
|
self.i.move(operation=MoveOperation.COPY)
|
|
assert self.path.exists()
|
|
|
|
def test_reflink_arrives(self):
|
|
self.i.move(operation=MoveOperation.REFLINK_AUTO)
|
|
assert self.dest.exists()
|
|
|
|
def test_reflink_does_not_depart(self):
|
|
self.i.move(operation=MoveOperation.REFLINK_AUTO)
|
|
assert self.path.exists()
|
|
|
|
@NEEDS_REFLINK
|
|
def test_force_reflink_arrives(self):
|
|
self.i.move(operation=MoveOperation.REFLINK)
|
|
assert self.dest.exists()
|
|
|
|
@NEEDS_REFLINK
|
|
def test_force_reflink_does_not_depart(self):
|
|
self.i.move(operation=MoveOperation.REFLINK)
|
|
assert self.path.exists()
|
|
|
|
def test_move_changes_path(self):
|
|
self.i.move()
|
|
assert self.i.path == util.normpath(self.dest)
|
|
|
|
def test_copy_already_at_destination(self):
|
|
self.i.move()
|
|
old_path = self.i.path
|
|
self.i.move(operation=MoveOperation.COPY)
|
|
assert self.i.path == old_path
|
|
|
|
def test_move_already_at_destination(self):
|
|
self.i.move()
|
|
old_path = self.i.path
|
|
self.i.move()
|
|
assert self.i.path == old_path
|
|
|
|
def test_move_file_with_colon(self):
|
|
self.i.artist = "C:DOS"
|
|
self.i.move()
|
|
assert "C_DOS" in self.i.path.decode()
|
|
|
|
def test_move_file_with_multiple_colons(self):
|
|
# print(beets.config["replace"])
|
|
self.i.artist = "COM:DOS"
|
|
self.i.move()
|
|
assert "COM_DOS" in self.i.path.decode()
|
|
|
|
def test_move_file_with_colon_alt_separator(self):
|
|
old = beets.config["drive_sep_replace"]
|
|
beets.config["drive_sep_replace"] = "0"
|
|
self.i.artist = "C:DOS"
|
|
self.i.move()
|
|
assert "C0DOS" in self.i.path.decode()
|
|
beets.config["drive_sep_replace"] = old
|
|
|
|
def test_read_only_file_copied_writable(self):
|
|
# Make the source file read-only.
|
|
os.chmod(syspath(self.path), 0o444)
|
|
|
|
try:
|
|
self.i.move(operation=MoveOperation.COPY)
|
|
assert os.access(syspath(self.i.path), os.W_OK)
|
|
finally:
|
|
# Make everything writable so it can be cleaned up.
|
|
os.chmod(syspath(self.path), 0o777)
|
|
os.chmod(syspath(self.i.path), 0o777)
|
|
|
|
def test_move_avoids_collision_with_existing_file(self):
|
|
# Make a conflicting file at the destination.
|
|
dest = self.i.destination()
|
|
os.makedirs(syspath(os.path.dirname(dest)))
|
|
touch(dest)
|
|
|
|
self.i.move()
|
|
assert self.i.path != dest
|
|
assert os.path.dirname(self.i.path) == os.path.dirname(dest)
|
|
|
|
@unittest.skipUnless(_common.HAVE_SYMLINK, "need symlinks")
|
|
def test_link_arrives(self):
|
|
self.i.move(operation=MoveOperation.LINK)
|
|
assert self.dest.exists()
|
|
assert os.path.islink(syspath(self.dest))
|
|
assert self.dest.resolve() == self.path.resolve()
|
|
|
|
@unittest.skipUnless(_common.HAVE_SYMLINK, "need symlinks")
|
|
def test_link_does_not_depart(self):
|
|
self.i.move(operation=MoveOperation.LINK)
|
|
assert self.path.exists()
|
|
|
|
@unittest.skipUnless(_common.HAVE_SYMLINK, "need symlinks")
|
|
def test_link_changes_path(self):
|
|
self.i.move(operation=MoveOperation.LINK)
|
|
assert self.i.path == util.normpath(self.dest)
|
|
|
|
@unittest.skipUnless(_common.HAVE_HARDLINK, "need hardlinks")
|
|
def test_hardlink_arrives(self):
|
|
self.i.move(operation=MoveOperation.HARDLINK)
|
|
assert self.dest.exists()
|
|
s1 = os.stat(syspath(self.path))
|
|
s2 = os.stat(syspath(self.dest))
|
|
assert (s1[stat.ST_INO], s1[stat.ST_DEV]) == (
|
|
s2[stat.ST_INO],
|
|
s2[stat.ST_DEV],
|
|
)
|
|
|
|
@unittest.skipUnless(_common.HAVE_HARDLINK, "need hardlinks")
|
|
def test_hardlink_does_not_depart(self):
|
|
self.i.move(operation=MoveOperation.HARDLINK)
|
|
assert self.path.exists()
|
|
|
|
@unittest.skipUnless(_common.HAVE_HARDLINK, "need hardlinks")
|
|
def test_hardlink_changes_path(self):
|
|
self.i.move(operation=MoveOperation.HARDLINK)
|
|
assert self.i.path == util.normpath(self.dest)
|
|
|
|
@unittest.skipUnless(_common.HAVE_HARDLINK, "need hardlinks")
|
|
def test_hardlink_from_symlink(self):
|
|
link_path = join(self.temp_dir, b"temp_link.mp3")
|
|
link_source = join("./", self.temp_music_file_name)
|
|
os.symlink(syspath(link_source), syspath(link_path))
|
|
self.i.path = link_path
|
|
self.i.move(operation=MoveOperation.HARDLINK)
|
|
|
|
s1 = os.stat(syspath(self.path))
|
|
s2 = os.stat(syspath(self.dest))
|
|
assert (s1[stat.ST_INO], s1[stat.ST_DEV]) == (
|
|
s2[stat.ST_INO],
|
|
s2[stat.ST_DEV],
|
|
)
|
|
|
|
|
|
class AlbumFileTest(BeetsTestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
# Make library and item.
|
|
self.lib.path_formats = [
|
|
("default", join("$albumartist", "$album", "$title"))
|
|
]
|
|
self.i = item(self.lib)
|
|
# Make a file for the item.
|
|
self.i.path = self.i.destination()
|
|
util.mkdirall(self.i.path)
|
|
touch(self.i.path)
|
|
# Make an album.
|
|
self.ai = self.lib.add_album((self.i,))
|
|
# Alternate destination dir.
|
|
self.otherdir = os.path.join(self.temp_dir, b"testotherdir")
|
|
|
|
def test_albuminfo_move_changes_paths(self):
|
|
self.ai.album = "newAlbumName"
|
|
self.ai.move()
|
|
self.ai.store()
|
|
self.i.load()
|
|
|
|
assert b"newAlbumName" in self.i.path
|
|
|
|
def test_albuminfo_move_moves_file(self):
|
|
oldpath = self.i.filepath
|
|
self.ai.album = "newAlbumName"
|
|
self.ai.move()
|
|
self.ai.store()
|
|
self.i.load()
|
|
|
|
assert not oldpath.exists()
|
|
assert self.i.filepath.exists()
|
|
|
|
def test_albuminfo_move_copies_file(self):
|
|
oldpath = self.i.filepath
|
|
self.ai.album = "newAlbumName"
|
|
self.ai.move(operation=MoveOperation.COPY)
|
|
self.ai.store()
|
|
self.i.load()
|
|
|
|
assert oldpath.exists()
|
|
assert self.i.filepath.exists()
|
|
|
|
@NEEDS_REFLINK
|
|
def test_albuminfo_move_reflinks_file(self):
|
|
oldpath = self.i.path
|
|
self.ai.album = "newAlbumName"
|
|
self.ai.move(operation=MoveOperation.REFLINK)
|
|
self.ai.store()
|
|
self.i.load()
|
|
|
|
assert os.path.exists(oldpath)
|
|
assert os.path.exists(self.i.path)
|
|
|
|
def test_albuminfo_move_to_custom_dir(self):
|
|
self.ai.move(basedir=self.otherdir)
|
|
self.i.load()
|
|
self.ai.store()
|
|
assert b"testotherdir" in self.i.path
|
|
|
|
|
|
class ArtFileTest(BeetsTestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
# Make library and item.
|
|
self.i = item(self.lib)
|
|
self.i.path = self.i.destination()
|
|
# Make a music file.
|
|
util.mkdirall(self.i.path)
|
|
touch(self.i.path)
|
|
# Make an album.
|
|
self.ai = self.lib.add_album((self.i,))
|
|
# Make an art file too.
|
|
art_bytes = self.lib.get_album(self.i).art_destination("something.jpg")
|
|
self.art = Path(os.fsdecode(art_bytes))
|
|
self.art.touch()
|
|
self.ai.artpath = art_bytes
|
|
self.ai.store()
|
|
# Alternate destination dir.
|
|
self.otherdir = os.path.join(self.temp_dir, b"testotherdir")
|
|
|
|
def test_art_deleted_when_items_deleted(self):
|
|
assert self.art.exists()
|
|
self.ai.remove(True)
|
|
assert not self.art.exists()
|
|
|
|
def test_art_moves_with_album(self):
|
|
assert self.art.exists()
|
|
oldpath = self.i.path
|
|
self.ai.album = "newAlbum"
|
|
self.ai.move()
|
|
self.i.load()
|
|
|
|
assert self.i.path != oldpath
|
|
assert not self.art.exists()
|
|
newart = self.lib.get_album(self.i).art_destination(self.art)
|
|
assert Path(os.fsdecode(newart)).exists()
|
|
|
|
def test_art_moves_with_album_to_custom_dir(self):
|
|
# Move the album to another directory.
|
|
self.ai.move(basedir=self.otherdir)
|
|
self.ai.store()
|
|
self.i.load()
|
|
|
|
# Art should be in new directory.
|
|
assert not self.art.exists()
|
|
newart = self.lib.get_album(self.i).art_filepath
|
|
assert newart.exists()
|
|
assert "testotherdir" in str(newart)
|
|
|
|
def test_setart_copies_image(self):
|
|
util.remove(self.art)
|
|
|
|
newart = os.path.join(self.libdir, b"newart.jpg")
|
|
touch(newart)
|
|
i2 = item()
|
|
i2.path = self.i.path
|
|
i2.artist = "someArtist"
|
|
ai = self.lib.add_album((i2,))
|
|
i2.move(operation=MoveOperation.COPY)
|
|
|
|
assert ai.artpath is None
|
|
ai.set_art(newart)
|
|
assert ai.art_filepath.exists()
|
|
|
|
def test_setart_to_existing_art_works(self):
|
|
util.remove(self.art)
|
|
|
|
# Original art.
|
|
newart = os.path.join(self.libdir, b"newart.jpg")
|
|
touch(newart)
|
|
i2 = item()
|
|
i2.path = self.i.path
|
|
i2.artist = "someArtist"
|
|
ai = self.lib.add_album((i2,))
|
|
i2.move(operation=MoveOperation.COPY)
|
|
ai.set_art(newart)
|
|
|
|
# Set the art again.
|
|
ai.set_art(ai.artpath)
|
|
assert ai.art_filepath.exists()
|
|
|
|
def test_setart_to_existing_but_unset_art_works(self):
|
|
newart = os.path.join(self.libdir, b"newart.jpg")
|
|
touch(newart)
|
|
i2 = item()
|
|
i2.path = self.i.path
|
|
i2.artist = "someArtist"
|
|
ai = self.lib.add_album((i2,))
|
|
i2.move(operation=MoveOperation.COPY)
|
|
|
|
# Copy the art to the destination.
|
|
artdest = ai.art_destination(newart)
|
|
shutil.copy(syspath(newart), syspath(artdest))
|
|
|
|
# Set the art again.
|
|
ai.set_art(artdest)
|
|
assert ai.art_filepath.exists()
|
|
|
|
def test_setart_to_conflicting_file_replaces_it(self):
|
|
newart = os.path.join(self.libdir, b"newart.jpg")
|
|
touch(newart)
|
|
i2 = item()
|
|
i2.path = self.i.path
|
|
i2.artist = "someArtist"
|
|
ai = self.lib.add_album((i2,))
|
|
i2.move(operation=MoveOperation.COPY)
|
|
|
|
# Make a file at the destination.
|
|
artdest = ai.art_destination(newart)
|
|
touch(artdest)
|
|
|
|
# Set the art - should replace the existing file, not create a suffixed
|
|
# duplicate like cover.2.jpg.
|
|
ai.set_art(newart)
|
|
assert artdest == ai.artpath
|
|
|
|
def test_setart_replaces_old_art_at_different_path(self):
|
|
newart = os.path.join(self.libdir, b"newart.png")
|
|
touch(newart)
|
|
i2 = item()
|
|
i2.path = self.i.path
|
|
i2.artist = "someArtist"
|
|
ai = self.lib.add_album((i2,))
|
|
i2.move(operation=MoveOperation.COPY)
|
|
|
|
# Set initial art.
|
|
ai.set_art(newart)
|
|
old_artpath = ai.artpath
|
|
assert os.path.exists(syspath(old_artpath))
|
|
|
|
# Set new art with a different extension.
|
|
another_art = os.path.join(self.libdir, b"another.jpg")
|
|
touch(another_art)
|
|
ai.set_art(another_art)
|
|
|
|
# Old art should be removed.
|
|
assert not os.path.exists(syspath(old_artpath))
|
|
assert ai.art_filepath.exists()
|
|
|
|
def test_setart_sets_permissions(self):
|
|
util.remove(self.art)
|
|
|
|
newart = os.path.join(self.libdir, b"newart.jpg")
|
|
touch(newart)
|
|
os.chmod(syspath(newart), 0o400) # read-only
|
|
|
|
try:
|
|
i2 = item()
|
|
i2.path = self.i.path
|
|
i2.artist = "someArtist"
|
|
ai = self.lib.add_album((i2,))
|
|
i2.move(operation=MoveOperation.COPY)
|
|
ai.set_art(newart)
|
|
|
|
mode = stat.S_IMODE(os.stat(syspath(ai.artpath)).st_mode)
|
|
assert mode & stat.S_IRGRP
|
|
assert os.access(syspath(ai.artpath), os.W_OK)
|
|
|
|
finally:
|
|
# Make everything writable so it can be cleaned up.
|
|
os.chmod(syspath(newart), 0o777)
|
|
os.chmod(syspath(ai.artpath), 0o777)
|
|
|
|
def test_move_last_file_moves_albumart(self):
|
|
oldartpath = self.lib.albums()[0].art_filepath
|
|
assert oldartpath.exists()
|
|
|
|
self.ai.album = "different_album"
|
|
self.ai.store()
|
|
self.ai.items()[0].move()
|
|
|
|
artpath = self.lib.albums()[0].art_filepath
|
|
assert "different_album" in str(artpath)
|
|
assert artpath.exists()
|
|
assert not oldartpath.exists()
|
|
|
|
def test_move_not_last_file_does_not_move_albumart(self):
|
|
i2 = item()
|
|
i2.albumid = self.ai.id
|
|
self.lib.add(i2)
|
|
|
|
oldartpath = self.lib.albums()[0].art_filepath
|
|
assert oldartpath.exists()
|
|
|
|
self.i.album = "different_album"
|
|
self.i.album_id = None # detach from album
|
|
self.i.move()
|
|
|
|
artpath = self.lib.albums()[0].art_filepath
|
|
assert "different_album" not in str(artpath)
|
|
assert artpath == oldartpath
|
|
assert oldartpath.exists()
|
|
|
|
|
|
class RemoveTest(BeetsTestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
# Make library and item.
|
|
self.i = item(self.lib)
|
|
self.i.path = self.i.destination()
|
|
# Make a music file.
|
|
util.mkdirall(self.i.path)
|
|
touch(self.i.path)
|
|
# Make an album with the item.
|
|
self.ai = self.lib.add_album((self.i,))
|
|
|
|
def test_removing_last_item_prunes_empty_dir(self):
|
|
assert self.i.filepath.parent.exists()
|
|
self.i.remove(True)
|
|
assert not self.i.filepath.parent.exists()
|
|
|
|
def test_removing_last_item_preserves_nonempty_dir(self):
|
|
(self.i.filepath.parent / "dummy.txt").touch()
|
|
self.i.remove(True)
|
|
assert self.i.filepath.parent.exists()
|
|
|
|
def test_removing_last_item_prunes_dir_with_blacklisted_file(self):
|
|
(self.i.filepath.parent / ".DS_Store").touch()
|
|
self.i.remove(True)
|
|
assert not self.i.filepath.parent.exists()
|
|
|
|
def test_removing_without_delete_leaves_file(self):
|
|
self.i.remove(False)
|
|
assert self.i.filepath.parent.exists()
|
|
|
|
def test_removing_last_item_preserves_library_dir(self):
|
|
self.i.remove(True)
|
|
assert self.lib_path.exists()
|
|
|
|
def test_removing_last_item_in_album_with_albumart_prunes_dir(self):
|
|
artfile = os.path.join(self.temp_dir, b"testart.jpg")
|
|
touch(artfile)
|
|
self.ai.set_art(artfile)
|
|
self.ai.store()
|
|
|
|
self.i.remove(True)
|
|
assert not self.i.filepath.parent.exists()
|