mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-07-17 14:15:13 +00:00
Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 779f297c85 | |||
| 35a4c355fe | |||
| b0ae1aba54 | |||
| 57d75b1e13 | |||
| bf5f6db7c3 | |||
| b4d7e7f396 | |||
| f9776ac47a | |||
| 8c1a6cc465 | |||
| d6d4773fd9 | |||
| 82913291b6 | |||
| e5da813a9f | |||
| 331931d617 |
47
CHANGELOG.md
47
CHANGELOG.md
@@ -1,5 +1,52 @@
|
||||
# Changelog
|
||||
|
||||
## [3.1.0] - 2026-07-15
|
||||
|
||||
- Restore: the postgres *--empty* pre-clean emits one DROP per object and
|
||||
runs them via *\gexec* instead of a single DO-block, so large schemas
|
||||
(e.g. gitlab) no longer exhaust *max_locks_per_transaction* in one
|
||||
transaction. It also drops user-owned non-public schemas, so dumps that
|
||||
CREATE SCHEMA (e.g. discourse's *discourse_functions*) no longer abort
|
||||
on the already-existing schema under ON_ERROR_STOP.
|
||||
- Backup: *--database-containers* and *--images-no-stop-required* are now
|
||||
optional and default to an empty list, so a pure file backup needs no
|
||||
dummy arguments; an empty stop whitelist keeps the conservative
|
||||
stop-all behavior.
|
||||
- Tests: new e2e test restores *--empty* against a fully populated
|
||||
database containing a non-public schema and every dropped object class.
|
||||
*make test* runs the three suites concurrently after a single
|
||||
clean+build; *E2E_TEST_PATTERN* runs an e2e subset.
|
||||
|
||||
## [3.0.0] - 2026-07-12
|
||||
|
||||
- Backup: *--images-no-stop-required* and *--images-no-backup-required* now
|
||||
match a container's exact *.Config.Image* (full *repo:tag*, registry
|
||||
prefix included) instead of a substring, so a near-miss image name no
|
||||
longer flips the stop/skip decision. Callers must pass exact image
|
||||
references. **Breaking.**
|
||||
- Backup: renamed *--hard-compose-restart* to *--hard-restart-projects*
|
||||
(its value stays a list of compose project dir names). **Breaking:** the
|
||||
old flag name is removed.
|
||||
|
||||
## [2.0.0] - 2026-07-12
|
||||
|
||||
- Backup: renamed *--docker-compose-hard-restart-required* to
|
||||
*--hard-compose-restart* and changed its default from *["mailu"]* to *[]*
|
||||
(nargs="*"). The compose down/up is now opt-in: compose hosts pass
|
||||
*mailu* explicitly, while swarm hosts pass nothing, since there the dir is
|
||||
a stack whose overlay network collides with *compose up*. **Breaking:** the
|
||||
old flag name is removed and the implicit mailu default is gone.
|
||||
- Backup: *--backups-dir* is now required (no */var/lib/backup/* default) so
|
||||
a run can never silently target the wrong backup root. **Breaking.**
|
||||
- Restore: volume files are rsynced directly into the target volume's
|
||||
mountpoint (resolved via *docker volume inspect*), mirroring the backup
|
||||
path; the *alpine-rsync* helper image and the *--rsync-image* flag are
|
||||
gone. The caller needs write access to the docker volume root (root on the
|
||||
host, baudolo's normal privilege). **Breaking:** the restore *files*
|
||||
subcommand no longer accepts *--rsync-image*.
|
||||
- Tests: the e2e suite tracks *postgres:alpine* (18+, mounted at
|
||||
*/var/lib/postgresql*) and *mariadb:latest* from a single source of truth.
|
||||
|
||||
## [1.8.1] - 2026-07-12
|
||||
|
||||
- Restore: the postgres empty mode also drops user-owned collations in
|
||||
|
||||
40
Makefile
40
Makefile
@@ -1,5 +1,6 @@
|
||||
.PHONY: install build \
|
||||
test-e2e test test-unit test-integration
|
||||
.PHONY: install build clean \
|
||||
test test-unit test-integration test-e2e \
|
||||
test-unit-run test-integration-run test-e2e-run
|
||||
|
||||
# Default python if no venv is active
|
||||
PY_DEFAULT ?= python3
|
||||
@@ -33,25 +34,32 @@ build:
|
||||
clean:
|
||||
git clean -fdX .
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Run E2E tests inside the container (Docker socket required)
|
||||
# ------------------------------------------------------------
|
||||
# E2E via isolated Docker-in-Docker (DinD)
|
||||
# - depends on local image build
|
||||
# - starts a DinD daemon container on a dedicated network
|
||||
# - loads the freshly built image into DinD
|
||||
# - runs the unittest suite inside a container that talks to DinD via DOCKER_HOST
|
||||
test-e2e: clean build
|
||||
@bash scripts/test-e2e.sh
|
||||
# clean + build run once and in order, then the three suites run concurrently
|
||||
# via -j3; the *-run targets carry no clean/build prereq so the sub-make cannot
|
||||
# race a second clean against build.
|
||||
test:
|
||||
@$(MAKE) clean
|
||||
@$(MAKE) build
|
||||
@$(MAKE) -j3 test-unit-run test-integration-run test-e2e-run
|
||||
|
||||
test: test-unit test-integration test-e2e
|
||||
test-unit: clean build test-unit-run
|
||||
|
||||
test-unit: clean build
|
||||
test-integration: clean build test-integration-run
|
||||
|
||||
test-e2e: clean build test-e2e-run
|
||||
|
||||
test-unit-run:
|
||||
@echo ">> Running unit tests"
|
||||
@docker run --rm -t $(IMAGE) \
|
||||
bash -lc 'python -m unittest discover -t . -s tests/unit -p "test_*.py" -v'
|
||||
|
||||
test-integration: clean build
|
||||
test-integration-run:
|
||||
@echo ">> Running integration tests"
|
||||
@docker run --rm -t $(IMAGE) \
|
||||
bash -lc 'python -m unittest discover -t . -s tests/integration -p "test_*.py" -v'
|
||||
bash -lc 'python -m unittest discover -t . -s tests/integration -p "test_*.py" -v'
|
||||
|
||||
# E2E via isolated Docker-in-Docker (DinD): starts a DinD daemon on a dedicated
|
||||
# network, loads the freshly built image into it, and runs tests/e2e inside a
|
||||
# container that talks to DinD via DOCKER_HOST.
|
||||
test-e2e-run:
|
||||
@bash scripts/test-e2e.sh
|
||||
|
||||
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "backup-docker-to-local"
|
||||
version = "1.8.1"
|
||||
version = "3.1.0"
|
||||
description = "Backup Docker volumes to local with rsync and optional DB dumps."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.9"
|
||||
|
||||
@@ -27,7 +27,6 @@ dind() { docker exec "${DIND}" docker "$@"; }
|
||||
dind_stdin() { docker exec -i "${DIND}" docker "$@"; }
|
||||
|
||||
IMG="${E2E_IMAGE:-baudolo:local}"
|
||||
RSYNC_IMG="${E2E_RSYNC_IMAGE:-ghcr.io/kevinveenbirkenbach/alpine-rsync}"
|
||||
|
||||
READY_TIMEOUT_SECONDS="${E2E_READY_TIMEOUT_SECONDS:-120}"
|
||||
ARTIFACTS_DIR="${E2E_ARTIFACTS_DIR:-./artifacts}"
|
||||
@@ -38,6 +37,9 @@ KEEP_ON_FAIL="${E2E_KEEP_ON_FAIL:-0}"
|
||||
KEEP_VOLUMES="${E2E_KEEP_VOLUMES:-0}"
|
||||
DEBUG_SHELL="${E2E_DEBUG_SHELL:-0}"
|
||||
|
||||
# Override to run a subset, e.g. E2E_TEST_PATTERN=test_e2e_postgres_empty_drop_hard.py
|
||||
TEST_PATTERN="${E2E_TEST_PATTERN:-test_*.py}"
|
||||
|
||||
FAILED=0
|
||||
TS="$(date +%Y%m%d%H%M%S)"
|
||||
|
||||
@@ -164,10 +166,6 @@ for i in $(seq 1 "${READY_TIMEOUT_SECONDS}"); do
|
||||
fi
|
||||
done
|
||||
|
||||
log "Pre-pulling helper images in DinD..."
|
||||
log " - Pulling: ${RSYNC_IMG}"
|
||||
dind pull "${RSYNC_IMG}"
|
||||
|
||||
log "Ensuring alpine exists in DinD (for debug helpers)"
|
||||
dind pull alpine:3.20 >/dev/null
|
||||
|
||||
@@ -181,8 +179,7 @@ if [ "${DEBUG_SHELL}" = "1" ]; then
|
||||
docker run --rm -it \
|
||||
--network "${NET}" \
|
||||
-e DOCKER_HOST="${DIND_HOST_IN_NET}" \
|
||||
-e E2E_RSYNC_IMAGE="${RSYNC_IMG}" \
|
||||
-v "${DIND_VOL}:/var/lib/docker:ro" \
|
||||
-v "${DIND_VOL}:/var/lib/docker" \
|
||||
-v "${E2E_TMP_VOL}:/tmp" \
|
||||
"${IMG}" \
|
||||
bash -lc '
|
||||
@@ -200,8 +197,8 @@ else
|
||||
docker run --rm \
|
||||
--network "${NET}" \
|
||||
-e DOCKER_HOST="${DIND_HOST_IN_NET}" \
|
||||
-e E2E_RSYNC_IMAGE="${RSYNC_IMG}" \
|
||||
-v "${DIND_VOL}:/var/lib/docker:ro" \
|
||||
-e E2E_TEST_PATTERN="${TEST_PATTERN}" \
|
||||
-v "${DIND_VOL}:/var/lib/docker" \
|
||||
-v "${E2E_TMP_VOL}:/tmp" \
|
||||
"${IMG}" \
|
||||
bash -lc '
|
||||
@@ -216,7 +213,7 @@ else
|
||||
cat /proc/sys/kernel/random/uuid > /etc/machine-id
|
||||
fi
|
||||
|
||||
python -m unittest discover -t . -s tests/e2e -p "test_*.py" -v -f
|
||||
python -m unittest discover -t . -s tests/e2e -p "${E2E_TEST_PATTERN}" -v -f
|
||||
'
|
||||
rc=$?
|
||||
fi
|
||||
|
||||
@@ -52,7 +52,7 @@ def is_image_ignored(container: str, images_no_backup_required: list[str]) -> bo
|
||||
if not images_no_backup_required:
|
||||
return False
|
||||
img = get_image_info(container)
|
||||
return any(pat in img for pat in images_no_backup_required)
|
||||
return img in images_no_backup_required
|
||||
|
||||
|
||||
def volume_is_fully_ignored(
|
||||
@@ -68,15 +68,15 @@ def volume_is_fully_ignored(
|
||||
|
||||
def requires_stop(containers: list[str], images_no_stop_required: list[str]) -> bool:
|
||||
"""
|
||||
Stop is required if ANY stoppable container image is NOT in the
|
||||
whitelist patterns. Swarm task containers never count: baudolo must
|
||||
Stop is required if ANY stoppable container image is NOT in the exact
|
||||
image whitelist. Swarm task containers never count: baudolo must
|
||||
not cycle them (see docker.is_swarm_task).
|
||||
"""
|
||||
for c in containers:
|
||||
if is_swarm_task(c):
|
||||
continue
|
||||
img = get_image_info(c)
|
||||
if not any(pat in img for pat in images_no_stop_required):
|
||||
if img not in images_no_stop_required:
|
||||
return True
|
||||
return False
|
||||
|
||||
@@ -247,8 +247,6 @@ def main() -> int:
|
||||
print("Finished volume backups.", flush=True)
|
||||
|
||||
print("Handling Docker Compose services...", flush=True)
|
||||
handle_docker_compose_services(
|
||||
args.compose_dir, args.docker_compose_hard_restart_required
|
||||
)
|
||||
handle_docker_compose_services(args.compose_dir, args.hard_restart_projects)
|
||||
|
||||
return 0
|
||||
|
||||
@@ -17,10 +17,10 @@ def parse_args() -> argparse.Namespace:
|
||||
help="Path to the parent directory containing docker-compose setups",
|
||||
)
|
||||
p.add_argument(
|
||||
"--docker-compose-hard-restart-required",
|
||||
nargs="+",
|
||||
default=["mailu"],
|
||||
help="Compose dir names that require 'docker-compose down && up -d' (default: mailu)",
|
||||
"--hard-restart-projects",
|
||||
nargs="*",
|
||||
default=[],
|
||||
help="Compose dir names that require 'docker-compose down && up -d' (default: none; pass e.g. 'mailu' under compose where the DB cannot be backed up hot)",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
@@ -35,27 +35,27 @@ def parse_args() -> argparse.Namespace:
|
||||
)
|
||||
p.add_argument(
|
||||
"--backups-dir",
|
||||
default="/var/lib/backup/",
|
||||
help="Backup root directory (default: /var/lib/backup/)",
|
||||
required=True,
|
||||
help="Backup root directory (e.g. /var/lib/backup/)",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
"--database-containers",
|
||||
nargs="+",
|
||||
required=True,
|
||||
default=[],
|
||||
help="Container names treated as special instances for database backups",
|
||||
)
|
||||
p.add_argument(
|
||||
"--images-no-stop-required",
|
||||
nargs="+",
|
||||
required=True,
|
||||
help="Image name patterns for which containers should not be stopped during file backup",
|
||||
default=[],
|
||||
help="Exact image references (repo:tag, incl. any registry prefix) whose containers must not be stopped during file backup",
|
||||
)
|
||||
p.add_argument(
|
||||
"--images-no-backup-required",
|
||||
nargs="+",
|
||||
default=[],
|
||||
help="Image name patterns for which no backup should be performed",
|
||||
help="Exact image references (repo:tag, incl. any registry prefix) for which no backup should be performed",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
|
||||
@@ -38,10 +38,6 @@ def main(argv: list[str] | None = None) -> int:
|
||||
# ------------------------------------------------------------------
|
||||
p_files = sub.add_parser("files", help="Restore files into a docker volume")
|
||||
_add_common_backup_args(p_files)
|
||||
p_files.add_argument(
|
||||
"--rsync-image",
|
||||
default="ghcr.io/kevinveenbirkenbach/alpine-rsync",
|
||||
)
|
||||
p_files.add_argument(
|
||||
"--source-volume",
|
||||
default=None,
|
||||
@@ -95,7 +91,6 @@ def main(argv: list[str] | None = None) -> int:
|
||||
return restore_volume_files(
|
||||
args.volume_name,
|
||||
bp_files.files_dir(),
|
||||
rsync_image=args.rsync_image,
|
||||
)
|
||||
|
||||
if args.cmd == "postgres":
|
||||
|
||||
@@ -53,11 +53,15 @@ def restore_postgres_sql(
|
||||
docker_env = {"PGPASSWORD": password}
|
||||
|
||||
if empty:
|
||||
# Owner-filtered: extension members (pg_trgm's set_limit) are superuser-owned; IF EXISTS absorbs CASCADE fallout.
|
||||
# Owner-filtered pre-clean emitted as one DROP per row and run via \gexec so each
|
||||
# executes as its own top-level statement: a single DO-block runs every DROP in one
|
||||
# transaction and exhausts max_locks_per_transaction on large schemas (e.g. gitlab).
|
||||
# Also drop user-owned non-public schemas so a dump that CREATE SCHEMAs (e.g.
|
||||
# discourse's discourse_functions) does not fail on an already-existing schema.
|
||||
# Extension members (pg_trgm's set_limit) are superuser-owned; IF EXISTS absorbs CASCADE fallout.
|
||||
drop_sql = r"""
|
||||
DO $$ DECLARE r RECORD;
|
||||
BEGIN
|
||||
FOR r IN (
|
||||
SELECT format('DROP %s IF EXISTS public.%I CASCADE', obj.type, obj.name)
|
||||
FROM (
|
||||
SELECT c.relname AS name,
|
||||
CASE c.relkind
|
||||
WHEN 'v' THEN 'VIEW'
|
||||
@@ -93,10 +97,14 @@ BEGIN
|
||||
FROM pg_collation col JOIN pg_namespace n ON n.oid = col.collnamespace
|
||||
WHERE n.nspname = 'public'
|
||||
AND pg_get_userbyid(col.collowner) = current_user
|
||||
) LOOP
|
||||
EXECUTE format('DROP %s IF EXISTS public.%I CASCADE', r.type, r.name);
|
||||
END LOOP;
|
||||
END $$;
|
||||
) obj
|
||||
UNION ALL
|
||||
SELECT format('DROP SCHEMA IF EXISTS %I CASCADE', n.nspname)
|
||||
FROM pg_namespace n
|
||||
WHERE NOT starts_with(n.nspname, 'pg_')
|
||||
AND n.nspname NOT IN ('public', 'information_schema')
|
||||
AND pg_get_userbyid(n.nspowner) = current_user
|
||||
\gexec
|
||||
"""
|
||||
docker_exec(
|
||||
container,
|
||||
|
||||
@@ -3,12 +3,10 @@ from __future__ import annotations
|
||||
import os
|
||||
import sys
|
||||
|
||||
from .run import run, docker_volume_exists
|
||||
from .run import docker_volume_exists, run
|
||||
|
||||
|
||||
def restore_volume_files(
|
||||
volume_name: str, backup_files_dir: str, *, rsync_image: str
|
||||
) -> int:
|
||||
def restore_volume_files(volume_name: str, backup_files_dir: str) -> int:
|
||||
if not os.path.isdir(backup_files_dir):
|
||||
print(f"ERROR: backup files dir not found: {backup_files_dir}", file=sys.stderr)
|
||||
return 2
|
||||
@@ -19,21 +17,21 @@ def restore_volume_files(
|
||||
else:
|
||||
print(f"Volume {volume_name} already exists.")
|
||||
|
||||
# Keep behavior close to the old script: rsync -avv --delete
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{volume_name}:/recover/",
|
||||
"-v",
|
||||
f"{backup_files_dir}:/backup/",
|
||||
rsync_image,
|
||||
"sh",
|
||||
"-lc",
|
||||
"rsync -avv --delete /backup/ /recover/",
|
||||
]
|
||||
cp = run(
|
||||
["docker", "volume", "inspect", "--format", "{{ .Mountpoint }}", volume_name],
|
||||
capture=True,
|
||||
)
|
||||
raw = cp.stdout or b""
|
||||
mountpoint = (raw.decode() if isinstance(raw, bytes) else raw).strip()
|
||||
if not mountpoint:
|
||||
print(
|
||||
f"ERROR: could not resolve mountpoint for volume {volume_name}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 2
|
||||
|
||||
src = os.path.join(backup_files_dir, "")
|
||||
dest = os.path.join(mountpoint, "")
|
||||
run(["rsync", "-avv", "--delete", src, dest])
|
||||
print("File restore complete.")
|
||||
return 0
|
||||
|
||||
@@ -7,6 +7,14 @@ import time
|
||||
import uuid
|
||||
from pathlib import Path
|
||||
|
||||
# SPOT for the database images and their in-container data dirs the e2e
|
||||
# suite runs against. postgres:alpine tracks latest (18+), which mounts at
|
||||
# /var/lib/postgresql (not /var/lib/postgresql/data); bump here only.
|
||||
POSTGRES_IMAGE = "postgres:alpine"
|
||||
POSTGRES_DATA_DIR = "/var/lib/postgresql"
|
||||
MARIADB_IMAGE = "mariadb:latest"
|
||||
MARIADB_DATA_DIR = "/var/lib/mysql"
|
||||
|
||||
|
||||
def run(
|
||||
cmd: list[str],
|
||||
@@ -172,7 +180,7 @@ def backup_run(
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
compose_dir,
|
||||
"--docker-compose-hard-restart-required",
|
||||
"--hard-restart-projects",
|
||||
"mailu",
|
||||
"--repo-name",
|
||||
repo_name,
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
@@ -50,8 +52,8 @@ class TestE2EDumpOnlyFallbackToFiles(unittest.TestCase):
|
||||
"-e",
|
||||
"POSTGRES_USER=postgres",
|
||||
"-v",
|
||||
f"{cls.pg_volume}:/var/lib/postgresql/data",
|
||||
"postgres:16",
|
||||
f"{cls.pg_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
@@ -65,7 +67,7 @@ class TestE2EDumpOnlyFallbackToFiles(unittest.TestCase):
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f"echo '{cls.marker}' > /var/lib/postgresql/data/marker.txt",
|
||||
f"echo '{cls.marker}' > {POSTGRES_DATA_DIR}/marker.txt",
|
||||
]
|
||||
)
|
||||
|
||||
@@ -79,7 +81,7 @@ class TestE2EDumpOnlyFallbackToFiles(unittest.TestCase):
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--docker-compose-hard-restart-required",
|
||||
"--hard-restart-projects",
|
||||
"mailu",
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
@@ -90,10 +92,7 @@ class TestE2EDumpOnlyFallbackToFiles(unittest.TestCase):
|
||||
"--database-containers",
|
||||
cls.pg_container,
|
||||
"--images-no-stop-required",
|
||||
"postgres",
|
||||
"mariadb",
|
||||
"mysql",
|
||||
"alpine",
|
||||
POSTGRES_IMAGE,
|
||||
"--dump-only-sql",
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
@@ -116,8 +115,6 @@ class TestE2EDumpOnlyFallbackToFiles(unittest.TestCase):
|
||||
cls.repo_name,
|
||||
"--source-volume",
|
||||
cls.pg_volume,
|
||||
"--rsync-image",
|
||||
"ghcr.io/kevinveenbirkenbach/alpine-rsync",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
@@ -70,8 +72,8 @@ class TestE2EDumpOnlySqlMixedRun(unittest.TestCase):
|
||||
"-e",
|
||||
f"POSTGRES_PASSWORD={cls.pg_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:/var/lib/postgresql/data",
|
||||
"postgres:16-alpine",
|
||||
f"{cls.db_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
@@ -122,10 +124,7 @@ class TestE2EDumpOnlySqlMixedRun(unittest.TestCase):
|
||||
"--database-containers",
|
||||
cls.pg_container,
|
||||
"--images-no-stop-required",
|
||||
"alpine",
|
||||
"postgres",
|
||||
"mariadb",
|
||||
"mysql",
|
||||
POSTGRES_IMAGE,
|
||||
"--dump-only-sql",
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
|
||||
@@ -57,7 +57,7 @@ class TestE2EFilesFull(unittest.TestCase):
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=["dummy-db"],
|
||||
images_no_stop_required=["alpine", "postgres", "mariadb", "mysql"],
|
||||
images_no_stop_required=["alpine:3.20"],
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
@@ -94,8 +94,6 @@ class TestE2EFilesFull(unittest.TestCase):
|
||||
self.repo_name,
|
||||
"--source-volume",
|
||||
self.volume_src,
|
||||
"--rsync-image",
|
||||
"ghcr.io/kevinveenbirkenbach/alpine-rsync",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ class TestE2EFilesNoCopy(unittest.TestCase):
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=["dummy-db"],
|
||||
images_no_stop_required=["alpine", "postgres", "mariadb", "mysql"],
|
||||
images_no_stop_required=["alpine:3.20"],
|
||||
dump_only_sql=True,
|
||||
)
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ class TestE2EImagesNoBackupRequiredEarlySkip(unittest.TestCase):
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--docker-compose-hard-restart-required",
|
||||
"--hard-restart-projects",
|
||||
"mailu",
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
@@ -87,13 +87,9 @@ class TestE2EImagesNoBackupRequiredEarlySkip(unittest.TestCase):
|
||||
"--database-containers",
|
||||
"dummy-db",
|
||||
"--images-no-stop-required",
|
||||
"alpine",
|
||||
"redis",
|
||||
"postgres",
|
||||
"mariadb",
|
||||
"mysql",
|
||||
"redis:alpine",
|
||||
"--images-no-backup-required",
|
||||
"redis",
|
||||
"redis:alpine",
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
cls.stdout = cp.stdout or ""
|
||||
|
||||
@@ -30,6 +30,8 @@ import pandas
|
||||
from baudolo.backup import db as db_mod
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_IMAGE,
|
||||
MARIADB_DATA_DIR,
|
||||
cleanup_docker,
|
||||
require_docker,
|
||||
run,
|
||||
@@ -69,8 +71,8 @@ class TestE2EMariaDBAnonymousPreemption(unittest.TestCase):
|
||||
"-e",
|
||||
f"MARIADB_ROOT_PASSWORD={cls.root_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:/var/lib/mysql",
|
||||
"mariadb:12.2",
|
||||
f"{cls.db_volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_IMAGE,
|
||||
MARIADB_DATA_DIR,
|
||||
backup_run,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
@@ -56,8 +58,8 @@ class TestE2EMariaDBFull(unittest.TestCase):
|
||||
"-e",
|
||||
f"MARIADB_PASSWORD={cls.db_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:/var/lib/mysql",
|
||||
"mariadb:11",
|
||||
f"{cls.db_volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
|
||||
@@ -97,7 +99,7 @@ class TestE2EMariaDBFull(unittest.TestCase):
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=[cls.db_container],
|
||||
images_no_stop_required=["mariadb", "mysql", "alpine", "postgres"],
|
||||
images_no_stop_required=[MARIADB_IMAGE],
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_IMAGE,
|
||||
MARIADB_DATA_DIR,
|
||||
backup_run,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
@@ -55,8 +57,8 @@ class TestE2EMariaDBNoCopy(unittest.TestCase):
|
||||
"-e",
|
||||
f"MARIADB_PASSWORD={cls.db_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:/var/lib/mysql",
|
||||
"mariadb:11",
|
||||
f"{cls.db_volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
|
||||
@@ -94,7 +96,7 @@ class TestE2EMariaDBNoCopy(unittest.TestCase):
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=[cls.db_container],
|
||||
images_no_stop_required=["mariadb", "mysql", "alpine", "postgres"],
|
||||
images_no_stop_required=[MARIADB_IMAGE],
|
||||
dump_only_sql=True,
|
||||
)
|
||||
|
||||
|
||||
157
tests/e2e/test_e2e_postgres_empty_drop_hard.py
Normal file
157
tests/e2e/test_e2e_postgres_empty_drop_hard.py
Normal file
@@ -0,0 +1,157 @@
|
||||
# tests/e2e/test_e2e_postgres_empty_drop_hard.py
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
# The scenario the --empty pre-clean must survive: a non-public user schema
|
||||
# plus one object of every class the discovery SELECT enumerates. Restore
|
||||
# --empty runs against the still-populated DB (no wipe), so the pre-clean must
|
||||
# drop discourse_functions too or the dump's CREATE SCHEMA aborts the replay
|
||||
# under ON_ERROR_STOP; the old public-only DROP left it and broke discourse.
|
||||
SCENARIO_SQL = (
|
||||
"CREATE SCHEMA discourse_functions;"
|
||||
"CREATE TABLE discourse_functions.helper (id int);"
|
||||
"INSERT INTO discourse_functions.helper VALUES (1);"
|
||||
"CREATE TABLE public.t (id int primary key, v text);"
|
||||
"INSERT INTO public.t VALUES (1, 'ok');"
|
||||
"CREATE VIEW public.t_view AS SELECT * FROM public.t;"
|
||||
"CREATE SEQUENCE public.s;"
|
||||
"CREATE TYPE public.mood AS ENUM ('ok', 'bad');"
|
||||
"CREATE FUNCTION public.f() RETURNS int LANGUAGE sql AS 'SELECT 1';"
|
||||
"CREATE COLLATION public.c (locale = 'C');"
|
||||
)
|
||||
|
||||
|
||||
class TestE2EPostgresEmptyDropHard(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-postgres-empty-drop-hard")
|
||||
cls.backups_dir = f"/tmp/{cls.prefix}/Backups"
|
||||
ensure_empty_dir(cls.backups_dir)
|
||||
cls.compose_dir = create_minimal_compose_dir(f"/tmp/{cls.prefix}")
|
||||
cls.repo_name = cls.prefix
|
||||
|
||||
cls.pg_container = f"{cls.prefix}-pg"
|
||||
cls.pg_volume = f"{cls.prefix}-pg-vol"
|
||||
cls.containers = [cls.pg_container]
|
||||
cls.volumes = [cls.pg_volume]
|
||||
|
||||
run(["docker", "volume", "create", cls.pg_volume])
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.pg_container,
|
||||
"-e",
|
||||
"POSTGRES_PASSWORD=pgpw",
|
||||
"-e",
|
||||
"POSTGRES_DB=appdb",
|
||||
"-e",
|
||||
"POSTGRES_USER=postgres",
|
||||
"-v",
|
||||
f"{cls.pg_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'psql -U postgres -d appdb -v ON_ERROR_STOP=1 -c "{SCENARIO_SQL}"',
|
||||
]
|
||||
)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(
|
||||
cls.databases_csv, [(cls.pg_container, "appdb", "postgres", "pgpw")]
|
||||
)
|
||||
backup_run(
|
||||
backups_dir=cls.backups_dir,
|
||||
repo_name=cls.repo_name,
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=[cls.pg_container],
|
||||
images_no_stop_required=[POSTGRES_IMAGE],
|
||||
)
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
# No wipe: restore --empty must pre-clean the fully-populated DB
|
||||
# (incl. the non-public schema) before replaying the dump.
|
||||
run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"postgres",
|
||||
cls.pg_volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--container",
|
||||
cls.pg_container,
|
||||
"--db-name",
|
||||
"appdb",
|
||||
"--db-user",
|
||||
"postgres",
|
||||
"--db-password",
|
||||
"pgpw",
|
||||
"--empty",
|
||||
]
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def _scalar(self, sql: str) -> str:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
self.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'psql -U postgres -d appdb -t -A -c "{sql}"',
|
||||
]
|
||||
)
|
||||
return (p.stdout or "").strip()
|
||||
|
||||
def test_public_data_restored(self) -> None:
|
||||
self.assertEqual(self._scalar("SELECT v FROM public.t WHERE id=1;"), "ok")
|
||||
|
||||
def test_view_restored(self) -> None:
|
||||
self.assertEqual(self._scalar("SELECT count(*) FROM public.t_view;"), "1")
|
||||
|
||||
def test_non_public_schema_restored(self) -> None:
|
||||
self.assertEqual(
|
||||
self._scalar(
|
||||
"SELECT count(*) FROM pg_namespace WHERE nspname='discourse_functions';"
|
||||
),
|
||||
"1",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -2,6 +2,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
backup_run,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
@@ -47,8 +49,8 @@ class TestE2EPostgresFull(unittest.TestCase):
|
||||
"-e",
|
||||
"POSTGRES_USER=postgres",
|
||||
"-v",
|
||||
f"{cls.pg_volume}:/var/lib/postgresql/data",
|
||||
"postgres:16",
|
||||
f"{cls.pg_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
@@ -76,7 +78,7 @@ class TestE2EPostgresFull(unittest.TestCase):
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=[cls.pg_container],
|
||||
images_no_stop_required=["postgres", "mariadb", "mysql", "alpine"],
|
||||
images_no_stop_required=[POSTGRES_IMAGE],
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
backup_run,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
@@ -46,8 +48,8 @@ class TestE2EPostgresNoCopy(unittest.TestCase):
|
||||
"-e",
|
||||
"POSTGRES_USER=postgres",
|
||||
"-v",
|
||||
f"{cls.pg_volume}:/var/lib/postgresql/data",
|
||||
"postgres:16",
|
||||
f"{cls.pg_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
@@ -74,7 +76,7 @@ class TestE2EPostgresNoCopy(unittest.TestCase):
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=[cls.pg_container],
|
||||
images_no_stop_required=["postgres", "mariadb", "mysql", "alpine"],
|
||||
images_no_stop_required=[POSTGRES_IMAGE],
|
||||
dump_only_sql=True,
|
||||
)
|
||||
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
@@ -66,8 +68,8 @@ class TestE2ESeedStarAndDbEntriesBackupPostgres(unittest.TestCase):
|
||||
"-e",
|
||||
f"POSTGRES_PASSWORD={cls.pg_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:/var/lib/postgresql/data",
|
||||
"postgres:16-alpine",
|
||||
f"{cls.db_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
@@ -165,10 +167,7 @@ class TestE2ESeedStarAndDbEntriesBackupPostgres(unittest.TestCase):
|
||||
"--database-containers",
|
||||
cls.pg_container,
|
||||
"--images-no-stop-required",
|
||||
"alpine",
|
||||
"postgres",
|
||||
"mariadb",
|
||||
"mysql",
|
||||
POSTGRES_IMAGE,
|
||||
"--dump-only-sql",
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
|
||||
@@ -251,5 +251,61 @@ class TestCompose(unittest.TestCase):
|
||||
)
|
||||
|
||||
|
||||
class HardRestartArgTests(unittest.TestCase):
|
||||
"""The hard-restart list defaults to empty (no compose down/up); callers
|
||||
opt in per dir, e.g. compose hosts pass 'mailu' while swarm hosts, where
|
||||
the dir is a stack whose overlay network collides with compose up, pass
|
||||
nothing."""
|
||||
|
||||
def _parse(self, extra: List[str]):
|
||||
import sys
|
||||
|
||||
from baudolo.backup import cli
|
||||
|
||||
argv = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
"/tmp",
|
||||
"--backups-dir",
|
||||
"/tmp/backup",
|
||||
"--database-containers",
|
||||
"postgres",
|
||||
"--images-no-stop-required",
|
||||
"redis",
|
||||
*extra,
|
||||
]
|
||||
with patch.object(sys, "argv", argv):
|
||||
return cli.parse_args()
|
||||
|
||||
def test_default_is_empty(self) -> None:
|
||||
args = self._parse([])
|
||||
self.assertEqual(args.hard_restart_projects, [])
|
||||
|
||||
def test_empty_flag_stays_empty(self) -> None:
|
||||
args = self._parse(["--hard-restart-projects"])
|
||||
self.assertEqual(args.hard_restart_projects, [])
|
||||
|
||||
def test_explicit_names_preserved(self) -> None:
|
||||
args = self._parse(["--hard-restart-projects", "mailu", "foo"])
|
||||
self.assertEqual(args.hard_restart_projects, ["mailu", "foo"])
|
||||
|
||||
def test_backups_dir_is_required(self) -> None:
|
||||
import sys
|
||||
|
||||
from baudolo.backup import cli
|
||||
|
||||
argv = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
"/tmp",
|
||||
"--database-containers",
|
||||
"postgres",
|
||||
"--images-no-stop-required",
|
||||
"redis",
|
||||
]
|
||||
with patch.object(sys, "argv", argv), self.assertRaises(SystemExit):
|
||||
cli.parse_args()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main(verbosity=2)
|
||||
|
||||
@@ -10,13 +10,12 @@ class TestRequiresStop(unittest.TestCase):
|
||||
def test_requires_stop_false_when_all_images_are_whitelisted(
|
||||
self, mock_get_image_info, _mock_is_swarm_task
|
||||
):
|
||||
# All containers use images containing allowed substrings
|
||||
mock_get_image_info.side_effect = [
|
||||
"repo/mastodon:v4",
|
||||
"repo/wordpress:latest",
|
||||
]
|
||||
containers = ["c1", "c2"]
|
||||
whitelist = ["mastodon", "wordpress"]
|
||||
whitelist = ["repo/mastodon:v4", "repo/wordpress:latest"]
|
||||
self.assertFalse(requires_stop(containers, whitelist))
|
||||
|
||||
@patch("baudolo.backup.app.get_image_info")
|
||||
@@ -28,9 +27,17 @@ class TestRequiresStop(unittest.TestCase):
|
||||
"repo/nginx:latest",
|
||||
]
|
||||
containers = ["c1", "c2"]
|
||||
whitelist = ["mastodon", "wordpress"]
|
||||
whitelist = ["repo/mastodon:v4", "repo/wordpress:latest"]
|
||||
self.assertTrue(requires_stop(containers, whitelist))
|
||||
|
||||
@patch("baudolo.backup.app.get_image_info")
|
||||
def test_requires_stop_true_on_substring_only_match(
|
||||
self, mock_get_image_info, _mock_is_swarm_task
|
||||
):
|
||||
mock_get_image_info.return_value = "reg:5000/repo/mastodon:v4"
|
||||
self.assertTrue(requires_stop(["c1"], ["mastodon"]))
|
||||
self.assertTrue(requires_stop(["c1"], ["repo/mastodon:v4"]))
|
||||
|
||||
@patch("baudolo.backup.app.get_image_info")
|
||||
def test_requires_stop_true_when_whitelist_empty(
|
||||
self, mock_get_image_info, _mock_is_swarm_task
|
||||
|
||||
Reference in New Issue
Block a user