mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-20 13:12:48 +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>
66 lines
2.0 KiB
Python
66 lines
2.0 KiB
Python
"""Contract of the generation manifest document and the file it lands in."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
from baudolo.backup.dumps import VolumeOutcome
|
|
from baudolo.backup.layout import write_manifest
|
|
from baudolo.generation import (
|
|
CLUSTER_SUFFIX,
|
|
DUMP_SUFFIX,
|
|
FILES_DIR,
|
|
MANIFEST_FILE,
|
|
MANIFEST_SCHEMA,
|
|
SQL_DIR,
|
|
manifest_document,
|
|
)
|
|
|
|
|
|
class TestManifestDocument(unittest.TestCase):
|
|
def test_it_states_the_layout_a_reader_needs(self) -> None:
|
|
document = manifest_document({})
|
|
self.assertEqual(
|
|
document["layout"],
|
|
{
|
|
"files_dir": FILES_DIR,
|
|
"sql_dir": SQL_DIR,
|
|
"dump_suffix": DUMP_SUFFIX,
|
|
"cluster_suffix": CLUSTER_SUFFIX,
|
|
},
|
|
)
|
|
|
|
def test_it_carries_a_schema_so_a_reader_can_refuse_a_newer_one(self) -> None:
|
|
self.assertEqual(manifest_document({})["schema"], MANIFEST_SCHEMA)
|
|
|
|
def test_it_sorts_volumes_so_two_runs_produce_the_same_bytes(self) -> None:
|
|
state = VolumeOutcome(database=False, dumped=False)
|
|
document = manifest_document({"b": state, "a": state})
|
|
self.assertEqual(list(document["volumes"]), ["a", "b"])
|
|
|
|
|
|
class TestWriteManifest(unittest.TestCase):
|
|
def test_it_writes_readable_json_next_to_the_volumes(self) -> None:
|
|
with tempfile.TemporaryDirectory() as version_dir:
|
|
path = write_manifest(
|
|
version_dir,
|
|
{
|
|
"pgdata": VolumeOutcome(
|
|
database=True, dumped=False, engine="postgres"
|
|
)
|
|
},
|
|
)
|
|
self.assertEqual(Path(path).name, MANIFEST_FILE)
|
|
document = json.loads(Path(path).read_text(encoding="utf-8"))
|
|
self.assertEqual(
|
|
document["volumes"]["pgdata"],
|
|
{"database": True, "dumped": False, "engine": "postgres"},
|
|
)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|