mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-01 12:34:50 +00:00
Kevin Veen-Birkenbach
b10d50efbe
Four defects in the snapshot mode 3.2.0 introduced. The resolver dropped the trailing separator get_storage_path puts on a volume path, because os.path.abspath strips it. rsync reads "dir" as "copy the directory" where "dir/" means "copy its contents", so every snapshot generation landed at <volume>/files/_data/... while the live path lands at <volume>/files/... . Restores read the live layout, and --link-dest found nothing to match against the previous generation. The e2e never caught it because its driver appended the separator by hand. Snapshot teardown was fatal and masking. A busy `btrfs subvolume delete` raised out of the finally, which skipped the generation stamp and the compose handling on a run whose data was already complete, and replaced whatever the body had raised. The leftover is reported instead; removing it is a cleanup problem, not a reason to discard a good generation. A volume created after the snapshot was taken aborted the whole run: the volume list is enumerated inside the snapshot context, and nothing is stopped in snapshot mode, so the host keeps creating volumes for the duration of the copy. Such a volume is now copied live with a warning, which is exactly what the pre-snapshot code did for it. The snapshot pass compares by content again. 3.2.0 dropped --checksum because a snapshot source cannot move, which is true, but the comparison that matters is against --link-dest: a file that changed while keeping its size and whole-second mtime was hard-linked stale out of the previous generation, and the single snapshot pass had no authoritative pass to repair it the way the live path does. It is still one pass against two. --hard-restart-projects is refused alongside --snapshot, the same way --shutdown already is: the flag exists for stacks whose database cannot be backed up hot, which is what a snapshot removes. Tests: the trailing separator, both teardown behaviours, the new refusal, and app.main driving the snapshot branch - the caller that runs in production, which no test had exercised and where the layout defect therefore stayed invisible. The e2e driver now feeds the resolver the string shape get_storage_path really produces. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
80 lines
2.9 KiB
Python
80 lines
2.9 KiB
Python
"""Contract of app.main's snapshot branch - the caller that runs in production."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import unittest
|
|
from unittest import mock
|
|
|
|
from baudolo.backup import app
|
|
from baudolo.backup.snapshot import volume_snapshot
|
|
|
|
|
|
def stubbed_snapshot(kind: str, subject: str, tag: str):
|
|
return volume_snapshot(kind, subject, tag, run=lambda command: [])
|
|
|
|
ARGV = [
|
|
"baudolo",
|
|
"--compose-dir",
|
|
"/compose",
|
|
"--backups-dir",
|
|
"/backups",
|
|
"--snapshot",
|
|
"btrfs",
|
|
"--snapshot-subject",
|
|
"/var/lib/docker",
|
|
]
|
|
|
|
|
|
def drive(*, present: bool) -> list[dict]:
|
|
calls: list[dict] = []
|
|
|
|
def record(versions_dir, volume_name, volume_dir, *, authoritative, source):
|
|
calls.append(
|
|
{"volume": volume_name, "authoritative": authoritative, "source": source}
|
|
)
|
|
|
|
with (
|
|
mock.patch("sys.argv", ARGV),
|
|
mock.patch.object(app, "get_machine_id", return_value="machine"),
|
|
mock.patch.object(app, "create_version_directory", return_value="/gen"),
|
|
mock.patch.object(app, "create_volume_directory", return_value="/gen/vol"),
|
|
mock.patch.object(app, "load_databases_df", return_value=None),
|
|
mock.patch.object(app, "docker_volume_names", return_value=["vol"]),
|
|
mock.patch.object(app, "containers_using_volume", return_value=[]),
|
|
mock.patch.object(app, "volume_is_fully_ignored", return_value=False),
|
|
mock.patch.object(app, "backup_dumps_for_volume", return_value=(False, False)),
|
|
mock.patch.object(
|
|
app, "get_storage_path", return_value="/var/lib/docker/volumes/vol/_data/"
|
|
),
|
|
mock.patch.object(app, "stamp_directory"),
|
|
mock.patch.object(app, "handle_docker_compose_services"),
|
|
mock.patch.object(app.os.path, "isdir", return_value=present),
|
|
mock.patch.object(app, "backup_volume", side_effect=record),
|
|
mock.patch.object(app, "volume_snapshot", stubbed_snapshot),
|
|
):
|
|
app.main()
|
|
return calls
|
|
|
|
|
|
class TestSnapshotBranch(unittest.TestCase):
|
|
def test_it_passes_a_path_ending_in_a_separator(self) -> None:
|
|
source = drive(present=True)[0]["source"]
|
|
self.assertTrue(source.endswith("/volumes/vol/_data/"), source)
|
|
self.assertNotIn("/var/lib/docker/volumes", source)
|
|
|
|
def test_it_reads_from_the_snapshot_and_not_from_the_live_tree(self) -> None:
|
|
source = drive(present=True)[0]["source"]
|
|
self.assertTrue(source.startswith("/var/lib/.baudolo-"), source)
|
|
|
|
def test_it_compares_by_content_against_the_previous_generation(self) -> None:
|
|
self.assertTrue(drive(present=True)[0]["authoritative"])
|
|
|
|
def test_a_volume_missing_from_the_snapshot_is_copied_live(self) -> None:
|
|
call = drive(present=False)[0]
|
|
self.assertEqual(call["source"], "/var/lib/docker/volumes/vol/_data/")
|
|
self.assertFalse(call["authoritative"])
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|