|
| 1 | +"""Tests for delete_orphaned functionality.""" |
| 2 | + |
| 3 | +import logging |
| 4 | +import os |
| 5 | +import sqlite3 |
| 6 | +import tempfile |
| 7 | +from unittest.mock import MagicMock |
| 8 | + |
| 9 | +import pytest |
| 10 | + |
| 11 | +from icloudpd.base import delete_orphaned |
| 12 | +from icloudpd.manifest import ManifestDB |
| 13 | + |
| 14 | + |
| 15 | +def _setup_manifest_with_files( |
| 16 | + tmpdir: str, |
| 17 | + entries: list[dict[str, str]], |
| 18 | +) -> ManifestDB: |
| 19 | + """Create a manifest DB with entries and corresponding files on disk.""" |
| 20 | + manifest = ManifestDB(tmpdir) |
| 21 | + manifest.open() |
| 22 | + for entry in entries: |
| 23 | + asset_id = entry["asset_id"] |
| 24 | + zone_id = entry.get("zone_id", "PrimarySync") |
| 25 | + local_path = entry["local_path"] |
| 26 | + asset_resource = entry.get("asset_resource", "resOriginal") |
| 27 | + # Create the file on disk |
| 28 | + full_path = os.path.join(tmpdir, local_path) |
| 29 | + os.makedirs(os.path.dirname(full_path), exist_ok=True) |
| 30 | + with open(full_path, "w") as f: |
| 31 | + f.write("test content") |
| 32 | + # Create XMP sidecar |
| 33 | + with open(full_path + ".xmp", "w") as f: |
| 34 | + f.write("<xmp>test</xmp>") |
| 35 | + # Add to manifest |
| 36 | + manifest.upsert( |
| 37 | + asset_id=asset_id, |
| 38 | + zone_id=zone_id, |
| 39 | + local_path=local_path, |
| 40 | + version_size=1, |
| 41 | + asset_resource=asset_resource, |
| 42 | + ) |
| 43 | + manifest.flush() |
| 44 | + return manifest |
| 45 | + |
| 46 | + |
| 47 | +class TestFindOrphaned: |
| 48 | + """Tests for ManifestDB.find_orphaned().""" |
| 49 | + |
| 50 | + def test_no_orphans(self, tmp_path: object) -> None: |
| 51 | + tmpdir = str(tmp_path) |
| 52 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 53 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 54 | + {"asset_id": "A2", "local_path": "2024-01/photo2.HEIC"}, |
| 55 | + ]) |
| 56 | + seen = {"A1", "A2"} |
| 57 | + orphans = manifest.find_orphaned(seen) |
| 58 | + assert len(orphans) == 0 |
| 59 | + manifest.close() |
| 60 | + |
| 61 | + def test_all_orphaned(self, tmp_path: object) -> None: |
| 62 | + tmpdir = str(tmp_path) |
| 63 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 64 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 65 | + {"asset_id": "A2", "local_path": "2024-01/photo2.HEIC"}, |
| 66 | + ]) |
| 67 | + seen: set[str] = set() |
| 68 | + orphans = manifest.find_orphaned(seen) |
| 69 | + assert len(orphans) == 2 |
| 70 | + assert {o.asset_id for o in orphans} == {"A1", "A2"} |
| 71 | + manifest.close() |
| 72 | + |
| 73 | + def test_partial_orphan(self, tmp_path: object) -> None: |
| 74 | + tmpdir = str(tmp_path) |
| 75 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 76 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 77 | + {"asset_id": "A2", "local_path": "2024-01/photo2.HEIC"}, |
| 78 | + {"asset_id": "A3", "local_path": "2024-01/photo3.HEIC"}, |
| 79 | + ]) |
| 80 | + seen = {"A1", "A3"} |
| 81 | + orphans = manifest.find_orphaned(seen) |
| 82 | + assert len(orphans) == 1 |
| 83 | + assert orphans[0].asset_id == "A2" |
| 84 | + manifest.close() |
| 85 | + |
| 86 | + def test_multi_resource_orphan(self, tmp_path: object) -> None: |
| 87 | + """An asset with multiple resources (HEIC + MOV) should return all rows.""" |
| 88 | + tmpdir = str(tmp_path) |
| 89 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 90 | + {"asset_id": "A1", "local_path": "2024-01/IMG_001.HEIC", "asset_resource": "resOriginal"}, |
| 91 | + {"asset_id": "A1", "local_path": "2024-01/IMG_001_HEVC.MOV", "asset_resource": "resOriginalVidCompl"}, |
| 92 | + {"asset_id": "A2", "local_path": "2024-01/IMG_002.HEIC", "asset_resource": "resOriginal"}, |
| 93 | + ]) |
| 94 | + seen = {"A2"} |
| 95 | + orphans = manifest.find_orphaned(seen) |
| 96 | + assert len(orphans) == 2 |
| 97 | + assert all(o.asset_id == "A1" for o in orphans) |
| 98 | + manifest.close() |
| 99 | + |
| 100 | + def test_empty_manifest(self, tmp_path: object) -> None: |
| 101 | + tmpdir = str(tmp_path) |
| 102 | + manifest = ManifestDB(tmpdir) |
| 103 | + manifest.open() |
| 104 | + orphans = manifest.find_orphaned({"A1", "A2"}) |
| 105 | + assert len(orphans) == 0 |
| 106 | + manifest.close() |
| 107 | + |
| 108 | + |
| 109 | +class TestDeleteOrphaned: |
| 110 | + """Tests for the delete_orphaned() function.""" |
| 111 | + |
| 112 | + def test_warning_mode_no_flag(self, tmp_path: object) -> None: |
| 113 | + """Without --delete-orphaned, logs warning but doesn't delete.""" |
| 114 | + tmpdir = str(tmp_path) |
| 115 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 116 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 117 | + ]) |
| 118 | + logger = logging.getLogger("test") |
| 119 | + with pytest.raises(Exception) if False else nullcontext(): |
| 120 | + pass |
| 121 | + # Call without delete flag |
| 122 | + delete_orphaned(logger, manifest, tmpdir, set(), delete=False, dry_run=False) |
| 123 | + # File should still exist |
| 124 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC")) |
| 125 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC.xmp")) |
| 126 | + # Manifest should still have the entry |
| 127 | + assert manifest.count() == 1 |
| 128 | + manifest.close() |
| 129 | + |
| 130 | + def test_delete_mode(self, tmp_path: object) -> None: |
| 131 | + """With --delete-orphaned, files and manifest entries are removed.""" |
| 132 | + tmpdir = str(tmp_path) |
| 133 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 134 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 135 | + {"asset_id": "A2", "local_path": "2024-01/photo2.HEIC"}, |
| 136 | + ]) |
| 137 | + logger = logging.getLogger("test") |
| 138 | + delete_orphaned(logger, manifest, tmpdir, {"A2"}, delete=True, dry_run=False) |
| 139 | + # A1 should be deleted |
| 140 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC")) |
| 141 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC.xmp")) |
| 142 | + # A2 should remain |
| 143 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo2.HEIC")) |
| 144 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo2.HEIC.xmp")) |
| 145 | + # Manifest should only have A2 |
| 146 | + assert manifest.count() == 1 |
| 147 | + manifest.close() |
| 148 | + |
| 149 | + def test_dry_run_skips_deletion(self, tmp_path: object) -> None: |
| 150 | + """Dry run logs but doesn't delete files or manifest entries.""" |
| 151 | + tmpdir = str(tmp_path) |
| 152 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 153 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 154 | + ]) |
| 155 | + logger = logging.getLogger("test") |
| 156 | + delete_orphaned(logger, manifest, tmpdir, set(), delete=True, dry_run=True) |
| 157 | + # File should still exist |
| 158 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC")) |
| 159 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC.xmp")) |
| 160 | + # Manifest should still have the entry |
| 161 | + assert manifest.count() == 1 |
| 162 | + manifest.close() |
| 163 | + |
| 164 | + def test_multi_resource_cleanup(self, tmp_path: object) -> None: |
| 165 | + """Deleting orphaned asset removes all resources (HEIC + MOV + XMPs).""" |
| 166 | + tmpdir = str(tmp_path) |
| 167 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 168 | + {"asset_id": "A1", "local_path": "2024-01/IMG.HEIC", "asset_resource": "resOriginal"}, |
| 169 | + {"asset_id": "A1", "local_path": "2024-01/IMG_HEVC.MOV", "asset_resource": "resOriginalVidCompl"}, |
| 170 | + ]) |
| 171 | + logger = logging.getLogger("test") |
| 172 | + delete_orphaned(logger, manifest, tmpdir, set(), delete=True, dry_run=False) |
| 173 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/IMG.HEIC")) |
| 174 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/IMG.HEIC.xmp")) |
| 175 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/IMG_HEVC.MOV")) |
| 176 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/IMG_HEVC.MOV.xmp")) |
| 177 | + assert manifest.count() == 0 |
| 178 | + manifest.close() |
| 179 | + |
| 180 | + def test_no_orphans_no_action(self, tmp_path: object) -> None: |
| 181 | + """When all assets are seen, no warning or deletion.""" |
| 182 | + tmpdir = str(tmp_path) |
| 183 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 184 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 185 | + ]) |
| 186 | + logger = logging.getLogger("test") |
| 187 | + delete_orphaned(logger, manifest, tmpdir, {"A1"}, delete=True, dry_run=False) |
| 188 | + assert os.path.exists(os.path.join(tmpdir, "2024-01/photo1.HEIC")) |
| 189 | + assert manifest.count() == 1 |
| 190 | + manifest.close() |
| 191 | + |
| 192 | + def test_file_already_missing(self, tmp_path: object) -> None: |
| 193 | + """Orphan in manifest but file already deleted from disk.""" |
| 194 | + tmpdir = str(tmp_path) |
| 195 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 196 | + {"asset_id": "A1", "local_path": "2024-01/photo1.HEIC"}, |
| 197 | + ]) |
| 198 | + # Remove the file manually |
| 199 | + os.remove(os.path.join(tmpdir, "2024-01/photo1.HEIC")) |
| 200 | + os.remove(os.path.join(tmpdir, "2024-01/photo1.HEIC.xmp")) |
| 201 | + logger = logging.getLogger("test") |
| 202 | + # Should not crash, just remove manifest entry |
| 203 | + delete_orphaned(logger, manifest, tmpdir, set(), delete=True, dry_run=False) |
| 204 | + assert manifest.count() == 0 |
| 205 | + manifest.close() |
| 206 | + |
| 207 | + def test_dedup_suffix_files(self, tmp_path: object) -> None: |
| 208 | + """Orphan with dedup suffix in path is handled correctly.""" |
| 209 | + tmpdir = str(tmp_path) |
| 210 | + manifest = _setup_manifest_with_files(tmpdir, [ |
| 211 | + {"asset_id": "A1", "local_path": "2024-01/IMG_001_aB3x.HEIC"}, |
| 212 | + ]) |
| 213 | + logger = logging.getLogger("test") |
| 214 | + delete_orphaned(logger, manifest, tmpdir, set(), delete=True, dry_run=False) |
| 215 | + assert not os.path.exists(os.path.join(tmpdir, "2024-01/IMG_001_aB3x.HEIC")) |
| 216 | + assert manifest.count() == 0 |
| 217 | + manifest.close() |
| 218 | + |
| 219 | + |
| 220 | +# Python 3.10 doesn't have contextlib.nullcontext with args |
| 221 | +from contextlib import nullcontext |
0 commit comments