mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-20 21:22:54 +00:00
Kevin Veen-Birkenbach
94637c32aa
A finished generation cannot show whether a volume held a database, nor whether a dump was produced for it: under --only-sql a failed dump falls back to a file copy, and the resulting files/ tree looks like any other copy. The run knows both and threw the knowledge away as a printed warning, leaving every reader to guess from file names. Each generation now carries a manifest.json stating its layout and, per volume, database / dumped / engine. baudolo.generation is the single place those names are spelled; restore/paths.py, backup/db.py and backup/volume.py stop repeating them. It is deliberately import-free so a consumer can read the manifest with nothing but json, on hosts where this package is not installed. BREAKING CHANGE: BackupException is renamed BackupError. The rename is atomic across the ten modules that define or import it, three of which also carry the manifest change, so it lands in this commit rather than a separate one that could not import. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
85 lines
3.3 KiB
Python
85 lines
3.3 KiB
Python
"""What main() records in the manifest for each volume it touched."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import unittest
|
|
from unittest import mock
|
|
|
|
from baudolo.backup import app
|
|
from baudolo.backup.dumps import VolumeOutcome
|
|
from baudolo.backup.volume import Backing
|
|
|
|
from . import REQUIRED_PAIRS
|
|
|
|
ARGV = ["baudolo", *[arg for pair in REQUIRED_PAIRS for arg in pair]]
|
|
|
|
|
|
def drive(argv: list[str], dump_result: VolumeOutcome) -> dict:
|
|
"""Run main() over one volume and return the manifest's volume section.
|
|
|
|
Args:
|
|
argv: the command line under test.
|
|
dump_result: what backup_dumps_for_volume reports.
|
|
"""
|
|
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=["pgdata"]),
|
|
mock.patch.object(app, "containers_using_volume", return_value=["db"]),
|
|
mock.patch.object(app, "volume_is_fully_ignored", return_value=False),
|
|
mock.patch.object(app, "backup_dumps_for_volume", return_value=dump_result),
|
|
mock.patch.object(app, "inspect_backing", return_value=Backing("/data")),
|
|
mock.patch.object(app, "write_manifest") as manifest,
|
|
mock.patch.object(app, "stamp_directory"),
|
|
mock.patch.object(app, "handle_docker_compose_services"),
|
|
mock.patch("os.path.isdir", return_value=True),
|
|
mock.patch.object(app, "backup_volume"),
|
|
mock.patch.object(app, "filter_stoppable", return_value=[]),
|
|
mock.patch.object(app, "requires_stop", return_value=False),
|
|
mock.patch.object(app, "change_containers_status"),
|
|
):
|
|
app.main()
|
|
return manifest.call_args.args[1]
|
|
|
|
|
|
class TestManifest(unittest.TestCase):
|
|
def test_a_database_volume_without_a_dump_is_recorded_as_undumped(self) -> None:
|
|
volumes = drive(
|
|
[*ARGV, "--only-sql"],
|
|
VolumeOutcome(database=True, dumped=False, engine="postgres"),
|
|
)
|
|
self.assertEqual(
|
|
volumes["pgdata"],
|
|
VolumeOutcome(database=True, dumped=False, engine="postgres"),
|
|
)
|
|
|
|
def test_a_dumped_database_volume_is_recorded_as_dumped(self) -> None:
|
|
volumes = drive(
|
|
[*ARGV, "--only-sql"],
|
|
VolumeOutcome(database=True, dumped=True, engine="mariadb"),
|
|
)
|
|
self.assertEqual(volumes["pgdata"].dumped, True)
|
|
self.assertEqual(volumes["pgdata"].engine, "mariadb")
|
|
|
|
def test_a_plain_volume_is_recorded_as_no_database(self) -> None:
|
|
volumes = drive(ARGV, VolumeOutcome(database=False, dumped=False))
|
|
self.assertEqual(volumes["pgdata"].database, False)
|
|
self.assertIsNone(volumes["pgdata"].engine)
|
|
|
|
def test_the_dumped_volume_is_recorded_even_though_the_copy_is_skipped(
|
|
self,
|
|
) -> None:
|
|
"""--only-sql returns to the loop head on success, before the copy."""
|
|
volumes = drive(
|
|
[*ARGV, "--only-sql"],
|
|
VolumeOutcome(database=True, dumped=True, engine="postgres"),
|
|
)
|
|
self.assertIn("pgdata", volumes)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|