298d825757
Reorganize leaves a cover.jpg (and other leftovers) behind when it moves an album, and the Empty Folder Cleaner is too conservative to sweep them. Two complementary fixes over one shared 'residual file' predicate (core/library/residual_files.py: junk + cover/scan images + lyric/metadata sidecars), so both features agree on what a dead folder is. 1. Reorganize (proactive): _delete_album_sidecars now sweeps ALL residual files when a source dir has no audio left — previously only a fixed list of cover NAMES, so back.jpg / disc.png / .webp survived and kept the folder un-prunable. 2. Empty Folder Cleaner (the request): new opt-in 'Remove Residual Files' setting (default off) treats a folder holding only images/sidecars/junk as removable — cleans the existing backlog + arbitrary names. Auto-renders as a UI toggle. Safe by construction: whitelist-only (a booklet.pdf / video / .txt is real content and kept), reorganize sweep gated on no-audio, cleaner re-checks at apply time. 20 new tests; 272 reorganize/repair/empty-folder green.
122 lines
5.5 KiB
Python
122 lines
5.5 KiB
Python
"""Empty Folder Cleaner (corruption's request) — pure removable decision + the
|
|
apply handler's re-check safety (never deletes a folder that gained content, the
|
|
library root, or a symlink)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
|
|
from core.repair_jobs.empty_folder_cleaner import dir_is_removable, remove_empty_folder, is_junk
|
|
|
|
|
|
# ── pure decision ───────────────────────────────────────────────────────────
|
|
def test_empty_dir_is_removable():
|
|
assert dir_is_removable([], []) is True
|
|
|
|
|
|
def test_dir_with_real_file_is_not_removable():
|
|
assert dir_is_removable(['cover.jpg'], []) is False
|
|
assert dir_is_removable(['song.flac'], []) is False
|
|
|
|
|
|
def test_dir_with_surviving_subdir_is_not_removable():
|
|
assert dir_is_removable([], ['Album']) is False
|
|
|
|
|
|
def test_junk_only_dir_removable_when_ignore_junk():
|
|
assert dir_is_removable(['.DS_Store', 'Thumbs.db'], []) is True
|
|
assert dir_is_removable(['.DS_Store'], [], ignore_junk=False) is False # strict mode keeps it
|
|
|
|
|
|
def test_junk_plus_real_file_not_removable():
|
|
assert dir_is_removable(['.DS_Store', 'cover.jpg'], []) is False
|
|
|
|
|
|
def test_is_junk():
|
|
assert is_junk('.DS_Store') and is_junk('thumbs.db') and not is_junk('cover.jpg')
|
|
|
|
|
|
# ── #891: residual (image / sidecar only) folders ───────────────────────────
|
|
def test_image_only_dir_kept_by_default_removed_with_residual_opt():
|
|
# Default (junk only): a cover.jpg keeps the folder (the conservative behavior).
|
|
assert dir_is_removable(['cover.jpg'], []) is False
|
|
# Opt-in: image/sidecar-only folders become removable.
|
|
assert dir_is_removable(['cover.jpg'], [], ignore_disposable=True) is True
|
|
assert dir_is_removable(['back.jpg', 'lyrics.lrc', '.DS_Store'], [], ignore_disposable=True) is True
|
|
assert dir_is_removable(['folder.png', 'album.nfo'], [], ignore_disposable=True) is True
|
|
|
|
|
|
def test_residual_opt_still_keeps_real_content():
|
|
# Audio, or anything not recognized as a leftover (a booklet pdf), still blocks.
|
|
assert dir_is_removable(['cover.jpg', 'song.flac'], [], ignore_disposable=True) is False
|
|
assert dir_is_removable(['cover.jpg', 'booklet.pdf'], [], ignore_disposable=True) is False
|
|
assert dir_is_removable([], ['Album'], ignore_disposable=True) is False # surviving subdir
|
|
|
|
|
|
# ── apply re-check (real FS) ────────────────────────────────────────────────
|
|
def _fx():
|
|
return dict(listdir=os.listdir, isdir=os.path.isdir, islink=os.path.islink,
|
|
remove_file=os.remove, rmdir=os.rmdir)
|
|
|
|
|
|
def test_apply_removes_truly_empty_folder(tmp_path):
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
empty = root / 'Artist' / 'Album'; empty.mkdir(parents=True)
|
|
res = remove_empty_folder(str(empty), junk_files=[], remove_junk=True, root=str(root), **_fx())
|
|
assert res['removed'] is True
|
|
assert not empty.exists()
|
|
|
|
|
|
def test_apply_deletes_junk_then_folder(tmp_path):
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
d = root / 'Empty'; d.mkdir()
|
|
(d / '.DS_Store').write_text('x')
|
|
res = remove_empty_folder(str(d), junk_files=['.DS_Store'], remove_junk=True, root=str(root), **_fx())
|
|
assert res['removed'] is True and not d.exists()
|
|
|
|
|
|
def test_apply_refuses_folder_that_gained_a_file(tmp_path):
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
d = root / 'NowFull'; d.mkdir()
|
|
(d / 'new.flac').write_text('audio') # appeared between scan and apply
|
|
res = remove_empty_folder(str(d), junk_files=[], remove_junk=True, root=str(root), **_fx())
|
|
assert res['removed'] is False and 'no longer empty' in res['error'].lower()
|
|
assert d.exists() # left untouched
|
|
|
|
|
|
def test_apply_refuses_library_root(tmp_path):
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
res = remove_empty_folder(str(root), junk_files=[], remove_junk=True, root=str(root), **_fx())
|
|
assert res['removed'] is False and 'root' in res['error'].lower()
|
|
assert root.exists()
|
|
|
|
|
|
def test_apply_sweeps_residual_then_folder_when_enabled(tmp_path):
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
d = root / 'Artist' / 'Old Album'; d.mkdir(parents=True)
|
|
(d / 'cover.jpg').write_text('img')
|
|
(d / 'back.jpg').write_text('img')
|
|
(d / 'lyrics.lrc').write_text('la')
|
|
res = remove_empty_folder(str(d), junk_files=[], remove_junk=True,
|
|
remove_disposable=True, root=str(root), **_fx())
|
|
assert res['removed'] is True and not d.exists()
|
|
|
|
|
|
def test_apply_without_residual_opt_leaves_image_folder(tmp_path):
|
|
# The default apply (no residual opt) must NOT delete a cover.jpg folder.
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
d = root / 'HasCover'; d.mkdir()
|
|
(d / 'cover.jpg').write_text('img')
|
|
res = remove_empty_folder(str(d), junk_files=[], remove_junk=True, root=str(root), **_fx())
|
|
assert res['removed'] is False and d.exists()
|
|
|
|
|
|
def test_apply_residual_opt_still_refuses_real_content(tmp_path):
|
|
root = tmp_path / 'lib'; root.mkdir()
|
|
d = root / 'Mixed'; d.mkdir()
|
|
(d / 'cover.jpg').write_text('img')
|
|
(d / 'booklet.pdf').write_text('pdf') # unrecognized → real content
|
|
res = remove_empty_folder(str(d), junk_files=[], remove_junk=True,
|
|
remove_disposable=True, root=str(root), **_fx())
|
|
assert res['removed'] is False and d.exists()
|
|
assert (d / 'booklet.pdf').exists() and (d / 'cover.jpg').exists() # nothing deleted
|