mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-20 21:22:54 +00:00
Kevin Veen-Birkenbach
df1c65ccac
Two defaults could not be right. --repo-name fell back to the literal 'backup-docker-to-local' while its help promised the git repo folder name, which nothing ever derived. --databases-csv pointed inside the installed package directory, where credentials must not live; when it applied, load_databases_df read a missing file as empty and the run finished without a single dump and without an error. Both are required now, --repo-name in the restore CLI too. The file itself may still be absent - babadcb's tolerance is untouched, only the path must be named. --everything is withdrawn. Its one effect was to ignore --images-no-stop-required, which is what leaving that list empty already does, and its branch was the default path minus the requires_stop check. No caller, no test, and help and README described it differently. --dump-only-sql becomes --only-sql, and --only-files joins it as the opposite half: no dumps at all, every volume as files. They form a mutually exclusive group. A host that only copies files has no business holding database passwords, so --databases-csv is not required there and is never read. The smallest valid argv turned out to be written four times across the test tree; it now lives once. Withdrawn flags are listed in one place and proven to exit 2. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
115 lines
3.4 KiB
Python
115 lines
3.4 KiB
Python
"""Fixtures and paths the e2e suite builds its scenarios from."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import shutil
|
|
import subprocess
|
|
from pathlib import Path
|
|
|
|
from .process import machine_hash, run
|
|
|
|
# postgres 18+ mounts at /var/lib/postgresql, not /var/lib/postgresql/data.
|
|
POSTGRES_IMAGE = "postgres:alpine"
|
|
POSTGRES_DATA_DIR = "/var/lib/postgresql"
|
|
MARIADB_IMAGE = "mariadb:latest"
|
|
MARIADB_DATA_DIR = "/var/lib/mysql"
|
|
|
|
|
|
def backup_run(
|
|
*,
|
|
backups_dir: str,
|
|
repo_name: str,
|
|
compose_dir: str,
|
|
databases_csv: str,
|
|
database_containers: list[str],
|
|
images_no_stop_required: list[str],
|
|
images_no_backup_required: list[str] | None = None,
|
|
only_sql: bool = False,
|
|
) -> None:
|
|
cmd = [
|
|
"baudolo",
|
|
"--compose-dir",
|
|
compose_dir,
|
|
"--hard-restart-projects",
|
|
"mailu",
|
|
"--repo-name",
|
|
repo_name,
|
|
"--databases-csv",
|
|
databases_csv,
|
|
"--backups-dir",
|
|
backups_dir,
|
|
"--database-containers",
|
|
*database_containers,
|
|
"--images-no-stop-required",
|
|
*images_no_stop_required,
|
|
]
|
|
if images_no_backup_required:
|
|
cmd += ["--images-no-backup-required", *images_no_backup_required]
|
|
if only_sql:
|
|
cmd += ["--only-sql"]
|
|
|
|
try:
|
|
run(cmd, capture=True, check=True)
|
|
except subprocess.CalledProcessError as e:
|
|
print(">>> baudolo failed (exit code:", e.returncode, ")")
|
|
if e.stdout:
|
|
print(">>> baudolo STDOUT:\n" + e.stdout)
|
|
if e.stderr:
|
|
print(">>> baudolo STDERR:\n" + e.stderr)
|
|
raise
|
|
|
|
|
|
def latest_version_dir(backups_dir: str, repo_name: str) -> tuple[str, str]:
|
|
"""
|
|
Returns (hash, version) for the latest backup.
|
|
"""
|
|
h = machine_hash()
|
|
root = Path(backups_dir) / h / repo_name
|
|
if not root.is_dir():
|
|
raise FileNotFoundError(str(root))
|
|
|
|
versions = sorted([p.name for p in root.iterdir() if p.is_dir()])
|
|
if not versions:
|
|
raise RuntimeError(f"No versions found under {root}")
|
|
return h, versions[-1]
|
|
|
|
|
|
def backup_path(backups_dir: str, repo_name: str, version: str, volume: str) -> Path:
|
|
h = machine_hash()
|
|
return Path(backups_dir) / h / repo_name / version / volume
|
|
|
|
|
|
def create_minimal_compose_dir(base: str) -> str:
|
|
"""
|
|
baudolo requires --compose-dir. Create an empty dir with one non-compose subdir.
|
|
"""
|
|
p = Path(base) / "compose-root"
|
|
p.mkdir(parents=True, exist_ok=True)
|
|
(p / "noop").mkdir(parents=True, exist_ok=True)
|
|
return str(p)
|
|
|
|
|
|
def write_databases_csv(path: str, rows: list[tuple[str, str, str, str]]) -> None:
|
|
"""
|
|
rows: (instance, database, username, password)
|
|
database may be '' (empty) to trigger pg_dumpall behavior if you want, but here we use db name.
|
|
"""
|
|
Path(path).parent.mkdir(parents=True, exist_ok=True)
|
|
with open(path, "w", encoding="utf-8") as f:
|
|
f.write("instance;database;username;password\n")
|
|
f.writelines(f"{inst};{db};{user};{pw}\n" for inst, db, user, pw in rows)
|
|
|
|
|
|
def cleanup_docker(*, containers: list[str], volumes: list[str]) -> None:
|
|
for c in containers:
|
|
run(["docker", "rm", "-f", c], capture=True, check=False)
|
|
for v in volumes:
|
|
run(["docker", "volume", "rm", "-f", v], capture=True, check=False)
|
|
|
|
|
|
def ensure_empty_dir(path: str) -> None:
|
|
p = Path(path)
|
|
if p.exists():
|
|
shutil.rmtree(p)
|
|
p.mkdir(parents=True, exist_ok=True)
|