mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-24 14:54:32 +00:00
Compare commits
208 Commits
d8471e5b4b
...
v4.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 37a07fe100 | |||
| 1d86277a94 | |||
| 03013b6c76 | |||
| df1c65ccac | |||
| f791046c02 | |||
| c03329e4ca | |||
| 5f3ee0a669 | |||
| 8dac7371cb | |||
| 23cfc3b7e2 | |||
| da9c3a1e6f | |||
| e80f11d5e4 | |||
| bb647c66ec | |||
| f437787e64 | |||
| 2129c5e362 | |||
| a0204fd3ea | |||
| 90d289d92f | |||
| 57fc7c96bc | |||
| 30fd68bdcf | |||
| 36b2336742 | |||
| 756e236d10 | |||
| 1dfeb17ab4 | |||
| cd21f1fa67 | |||
| 8a93a61ca9 | |||
| 988d92534c | |||
| 934e693810 | |||
| 2e0e67ca87 | |||
| 95c34d4db0 | |||
| c2f1cb8e8c | |||
| eeaa838d02 | |||
| 4e2b3641f9 | |||
| b10d50efbe | |||
| 7e815bfcf7 | |||
| d4317827bd | |||
| ec3d1a5046 | |||
| 37b735cf7b | |||
| 9dc57c3235 | |||
| 8409843ff9 | |||
| d2ba2eb5ae | |||
| 6a016d7a58 | |||
| d1d5445b1d | |||
| bd267cc280 | |||
| 53460242d8 | |||
| 01a00dd791 | |||
| 779f297c85 | |||
| 35a4c355fe | |||
| b0ae1aba54 | |||
| 57d75b1e13 | |||
| bf5f6db7c3 | |||
| b4d7e7f396 | |||
| f9776ac47a | |||
| 8c1a6cc465 | |||
| d6d4773fd9 | |||
| 82913291b6 | |||
| e5da813a9f | |||
| 331931d617 | |||
| 45d3b0ad7c | |||
| fe5bed8254 | |||
| 7a7ec57b54 | |||
| 2bbe7d180a | |||
|
|
286ef179da | ||
|
|
6cb0b8a548 | ||
| e1f1b602d3 | |||
| b9a8b391f0 | |||
| c949f2c5cf | |||
| 96e6b3ea93 | |||
| 79214e64e8 | |||
| e9030e8443 | |||
| 57ea4592c1 | |||
| ad5d8fcda3 | |||
| bfa596ae30 | |||
| 21b4d237d3 | |||
| ec051b4c2b | |||
| ed78f69b3b | |||
| a69074c302 | |||
| 0b4696f649 | |||
| e3f28098bd | |||
| babadcb038 | |||
| fbfdb8615f | |||
| 2f5882f5c1 | |||
| 522391fdd3 | |||
| b3c9cf5ce1 | |||
| 2ed3472527 | |||
| 54737cefa7 | |||
| d976640312 | |||
| e4bc075474 | |||
| f3ef86a444 | |||
| c01ab55f2d | |||
| e3cdfd6fc4 | |||
| df32671cec | |||
| d563dce20f | |||
| 0222f7f109 | |||
| 6adafe6b1f | |||
| 88b35ee923 | |||
| 71f79929be | |||
| 0fb8efba4f | |||
| 3b39a6ef02 | |||
| e0b2e8934e | |||
| bbb2dd1732 | |||
| 159502af5e | |||
| 698d1e7a9e | |||
| f8420c8bea | |||
| 8e1a53e1f9 | |||
| 7b55d59300 | |||
| cf6f4d8326 | |||
| 4af15d9074 | |||
| c30b4865d4 | |||
| 41910aece2 | |||
| b6dd624f97 | |||
| 47828c44db | |||
| a538e537cb | |||
| 8f72d61300 | |||
| c754083cec | |||
| 84d0fd6346 | |||
| 627187cecb | |||
| 978e153723 | |||
| 2bf2b0798e | |||
| 8196a0206b | |||
| c4cbb290b3 | |||
| 2d2376eac8 | |||
| 8c4ae60a6a | |||
| 18d6136de0 | |||
| 3ed89a59a8 | |||
| 7d3f0a3ae3 | |||
| 5762754ed7 | |||
| 556cb17433 | |||
| 2e2c8131c4 | |||
| 5005d577cc | |||
| 327b666237 | |||
| a7c6fa861a | |||
| f6c57be1b7 | |||
| 9d990a728d | |||
| a355f34e6e | |||
| f847c8dd74 | |||
| 3e225b0317 | |||
| 6537626d77 | |||
| da7e5cc9be | |||
| 69a1ea30aa | |||
| e9588b0e31 | |||
| 42566815c4 | |||
| 8bc2b068ff | |||
| 25d428fc9c | |||
| 0077efa63c | |||
| 9d8e80f793 | |||
| d2b699c271 | |||
| b7dcb17fd5 | |||
| 7f6f5f6dc8 | |||
| 75d48fb3e9 | |||
| bb3d20c424 | |||
| f057104a65 | |||
| 7fe1886ff9 | |||
| 35e28f31d2 | |||
| 15a1f17184 | |||
| ace1a70488 | |||
| d537393da8 | |||
| 2b716e5d90 | |||
| 7702b17a9d | |||
| 489b5796b7 | |||
| bf9986f282 | |||
| e2e62c5835 | |||
| 4388e09937 | |||
| 31133f251e | |||
| 850fc3bf0c | |||
| 00fd102f81 | |||
| f369a13d37 | |||
| f505be35d3 | |||
| 49c442b299 | |||
| 0322eee107 | |||
| 9a5b544e0b | |||
| 15d7406b7e | |||
| 9dd58f3ee4 | |||
| 7f383fcce2 | |||
| a72753921a | |||
| 407eddc2c3 | |||
| 3fedf49f4e | |||
| fb2e1df233 | |||
| 47922f53fa | |||
| 162b3eec06 | |||
| e0fc263dcb | |||
| 581ff501fc | |||
| 540797f244 | |||
| 7853283ef3 | |||
| 5e91e298c4 | |||
| de59646fc0 | |||
| bcc8a7fb00 | |||
| 8c4785dfe6 | |||
| d4799af904 | |||
| d1f942bc58 | |||
| 397e242e5b | |||
| b06317ad48 | |||
| 79f4cb5e7f | |||
| 50db914c36 | |||
| 02062c7d49 | |||
| a1c33c1747 | |||
| b83e481d01 | |||
| c4107d91b0 | |||
| bff513d639 | |||
| be0bdff4d8 | |||
| d8aa5f7d79 | |||
| cdd3d88202 | |||
| 7488262c4c | |||
| 3a8f002f85 | |||
| 978a8f93e3 | |||
| 5786e21c11 | |||
| 7832c85de7 | |||
| 9fa37046ab | |||
| eddccb1936 | |||
| 02449cb501 | |||
| 4290464986 |
3
.claude/.gitignore
vendored
Normal file
3
.claude/.gitignore
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
*
|
||||
!.gitignore
|
||||
!settings.json
|
||||
11
.claude/settings.json
Normal file
11
.claude/settings.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"permissions": {
|
||||
"ask": [
|
||||
"Bash(git commit*)",
|
||||
"Edit(CHANGELOG.md)",
|
||||
"Write(CHANGELOG.md)",
|
||||
"Edit(pyproject.toml)",
|
||||
"Write(pyproject.toml)"
|
||||
]
|
||||
}
|
||||
}
|
||||
7
.github/FUNDING.yml
vendored
Normal file
7
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
github: kevinveenbirkenbach
|
||||
|
||||
patreon: kevinveenbirkenbach
|
||||
|
||||
buy_me_a_coffee: kevinveenbirkenbach
|
||||
|
||||
custom: https://s.veen.world/paypaldonate
|
||||
21
.github/dependabot.yml
vendored
Normal file
21
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
groups:
|
||||
actions:
|
||||
patterns:
|
||||
- "*"
|
||||
|
||||
- package-ecosystem: docker
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
|
||||
- package-ecosystem: pip
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
100
.github/workflows/ci.yml
vendored
Normal file
100
.github/workflows/ci.yml
vendored
Normal file
@@ -0,0 +1,100 @@
|
||||
name: CI (make tests, stable, publish)
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["**"]
|
||||
tags: ["v*.*.*"] # SemVer tags like v1.2.3
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
contents: write # push/update 'stable' tag
|
||||
packages: write # push to GHCR
|
||||
|
||||
env:
|
||||
IMAGE_NAME: baudolo
|
||||
REGISTRY: ghcr.io
|
||||
IMAGE_REPO: ${{ github.repository }}
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: make test
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Show docker info
|
||||
run: |
|
||||
docker version
|
||||
docker info
|
||||
|
||||
- name: Provide zfs so the snapshot suite covers every filesystem
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y --no-install-recommends zfsutils-linux
|
||||
sudo modprobe zfs
|
||||
zpool version
|
||||
|
||||
- name: Run all tests via Makefile
|
||||
env:
|
||||
E2E_REQUIRE_FILESYSTEMS: "btrfs ext4 zfs"
|
||||
run: |
|
||||
make test
|
||||
|
||||
- name: Upload E2E artifacts (always)
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: e2e-artifacts
|
||||
path: artifacts
|
||||
if-no-files-found: ignore
|
||||
|
||||
stable_and_publish:
|
||||
name: Mark stable + publish image (SemVer tags only)
|
||||
needs: [test]
|
||||
runs-on: ubuntu-latest
|
||||
if: startsWith(github.ref, 'refs/tags/v')
|
||||
|
||||
steps:
|
||||
- name: Checkout (full history for tags)
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Derive version from tag
|
||||
id: ver
|
||||
run: |
|
||||
TAG="${GITHUB_REF#refs/tags/}" # v1.2.3
|
||||
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Mark 'stable' git tag (force update)
|
||||
run: |
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git tag -f stable "${GITHUB_SHA}"
|
||||
git push -f origin stable
|
||||
|
||||
- name: Login to GHCR
|
||||
uses: docker/login-action@v4
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Build image (Makefile)
|
||||
run: |
|
||||
make build
|
||||
|
||||
- name: Tag image for registry
|
||||
run: |
|
||||
# local image built by Makefile is: baudolo:local
|
||||
docker tag "${IMAGE_NAME}:local" "${REGISTRY}/${IMAGE_REPO}:${{ steps.ver.outputs.tag }}"
|
||||
docker tag "${IMAGE_NAME}:local" "${REGISTRY}/${IMAGE_REPO}:stable"
|
||||
docker tag "${IMAGE_NAME}:local" "${REGISTRY}/${IMAGE_REPO}:sha-${GITHUB_SHA::12}"
|
||||
|
||||
- name: Push image
|
||||
run: |
|
||||
docker push "${REGISTRY}/${IMAGE_REPO}:${{ steps.ver.outputs.tag }}"
|
||||
docker push "${REGISTRY}/${IMAGE_REPO}:stable"
|
||||
docker push "${REGISTRY}/${IMAGE_REPO}:sha-${GITHUB_SHA::12}"
|
||||
29
.github/workflows/dependabot-auto-merge.yml
vendored
Normal file
29
.github/workflows/dependabot-auto-merge.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Dependabot auto-merge
|
||||
|
||||
on: pull_request
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
auto-merge:
|
||||
# Enable auto-merge for minor/patch dependency bumps; majors stay manual.
|
||||
# The merge only happens once every required status check (make test) is
|
||||
# green, so the CI stays the gate.
|
||||
if: github.actor == 'dependabot[bot]'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Fetch dependency metadata
|
||||
id: metadata
|
||||
uses: dependabot/fetch-metadata@v3
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Enable auto-merge (minor + patch)
|
||||
if: steps.metadata.outputs.update-type != 'version-update:semver-major'
|
||||
run: gh pr merge --auto --squash "$PR_URL"
|
||||
env:
|
||||
PR_URL: ${{ github.event.pull_request.html_url }}
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -1 +1,6 @@
|
||||
databases.csv
|
||||
__pycache__
|
||||
artifacts/
|
||||
*.egg-info
|
||||
dist/
|
||||
build/
|
||||
.mcp.json
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
language: shell
|
||||
script: shellcheck $(find . -type f -name '*.sh')
|
||||
452
CHANGELOG.md
Normal file
452
CHANGELOG.md
Normal file
@@ -0,0 +1,452 @@
|
||||
# Changelog
|
||||
|
||||
## [4.0.0] - 2026-08-17
|
||||
|
||||
Breaking:
|
||||
- CLI: *--repo-name* and *--databases-csv* are required. One default was the
|
||||
literal *backup-docker-to-local* while its help promised the git folder name;
|
||||
the other pointed into the installed package, so a forgotten flag ran the
|
||||
whole backup silently without a single dump.
|
||||
- CLI: *--dump-only-sql* is now *--only-sql*; the old spelling exits 2.
|
||||
- CLI: *--everything* is withdrawn. Its only real effect was to ignore
|
||||
*--images-no-stop-required*, which leaving that list empty already does.
|
||||
- Library: the runner injected into *volume_snapshot* receives an argv list
|
||||
instead of a command string.
|
||||
|
||||
New:
|
||||
- Backup: *--only-files* — no dumps at all, every volume as files, for hosts
|
||||
that hold no database credentials. Needs no *--databases-csv*; mutually
|
||||
exclusive with *--only-sql*.
|
||||
- Backup: the engine is detected by executing the dump tool in the container
|
||||
(*pg_dumpall*, *mariadb-dump*, *mysqldump*), not by reading the image name.
|
||||
A dedicated Postgres tagged *<app>-database* is finally dumped; an image
|
||||
merely named like an engine no longer kills the run with exit 127. Probed
|
||||
once per image ID, and an image shipping only *mysqldump* is dumped with it.
|
||||
- Library: *baudolo.databases* states the databases.csv contract once —
|
||||
columns, delimiter, cluster marker, validator, *read_rows()* — for the seed,
|
||||
the backup, and external consumers.
|
||||
|
||||
Changed:
|
||||
- Backup: every command is an argv list; *shell=True* is gone. A database name
|
||||
is validated on read as strictly as the seed writes it, *PGPASSWORD* travels
|
||||
in the child's environment instead of the command string, and a failing dump
|
||||
deletes its partial file instead of leaving it behind.
|
||||
|
||||
## [3.6.1] - 2026-08-17
|
||||
|
||||
- Restore: *--empty* on a cluster dump is a catalog-wide sweep — it drops every
|
||||
non-template database and every non-pg_ role of the instance. On a dedicated
|
||||
instance that is right, because the dump recreates all of it; on a shared one
|
||||
it destroys databases the dump does not carry, with nothing to restore them
|
||||
from. No test had ever executed that sweep: the e2e dropped the cluster by
|
||||
hand first and left the pre-clean with zero rows to generate.
|
||||
- Restore: the instance is checked instead of the sweep being narrowed.
|
||||
*--empty* refuses when the instance holds a database the dump does not carry,
|
||||
names it, and touches nothing. Narrowing the sweep is the obvious fix and is
|
||||
worse — a surviving database that owns or merely grants to one of the dump's
|
||||
roles pins it in *pg_shdepend*, *DROP OWNED BY* reaches only the control
|
||||
database the pre-clean is connected to, so *DROP ROLE* fails after the dump's
|
||||
own databases are already gone and the replay never starts.
|
||||
- Restore: the dump's inventory is read with a real identifier parser. A quoted
|
||||
name may hold spaces, and psql options precede the target of a *\connect*
|
||||
line, so a character class that stops at whitespace read *"odd name"* as
|
||||
*odd* and *-reuse-previous=on* as a database.
|
||||
- Tests: the cluster e2e no longer empties the instance itself, so *--empty*
|
||||
has to do it and the replay has to put it back. A second pass adds a foreign
|
||||
database and requires the refusal to leave both it and the restored data
|
||||
untouched.
|
||||
|
||||
## [3.6.0] - 2026-08-17
|
||||
|
||||
- Restore: *--empty* drops the schema in one session and replays in the next,
|
||||
with no rollback across the two, so a dump the engine could not parse left an
|
||||
emptied database behind. The dump's header is now checked against the running
|
||||
engine before anything is dropped, and a newer dump is refused.
|
||||
Forward across a major version stays allowed; *--no-version-check* is the way out.
|
||||
- Restore: a volume with driver options — NFS, a bind device, tmpfs — keeps the
|
||||
usual *_data* path, but docker mounts its real storage over it only while a
|
||||
container holds it. Restoring meanwhile landed under the mount, stayed hidden
|
||||
there, and rsync reported success. That volume is now refused until something
|
||||
mounts it.
|
||||
- Backup: the same volume sits in a snapshot as an empty directory, so it was
|
||||
copied empty and the generation stamped complete. Capture is decided per volume
|
||||
now — an uncaptured one is copied live, the rest keep their snapshot. A single
|
||||
NFS volume no longer costs the whole host its consistent backup.
|
||||
|
||||
## [3.5.0] - 2026-08-17
|
||||
|
||||
- Restore: a *database = '*'* row makes the backup write
|
||||
*<instance>.cluster.backup.sql* via *pg_dumpall*, and nothing could read it
|
||||
back — the CLI knew *files*, *postgres* and *mariadb*, so that dump was
|
||||
stored and unrestorable. *baudolo-restore cluster* replays it against the
|
||||
control database, deliberately without *--single-transaction* because
|
||||
CREATE DATABASE is forbidden inside a transaction block, and filters out the
|
||||
CREATE ROLE of the connecting role, which the pre-clean cannot drop while it
|
||||
holds the session. *--empty* drops the cluster's databases first, then
|
||||
releases what its roles still own, then the roles themselves.
|
||||
|
||||
- Lint: ruff was never wired into the repository — no target, no CI step, no
|
||||
pin — and reported 45 findings across sources and tests. *make ruff* and
|
||||
*make lint* now run it over every file, *make test* gates on a clean run as a
|
||||
fourth parallel spur, and the linter is pinned in a *lint* extra because a
|
||||
minor bump changes which rules fire.
|
||||
|
||||
## [3.4.3] - 2026-08-16
|
||||
|
||||
- Backup: *create_version_directory* carried *exist_ok=True*, so a run starting
|
||||
in the same wall-clock second as its predecessor claimed that predecessor's
|
||||
generation. Generation names carry seconds, and a host with little to copy
|
||||
finishes inside one — rsync *--delete* then overwrote a finished generation,
|
||||
and only afterwards did *create_stamp_file* refuse the already-stamped
|
||||
directory and exit 2. The guard reported the damage instead of preventing it.
|
||||
- Backup: the generation directory is claimed exclusively. Claiming it is the
|
||||
first filesystem action of a run, so a collision aborts before the first
|
||||
write and names the second it collided on.
|
||||
- Tests: the idempotence test asserted the reuse and gave way to one that
|
||||
requires the refusal.
|
||||
|
||||
## [3.4.2] - 2026-08-15
|
||||
|
||||
- Backup: *has_image* matched the raw *.Config.Image*, so the registry host and
|
||||
the tag decided the dump tool. On a swarm node named after the app under test,
|
||||
*svc-db-mariadb-swarm-mgr-01:5000/postgres_custom* read as MariaDB and
|
||||
*mariadb-dump* ran inside a Postgres container: exit 127, and the
|
||||
*BackupException* took the backup unit with it.
|
||||
- Backup: *image_name* strips digest, tag and registry host, so the engine rests
|
||||
on the repository path alone — the exact-matching intent of 3.0.0 applied to
|
||||
the one place that change did not reach.
|
||||
- Tests: both false-positive directions on *has_image*, plus an e2e that
|
||||
reproduces the shape with a *docker tag* and asserts a real *pg_dump* lands.
|
||||
|
||||
## [3.4.1] - 2026-08-05
|
||||
|
||||
- Backup: each volume is copied twice into the same destination — once hot,
|
||||
once cold after the container is stopped — and rsync ran with *-b*, so
|
||||
*--delete* renamed rather than removed a file the source had dropped between
|
||||
the passes. Stopping a container is what makes the source drop files: a
|
||||
graceful shutdown flushes and the format rolls its commit point. The
|
||||
superseded file survived as *name~* beside the real one and was restored into
|
||||
live data.
|
||||
- Backup: for an opaque payload that is stale bytes nobody reads; for a format
|
||||
that enumerates its own directory it is corruption. Lucene resolves the
|
||||
current commit by parsing every file starting with *segments* as a radix-36
|
||||
generation, so a restored *segments_3~* leaves the shard store unreadable and
|
||||
the primary at *NO_VALID_SHARD_COPY*. With *.security-7* unallocatable the
|
||||
reserved *elastic* user has no password hash, every probe answers 401 and the
|
||||
container never turns healthy.
|
||||
- Backup: *--link-dest* already provides the incrementals and nothing reads the
|
||||
twins — the restore path is an unfiltered *rsync -avv --delete* into the live
|
||||
volume. Dropping *-b* leaves the predecessor generation byte-identical, keeps
|
||||
the hardlinks intact and makes generations smaller, never larger.
|
||||
- Tests: the absence of *--backup* is asserted on the rsync invocation.
|
||||
|
||||
## [3.4.0] - 2026-08-02
|
||||
|
||||
- Backup: *-a* implies *-D*, so a generation was written with
|
||||
*--devices --specials* and rsync recreated every unix socket and fifo found in
|
||||
a volume. Where the backup root is an nfs-ganesha export, ganesha accepts the
|
||||
socket on write but cannot serve it back, and the remote pull's sender then
|
||||
fails with *readdir* / *readlink_stat* "Invalid argument (22)" and exits 23 —
|
||||
deterministically, for every retry. *--no-D* keeps them out of the generation.
|
||||
- Backup: nothing restorable is lost. Sockets and fifos are recreated by the
|
||||
daemons that own them, and the postfix queue itself — *incoming*, *active*,
|
||||
*deferred*, *hold*, *maildrop* — is unaffected, so accepted-but-undelivered
|
||||
mail stays in the backup. Device nodes go too; the only volume that could hold
|
||||
them is a nested docker data root, which does not belong in a backup anyway.
|
||||
- Tests: the flag is asserted on the rsync invocation.
|
||||
|
||||
## [3.3.0] - 2026-08-02
|
||||
|
||||
- Backup: *--volumes-no-backup-required* excludes a volume by name.
|
||||
*--images-no-backup-required* resolves through *volume_is_fully_ignored*,
|
||||
which skips a volume only when every container using it is ignored — a
|
||||
container holding a derived tree beside state that must be kept cannot
|
||||
express the exclusion at all. A docker-in-docker data root is exactly that
|
||||
shape, and excluding by image would drop all three of its volumes.
|
||||
- Backup: the name check runs before *containers_using_volume*, so an excluded
|
||||
volume costs no docker inspection and the decision does not depend on which
|
||||
containers exist when the run starts.
|
||||
- Tests: two volumes off one container, asserting the sibling survives — the
|
||||
property the image lever cannot provide — as unit and end-to-end.
|
||||
|
||||
## [3.2.2] - 2026-07-31
|
||||
|
||||
- Backup: the btrfs snapshot is carved inside its subject, as
|
||||
*<data root>/.baudolo-<tag>*, not beside it. The kernel refuses a snapshot
|
||||
whose destination is on another filesystem, which is exactly what the parent
|
||||
directory is when the data root is a mountpoint of its own — a dedicated disk
|
||||
mounted onto */var/lib/docker* failed every run with EXDEV. Placing it inside
|
||||
makes source and destination the same filesystem by construction, and aligns
|
||||
btrfs with the zfs path, which already resolves its snapshot inside the
|
||||
subject at *<subject>/.zfs/snapshot/<tag>*. A leftover from an interrupted run
|
||||
appears in the next snapshot as an empty directory rather than recursing,
|
||||
since btrfs does not include nested subvolumes.
|
||||
|
||||
## [3.2.1] - 2026-07-31
|
||||
|
||||
- Backup: the snapshot resolver keeps the trailing separator *get_storage_path*
|
||||
puts on a volume path — *os.path.abspath* stripped 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* had
|
||||
nothing to match against the previous generation.
|
||||
- Backup: snapshot teardown no longer fails a completed run. A busy
|
||||
*btrfs subvolume delete* raised out of the *finally*, skipping the generation
|
||||
stamp and the compose handling on a run whose data was already copied, and
|
||||
masking whatever the body had raised. The leftover is reported instead.
|
||||
- Backup: a volume created after the snapshot was taken is copied live with a
|
||||
warning instead of aborting the run. Nothing is stopped in snapshot mode, so
|
||||
the host keeps creating volumes for the whole copy.
|
||||
- Backup: the snapshot pass compares by content (*--checksum*) again. 3.2.0
|
||||
dropped it 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 pass had no authoritative pass to repair
|
||||
it. Still one pass where the live path takes two.
|
||||
- Backup: *--hard-restart-projects* is refused alongside *--snapshot*, like
|
||||
*--shutdown* already is. It 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, which is why the layout defect shipped.
|
||||
|
||||
## [3.2.0] - 2026-07-31
|
||||
|
||||
- Backup: *--snapshot {btrfs,zfs}* with *--snapshot-subject* captures every
|
||||
volume from one atomic filesystem snapshot. The subject — the btrfs subvolume
|
||||
or zfs dataset holding the docker volumes, e.g. */var/lib/docker* — is frozen
|
||||
once per run, so a generation shares a single point in time and no container
|
||||
is stopped. Restoring such a copy is an ordinary crash recovery, which every
|
||||
supported engine performs at startup. This is the mode 3.1.4 pointed to for
|
||||
volumes where two rsync passes over a live tree stop being affordable.
|
||||
- Backup: snapshot passes copy once and drop *--checksum*. Verification exists
|
||||
because a hot pass writes its destination from a moving source; a snapshot
|
||||
source cannot move, so size and mtime cannot race and the second full read is
|
||||
pure cost.
|
||||
- Backup: an unsupported filesystem or unknown kind fails with *SnapshotError*.
|
||||
The kind is stated, not probed — an inconclusive probe would fall back to a
|
||||
live copy and hand out the torn backup the mode prevents. *--shutdown* is
|
||||
rejected alongside *--snapshot* rather than ignored, since nothing is stopped.
|
||||
- Refactor: *backup/app.py* splits into *layout.py*, *policy.py* and *dumps.py*
|
||||
along the lines it already had; 276 lines down to 124.
|
||||
- Tests: unit coverage for snapshot, layout, policy, volume and CLI validation.
|
||||
E2E cases drive real btrfs, zfs and ext4 on loop devices, one proving the
|
||||
loud refusal; another writes a MariaDB across the snapshot and requires the
|
||||
restored server to recover on its own with every committed row and none of
|
||||
the later ones. CI installs zfs and sets *E2E_REQUIRE_FILESYSTEMS*, so a
|
||||
missing kernel module fails the build instead of skipping a filesystem.
|
||||
|
||||
## [3.1.4] - 2026-07-31
|
||||
|
||||
- Backup: the post-stop volume pass now compares by content (*--checksum*), so
|
||||
it can no longer skip a file the hot pass had copied from a live source. Each
|
||||
volume is rsynced twice into the same destination — once with the container
|
||||
running, once after it is stopped — and the second pass used rsync's quick
|
||||
check (size plus whole-second mtime). A pre-allocated 16 MiB WAL segment never
|
||||
changes size, so when its last pre-stop write and postgres' shutdown
|
||||
checkpoint fell in the same whole second, the cold pass skipped it while still
|
||||
replacing *global/pg_control*, whose previous write was seconds earlier. The
|
||||
generation then paired a post-shutdown *pg_control* with a WAL segment still
|
||||
zeroed at the recorded checkpoint LSN, and restoring it crash-looped postgres
|
||||
with "invalid record length … expected at least 24, got 0" followed by "PANIC:
|
||||
could not locate a valid checkpoint record". *backup_volume* takes
|
||||
*authoritative* as a required keyword rather than an optional flag, so each of
|
||||
the four call sites states which pass it is; the hot passes keep the quick
|
||||
check. *--ignore-times* was rejected because it destroys the *--link-dest*
|
||||
hardlink dedup (measured 20/20 to 0/20, generation size doubled), and
|
||||
*--modify-window=-1* because it makes correctness depend on the destination
|
||||
filesystem preserving sub-second mtimes, which degrades silently on NFS or
|
||||
ext3.
|
||||
- Cost: the quick check scales with file count, *--checksum* with bytes read on
|
||||
both sides, and it runs while the container is stopped. The extra stop time
|
||||
stays under a minute up to roughly 4 GB on spinning disk, 15 GB on a SATA SSD
|
||||
and 60 GB on NVMe; at 1 TB it is 17 minutes on NVMe and over three hours on
|
||||
spinning disk. No size threshold is built in, since a guessed one would drop
|
||||
the guarantee exactly where an unrestorable backup costs most — volumes at
|
||||
that scale want filesystem snapshots or *pg_basebackup* rather than two rsync
|
||||
passes over a live tree.
|
||||
|
||||
## [3.1.3] - 2026-07-20
|
||||
|
||||
- Restore: the postgres dump replay now runs under *--single-transaction*,
|
||||
so a concurrent writer on a live database can no longer interleave a row
|
||||
between the replay's table re-create and its *COPY* and trip a "duplicate
|
||||
key value violates unique constraint" abort under ON_ERROR_STOP. This is
|
||||
the discourse restore-drill race (*mini_scheduler* upserting
|
||||
*scheduler_stats(id=1)* mid-restore) that failed the whole restore. The
|
||||
*--empty* pre-clean stays multi-statement (*\gexec*, one DROP per
|
||||
statement) because a single DROP transaction exhausts
|
||||
*max_locks_per_transaction* on large schemas (e.g. gitlab).
|
||||
- Refactor: the *--empty* pre-clean SQL moves out of the inline Python
|
||||
string into *src/baudolo/restore/db/empty_preclean.sql* (loaded via
|
||||
*dirname(__file__)*, declared as package-data so it ships in the wheel).
|
||||
- Tests: a unit test guards the single-transaction / multi-statement split
|
||||
(replay carries *--single-transaction*, pre-clean does not); a new e2e
|
||||
reproduces the live-writer race and asserts the restore survives it.
|
||||
|
||||
## [3.1.2] - 2026-07-18
|
||||
|
||||
- Restore: the postgres *--empty* pre-clean also drops user-owned text
|
||||
search configurations and dictionaries (*pg_ts_config*, *pg_ts_dict*),
|
||||
so a schema shipping a custom dictionary (e.g. taiga's
|
||||
*english_stem_nostop*) no longer aborts the replay with "duplicate key
|
||||
value violates unique constraint pg_ts_dict_dictname_index" under
|
||||
ON_ERROR_STOP.
|
||||
- Tests: the string-assertion unit test for the pre-clean SQL is replaced
|
||||
by real scenario data in the e2e: the seeded schema contains an
|
||||
overloaded *f()/f(int)* pair and the nostop dictionary plus
|
||||
configuration, and the restored database is queried to prove each
|
||||
survives the backup, pre-clean and replay cycle exactly once.
|
||||
|
||||
## [3.1.1] - 2026-07-17
|
||||
|
||||
- Restore: the postgres *--empty* pre-clean drops functions and procedures
|
||||
by their identity signature (*pg_get_function_identity_arguments*), so a
|
||||
schema that overloads a function name (e.g. discourse) no longer aborts
|
||||
the replay with "function name is not unique" under ON_ERROR_STOP.
|
||||
Identifier quoting moves from the outer DROP format into each object
|
||||
branch, since the *name(args)* compound must not be quoted as a whole; a
|
||||
unit test pins the per-branch *%I* quoting so future branches cannot
|
||||
regress unquoted.
|
||||
|
||||
## [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
|
||||
public; dumps containing CREATE COLLATION (e.g. OpenProject's ICU
|
||||
collation versions_name) no longer abort the replay with 'collation
|
||||
already exists'.
|
||||
- Maintenance: base image bumped from python 3.11-slim to 3.14-slim.
|
||||
|
||||
## [1.8.0] - 2026-07-11
|
||||
|
||||
Swarm-aware backups and replayable restores.
|
||||
|
||||
- Backup: swarm task containers are never stopped or started manually
|
||||
anymore; they are skipped visibly and backed up hot, while the sql dump
|
||||
stays the consistent database backup.
|
||||
- Backup: a container that vanishes between listing and inspect no longer
|
||||
aborts the run; a failing inspect on a container that still exists keeps
|
||||
failing loudly.
|
||||
- Backup: pg_dump runs with the no-owner and no-privileges flags so dumps
|
||||
are replayable by the owning app user.
|
||||
- Restore: the mariadb empty mode drops all tables in one client session
|
||||
with FOREIGN_KEY_CHECKS disabled; FK-linked parent tables no longer abort
|
||||
the replay with ERROR 1451.
|
||||
- Restore: the postgres empty mode drops only current-user-owned objects,
|
||||
and the replay skips superuser-only dump lines without ever touching
|
||||
COPY data blocks.
|
||||
- Restore: the replay streams the dump through a temp file instead of
|
||||
buffering it in memory; multi-GB dumps no longer OOM the restore.
|
||||
- Tooling: the e2e runner reaches the DinD daemon via docker exec instead
|
||||
of a host-published unencrypted API port.
|
||||
- Tooling: new end-to-end test reproducing the swarm stop flake, plus unit
|
||||
tests for the restore filters and the swarm probes; the suite is 36 unit,
|
||||
9 integration and 30 e2e tests.
|
||||
- Tooling: Dependabot with auto-merge for minor and patch updates.
|
||||
|
||||
## [1.7.1] - 2026-05-26
|
||||
|
||||
* 🔌 MariaDB SQL backups now connect over TCP loopback so the dump always matches the same wildcard-host grant the application uses — no more surprise `ERROR 1045 Access denied` when a localhost-bound auth row preempts.
|
||||
* 🧪 New regression and bug-repro tests pin the TCP behaviour and prove it under the exact preemption setup that caused the production failure on MariaDB 12.
|
||||
* 🩺 E2E test infrastructure: DinD bridge and inner daemon now default to MTU 1280 so registry pulls survive host paths with broken PMTUD (override via `E2E_DIND_MTU`).
|
||||
|
||||
|
||||
## [1.7.0] - 2026-02-07
|
||||
|
||||
* 🚀 Backup jobs now support all valid Docker Compose file names – case-insensitive and hassle-free.
|
||||
|
||||
|
||||
## [1.6.0] - 2026-02-06
|
||||
|
||||
* Compose handling is now fully delegated to the Infinito.Nexus compose wrapper or plain docker compose, removing all custom env and file detection to ensure a single, consistent source of truth.
|
||||
|
||||
|
||||
## [1.5.0] - 2026-01-31
|
||||
|
||||
* * Make `databases.csv` optional: missing or empty files now emit warnings and no longer break backups
|
||||
* Fix Docker CLI compatibility by switching to `docker-ce-cli` and required build tools
|
||||
|
||||
|
||||
## [1.4.0] - 2026-01-31
|
||||
|
||||
* Baudolo now restarts Docker Compose stacks in a wrapper-aware way (with a `docker compose` fallback), ensuring that all Compose overrides and env files are applied identically to the Infinito.Nexus workflow.
|
||||
|
||||
|
||||
## [1.3.0] - 2026-01-10
|
||||
|
||||
* Empty databases.csv no longer causes baudolo-seed to fail
|
||||
|
||||
|
||||
## [1.2.0] - 2025-12-29
|
||||
|
||||
* * Introduced **`--dump-only-sql`** mode for reliable, SQL-only database backups (replaces `--dump-only`).
|
||||
* Database configuration in `databases.csv` is now **strict and explicit** (`*` or concrete database name only).
|
||||
* **PostgreSQL cluster backups** are supported via `*`.
|
||||
* SQL dumps are written **atomically** to avoid corrupted or empty files.
|
||||
* Backups are **smarter and faster**: ignored volumes are skipped early, file backups run only when needed.
|
||||
* Improved reliability through expanded end-to-end tests and safer defaults.
|
||||
|
||||
|
||||
## [1.1.1] - 2025-12-28
|
||||
|
||||
* * **Backup:** In ***--dump-only-sql*** mode, fall back to file backups with a warning when no database dump can be produced (e.g. missing `databases.csv` entry).
|
||||
|
||||
|
||||
## [1.1.0] - 2025-12-28
|
||||
|
||||
* * **Backup:** Log a warning and skip database dumps when no databases.csv entry is present instead of raising an exception; introduce module-level logging and apply formatting cleanups across backup/restore code and tests.
|
||||
* **CLI:** Switch to an FHS-compliant default backup directory (/var/lib/backup) and use a stable default repository name instead of dynamic detection.
|
||||
* **Maintenance:** Update mirror configuration and ignore generated .egg-info files.
|
||||
|
||||
|
||||
## [1.0.0] - 2025-12-27
|
||||
|
||||
* Official Release 🥳
|
||||
|
||||
37
Dockerfile
Normal file
37
Dockerfile
Normal file
@@ -0,0 +1,37 @@
|
||||
# syntax=docker/dockerfile:1
|
||||
FROM python:3.14-slim
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Base deps for build/runtime + docker repo key
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
make \
|
||||
rsync \
|
||||
ca-certificates \
|
||||
bash \
|
||||
curl \
|
||||
gnupg \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install Docker CLI (docker-ce-cli) from Docker's official apt repo
|
||||
RUN bash -lc "set -euo pipefail \
|
||||
&& install -m 0755 -d /etc/apt/keyrings \
|
||||
&& curl -fsSL https://download.docker.com/linux/debian/gpg \
|
||||
| gpg --dearmor -o /etc/apt/keyrings/docker.gpg \
|
||||
&& chmod a+r /etc/apt/keyrings/docker.gpg \
|
||||
&& . /etc/os-release \
|
||||
&& echo \"deb [arch=\$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \${VERSION_CODENAME} stable\" \
|
||||
> /etc/apt/sources.list.d/docker.list \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y --no-install-recommends docker-ce-cli \
|
||||
&& rm -rf /var/lib/apt/lists/*"
|
||||
|
||||
# Fail fast if docker client is missing
|
||||
RUN docker version || true
|
||||
RUN command -v docker
|
||||
|
||||
COPY . .
|
||||
RUN make install
|
||||
|
||||
ENV PYTHONUNBUFFERED=1
|
||||
CMD ["baudolo", "--help"]
|
||||
4
MIRRORS
Normal file
4
MIRRORS
Normal file
@@ -0,0 +1,4 @@
|
||||
git@github.com:kevinveenbirkenbach/backup-docker-to-local.git
|
||||
ssh://git@git.veen.world:2201/kevinveenbirkenbach/backup-docker-to-local.git
|
||||
ssh://git@code.infinito.nexus:2201/kevinveenbirkenbach/backup-docker-to-local.git
|
||||
https://pypi.org/project/backup-docker-to-local/
|
||||
82
Makefile
Normal file
82
Makefile
Normal file
@@ -0,0 +1,82 @@
|
||||
.PHONY: install install-lint build clean lint ruff ruff-fix \
|
||||
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
|
||||
|
||||
IMAGE_NAME ?= baudolo
|
||||
IMAGE_TAG ?= local
|
||||
IMAGE := $(IMAGE_NAME):$(IMAGE_TAG)
|
||||
|
||||
install:
|
||||
@set -eu; \
|
||||
PY="$(PY_DEFAULT)"; \
|
||||
if [ -n "$${VIRTUAL_ENV:-}" ] && [ -x "$${VIRTUAL_ENV}/bin/python" ]; then \
|
||||
PY="$${VIRTUAL_ENV}/bin/python"; \
|
||||
fi; \
|
||||
echo ">>> Using python: $$PY"; \
|
||||
"$$PY" -m pip install --upgrade pip; \
|
||||
"$$PY" -m pip install -e .; \
|
||||
command -v baudolo >/dev/null 2>&1 || { \
|
||||
echo "ERROR: baudolo not found on PATH after install"; \
|
||||
exit 2; \
|
||||
}; \
|
||||
baudolo --help >/dev/null 2>&1 || true
|
||||
|
||||
# ------------------------------------------------------------
|
||||
# Build the baudolo Docker image
|
||||
# ------------------------------------------------------------
|
||||
build:
|
||||
@echo ">> Building Docker image $(IMAGE)"
|
||||
docker build -t $(IMAGE) .
|
||||
|
||||
clean:
|
||||
git clean -fdX .
|
||||
|
||||
# Separate from `install` so the test image does not have to carry the linter.
|
||||
install-lint:
|
||||
@$(PY_DEFAULT) -m pip install -q -e ".[lint]"
|
||||
|
||||
# Runs on the host, not in the image, so it also covers what the Dockerfile
|
||||
# does not copy.
|
||||
ruff: install-lint
|
||||
@echo ">> Running ruff over the whole repository"
|
||||
@$(PY_DEFAULT) -m ruff check .
|
||||
@$(PY_DEFAULT) -m ruff format --check .
|
||||
|
||||
ruff-fix: install-lint
|
||||
@$(PY_DEFAULT) -m ruff check --fix .
|
||||
@$(PY_DEFAULT) -m ruff format .
|
||||
|
||||
lint: ruff
|
||||
|
||||
# clean + build run once and in order, then lint and the three suites run
|
||||
# concurrently via -j4; 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) -j4 lint test-unit-run test-integration-run test-e2e-run
|
||||
|
||||
test-unit: clean build test-unit-run
|
||||
|
||||
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-run:
|
||||
@echo ">> Running integration tests"
|
||||
@docker run --rm -t $(IMAGE) \
|
||||
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
|
||||
242
README.md
242
README.md
@@ -1,62 +1,220 @@
|
||||
# docker-volume-backup
|
||||
[](./LICENSE.txt) [](https://travis-ci.org/kevinveenbirkenbach/docker-volume-backup)
|
||||
# baudolo – Deterministic Backup & Restore for Docker Volumes 📦🔄
|
||||
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate) [](https://www.gnu.org/licenses/agpl-3.0) [](https://www.docker.com) [](https://www.python.org) [](https://github.com/kevinveenbirkenbach/backup-docker-to-local/stargazers)
|
||||
|
||||
## goal
|
||||
This script backups all docker-volumes with the help of rsync.
|
||||
|
||||
## scheme
|
||||
It is part of the following scheme:
|
||||

|
||||
Further information you will find [in this blog post](https://www.veen.world/2020/12/26/how-i-backup-dedicated-root-servers/).
|
||||
`baudolo` is a backup and restore system for Docker volumes with
|
||||
**mandatory file backups** and **explicit, deterministic database dumps**.
|
||||
It is designed for environments with many Docker services where:
|
||||
- file-level backups must always exist
|
||||
- database dumps must be intentional, predictable, and auditable
|
||||
|
||||
## Backup all volumes
|
||||
Execute:
|
||||
## ✨ Key Features
|
||||
|
||||
```bash
|
||||
./docker-volume-backup.sh
|
||||
- 📦 Incremental Docker volume backups using `rsync --link-dest`
|
||||
- 🗄 Optional SQL dumps for:
|
||||
- PostgreSQL
|
||||
- MariaDB / MySQL
|
||||
- 🌱 Explicit database definition for SQL backups (no auto-discovery)
|
||||
- 🧾 Backup integrity stamping via `dirval` (Python API)
|
||||
- ⏸ Automatic container stop/start when required for consistency
|
||||
- 🚫 Whitelisting of containers that do not require stopping
|
||||
- ♻️ Modular, maintainable Python architecture
|
||||
|
||||
|
||||
## 🧠 Core Concept (Important!)
|
||||
|
||||
`baudolo` **separates file backups from database dumps**.
|
||||
|
||||
- **Docker volumes are always backed up at file level**
|
||||
- **SQL dumps are created only for explicitly defined databases**
|
||||
|
||||
This results in the following behavior:
|
||||
|
||||
| Database defined | File backup | SQL dump |
|
||||
|------------------|-------------|----------|
|
||||
| No | ✔ yes | ✘ no |
|
||||
| Yes | ✔ yes | ✔ yes |
|
||||
|
||||
## 📁 Backup Layout
|
||||
|
||||
Backups are stored in a deterministic, fully nested structure:
|
||||
|
||||
```text
|
||||
<backups-dir>/
|
||||
└── <machine-hash>/
|
||||
└── <repo-name>/
|
||||
└── <timestamp>/
|
||||
└── <volume-name>/
|
||||
├── files/
|
||||
└── sql/
|
||||
└── <database>.backup.sql
|
||||
```
|
||||
|
||||
## Recover
|
||||
### Meaning of each level
|
||||
|
||||
### database
|
||||
```bash
|
||||
docker exec -i mysql_container mysql -uroot -psecret database < db.sql
|
||||
```
|
||||
* `<machine-hash>`
|
||||
SHA256 hash of `/etc/machine-id` (host separation)
|
||||
|
||||
### volume
|
||||
Execute:
|
||||
* `<repo-name>`
|
||||
Logical backup namespace (project / stack)
|
||||
|
||||
* `<timestamp>`
|
||||
Backup generation (`YYYYMMDDHHMMSS`)
|
||||
|
||||
* `<volume-name>`
|
||||
Docker volume name
|
||||
|
||||
* `files/`
|
||||
Incremental file backup (rsync)
|
||||
|
||||
* `sql/`
|
||||
Optional SQL dumps (only for defined databases)
|
||||
|
||||
## 🚀 Installation
|
||||
|
||||
### Local (editable install)
|
||||
|
||||
```bash
|
||||
|
||||
bash ./docker-volume-recover.sh "{{volume_name}}" "$(sha256sum /etc/machine-id | head -c 64)" "{{version_to_recover}}"
|
||||
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Database
|
||||
## 🌱 Database Definition (SQL Backup Scope)
|
||||
|
||||
## Debug
|
||||
To checkout what's going on in the mount container type in the following command:
|
||||
### How SQL backups are defined
|
||||
|
||||
`baudolo` creates SQL dumps **only** for databases that are **explicitly defined**
|
||||
via configuration (e.g. a databases definition file or seeding step).
|
||||
|
||||
If a database is **not defined**:
|
||||
|
||||
* its Docker volume is still backed up (files)
|
||||
* **no SQL dump is created**
|
||||
|
||||
> No database definition → file backup only
|
||||
> Database definition present → file backup + SQL dump
|
||||
|
||||
### Why explicit definition?
|
||||
|
||||
`baudolo` does **not** inspect running containers to guess databases.
|
||||
|
||||
Databases must be explicitly defined to guarantee:
|
||||
|
||||
* deterministic backups
|
||||
* predictable restore behavior
|
||||
* reproducible environments
|
||||
* zero accidental production data exposure
|
||||
|
||||
### Required database metadata
|
||||
|
||||
Each database definition provides:
|
||||
|
||||
* database instance (container or logical instance)
|
||||
* database name
|
||||
* database user
|
||||
* database password
|
||||
|
||||
This information is used by `baudolo` to execute
|
||||
`pg_dump`, `pg_dumpall`, or `mariadb-dump`.
|
||||
|
||||
## 💾 Running a Backup
|
||||
|
||||
```bash
|
||||
docker run -it --entrypoint /bin/sh --rm --volumes-from {{container_name}} -v /Backups/:/Backups/ kevinveenbirkenbach/alpine-rsync
|
||||
baudolo \
|
||||
--compose-dir /srv/docker \
|
||||
--backups-dir /Backups \
|
||||
--repo-name my-repo \
|
||||
--databases-csv /etc/baudolo/databases.csv \
|
||||
--database-containers central-postgres central-mariadb \
|
||||
--images-no-stop-required alpine postgres mariadb mysql \
|
||||
--images-no-backup-required redis busybox
|
||||
```
|
||||
|
||||
## Setup
|
||||
Install pandas
|
||||
### Common Backup Flags
|
||||
|
||||
## Optimation
|
||||
This setup script is not optimized yet for performance. Please optimized this script for performance if you want to use it in a professional environment.
|
||||
| Flag | Description |
|
||||
| --------------- | ------------------------------------------- |
|
||||
| `--only-sql` | Skip file backups only for DB volumes when dumps succeed; non-DB volumes are still backed up; fallback to files if no dump. |
|
||||
| `--only-files` | Take no dumps at all; every volume is backed up as files. Needs no `--databases-csv`. Mutually exclusive with `--only-sql`. |
|
||||
| `--shutdown` | Do not restart containers after backup |
|
||||
| `--backups-dir` | Backup root directory (required) |
|
||||
| `--repo-name` | Backup namespace under machine hash (required) |
|
||||
| `--databases-csv`| Path to `databases.csv` (required) |
|
||||
|
||||
## Stucking rsync
|
||||
- https://stackoverflow.com/questions/20773118/rsync-suddenly-hanging-indefinitely-during-transfers
|
||||
## ♻️ Restore Operations
|
||||
|
||||
## More information
|
||||
- https://docs.docker.com/storage/volumes/
|
||||
- https://blog.ssdnodes.com/blog/docker-backup-volumes/
|
||||
- https://www.baculasystems.com/blog/docker-backup-containers/
|
||||
- https://gist.github.com/spalladino/6d981f7b33f6e0afe6bb
|
||||
- https://stackoverflow.com/questions/26331651/how-can-i-backup-a-docker-container-with-its-data-volumes
|
||||
- https://netfuture.ch/2013/08/simple-versioned-timemachine-like-backup-using-rsync/
|
||||
- https://zwischenzugs.com/2016/08/29/bash-to-python-converter/
|
||||
- https://en.wikipedia.org/wiki/Incremental_backup#Incremental
|
||||
- https://unix.stackexchange.com/questions/567837/linux-backup-utility-for-incremental-backups
|
||||
### Restore Volume Files
|
||||
|
||||
```bash
|
||||
baudolo-restore files \
|
||||
my-volume \
|
||||
<machine-hash> \
|
||||
<version> \
|
||||
--backups-dir /Backups \
|
||||
--repo-name my-repo
|
||||
```
|
||||
|
||||
Restore into a **different target volume**:
|
||||
|
||||
```bash
|
||||
baudolo-restore files \
|
||||
target-volume \
|
||||
<machine-hash> \
|
||||
<version> \
|
||||
--source-volume source-volume
|
||||
```
|
||||
|
||||
### Restore PostgreSQL
|
||||
|
||||
```bash
|
||||
baudolo-restore postgres \
|
||||
my-volume \
|
||||
<machine-hash> \
|
||||
<version> \
|
||||
--container postgres \
|
||||
--db-name appdb \
|
||||
--db-password secret \
|
||||
--empty
|
||||
```
|
||||
|
||||
### Restore MariaDB / MySQL
|
||||
|
||||
```bash
|
||||
baudolo-restore mariadb \
|
||||
my-volume \
|
||||
<machine-hash> \
|
||||
<version> \
|
||||
--container mariadb \
|
||||
--db-name shopdb \
|
||||
--db-password secret \
|
||||
--empty
|
||||
```
|
||||
|
||||
> `baudolo` automatically detects whether `mariadb` or `mysql`
|
||||
> is available inside the container
|
||||
|
||||
## 🔍 Backup Scheme
|
||||
|
||||
The backup mechanism uses incremental backups with rsync and stamps directories with a unique hash. For more details on the backup scheme, check out [this blog post](https://blog.veen.world/blog/2020/12/26/how-i-backup-dedicated-root-servers/).
|
||||

|
||||
|
||||
## 👨💻 Author
|
||||
|
||||
**Kevin Veen-Birkenbach**
|
||||
- 📧 [kevin@veen.world](mailto:kevin@veen.world)
|
||||
- 🌐 [https://www.veen.world/](https://www.veen.world/)
|
||||
|
||||
## 📜 License
|
||||
|
||||
This project is licensed under the **GNU Affero General Public License v3.0**. See the [LICENSE](./LICENSE) file for details.
|
||||
|
||||
## 🔗 More Information
|
||||
|
||||
- [Docker Volumes Documentation](https://docs.docker.com/storage/volumes/)
|
||||
- [Docker Backup Volumes Blog](https://blog.ssdnodes.com/blog/docker-backup-volumes/)
|
||||
- [Backup Strategies](https://en.wikipedia.org/wiki/Incremental_backup#Incremental)
|
||||
|
||||
---
|
||||
|
||||
Happy Backing Up! 🚀🔐
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
database;username;password;container
|
||||
@@ -1,118 +0,0 @@
|
||||
#!/bin/python
|
||||
# Backups volumes of running containers
|
||||
#
|
||||
import subprocess
|
||||
import os
|
||||
import re
|
||||
import pathlib
|
||||
import pandas
|
||||
from datetime import datetime
|
||||
|
||||
|
||||
def bash(command):
|
||||
print(command)
|
||||
process = subprocess.Popen([command], stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
|
||||
out, err = process.communicate()
|
||||
stdout = out.splitlines()
|
||||
output = []
|
||||
for line in stdout:
|
||||
output.append(line.decode("utf-8"))
|
||||
if process.wait() > bool(0):
|
||||
print(command, out, err)
|
||||
raise Exception("Exitcode is greater then 0")
|
||||
return output
|
||||
|
||||
|
||||
def print_bash(command):
|
||||
output = bash(command)
|
||||
print(list_to_string(output))
|
||||
return output
|
||||
|
||||
|
||||
def list_to_string(list):
|
||||
return str(' '.join(list))
|
||||
|
||||
|
||||
print('start backup routine...')
|
||||
|
||||
dirname = os.path.dirname(__file__)
|
||||
repository_name = os.path.basename(dirname)
|
||||
# identifier of this backups
|
||||
machine_id = bash("sha256sum /etc/machine-id")[0][0:64]
|
||||
# Folder in which all Backups are stored
|
||||
backups_dir = '/Backups/'
|
||||
# Folder in which docker volume backups are stored
|
||||
backup_type_dir = backups_dir + machine_id + "/" + repository_name + "/"
|
||||
# Folder containing all versions
|
||||
versions_dir = backup_type_dir + "versions/"
|
||||
# Time when the backup started
|
||||
backup_time = datetime.now().strftime("%Y%m%d%H%M%S")
|
||||
# Folder containing the current version
|
||||
version_dir = versions_dir + backup_time + "/"
|
||||
# Define latest path
|
||||
latest_link = backup_type_dir + "latest/"
|
||||
# Create folder to store version in
|
||||
pathlib.Path(version_dir).mkdir(parents=True, exist_ok=True)
|
||||
|
||||
if pathlib.Path(latest_link).is_symlink():
|
||||
print("Unlink " + latest_link + "...")
|
||||
pathlib.Path(latest_link).unlink()
|
||||
# Link latest to current version
|
||||
pathlib.Path(latest_link).symlink_to(version_dir)
|
||||
|
||||
print('start volume backups...')
|
||||
print('load connection data...')
|
||||
databases = pandas.read_csv(dirname + "/databases.csv", sep=";")
|
||||
volume_names = bash("docker volume ls --format '{{.Name}}'")
|
||||
for volume_name in volume_names:
|
||||
print('start backup routine for volume: ' + volume_name)
|
||||
containers = bash("docker ps --filter volume=\"" + volume_name + "\" --format '{{.Names}}'")
|
||||
if len(containers) == 0:
|
||||
print('skipped due to no running containers using this volume.')
|
||||
else:
|
||||
container = containers[0]
|
||||
# Folder to which the volumes are copied
|
||||
volume_destination_dir = version_dir + volume_name
|
||||
# Database name
|
||||
database_name = re.split("(_|-)(database|db)", container)[0]
|
||||
# Entries with database login data concerning this container
|
||||
databases_entries = databases.loc[databases['database'] == database_name]
|
||||
# Exception for akaunting due to fast implementation
|
||||
if len(databases_entries) == 1 and container != 'akaunting':
|
||||
print("Backup database...")
|
||||
mysqldump_destination_dir = volume_destination_dir + "/sql"
|
||||
mysqldump_destination_file = mysqldump_destination_dir + "/backup.sql"
|
||||
pathlib.Path(mysqldump_destination_dir).mkdir(parents=True, exist_ok=True)
|
||||
database_entry = databases_entries.iloc[0]
|
||||
database_backup_command = "docker exec " + container + " /usr/bin/mysqldump -u " + database_entry["username"] + " -p" + database_entry["password"] + " " + database_entry["database"] + " > " + mysqldump_destination_file
|
||||
print_bash(database_backup_command)
|
||||
print("Backup files...")
|
||||
files_rsync_destination_path = volume_destination_dir + "/files"
|
||||
pathlib.Path(files_rsync_destination_path).mkdir(parents=True, exist_ok=True)
|
||||
versions = os.listdir(versions_dir)
|
||||
versions.sort(reverse=True)
|
||||
if len(versions) > 1:
|
||||
last_version = versions[1]
|
||||
last_version_files_dir = versions_dir + last_version + "/" + volume_name + "/files"
|
||||
if os.path.isdir(last_version_files_dir):
|
||||
link_dest_parameter="--link-dest='" + last_version_files_dir + "' "
|
||||
else:
|
||||
print("No previous version exists in path "+ last_version_files_dir + ".")
|
||||
link_dest_parameter=""
|
||||
else:
|
||||
print("No previous version exists in path "+ last_version_files_dir + ".")
|
||||
link_dest_parameter=""
|
||||
source_dir = "/var/lib/docker/volumes/" + volume_name + "/_data/"
|
||||
rsync_command = "rsync -abP --delete --delete-excluded " + link_dest_parameter + source_dir + " " + files_rsync_destination_path
|
||||
print_bash(rsync_command)
|
||||
print("stop containers...")
|
||||
print("Backup data after container is stopped...")
|
||||
print_bash("docker stop " + list_to_string(containers))
|
||||
print_bash(rsync_command)
|
||||
print("start containers...")
|
||||
print_bash("docker start " + list_to_string(containers))
|
||||
print("end backup routine for volume:" + volume_name)
|
||||
print('finished volume backups.')
|
||||
print('restart docker service...')
|
||||
print_bash("systemctl restart docker")
|
||||
print('finished backup routine.')
|
||||
@@ -1,32 +0,0 @@
|
||||
#!/bin/bash
|
||||
volume_name="$1" # Volume-Name
|
||||
backup_hash="$2" # Hashed Machine ID
|
||||
version="$3" # version to backup
|
||||
container="$4" # optional
|
||||
mysql_root_password="$5" # optional
|
||||
database="$6" # optional
|
||||
backup_folder="Backups/$backup_hash/docker-volume-backup/versions/$version/$volume_name"
|
||||
backup_files="/$backup_folder/files"
|
||||
backup_sql="/$backup_folder/sql/backup.sql"
|
||||
echo "Inspect volume $volume_name"
|
||||
docker volume inspect "$volume_name"
|
||||
exit_status_volume_inspect=$?
|
||||
if [ $exit_status_volume_inspect -eq 0 ]; then
|
||||
echo "Volume $volume_name allready exists"
|
||||
else
|
||||
echo "Create volume $volume_name"
|
||||
docker volume create "$volume_name"
|
||||
fi
|
||||
|
||||
if [ -f "$backup_sql" ]; then
|
||||
echo "recover mysql dump"
|
||||
cat $backup_sql | docker exec -i "$container" /usr/bin/mysql -u root --password="$mysql_root_password" $database
|
||||
exit 0
|
||||
else
|
||||
if [ -d "$backup_files" ]; then
|
||||
echo "recover files"
|
||||
docker run --rm -v "$volume_name:/recover/" -v "$backup_files:/backup/" "kevinveenbirkenbach/alpine-rsync" sh -c "rsync -avv --delete /backup/ /recover/"
|
||||
fi
|
||||
fi
|
||||
echo "ERROR: $backup_files and $backup_sql don't exist"
|
||||
exit 1
|
||||
37
pyproject.toml
Normal file
37
pyproject.toml
Normal file
@@ -0,0 +1,37 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=69", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "backup-docker-to-local"
|
||||
version = "4.0.0"
|
||||
description = "Backup Docker volumes to local with rsync and optional DB dumps."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.9"
|
||||
license = { text = "AGPL-3.0-or-later" }
|
||||
authors = [{ name = "Kevin Veen-Birkenbach" }]
|
||||
|
||||
dependencies = [
|
||||
"pandas",
|
||||
"dirval",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
# Pinned: a ruff minor bump changes which rules fire, and `make test` gates on
|
||||
# a clean run, so an unpinned lint would fail the suite on an unrelated day.
|
||||
lint = ["ruff==0.16.1"]
|
||||
|
||||
[project.scripts]
|
||||
baudolo = "baudolo.backup.__main__:main"
|
||||
baudolo-restore = "baudolo.restore.__main__:main"
|
||||
baudolo-seed = "baudolo.seed.__main__:main"
|
||||
|
||||
[tool.setuptools]
|
||||
package-dir = { "" = "src" }
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
exclude = ["tests*"]
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
"baudolo.restore.db" = ["*.sql"]
|
||||
230
scripts/test-e2e.sh
Executable file
230
scripts/test-e2e.sh
Executable file
@@ -0,0 +1,230 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# E2E runner using Docker-in-Docker (DinD) with debug-on-failure
|
||||
#
|
||||
# Debug toggles:
|
||||
# E2E_KEEP_ON_FAIL=1 -> keep DinD + volumes + network if tests fail
|
||||
# E2E_KEEP_VOLUMES=1 -> keep volumes even on success/cleanup
|
||||
# E2E_DEBUG_SHELL=1 -> open an interactive shell in the test container instead of running tests
|
||||
# E2E_ARTIFACTS_DIR=./artifacts
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
NET="${E2E_NET:-baudolo-e2e-net}"
|
||||
DIND="${E2E_DIND_NAME:-baudolo-e2e-dind}"
|
||||
DIND_VOL="${E2E_DIND_VOL:-baudolo-e2e-dind-data}"
|
||||
E2E_TMP_VOL="${E2E_TMP_VOL:-baudolo-e2e-tmp}"
|
||||
|
||||
# Host-side access to the DinD daemon goes through `docker exec` (dind()
|
||||
# below) instead of a host-published port: port publishing is not reachable
|
||||
# from every environment (sandboxed runners, hosts with broken loopback
|
||||
# publishing), while exec only needs the outer docker socket. The TCP
|
||||
# listener stays for the test container inside the dedicated network.
|
||||
DIND_HOST_IN_NET="${E2E_DIND_HOST_IN_NET:-tcp://${DIND}:2375}"
|
||||
|
||||
dind() { docker exec "${DIND}" docker "$@"; }
|
||||
dind_stdin() { docker exec -i "${DIND}" docker "$@"; }
|
||||
|
||||
IMG="${E2E_IMAGE:-baudolo:local}"
|
||||
|
||||
READY_TIMEOUT_SECONDS="${E2E_READY_TIMEOUT_SECONDS:-120}"
|
||||
ARTIFACTS_DIR="${E2E_ARTIFACTS_DIR:-./artifacts}"
|
||||
|
||||
DIND_MTU="${E2E_DIND_MTU:-1280}"
|
||||
|
||||
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)"
|
||||
|
||||
mkdir -p "${ARTIFACTS_DIR}"
|
||||
|
||||
log() { echo ">> $*"; }
|
||||
|
||||
dump_debug() {
|
||||
log "DEBUG: collecting diagnostics into ${ARTIFACTS_DIR}"
|
||||
|
||||
{
|
||||
echo "=== Host docker version ==="
|
||||
docker version || true
|
||||
echo
|
||||
echo "=== Host docker info ==="
|
||||
docker info || true
|
||||
echo
|
||||
echo "=== DinD reachable? (docker exec ${DIND} docker version) ==="
|
||||
dind version || true
|
||||
echo
|
||||
} > "${ARTIFACTS_DIR}/debug-host-${TS}.txt" 2>&1 || true
|
||||
|
||||
# DinD logs
|
||||
docker logs --tail=5000 "${DIND}" > "${ARTIFACTS_DIR}/dind-logs-${TS}.txt" 2>&1 || true
|
||||
|
||||
# DinD state
|
||||
{
|
||||
echo "=== dind ps -a ==="
|
||||
dind ps -a || true
|
||||
echo
|
||||
echo "=== dind images ==="
|
||||
dind images || true
|
||||
echo
|
||||
echo "=== dind network ls ==="
|
||||
dind network ls || true
|
||||
echo
|
||||
echo "=== dind volume ls ==="
|
||||
dind volume ls || true
|
||||
echo
|
||||
echo "=== dind system df ==="
|
||||
dind system df || true
|
||||
} > "${ARTIFACTS_DIR}/debug-dind-${TS}.txt" 2>&1 || true
|
||||
|
||||
# Try to capture recent events (best effort; might be noisy)
|
||||
dind events --since 10m --until 0s \
|
||||
> "${ARTIFACTS_DIR}/dind-events-${TS}.txt" 2>&1 || true
|
||||
|
||||
# The shared tmp volume is mounted at /tmp inside the DinD container
|
||||
# itself, so tar it there and copy it out with the outer daemon.
|
||||
log "DEBUG: archiving shared /tmp (volume ${E2E_TMP_VOL})"
|
||||
docker exec "${DIND}" tar -czf "/tmpdump-${TS}.tar.gz" -C /tmp . >/dev/null 2>&1 || true
|
||||
docker cp "${DIND}:/tmpdump-${TS}.tar.gz" "${ARTIFACTS_DIR}/e2e-tmp-${TS}.tar.gz" >/dev/null 2>&1 || true
|
||||
|
||||
log "DEBUG: artifacts written:"
|
||||
find "${ARTIFACTS_DIR}" -maxdepth 1 -mindepth 1 -print | sed 's/^/ /' || true
|
||||
}
|
||||
|
||||
cleanup() {
|
||||
if [ "${FAILED}" -eq 1 ] && [ "${KEEP_ON_FAIL}" = "1" ]; then
|
||||
log "KEEP_ON_FAIL=1 and failure detected -> skipping cleanup."
|
||||
log "Next steps:"
|
||||
echo " - Inspect DinD logs: docker logs ${DIND} | less"
|
||||
echo " - Use DinD daemon: docker exec ${DIND} docker ps -a"
|
||||
echo " - Shared tmp vol: docker exec ${DIND} ls -la /tmp"
|
||||
echo " - DinD docker root: docker exec ${DIND} ls -la /var/lib/docker/volumes"
|
||||
return 0
|
||||
fi
|
||||
|
||||
log "Cleanup: stopping ${DIND} and removing network ${NET}"
|
||||
docker rm -f "${DIND}" >/dev/null 2>&1 || true
|
||||
docker network rm "${NET}" >/dev/null 2>&1 || true
|
||||
|
||||
if [ "${KEEP_VOLUMES}" != "1" ]; then
|
||||
docker volume rm -f "${DIND_VOL}" >/dev/null 2>&1 || true
|
||||
docker volume rm -f "${E2E_TMP_VOL}" >/dev/null 2>&1 || true
|
||||
else
|
||||
log "Keeping volumes (E2E_KEEP_VOLUMES=1): ${DIND_VOL}, ${E2E_TMP_VOL}"
|
||||
fi
|
||||
}
|
||||
trap cleanup EXIT INT TERM
|
||||
|
||||
log "(Re)creating network ${NET} with MTU ${DIND_MTU}"
|
||||
docker network rm "${NET}" >/dev/null 2>&1 || true
|
||||
docker network create \
|
||||
--opt com.docker.network.driver.mtu="${DIND_MTU}" \
|
||||
"${NET}" >/dev/null
|
||||
|
||||
log "Removing old ${DIND} (if any)"
|
||||
docker rm -f "${DIND}" >/dev/null 2>&1 || true
|
||||
|
||||
log "(Re)creating DinD data volume ${DIND_VOL}"
|
||||
docker volume rm -f "${DIND_VOL}" >/dev/null 2>&1 || true
|
||||
docker volume create "${DIND_VOL}" >/dev/null
|
||||
|
||||
log "(Re)creating shared /tmp volume ${E2E_TMP_VOL}"
|
||||
docker volume rm -f "${E2E_TMP_VOL}" >/dev/null 2>&1 || true
|
||||
docker volume create "${E2E_TMP_VOL}" >/dev/null
|
||||
|
||||
log "Starting Docker-in-Docker daemon ${DIND}"
|
||||
docker run -d --privileged \
|
||||
--name "${DIND}" \
|
||||
--network "${NET}" \
|
||||
-e DOCKER_TLS_CERTDIR="" \
|
||||
-v "${DIND_VOL}:/var/lib/docker" \
|
||||
-v "${E2E_TMP_VOL}:/tmp" \
|
||||
docker:dind \
|
||||
--host=tcp://0.0.0.0:2375 \
|
||||
--tls=false \
|
||||
--mtu="${DIND_MTU}" >/dev/null
|
||||
|
||||
log "Waiting for DinD to be ready..."
|
||||
for i in $(seq 1 "${READY_TIMEOUT_SECONDS}"); do
|
||||
if dind version >/dev/null 2>&1; then
|
||||
log "DinD is ready."
|
||||
break
|
||||
fi
|
||||
sleep 1
|
||||
if [ "${i}" -eq "${READY_TIMEOUT_SECONDS}" ]; then
|
||||
echo "ERROR: DinD did not become ready in time"
|
||||
docker logs --tail=200 "${DIND}" || true
|
||||
FAILED=1
|
||||
dump_debug || true
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
log "Ensuring alpine exists in DinD (for debug helpers)"
|
||||
dind pull alpine:3.20 >/dev/null
|
||||
|
||||
log "Loading ${IMG} image into DinD..."
|
||||
docker save "${IMG}" | dind_stdin load >/dev/null
|
||||
|
||||
log "Running E2E tests inside DinD"
|
||||
set +e
|
||||
if [ "${DEBUG_SHELL}" = "1" ]; then
|
||||
log "E2E_DEBUG_SHELL=1 -> opening shell in test container"
|
||||
docker run --rm -it \
|
||||
--network "${NET}" \
|
||||
-e DOCKER_HOST="${DIND_HOST_IN_NET}" \
|
||||
-v "${DIND_VOL}:/var/lib/docker" \
|
||||
-v "${E2E_TMP_VOL}:/tmp" \
|
||||
"${IMG}" \
|
||||
bash -lc '
|
||||
set -e
|
||||
if [ ! -f /etc/machine-id ]; then
|
||||
mkdir -p /etc
|
||||
cat /proc/sys/kernel/random/uuid > /etc/machine-id
|
||||
fi
|
||||
echo ">> DOCKER_HOST=${DOCKER_HOST}"
|
||||
docker ps -a || true
|
||||
exec bash
|
||||
'
|
||||
rc=$?
|
||||
else
|
||||
docker run --rm \
|
||||
--network "${NET}" \
|
||||
-e DOCKER_HOST="${DIND_HOST_IN_NET}" \
|
||||
-e E2E_TEST_PATTERN="${TEST_PATTERN}" \
|
||||
-e E2E_REQUIRE_FILESYSTEMS="${E2E_REQUIRE_FILESYSTEMS:-}" \
|
||||
-v "${DIND_VOL}:/var/lib/docker" \
|
||||
-v "${E2E_TMP_VOL}:/tmp" \
|
||||
"${IMG}" \
|
||||
bash -lc '
|
||||
set -euo pipefail
|
||||
set -x
|
||||
export PYTHONUNBUFFERED=1
|
||||
|
||||
export TMPDIR=/tmp TMP=/tmp TEMP=/tmp
|
||||
|
||||
if [ ! -f /etc/machine-id ]; then
|
||||
mkdir -p /etc
|
||||
cat /proc/sys/kernel/random/uuid > /etc/machine-id
|
||||
fi
|
||||
|
||||
python -m unittest discover -t . -s tests/e2e -p "${E2E_TEST_PATTERN}" -v -f
|
||||
'
|
||||
rc=$?
|
||||
fi
|
||||
set -e
|
||||
|
||||
if [ "${rc}" -ne 0 ]; then
|
||||
FAILED=1
|
||||
echo "ERROR: E2E tests failed (exit code: ${rc})"
|
||||
dump_debug || true
|
||||
exit "${rc}"
|
||||
fi
|
||||
|
||||
log "E2E tests passed."
|
||||
0
src/baudolo/__init__.py
Normal file
0
src/baudolo/__init__.py
Normal file
1
src/baudolo/backup/__init__.py
Normal file
1
src/baudolo/backup/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Baudolo backup package."""
|
||||
6
src/baudolo/backup/__main__.py
Normal file
6
src/baudolo/backup/__main__.py
Normal file
@@ -0,0 +1,6 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from .app import main
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
138
src/baudolo/backup/app.py
Normal file
138
src/baudolo/backup/app.py
Normal file
@@ -0,0 +1,138 @@
|
||||
"""Back up every Docker volume of a host into a timestamped generation."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from contextlib import ExitStack
|
||||
from datetime import datetime
|
||||
|
||||
from .cli import parse_args
|
||||
from .compose import handle_docker_compose_services
|
||||
from .docker import (
|
||||
change_containers_status,
|
||||
containers_using_volume,
|
||||
docker_volume_names,
|
||||
filter_stoppable,
|
||||
)
|
||||
from .dumps import backup_dumps_for_volume, load_databases_df
|
||||
from .layout import (
|
||||
create_version_directory,
|
||||
create_volume_directory,
|
||||
get_machine_id,
|
||||
stamp_directory,
|
||||
)
|
||||
from .policy import requires_stop, volume_is_fully_ignored
|
||||
from .snapshot import snapshot_source, volume_snapshot
|
||||
from .volume import backup_volume, inspect_backing
|
||||
|
||||
|
||||
def main() -> int:
|
||||
args = parse_args()
|
||||
|
||||
machine_id = get_machine_id()
|
||||
# Local wall clock on purpose: generations sort by this name, and UTC would
|
||||
# order new ones before the existing ones wherever the offset is positive.
|
||||
backup_time = datetime.now().strftime("%Y%m%d%H%M%S") # noqa: DTZ005
|
||||
|
||||
versions_dir = os.path.join(args.backups_dir, machine_id, args.repo_name)
|
||||
version_dir = create_version_directory(versions_dir, backup_time)
|
||||
|
||||
databases_df = None if args.only_files else load_databases_df(args.databases_csv)
|
||||
|
||||
print("💾 Start volume backups...", flush=True)
|
||||
|
||||
with ExitStack() as stack:
|
||||
resolve_source = None
|
||||
if args.snapshot:
|
||||
resolve_source = stack.enter_context(
|
||||
volume_snapshot(args.snapshot, args.snapshot_subject, backup_time)
|
||||
)
|
||||
|
||||
for volume_name in docker_volume_names():
|
||||
print(f"Start backup routine for volume: {volume_name}", flush=True)
|
||||
|
||||
if volume_name in args.volumes_no_backup_required:
|
||||
print(
|
||||
f"Skipping volume '{volume_name}' entirely (declared no-backup).",
|
||||
flush=True,
|
||||
)
|
||||
continue
|
||||
|
||||
containers = containers_using_volume(volume_name)
|
||||
|
||||
if volume_is_fully_ignored(containers, args.images_no_backup_required):
|
||||
print(
|
||||
f"Skipping volume '{volume_name}' entirely (all linked containers are ignored).",
|
||||
flush=True,
|
||||
)
|
||||
continue
|
||||
|
||||
vol_dir = create_volume_directory(version_dir, volume_name)
|
||||
|
||||
found_db = dumped_any = False
|
||||
if not args.only_files:
|
||||
found_db, dumped_any = backup_dumps_for_volume(
|
||||
containers=containers,
|
||||
vol_dir=vol_dir,
|
||||
databases_df=databases_df,
|
||||
database_containers=args.database_containers,
|
||||
)
|
||||
|
||||
if args.only_sql and found_db:
|
||||
if not dumped_any:
|
||||
print(
|
||||
f"WARNING: only-sql requested but no DB dump was produced for DB volume '{volume_name}'. "
|
||||
"Falling back to file backup.",
|
||||
flush=True,
|
||||
)
|
||||
else:
|
||||
continue
|
||||
|
||||
backing = inspect_backing(volume_name)
|
||||
live_source = backing.source
|
||||
|
||||
def copy(
|
||||
*,
|
||||
authoritative: bool,
|
||||
source: str = live_source,
|
||||
volume: str = volume_name,
|
||||
target: str = vol_dir,
|
||||
) -> None:
|
||||
backup_volume(
|
||||
versions_dir,
|
||||
volume,
|
||||
target,
|
||||
authoritative=authoritative,
|
||||
source=source,
|
||||
)
|
||||
|
||||
if resolve_source is not None:
|
||||
source, reason = snapshot_source(
|
||||
resolve_source, backing, args.snapshot_subject
|
||||
)
|
||||
if source is not None:
|
||||
copy(authoritative=True, source=source)
|
||||
else:
|
||||
print(
|
||||
f"WARNING: volume '{volume_name}' is not in the snapshot "
|
||||
f"({reason}); copying it live instead.",
|
||||
flush=True,
|
||||
)
|
||||
copy(authoritative=False)
|
||||
continue
|
||||
|
||||
copy(authoritative=False)
|
||||
if requires_stop(containers, args.images_no_stop_required):
|
||||
stoppable = filter_stoppable(containers)
|
||||
change_containers_status(stoppable, "stop")
|
||||
copy(authoritative=True)
|
||||
if not args.shutdown:
|
||||
change_containers_status(stoppable, "start")
|
||||
|
||||
stamp_directory(version_dir)
|
||||
print("Finished volume backups.", flush=True)
|
||||
|
||||
print("Handling Docker Compose services...", flush=True)
|
||||
handle_docker_compose_services(args.compose_dir, args.hard_restart_projects)
|
||||
|
||||
return 0
|
||||
114
src/baudolo/backup/cli.py
Normal file
114
src/baudolo/backup/cli.py
Normal file
@@ -0,0 +1,114 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
|
||||
|
||||
def parse_args() -> argparse.Namespace:
|
||||
p = argparse.ArgumentParser(description="Backup Docker volumes.")
|
||||
|
||||
p.add_argument(
|
||||
"--compose-dir",
|
||||
type=str,
|
||||
required=True,
|
||||
help="Path to the parent directory containing docker-compose setups",
|
||||
)
|
||||
p.add_argument(
|
||||
"--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(
|
||||
"--repo-name",
|
||||
required=True,
|
||||
help="Backup repo folder name under <backups-dir>/<machine-id>/",
|
||||
)
|
||||
p.add_argument(
|
||||
"--databases-csv",
|
||||
help="Path to databases.csv; required unless --only-files is given",
|
||||
)
|
||||
p.add_argument(
|
||||
"--backups-dir",
|
||||
required=True,
|
||||
help="Backup root directory (e.g. /var/lib/backup/)",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
"--snapshot",
|
||||
choices=["btrfs", "zfs"],
|
||||
help="Capture every volume from one atomic filesystem snapshot instead of copying the live tree. Containers are not stopped, and the copy is a single pass. Requires --snapshot-subject. Omit to keep the live two-pass copy.",
|
||||
)
|
||||
p.add_argument(
|
||||
"--snapshot-subject",
|
||||
help="Btrfs subvolume or zfs dataset mountpoint holding the docker volumes, e.g. /var/lib/docker. Required with --snapshot.",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
"--database-containers",
|
||||
nargs="+",
|
||||
default=[],
|
||||
help="Container names treated as special instances for database backups",
|
||||
)
|
||||
p.add_argument(
|
||||
"--images-no-stop-required",
|
||||
nargs="+",
|
||||
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="Exact image references (repo:tag, incl. any registry prefix) for which no backup should be performed",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
"--volumes-no-backup-required",
|
||||
nargs="+",
|
||||
default=[],
|
||||
help="Exact volume names that are never backed up, whatever containers use them. For derived trees a restore cannot reproduce, above all a nested docker data root",
|
||||
)
|
||||
|
||||
p.add_argument(
|
||||
"--shutdown",
|
||||
action="store_true",
|
||||
help="Do not restart containers after backup",
|
||||
)
|
||||
|
||||
scope = p.add_mutually_exclusive_group()
|
||||
scope.add_argument(
|
||||
"--only-sql",
|
||||
action="store_true",
|
||||
help=(
|
||||
"Create database dumps only for DB volumes. "
|
||||
"File backups are skipped for DB volumes if a dump succeeds, "
|
||||
"but non-DB volumes are still backed up. "
|
||||
"If a DB dump cannot be produced, baudolo falls back to a file backup."
|
||||
),
|
||||
)
|
||||
scope.add_argument(
|
||||
"--only-files",
|
||||
action="store_true",
|
||||
help=(
|
||||
"Take no database dumps at all and back up every volume as files. "
|
||||
"For hosts that hold no database credentials. A database's files "
|
||||
"are only consistent if its containers are stopped for the second "
|
||||
"pass, so keep its image off --images-no-stop-required."
|
||||
),
|
||||
)
|
||||
args = p.parse_args()
|
||||
if not args.only_files and not args.databases_csv:
|
||||
p.error("--databases-csv is required unless --only-files is given")
|
||||
if bool(args.snapshot) != bool(args.snapshot_subject):
|
||||
p.error("--snapshot and --snapshot-subject must be given together")
|
||||
if args.snapshot and args.shutdown:
|
||||
p.error(
|
||||
"--shutdown is meaningless with --snapshot: containers are never stopped"
|
||||
)
|
||||
if args.snapshot and args.hard_restart_projects:
|
||||
p.error(
|
||||
"--hard-restart-projects is meaningless with --snapshot: the flag exists "
|
||||
"for stacks whose database cannot be backed up hot, which a snapshot solves"
|
||||
)
|
||||
return args
|
||||
98
src/baudolo/backup/compose.py
Normal file
98
src/baudolo/backup/compose.py
Normal file
@@ -0,0 +1,98 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def _build_compose_cmd(project_dir: str, passthrough: list[str]) -> list[str]:
|
||||
"""
|
||||
Build the compose command for this project directory.
|
||||
|
||||
Policy:
|
||||
- If `compose` wrapper exists (Infinito.Nexus): use it and delegate ALL logic to it.
|
||||
- Else: use plain `docker compose` with --chdir.
|
||||
- NO custom compose file/env detection in this project.
|
||||
"""
|
||||
pdir = Path(project_dir).resolve()
|
||||
|
||||
wrapper = shutil.which("compose")
|
||||
if wrapper:
|
||||
# "--" ensures wrapper stops parsing its own args.
|
||||
return [wrapper, "--chdir", str(pdir), "--", *passthrough]
|
||||
|
||||
docker = shutil.which("docker")
|
||||
if docker:
|
||||
return [docker, "compose", "--chdir", str(pdir), *passthrough]
|
||||
|
||||
raise RuntimeError("Neither 'compose' nor 'docker' found in PATH")
|
||||
|
||||
|
||||
def _find_compose_file(project_dir: str) -> Path | None:
|
||||
"""
|
||||
Detect a compose file in `project_dir` (case-insensitive).
|
||||
|
||||
Supported names:
|
||||
- compose.yml / compose.yaml
|
||||
- docker-compose.yml / docker-compose.yaml
|
||||
"""
|
||||
pdir = Path(project_dir)
|
||||
if not pdir.is_dir():
|
||||
return None
|
||||
|
||||
# Map lowercase filename -> actual Path (preserves original casing)
|
||||
by_lower = {p.name.lower(): p for p in pdir.iterdir() if p.is_file()}
|
||||
|
||||
# Preferred order (policy decision)
|
||||
candidates = [
|
||||
"docker-compose.yml",
|
||||
"docker-compose.yaml",
|
||||
"compose.yml",
|
||||
"compose.yaml",
|
||||
]
|
||||
|
||||
for name in candidates:
|
||||
found = by_lower.get(name)
|
||||
if found is not None:
|
||||
return found
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def hard_restart_docker_services(dir_path: str) -> None:
|
||||
print(f"Hard restart compose services in: {dir_path}", flush=True)
|
||||
|
||||
down_cmd = _build_compose_cmd(dir_path, ["down"])
|
||||
up_cmd = _build_compose_cmd(dir_path, ["up", "-d"])
|
||||
|
||||
print(">>> " + " ".join(down_cmd), flush=True)
|
||||
subprocess.run(down_cmd, check=True)
|
||||
|
||||
print(">>> " + " ".join(up_cmd), flush=True)
|
||||
subprocess.run(up_cmd, check=True)
|
||||
|
||||
|
||||
def handle_docker_compose_services(
|
||||
parent_directory: str,
|
||||
hard_restart_required: list[str],
|
||||
) -> None:
|
||||
for entry in os.scandir(parent_directory):
|
||||
if not entry.is_dir():
|
||||
continue
|
||||
|
||||
dir_path = entry.path
|
||||
name = os.path.basename(dir_path)
|
||||
|
||||
print(f"Checking directory: {dir_path}", flush=True)
|
||||
|
||||
compose_file = _find_compose_file(dir_path)
|
||||
if compose_file is None:
|
||||
print("No supported compose file found. Skipping.", flush=True)
|
||||
continue
|
||||
|
||||
if name in hard_restart_required:
|
||||
print(f"{name}: hard restart required.", flush=True)
|
||||
hard_restart_docker_services(dir_path)
|
||||
else:
|
||||
print(f"{name}: no restart required.", flush=True)
|
||||
148
src/baudolo/backup/db.py
Normal file
148
src/baudolo/backup/db.py
Normal file
@@ -0,0 +1,148 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import os
|
||||
import pathlib
|
||||
import re
|
||||
|
||||
import pandas
|
||||
|
||||
from baudolo.databases import CLUSTER_ROW, validate_database
|
||||
|
||||
from .docker import docker_exec_argv
|
||||
from .shell import BackupException, execute_to_file
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def get_instance(container: str, database_containers: list[str]) -> str:
|
||||
"""
|
||||
Derive a stable instance name from the container name.
|
||||
"""
|
||||
if container in database_containers:
|
||||
return container
|
||||
return re.split(r"(_|-)(database|db|postgres)", container)[0]
|
||||
|
||||
|
||||
def fallback_pg_dumpall(
|
||||
container: str, username: str, password: str, out_file: str
|
||||
) -> None:
|
||||
"""
|
||||
Perform a full Postgres cluster dump using pg_dumpall.
|
||||
"""
|
||||
execute_to_file(
|
||||
docker_exec_argv(
|
||||
container,
|
||||
["pg_dumpall", "-U", username, "-h", "localhost"],
|
||||
interactive=True,
|
||||
),
|
||||
out_file,
|
||||
env={"PGPASSWORD": password},
|
||||
)
|
||||
|
||||
|
||||
def backup_database(
|
||||
*,
|
||||
container: str,
|
||||
volume_dir: str,
|
||||
db_type: str,
|
||||
dump_tool: str,
|
||||
databases_df: pandas.DataFrame,
|
||||
database_containers: list[str],
|
||||
) -> bool:
|
||||
"""
|
||||
Backup databases for a given DB container.
|
||||
|
||||
Args:
|
||||
dump_tool: the MariaDB client found in the container, so an image
|
||||
that ships only mysqldump is dumped with the tool it has.
|
||||
|
||||
Returns True if at least one dump was produced.
|
||||
"""
|
||||
instance_name = get_instance(container, database_containers)
|
||||
|
||||
entries = databases_df[databases_df["instance"] == instance_name]
|
||||
if entries.empty:
|
||||
log.debug("No database entries for instance '%s'", instance_name)
|
||||
return False
|
||||
|
||||
out_dir = os.path.join(volume_dir, "sql")
|
||||
pathlib.Path(out_dir).mkdir(parents=True, exist_ok=True)
|
||||
|
||||
produced = False
|
||||
|
||||
for row in entries.itertuples(index=False):
|
||||
raw_db = getattr(row, "database", "")
|
||||
user = (getattr(row, "username", "") or "").strip()
|
||||
password = (getattr(row, "password", "") or "").strip()
|
||||
|
||||
db_value = validate_database(raw_db, instance=instance_name)
|
||||
|
||||
if db_value == CLUSTER_ROW:
|
||||
if db_type != "postgres":
|
||||
raise ValueError(
|
||||
f"databases.csv entry for instance '{instance_name}': "
|
||||
f"'{CLUSTER_ROW}' is currently only supported for Postgres."
|
||||
)
|
||||
|
||||
cluster_file = os.path.join(out_dir, f"{instance_name}.cluster.backup.sql")
|
||||
fallback_pg_dumpall(container, user, password, cluster_file)
|
||||
produced = True
|
||||
continue
|
||||
|
||||
db_name = db_value
|
||||
dump_file = os.path.join(out_dir, f"{db_name}.backup.sql")
|
||||
|
||||
if db_type == "mariadb":
|
||||
# Force TCP so auth matches '<user>'@'%' instead of socket -> 'localhost'.
|
||||
execute_to_file(
|
||||
docker_exec_argv(
|
||||
container,
|
||||
[
|
||||
dump_tool,
|
||||
"-h",
|
||||
"127.0.0.1",
|
||||
"--protocol=tcp",
|
||||
"-u",
|
||||
user,
|
||||
f"-p{password}",
|
||||
db_name,
|
||||
],
|
||||
),
|
||||
dump_file,
|
||||
)
|
||||
produced = True
|
||||
continue
|
||||
|
||||
if db_type == "postgres":
|
||||
try:
|
||||
execute_to_file(
|
||||
docker_exec_argv(
|
||||
container,
|
||||
[
|
||||
"pg_dump",
|
||||
"-U",
|
||||
user,
|
||||
"-d",
|
||||
db_name,
|
||||
"-h",
|
||||
"localhost",
|
||||
"--no-owner",
|
||||
"--no-privileges",
|
||||
],
|
||||
interactive=True,
|
||||
),
|
||||
dump_file,
|
||||
env={"PGPASSWORD": password},
|
||||
)
|
||||
produced = True
|
||||
except BackupException as e:
|
||||
raise BackupException(
|
||||
f"Postgres dump failed for instance '{instance_name}', "
|
||||
f"database '{db_name}'. This database was explicitly configured "
|
||||
"and therefore must succeed.\n"
|
||||
f"{e}"
|
||||
)
|
||||
continue
|
||||
|
||||
return produced
|
||||
115
src/baudolo/backup/docker.py
Normal file
115
src/baudolo/backup/docker.py
Normal file
@@ -0,0 +1,115 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from collections.abc import Sequence
|
||||
|
||||
from .shell import BackupException, execute_shell_command
|
||||
|
||||
|
||||
def docker_exec_argv(
|
||||
container: str, argv: Sequence[str], *, interactive: bool = False
|
||||
) -> list[str]:
|
||||
"""The argv that runs *argv* inside *container*."""
|
||||
return ["docker", "exec", *(["-i"] if interactive else []), container, *argv]
|
||||
|
||||
|
||||
def get_image_info(container: str) -> str:
|
||||
return execute_shell_command(
|
||||
["docker", "inspect", "--format", "{{.Config.Image}}", container]
|
||||
)[0]
|
||||
|
||||
|
||||
def image_id(container: str) -> str:
|
||||
"""The container's image ID, identical for every replica of one image."""
|
||||
return execute_shell_command(
|
||||
["docker", "inspect", "--format", "{{.Image}}", container]
|
||||
)[0].strip()
|
||||
|
||||
|
||||
def has_tool(container: str, tool: str) -> bool:
|
||||
"""Whether *tool* runs inside the container.
|
||||
|
||||
Executes the binary rather than asking a shell for it: a distroless image
|
||||
has no shell, and `sh -c 'command -v'` would answer "absent" for every
|
||||
tool it ships.
|
||||
"""
|
||||
try:
|
||||
execute_shell_command(docker_exec_argv(container, [tool, "--version"]))
|
||||
except BackupException:
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def docker_volume_names() -> list[str]:
|
||||
return execute_shell_command(["docker", "volume", "ls", "--format", "{{.Name}}"])
|
||||
|
||||
|
||||
def containers_using_volume(volume_name: str) -> list[str]:
|
||||
return execute_shell_command(
|
||||
[
|
||||
"docker",
|
||||
"ps",
|
||||
"--filter",
|
||||
f"volume={volume_name}",
|
||||
"--format",
|
||||
"{{.Names}}",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def is_swarm_task(container: str) -> bool:
|
||||
"""Swarm-managed task containers must never be stopped or started
|
||||
manually: the orchestrator replaces the stopped task and a later
|
||||
`docker start` fails on the detached overlay network. A container that
|
||||
vanished between listing and inspect (--rm one-shots, task-history GC)
|
||||
counts as not stoppable instead of aborting the whole backup run; if the
|
||||
container still exists the inspect failure re-raises, so a broken daemon
|
||||
keeps failing the run loudly instead of silently skipping the stop."""
|
||||
try:
|
||||
out = execute_shell_command(
|
||||
[
|
||||
"docker",
|
||||
"inspect",
|
||||
"--format",
|
||||
'{{index .Config.Labels "com.docker.swarm.task.id"}}',
|
||||
container,
|
||||
]
|
||||
)
|
||||
except BackupException:
|
||||
still_listed = execute_shell_command(
|
||||
[
|
||||
"docker",
|
||||
"ps",
|
||||
"-a",
|
||||
"--filter",
|
||||
f"name=^{container}$",
|
||||
"--format",
|
||||
"{{.Names}}",
|
||||
]
|
||||
)
|
||||
if still_listed and still_listed[0].strip():
|
||||
raise
|
||||
return True
|
||||
return bool(out and out[0].strip())
|
||||
|
||||
|
||||
def filter_stoppable(containers: list[str]) -> list[str]:
|
||||
"""Containers baudolo may stop/start itself (everything but swarm tasks)."""
|
||||
stoppable = []
|
||||
for container in containers:
|
||||
if is_swarm_task(container):
|
||||
print(
|
||||
f"Skipping stop/start for swarm task container '{container}'.",
|
||||
flush=True,
|
||||
)
|
||||
continue
|
||||
stoppable.append(container)
|
||||
return stoppable
|
||||
|
||||
|
||||
def change_containers_status(containers: list[str], status: str) -> None:
|
||||
"""Stop or start a list of containers."""
|
||||
if not containers:
|
||||
print(f"No containers to {status}.", flush=True)
|
||||
return
|
||||
print(f"{status.capitalize()} containers: {' '.join(containers)}...", flush=True)
|
||||
execute_shell_command(["docker", status, *containers])
|
||||
142
src/baudolo/backup/dumps.py
Normal file
142
src/baudolo/backup/dumps.py
Normal file
@@ -0,0 +1,142 @@
|
||||
"""Database dumps taken before a volume's files are copied."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import sys
|
||||
|
||||
import pandas
|
||||
from pandas.errors import EmptyDataError
|
||||
|
||||
from baudolo.databases import COLUMNS, DELIMITER
|
||||
|
||||
from .db import backup_database
|
||||
from .docker import has_tool, image_id
|
||||
|
||||
DUMP_TOOLS: tuple[tuple[str, str], ...] = (
|
||||
("postgres", "pg_dumpall"),
|
||||
("mariadb", "mariadb-dump"),
|
||||
("mariadb", "mysqldump"),
|
||||
)
|
||||
|
||||
_ENGINE_BY_IMAGE: dict[str, tuple[str, str] | None] = {}
|
||||
|
||||
|
||||
def container_engine(container: str) -> tuple[str, str] | None:
|
||||
"""The (engine, dump tool) a container can serve, or None for neither.
|
||||
|
||||
Asks the container what it can run instead of reading its image name. A
|
||||
dedicated Postgres is tagged `<app>-database` or `postgis/postgis` and
|
||||
carries no engine token at all, while a swarm registry host such as
|
||||
`svc-db-mariadb-swarm-mgr-01:5000` carries the wrong one.
|
||||
|
||||
Args:
|
||||
container: must be running - `docker exec` is the probe, and a
|
||||
stopped container would be cached as "no engine" for its whole
|
||||
image. The only caller feeds it `docker ps` output.
|
||||
|
||||
Returns:
|
||||
The engine and the tool that dumps it, cached per image ID so that
|
||||
replicas of one image are probed once.
|
||||
"""
|
||||
image = image_id(container)
|
||||
if image not in _ENGINE_BY_IMAGE:
|
||||
_ENGINE_BY_IMAGE[image] = next(
|
||||
(
|
||||
(engine, tool)
|
||||
for engine, tool in DUMP_TOOLS
|
||||
if has_tool(container, tool)
|
||||
),
|
||||
None,
|
||||
)
|
||||
return _ENGINE_BY_IMAGE[image]
|
||||
|
||||
|
||||
def backup_mariadb_or_postgres(
|
||||
*,
|
||||
container: str,
|
||||
volume_dir: str,
|
||||
databases_df: pandas.DataFrame,
|
||||
database_containers: list[str],
|
||||
) -> tuple[bool, bool]:
|
||||
"""
|
||||
Returns (is_db_container, dumped_any)
|
||||
"""
|
||||
engine = container_engine(container)
|
||||
if engine is None:
|
||||
return False, False
|
||||
db_type, dump_tool = engine
|
||||
dumped = backup_database(
|
||||
container=container,
|
||||
volume_dir=volume_dir,
|
||||
db_type=db_type,
|
||||
dump_tool=dump_tool,
|
||||
databases_df=databases_df,
|
||||
database_containers=database_containers,
|
||||
)
|
||||
return True, dumped
|
||||
|
||||
|
||||
def _empty_databases_df() -> pandas.DataFrame:
|
||||
"""
|
||||
Create an empty DataFrame with the expected schema for databases.csv.
|
||||
|
||||
This allows the backup to continue without DB dumps when the CSV is missing
|
||||
or empty (pandas EmptyDataError).
|
||||
"""
|
||||
return pandas.DataFrame(columns=list(COLUMNS))
|
||||
|
||||
|
||||
def load_databases_df(csv_path: str) -> pandas.DataFrame:
|
||||
"""
|
||||
Load databases.csv robustly.
|
||||
|
||||
- Missing file -> warn, continue with empty df
|
||||
- Empty file -> warn, continue with empty df
|
||||
- Valid CSV -> return dataframe
|
||||
"""
|
||||
try:
|
||||
return pandas.read_csv(
|
||||
csv_path, sep=DELIMITER, keep_default_na=False, dtype=str
|
||||
)
|
||||
except FileNotFoundError:
|
||||
print(
|
||||
f"WARNING: databases.csv not found: {csv_path}. Continuing without database dumps.",
|
||||
file=sys.stderr,
|
||||
flush=True,
|
||||
)
|
||||
return _empty_databases_df()
|
||||
except EmptyDataError:
|
||||
print(
|
||||
f"WARNING: databases.csv exists but is empty: {csv_path}. Continuing without database dumps.",
|
||||
file=sys.stderr,
|
||||
flush=True,
|
||||
)
|
||||
return _empty_databases_df()
|
||||
|
||||
|
||||
def backup_dumps_for_volume(
|
||||
*,
|
||||
containers: list[str],
|
||||
vol_dir: str,
|
||||
databases_df: pandas.DataFrame,
|
||||
database_containers: list[str],
|
||||
) -> tuple[bool, bool]:
|
||||
"""
|
||||
Returns (found_db_container, dumped_any)
|
||||
"""
|
||||
found_db = False
|
||||
dumped_any = False
|
||||
|
||||
for c in containers:
|
||||
is_db, dumped = backup_mariadb_or_postgres(
|
||||
container=c,
|
||||
volume_dir=vol_dir,
|
||||
databases_df=databases_df,
|
||||
database_containers=database_containers,
|
||||
)
|
||||
if is_db:
|
||||
found_db = True
|
||||
if dumped:
|
||||
dumped_any = True
|
||||
|
||||
return found_db, dumped_any
|
||||
40
src/baudolo/backup/layout.py
Normal file
40
src/baudolo/backup/layout.py
Normal file
@@ -0,0 +1,40 @@
|
||||
"""Where a backup run puts its files, and how a finished run is stamped."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import pathlib
|
||||
|
||||
from dirval import create_stamp_file
|
||||
|
||||
from .shell import BackupException, execute_shell_command
|
||||
|
||||
|
||||
def get_machine_id() -> str:
|
||||
return execute_shell_command(["sha256sum", "/etc/machine-id"])[0][0:64]
|
||||
|
||||
|
||||
def stamp_directory(version_dir: str) -> None:
|
||||
"""
|
||||
Use dirval as a Python library to stamp the directory (no CLI dependency).
|
||||
"""
|
||||
create_stamp_file(version_dir)
|
||||
|
||||
|
||||
def create_version_directory(versions_dir: str, backup_time: str) -> str:
|
||||
version_dir = os.path.join(versions_dir, backup_time)
|
||||
try:
|
||||
pathlib.Path(version_dir).mkdir(parents=True)
|
||||
except FileExistsError:
|
||||
raise BackupException(
|
||||
f"generation {backup_time} already exists at {version_dir}; "
|
||||
"another run claimed this second - refusing to write into it, "
|
||||
"since rsync --delete would overwrite that generation"
|
||||
) from None
|
||||
return version_dir
|
||||
|
||||
|
||||
def create_volume_directory(version_dir: str, volume_name: str) -> str:
|
||||
path = os.path.join(version_dir, volume_name)
|
||||
pathlib.Path(path).mkdir(parents=True, exist_ok=True)
|
||||
return path
|
||||
38
src/baudolo/backup/policy.py
Normal file
38
src/baudolo/backup/policy.py
Normal file
@@ -0,0 +1,38 @@
|
||||
"""Which volumes are backed up, and which containers must stop for it."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from .docker import get_image_info, is_swarm_task
|
||||
|
||||
|
||||
def is_image_ignored(container: str, images_no_backup_required: list[str]) -> bool:
|
||||
if not images_no_backup_required:
|
||||
return False
|
||||
img = get_image_info(container)
|
||||
return img in images_no_backup_required
|
||||
|
||||
|
||||
def volume_is_fully_ignored(
|
||||
containers: list[str], images_no_backup_required: list[str]
|
||||
) -> bool:
|
||||
"""
|
||||
Skip file backup only if all containers linked to the volume are ignored.
|
||||
"""
|
||||
if not containers:
|
||||
return False
|
||||
return all(is_image_ignored(c, images_no_backup_required) for c in containers)
|
||||
|
||||
|
||||
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 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 img not in images_no_stop_required:
|
||||
return True
|
||||
return False
|
||||
71
src/baudolo/backup/shell.py
Normal file
71
src/baudolo/backup/shell.py
Normal file
@@ -0,0 +1,71 @@
|
||||
"""Running external commands without a shell.
|
||||
|
||||
Every command is an argv list. A database name, a password or a container name
|
||||
therefore cannot close a quote and start a second command, which a formatted
|
||||
string handed to ``shell=True`` allowed.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
from collections.abc import Mapping, Sequence
|
||||
|
||||
|
||||
class BackupException(Exception):
|
||||
"""Generic exception for backup errors."""
|
||||
|
||||
|
||||
def _child_env(env: Mapping[str, str] | None) -> dict[str, str] | None:
|
||||
return None if env is None else {**os.environ, **env}
|
||||
|
||||
|
||||
def _fail(command: Sequence[str], returncode: int, out: bytes, err: bytes) -> None:
|
||||
raise BackupException(
|
||||
f"Error in command: {' '.join(command)}\n"
|
||||
f"Output: {out}\nError: {err}\n"
|
||||
f"Exit code: {returncode}"
|
||||
)
|
||||
|
||||
|
||||
def execute_shell_command(
|
||||
command: Sequence[str], *, env: Mapping[str, str] | None = None
|
||||
) -> list[str]:
|
||||
"""Run *command* and return its stdout lines.
|
||||
|
||||
Args:
|
||||
command: argv, the program first.
|
||||
env: variables added to the child's environment, for values that must
|
||||
not appear in the argv of a process listing.
|
||||
"""
|
||||
command = list(command)
|
||||
print(" ".join(command), flush=True)
|
||||
process = subprocess.Popen(
|
||||
command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=_child_env(env)
|
||||
)
|
||||
out, err = process.communicate()
|
||||
if process.returncode != 0:
|
||||
_fail(command, process.returncode, out, err)
|
||||
return [line.decode("utf-8") for line in out.splitlines()]
|
||||
|
||||
|
||||
def execute_to_file(
|
||||
command: Sequence[str], out_file: str, *, env: Mapping[str, str] | None = None
|
||||
) -> None:
|
||||
"""Run *command*, writing its stdout to *out_file* only once it succeeded.
|
||||
|
||||
The output goes to a sibling temporary file first, so a partial or empty
|
||||
stream from a failing dump never takes the place of a valid backup.
|
||||
"""
|
||||
command = list(command)
|
||||
print(" ".join(command), flush=True)
|
||||
tmp = f"{out_file}.tmp"
|
||||
with open(tmp, "wb") as handle:
|
||||
process = subprocess.Popen(
|
||||
command, stdout=handle, stderr=subprocess.PIPE, env=_child_env(env)
|
||||
)
|
||||
_, err = process.communicate()
|
||||
if process.returncode != 0:
|
||||
os.unlink(tmp)
|
||||
_fail(command, process.returncode, b"", err)
|
||||
os.replace(tmp, out_file)
|
||||
164
src/baudolo/backup/snapshot.py
Normal file
164
src/baudolo/backup/snapshot.py
Normal file
@@ -0,0 +1,164 @@
|
||||
"""Capture every volume from one atomic filesystem snapshot.
|
||||
|
||||
Copying a live tree file by file cannot produce a point in time: a database can
|
||||
write between two files and leave a control file and its write-ahead log
|
||||
disagreeing, which no recovery can repair. A snapshot freezes the whole subject
|
||||
at once, so a database reads it as a crash and replays its log - a case it is
|
||||
built for. That also removes the reason to stop containers at all.
|
||||
|
||||
The snapshot kind is stated by the caller rather than probed, because falling
|
||||
back to a live copy when a probe is inconclusive would hand out backups that
|
||||
look consistent and are not.
|
||||
|
||||
Which volumes a snapshot of the subject contains is a different question, and
|
||||
it is decided per volume: a volume with a backing store of its own appears
|
||||
inside the snapshot as an existing empty directory, so copying from there
|
||||
succeeds and stores nothing. Such a volume is copied live instead - correct
|
||||
data without the point in time - while every other volume of the same run
|
||||
keeps its snapshot.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from collections.abc import Callable, Iterator
|
||||
from contextlib import contextmanager
|
||||
|
||||
from .shell import BackupException, execute_shell_command
|
||||
from .volume import Backing
|
||||
|
||||
KINDS = ("btrfs", "zfs")
|
||||
|
||||
|
||||
class SnapshotError(RuntimeError):
|
||||
"""A snapshot could not be created, resolved or removed."""
|
||||
|
||||
|
||||
def _resolver(subject: str, root: str) -> Callable[[str], str]:
|
||||
def resolve(path: str) -> str:
|
||||
relative = os.path.relpath(os.path.abspath(path), os.path.abspath(subject))
|
||||
if relative.startswith(".."):
|
||||
raise SnapshotError(f"{path} lies outside the snapshot subject {subject}")
|
||||
resolved = root if relative == "." else os.path.join(root, relative)
|
||||
|
||||
# abspath drops a trailing separator, and rsync reads "dir/" as its
|
||||
# contents where "dir" means the directory itself.
|
||||
return resolved + os.sep if path.endswith(os.sep) else resolved
|
||||
|
||||
return resolve
|
||||
|
||||
|
||||
def _btrfs(
|
||||
subject: str, name: str, run: Callable[[list[str]], list[str]]
|
||||
) -> tuple[str, list[str]]:
|
||||
# The snapshot goes inside the subject, never beside it: the kernel rejects
|
||||
# a snapshot whose destination is on another filesystem, which is exactly
|
||||
# what the parent directory is when the subject is a mountpoint of its own.
|
||||
target = os.path.join(os.path.abspath(subject), f".{name}")
|
||||
run(["btrfs", "subvolume", "snapshot", "-r", subject, target])
|
||||
return target, ["btrfs", "subvolume", "delete", target]
|
||||
|
||||
|
||||
def _zfs(
|
||||
subject: str, name: str, run: Callable[[list[str]], list[str]]
|
||||
) -> tuple[str, list[str]]:
|
||||
output = run(["zfs", "list", "-H", "-o", "name", subject])
|
||||
dataset = (output[0] if output else "").strip()
|
||||
if not dataset:
|
||||
raise SnapshotError(f"no zfs dataset is mounted at {subject}")
|
||||
run(["zfs", "snapshot", f"{dataset}@{name}"])
|
||||
root = os.path.join(subject, ".zfs", "snapshot", name)
|
||||
return root, ["zfs", "destroy", f"{dataset}@{name}"]
|
||||
|
||||
|
||||
_CREATE = {"btrfs": _btrfs, "zfs": _zfs}
|
||||
|
||||
|
||||
def unsnapshotted(backing: Backing, subject: str) -> str | None:
|
||||
"""Return why a snapshot of ``subject`` does not hold this volume's data.
|
||||
|
||||
Docker mounts a volume's own backing store lazily and unmounts it when the
|
||||
last consumer stops, so the declaration is what gets checked: it is true at
|
||||
every moment, where the mount table is only true while a container happens
|
||||
to hold the volume.
|
||||
|
||||
Args:
|
||||
backing: the volume as the daemon describes it.
|
||||
subject: the snapshot subject, e.g. ``/var/lib/docker``.
|
||||
|
||||
Returns:
|
||||
The reason, or None when the snapshot holds the volume.
|
||||
"""
|
||||
if backing.driver != "local":
|
||||
return f"it uses the {backing.driver} driver"
|
||||
if backing.options:
|
||||
return f"it declares its own backing store {backing.options}"
|
||||
if not backing.mountpoint:
|
||||
return "it reports no mountpoint"
|
||||
real = os.path.realpath(backing.mountpoint)
|
||||
if os.path.ismount(real):
|
||||
return f"its mountpoint {backing.mountpoint} sits on its own mount"
|
||||
try:
|
||||
crosses = os.stat(real).st_dev != os.stat(os.path.realpath(subject)).st_dev
|
||||
except OSError as error:
|
||||
return f"its mountpoint {backing.mountpoint} could not be read: {error}"
|
||||
if crosses:
|
||||
return f"its mountpoint {backing.mountpoint} crosses a filesystem boundary"
|
||||
return None
|
||||
|
||||
|
||||
def snapshot_source(
|
||||
resolve: Callable[[str], str], backing: Backing, subject: str
|
||||
) -> tuple[str | None, str]:
|
||||
"""Resolve where to read a volume from, and why if not from the snapshot.
|
||||
|
||||
Returns:
|
||||
``(path, "")`` to copy from the snapshot, or ``(None, reason)`` to copy
|
||||
it live.
|
||||
"""
|
||||
reason = unsnapshotted(backing, subject)
|
||||
if reason:
|
||||
return None, reason
|
||||
try:
|
||||
source = resolve(backing.source)
|
||||
except SnapshotError as error:
|
||||
return None, str(error)
|
||||
if not os.path.isdir(source):
|
||||
return None, "it was created after the snapshot was taken"
|
||||
return source, ""
|
||||
|
||||
|
||||
@contextmanager
|
||||
def volume_snapshot(
|
||||
kind: str,
|
||||
subject: str,
|
||||
tag: str,
|
||||
run: Callable[[list[str]], list[str]] = execute_shell_command,
|
||||
) -> Iterator[Callable[[str], str]]:
|
||||
"""Yield a resolver mapping a path under ``subject`` into a snapshot of it.
|
||||
|
||||
Args:
|
||||
kind: ``btrfs`` or ``zfs``; the caller states it, nothing is probed.
|
||||
subject: the btrfs subvolume or zfs dataset mountpoint holding the
|
||||
volumes, e.g. ``/var/lib/docker``.
|
||||
tag: unique suffix for the snapshot name, e.g. the backup timestamp.
|
||||
run: shell runner, injected so the mechanics are testable.
|
||||
|
||||
Raises:
|
||||
SnapshotError: the kind is unknown, or the snapshot cannot be created.
|
||||
Removal failure is reported, not raised: a leftover snapshot is a
|
||||
cleanup problem and must not discard a generation that is complete.
|
||||
"""
|
||||
create = _CREATE.get(kind)
|
||||
if create is None:
|
||||
raise SnapshotError(f"unknown snapshot kind {kind!r}; expected one of {KINDS}")
|
||||
|
||||
root, remove = create(subject, f"baudolo-{tag}", run)
|
||||
try:
|
||||
yield _resolver(subject, root)
|
||||
finally:
|
||||
try:
|
||||
run(remove)
|
||||
except BackupException as error:
|
||||
# Raising here would also mask whatever the body raised.
|
||||
print(f"WARNING: {root} could not be removed: {error}", flush=True)
|
||||
91
src/baudolo/backup/volume.py
Normal file
91
src/baudolo/backup/volume.py
Normal file
@@ -0,0 +1,91 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import pathlib
|
||||
from dataclasses import dataclass, field
|
||||
|
||||
from .shell import BackupException, execute_shell_command
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Backing:
|
||||
"""Where a docker volume actually keeps its data.
|
||||
|
||||
Args:
|
||||
mountpoint: the path the daemon reports.
|
||||
driver: the volume driver, ``local`` for the built-in one.
|
||||
options: the driver options; a non-empty map means the mountpoint is a
|
||||
mount target rather than the storage itself.
|
||||
"""
|
||||
|
||||
mountpoint: str
|
||||
driver: str = "local"
|
||||
options: dict = field(default_factory=dict)
|
||||
|
||||
@property
|
||||
def source(self) -> str:
|
||||
return f"{self.mountpoint}/"
|
||||
|
||||
|
||||
def inspect_backing(volume_name: str) -> Backing:
|
||||
reported = execute_shell_command(
|
||||
["docker", "volume", "inspect", "--format", "{{json .}}", volume_name]
|
||||
)[0]
|
||||
data = json.loads(reported)
|
||||
return Backing(
|
||||
data.get("Mountpoint") or "",
|
||||
data.get("Driver") or "",
|
||||
data.get("Options") or {},
|
||||
)
|
||||
|
||||
|
||||
def get_last_backup_dir(
|
||||
versions_dir: str, volume_name: str, current_backup_dir: str
|
||||
) -> str | None:
|
||||
versions = sorted(os.listdir(versions_dir), reverse=True)
|
||||
for version in versions:
|
||||
candidate = os.path.join(versions_dir, version, volume_name, "files", "")
|
||||
if candidate != current_backup_dir and os.path.isdir(candidate):
|
||||
return candidate
|
||||
return None
|
||||
|
||||
|
||||
def backup_volume(
|
||||
versions_dir: str,
|
||||
volume_name: str,
|
||||
volume_dir: str,
|
||||
*,
|
||||
authoritative: bool,
|
||||
source: str,
|
||||
) -> None:
|
||||
"""Perform incremental file backup of a Docker volume.
|
||||
|
||||
Args:
|
||||
authoritative: compare source and destination by content instead of by
|
||||
size and whole-second mtime. Required on a pass whose destination was
|
||||
already written from a live source, where a file can differ while
|
||||
both attributes still agree.
|
||||
source: directory to read from - the volume's mountpoint, or its path
|
||||
inside a snapshot.
|
||||
"""
|
||||
dest = os.path.join(volume_dir, "files") + "/"
|
||||
pathlib.Path(dest).mkdir(parents=True, exist_ok=True)
|
||||
|
||||
last = get_last_backup_dir(versions_dir, volume_name, dest)
|
||||
cmd = ["rsync", "-aP", "--no-D", "--delete", "--delete-excluded"]
|
||||
if authoritative:
|
||||
cmd.append("--checksum")
|
||||
if last:
|
||||
cmd.append(f"--link-dest={last}")
|
||||
cmd += [source, dest]
|
||||
|
||||
try:
|
||||
execute_shell_command(cmd)
|
||||
except BackupException as e:
|
||||
if "file has vanished" in str(e):
|
||||
print(
|
||||
"Warning: Some files vanished before transfer. Continuing.", flush=True
|
||||
)
|
||||
else:
|
||||
raise
|
||||
102
src/baudolo/databases.py
Normal file
102
src/baudolo/databases.py
Normal file
@@ -0,0 +1,102 @@
|
||||
"""The databases.csv contract: its columns, its delimiter, and what a row means.
|
||||
|
||||
``baudolo-seed`` writes the file, the backup reads it to learn which dumps to
|
||||
take, and a restore consumer reads it again to replay them. Stating the schema
|
||||
once keeps a column or a convention added here from being invisible to the
|
||||
other two.
|
||||
|
||||
Field values are handed back exactly as they stand in the file. A password may
|
||||
legitimately begin or end with a space, so stripping belongs to the caller that
|
||||
compares, never to the reader.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import csv
|
||||
import re
|
||||
from typing import NamedTuple
|
||||
|
||||
COLUMNS = ("instance", "database", "username", "password")
|
||||
DELIMITER = ";"
|
||||
CLUSTER_ROW = "*"
|
||||
|
||||
_NAME_RE = re.compile(r"^[a-zA-Z0-9_][a-zA-Z0-9_-]*$")
|
||||
|
||||
|
||||
class DatabasesCsvError(ValueError):
|
||||
"""A row does not match the contract."""
|
||||
|
||||
|
||||
class Row(NamedTuple):
|
||||
"""One databases.csv row, verbatim.
|
||||
|
||||
``database`` holds :data:`CLUSTER_ROW` when the whole instance is dumped.
|
||||
"""
|
||||
|
||||
instance: str
|
||||
database: str
|
||||
username: str
|
||||
password: str
|
||||
|
||||
@property
|
||||
def is_cluster(self) -> bool:
|
||||
return self.database.strip() == CLUSTER_ROW
|
||||
|
||||
|
||||
def validate_database(value: str | None, *, instance: str) -> str:
|
||||
"""The database column of one row, or raise.
|
||||
|
||||
The name reaches a shell as part of the dump command, so it is checked
|
||||
where it is read as well as where it is written: a file edited by hand
|
||||
never passed the seed.
|
||||
|
||||
Args:
|
||||
value: the raw column.
|
||||
instance: named in the error, so a bad row can be found.
|
||||
|
||||
Raises:
|
||||
DatabasesCsvError: the column is empty, literally ``nan``, or holds
|
||||
anything but letters, numbers, ``_`` and ``-``.
|
||||
"""
|
||||
text = (value or "").strip()
|
||||
if not text:
|
||||
raise DatabasesCsvError(
|
||||
f"Invalid databases.csv entry for instance '{instance}': column "
|
||||
f"'database' must be '{CLUSTER_ROW}' or a concrete database name "
|
||||
"(not empty)."
|
||||
)
|
||||
if text == CLUSTER_ROW:
|
||||
return CLUSTER_ROW
|
||||
if text.lower() == "nan":
|
||||
raise DatabasesCsvError(
|
||||
f"Invalid databases.csv entry for instance '{instance}': "
|
||||
"database must not be 'nan'."
|
||||
)
|
||||
if not _NAME_RE.match(text):
|
||||
raise DatabasesCsvError(
|
||||
f"Invalid databases.csv entry for instance '{instance}': invalid "
|
||||
f"database name '{text}'. Allowed: letters, numbers, '_' and '-'."
|
||||
)
|
||||
return text
|
||||
|
||||
|
||||
def read_rows(csv_path: str) -> list[Row]:
|
||||
"""Every row of the file in file order, header skipped, blank rows dropped.
|
||||
|
||||
Raises:
|
||||
DatabasesCsvError: a row holds fewer columns than :data:`COLUMNS`.
|
||||
"""
|
||||
rows: list[Row] = []
|
||||
with open(csv_path, newline="", encoding="utf-8") as handle:
|
||||
reader = csv.reader(handle, delimiter=DELIMITER)
|
||||
next(reader, None)
|
||||
for raw in reader:
|
||||
if not any(field.strip() for field in raw):
|
||||
continue
|
||||
if len(raw) < len(COLUMNS):
|
||||
raise DatabasesCsvError(
|
||||
f"{csv_path} has a row with {len(raw)} column(s), "
|
||||
f"expected {len(COLUMNS)}"
|
||||
)
|
||||
rows.append(Row(*raw[: len(COLUMNS)]))
|
||||
return rows
|
||||
1
src/baudolo/restore/__init__.py
Normal file
1
src/baudolo/restore/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
__all__ = ["main"]
|
||||
176
src/baudolo/restore/__main__.py
Normal file
176
src/baudolo/restore/__main__.py
Normal file
@@ -0,0 +1,176 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import sys
|
||||
|
||||
from .db.cluster import restore_cluster_sql
|
||||
from .db.mariadb import restore_mariadb_sql
|
||||
from .db.postgres import restore_postgres_sql
|
||||
from .files import restore_volume_files
|
||||
from .paths import BackupPaths
|
||||
|
||||
|
||||
def _add_common_backup_args(p: argparse.ArgumentParser) -> None:
|
||||
p.add_argument("volume_name", help="Docker volume name (target volume)")
|
||||
p.add_argument("backup_hash", help="Hashed machine id")
|
||||
p.add_argument("version", help="Backup version directory name")
|
||||
|
||||
p.add_argument(
|
||||
"--backups-dir",
|
||||
default="/Backups",
|
||||
help="Backup root directory (default: /Backups)",
|
||||
)
|
||||
p.add_argument(
|
||||
"--repo-name",
|
||||
required=True,
|
||||
help="Backup repo folder name under <backups-dir>/<hash>/",
|
||||
)
|
||||
|
||||
|
||||
def _add_common_engine_args(p: argparse.ArgumentParser) -> None:
|
||||
p.add_argument("--container", required=True)
|
||||
p.add_argument("--db-password", required=True)
|
||||
p.add_argument("--empty", action="store_true")
|
||||
p.add_argument(
|
||||
"--no-version-check",
|
||||
action="store_true",
|
||||
help=(
|
||||
"Replay even if the dump comes from a newer engine than the target. "
|
||||
"With --empty this can leave an emptied database behind."
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
parser = argparse.ArgumentParser(
|
||||
prog="baudolo-restore",
|
||||
description="Restore docker volume files and DB dumps.",
|
||||
)
|
||||
sub = parser.add_subparsers(dest="cmd", required=True)
|
||||
|
||||
p_files = sub.add_parser("files", help="Restore files into a docker volume")
|
||||
_add_common_backup_args(p_files)
|
||||
p_files.add_argument(
|
||||
"--source-volume",
|
||||
default=None,
|
||||
help=(
|
||||
"Volume name used as backup source path key. "
|
||||
"Defaults to <volume_name> (target volume). "
|
||||
"Use this when restoring from one volume backup into a different target volume."
|
||||
),
|
||||
)
|
||||
|
||||
p_pg = sub.add_parser("postgres", help="Restore a single PostgreSQL database dump")
|
||||
_add_common_backup_args(p_pg)
|
||||
_add_common_engine_args(p_pg)
|
||||
p_pg.add_argument("--db-name", required=True)
|
||||
p_pg.add_argument("--db-user", default=None, help="Defaults to db-name if omitted")
|
||||
|
||||
p_cluster = sub.add_parser(
|
||||
"cluster", help="Restore a full PostgreSQL cluster dump (pg_dumpall)"
|
||||
)
|
||||
_add_common_backup_args(p_cluster)
|
||||
_add_common_engine_args(p_cluster)
|
||||
p_cluster.add_argument(
|
||||
"--instance",
|
||||
required=True,
|
||||
help="Instance the dump was taken from; names <instance>.cluster.backup.sql",
|
||||
)
|
||||
p_cluster.add_argument(
|
||||
"--db-user",
|
||||
required=True,
|
||||
help="Superuser of the instance; the dump creates roles and databases",
|
||||
)
|
||||
|
||||
p_mdb = sub.add_parser(
|
||||
"mariadb", help="Restore a single MariaDB/MySQL-compatible dump"
|
||||
)
|
||||
_add_common_backup_args(p_mdb)
|
||||
_add_common_engine_args(p_mdb)
|
||||
p_mdb.add_argument("--db-name", required=True)
|
||||
p_mdb.add_argument("--db-user", default=None, help="Defaults to db-name if omitted")
|
||||
|
||||
args = parser.parse_args(argv)
|
||||
|
||||
try:
|
||||
if args.cmd == "files":
|
||||
source_volume = args.source_volume or args.volume_name
|
||||
|
||||
bp_files = BackupPaths(
|
||||
source_volume,
|
||||
args.backup_hash,
|
||||
args.version,
|
||||
repo_name=args.repo_name,
|
||||
backups_dir=args.backups_dir,
|
||||
)
|
||||
|
||||
return restore_volume_files(
|
||||
args.volume_name,
|
||||
bp_files.files_dir(),
|
||||
)
|
||||
|
||||
if args.cmd == "postgres":
|
||||
user = args.db_user or args.db_name
|
||||
restore_postgres_sql(
|
||||
container=args.container,
|
||||
db_name=args.db_name,
|
||||
user=user,
|
||||
password=args.db_password,
|
||||
sql_path=BackupPaths(
|
||||
args.volume_name,
|
||||
args.backup_hash,
|
||||
args.version,
|
||||
repo_name=args.repo_name,
|
||||
backups_dir=args.backups_dir,
|
||||
).sql_file(args.db_name),
|
||||
empty=args.empty,
|
||||
check_version=not args.no_version_check,
|
||||
)
|
||||
return 0
|
||||
|
||||
if args.cmd == "cluster":
|
||||
restore_cluster_sql(
|
||||
container=args.container,
|
||||
user=args.db_user,
|
||||
password=args.db_password,
|
||||
sql_path=BackupPaths(
|
||||
args.volume_name,
|
||||
args.backup_hash,
|
||||
args.version,
|
||||
repo_name=args.repo_name,
|
||||
backups_dir=args.backups_dir,
|
||||
).cluster_file(args.instance),
|
||||
empty=args.empty,
|
||||
check_version=not args.no_version_check,
|
||||
)
|
||||
return 0
|
||||
|
||||
if args.cmd == "mariadb":
|
||||
user = args.db_user or args.db_name
|
||||
restore_mariadb_sql(
|
||||
container=args.container,
|
||||
db_name=args.db_name,
|
||||
user=user,
|
||||
password=args.db_password,
|
||||
sql_path=BackupPaths(
|
||||
args.volume_name,
|
||||
args.backup_hash,
|
||||
args.version,
|
||||
repo_name=args.repo_name,
|
||||
backups_dir=args.backups_dir,
|
||||
).sql_file(args.db_name),
|
||||
empty=args.empty,
|
||||
check_version=not args.no_version_check,
|
||||
)
|
||||
return 0
|
||||
|
||||
parser.error("Unhandled command")
|
||||
return 2
|
||||
|
||||
except Exception as e: # noqa: BLE001 - CLI boundary: any failure becomes exit 1
|
||||
print(f"ERROR: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
1
src/baudolo/restore/db/__init__.py
Normal file
1
src/baudolo/restore/db/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""Database restore handlers (Postgres, MariaDB/MySQL)."""
|
||||
248
src/baudolo/restore/db/cluster.py
Normal file
248
src/baudolo/restore/db/cluster.py
Normal file
@@ -0,0 +1,248 @@
|
||||
"""Replay a full PostgreSQL cluster dump produced by ``pg_dumpall``.
|
||||
|
||||
The backup side writes one when a databases.csv row asks for every database of
|
||||
an instance (``database = '*'``, see ``backup/db.py``). Until now nothing read
|
||||
it back, so that dump was stored and unrestorable - a format whose producer has
|
||||
no consumer.
|
||||
|
||||
A cluster stream differs from a single-database one in three ways that decide
|
||||
the implementation:
|
||||
|
||||
* it recreates roles and databases, so it must be replayed against the control
|
||||
database rather than into a target database;
|
||||
* ``CREATE DATABASE`` cannot run inside a transaction block, so unlike
|
||||
:mod:`baudolo.restore.db.postgres` the replay must not be wrapped in
|
||||
``--single-transaction``;
|
||||
* it is replayed as a superuser, so the superuser-only statements that the
|
||||
single-database path filters out are exactly the ones that have to survive.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import re
|
||||
import tempfile
|
||||
from collections.abc import Iterable, Iterator
|
||||
|
||||
from ..run import docker_exec
|
||||
from .version import guard
|
||||
|
||||
CONTROL_DB = "postgres"
|
||||
_CLUSTER_PRECLEAN_SQL = os.path.join(os.path.dirname(__file__), "cluster_preclean.sql")
|
||||
_CREATE_ROLE = re.compile(rb'^CREATE ROLE "?([^";]+)"?;\s*$')
|
||||
_CREATE_DATABASE = re.compile(rb"^CREATE DATABASE\s+(.*)$")
|
||||
_CREATE_ROLE_LINE = re.compile(rb"^CREATE ROLE\s+(.*)$")
|
||||
_CONNECT = re.compile(rb"^\\connect\s+(.*)$")
|
||||
_NO_ROWS = "SELECT ''::text WHERE false"
|
||||
|
||||
|
||||
def _first_identifier(rest: str) -> str | None:
|
||||
"""The first SQL identifier in *rest*, quoted or bare.
|
||||
|
||||
A quoted identifier may hold spaces and doubled quotes, so it cannot be
|
||||
read with a character class that stops at whitespace - which is how a
|
||||
database called ``odd name`` used to leave the inventory as ``odd``.
|
||||
"""
|
||||
text = rest.strip()
|
||||
if not text:
|
||||
return None
|
||||
if text.startswith('"'):
|
||||
out = []
|
||||
index = 1
|
||||
while index < len(text):
|
||||
char = text[index]
|
||||
if char == '"':
|
||||
if index + 1 < len(text) and text[index + 1] == '"':
|
||||
out.append('"')
|
||||
index += 2
|
||||
continue
|
||||
return "".join(out)
|
||||
out.append(char)
|
||||
index += 1
|
||||
return None
|
||||
return re.split(r"[\s;(]", text, maxsplit=1)[0] or None
|
||||
|
||||
|
||||
def _connect_target(rest: str) -> str | None:
|
||||
"""The database a ``\\connect`` line switches to.
|
||||
|
||||
psql options precede the name (``\\connect -reuse-previous=on dbname=x``),
|
||||
and the name may arrive as a ``dbname=`` assignment rather than bare.
|
||||
"""
|
||||
for token in rest.strip().split():
|
||||
if token.startswith("-"):
|
||||
continue
|
||||
if token.startswith("dbname="):
|
||||
return _first_identifier(token[len("dbname=") :])
|
||||
return _first_identifier(rest.strip()[rest.strip().index(token) :])
|
||||
return None
|
||||
|
||||
|
||||
def dump_inventory(sql_path: str) -> tuple[list[str], list[str]]:
|
||||
"""The databases and roles a cluster dump recreates.
|
||||
|
||||
Args:
|
||||
sql_path: the ``pg_dumpall`` stream.
|
||||
|
||||
Returns:
|
||||
``(databases, roles)``, each in the order the dump names them. The
|
||||
pre-clean is scoped to these: everything else in the instance belongs
|
||||
to no backup this restore holds, and dropping it would destroy data
|
||||
the replay cannot bring back.
|
||||
"""
|
||||
databases: list[str] = []
|
||||
roles: list[str] = []
|
||||
with open(sql_path, "rb") as handle:
|
||||
for raw in handle:
|
||||
line = raw.decode("utf-8", "replace")
|
||||
for pattern, sink, read in (
|
||||
(_CREATE_DATABASE, databases, _first_identifier),
|
||||
(_CONNECT, databases, _connect_target),
|
||||
(_CREATE_ROLE_LINE, roles, _first_identifier),
|
||||
):
|
||||
found = pattern.match(raw)
|
||||
if not found:
|
||||
continue
|
||||
name = read(line[found.start(1) :])
|
||||
if name and name not in sink:
|
||||
sink.append(name)
|
||||
return databases, roles
|
||||
|
||||
|
||||
def preclean_sql() -> str:
|
||||
"""The catalog-wide pre-clean, safe only behind the instance check."""
|
||||
with open(_CLUSTER_PRECLEAN_SQL, encoding="utf-8") as preclean:
|
||||
return preclean.read()
|
||||
|
||||
|
||||
def instance_databases(container: str, user: str, docker_env: dict) -> list[str]:
|
||||
"""The instance's own databases, templates and control database aside."""
|
||||
listed = docker_exec(
|
||||
container,
|
||||
[
|
||||
"psql",
|
||||
"-U",
|
||||
user,
|
||||
"-d",
|
||||
CONTROL_DB,
|
||||
"-tAc",
|
||||
(
|
||||
"SELECT datname FROM pg_database "
|
||||
"WHERE NOT datistemplate AND datname <> current_database()"
|
||||
),
|
||||
],
|
||||
capture=True,
|
||||
docker_env=docker_env,
|
||||
).stdout
|
||||
text = listed.decode() if isinstance(listed, bytes) else listed
|
||||
return [name for name in text.split() if name]
|
||||
|
||||
|
||||
def assert_instance_matches_dump(
|
||||
container: str, user: str, sql_path: str, docker_env: dict
|
||||
) -> None:
|
||||
"""Refuse ``--empty`` on an instance holding anything the dump lacks.
|
||||
|
||||
The pre-clean is a catalog-wide sweep, so a foreign database would be
|
||||
destroyed with no way back. Scoping the sweep instead is not a fix: a
|
||||
surviving database that owns or grants to one of the dump's roles pins
|
||||
that role in pg_shdepend, and DROP ROLE then fails after the dump's own
|
||||
databases are already gone.
|
||||
|
||||
Raises:
|
||||
RuntimeError: the instance carries databases this dump cannot restore.
|
||||
"""
|
||||
dumped, _roles = dump_inventory(sql_path)
|
||||
present = instance_databases(container, user, docker_env)
|
||||
foreign = sorted(set(present) - set(dumped))
|
||||
if foreign:
|
||||
raise RuntimeError(
|
||||
f"{container} also holds {', '.join(foreign)}, which "
|
||||
f"{os.path.basename(sql_path)} does not carry. --empty wipes the "
|
||||
"instance, so those would be destroyed with nothing to restore "
|
||||
"them from. Move them off this instance, or drop them yourself if "
|
||||
"they are disposable."
|
||||
)
|
||||
|
||||
|
||||
def _psql(user: str) -> list[str]:
|
||||
"""The replay client: no --single-transaction, CREATE DATABASE forbids it."""
|
||||
return ["psql", "-v", "ON_ERROR_STOP=1", "-U", user, "-d", CONTROL_DB]
|
||||
|
||||
|
||||
def filter_own_role_creation(lines: Iterable[bytes], user: str) -> Iterator[bytes]:
|
||||
"""Drop the ``CREATE ROLE`` of the role holding this session.
|
||||
|
||||
A pg_dumpall stream recreates every role of the cluster, the bootstrap
|
||||
superuser included, and the pre-clean cannot drop the one it is connected
|
||||
as - so that single statement always collides. Its ``ALTER ROLE`` is kept:
|
||||
that is what re-applies the attributes and the password the dump captured.
|
||||
|
||||
Args:
|
||||
lines: dump lines including their trailing newlines.
|
||||
user: the connecting role.
|
||||
|
||||
Yields:
|
||||
Every line except that one CREATE.
|
||||
"""
|
||||
for line in lines:
|
||||
found = _CREATE_ROLE.match(line)
|
||||
if found and found.group(1).decode() == user:
|
||||
continue
|
||||
yield line
|
||||
|
||||
|
||||
def restore_cluster_sql(
|
||||
*,
|
||||
container: str,
|
||||
user: str,
|
||||
password: str,
|
||||
sql_path: str,
|
||||
empty: bool,
|
||||
check_version: bool = True,
|
||||
) -> None:
|
||||
"""Replay a pg_dumpall stream into a running instance.
|
||||
|
||||
Args:
|
||||
container: the running engine to replay into.
|
||||
user: a superuser of that instance; the dump creates roles and
|
||||
databases, which an application role may not do.
|
||||
password: its password, handed to psql through the container's env.
|
||||
sql_path: the ``<instance>.cluster.backup.sql`` of a generation.
|
||||
empty: drop the cluster's databases and roles first. Without it the
|
||||
replay stops at the first object that already exists, which is the
|
||||
honest outcome: recreating a cluster over a populated one is a
|
||||
decision, not a default.
|
||||
check_version: refuse a dump from a newer major version than the
|
||||
running engine before anything is dropped.
|
||||
"""
|
||||
if not os.path.isfile(sql_path):
|
||||
raise FileNotFoundError(sql_path)
|
||||
|
||||
if check_version:
|
||||
guard(
|
||||
sql_path=sql_path,
|
||||
engine="postgres",
|
||||
container=container,
|
||||
user=user,
|
||||
password=password,
|
||||
)
|
||||
|
||||
docker_env = {"PGPASSWORD": password}
|
||||
|
||||
if empty:
|
||||
assert_instance_matches_dump(container, user, sql_path, docker_env)
|
||||
docker_exec(
|
||||
container,
|
||||
_psql(user),
|
||||
stdin=preclean_sql().encode(),
|
||||
docker_env=docker_env,
|
||||
)
|
||||
|
||||
with open(sql_path, "rb") as src, tempfile.TemporaryFile() as filtered:
|
||||
for line in filter_own_role_creation(src, user):
|
||||
filtered.write(line)
|
||||
filtered.seek(0)
|
||||
docker_exec(container, _psql(user), stdin=filtered, docker_env=docker_env)
|
||||
|
||||
print(f"PostgreSQL cluster restore complete from '{os.path.basename(sql_path)}'.")
|
||||
33
src/baudolo/restore/db/cluster_preclean.sql
Normal file
33
src/baudolo/restore/db/cluster_preclean.sql
Normal file
@@ -0,0 +1,33 @@
|
||||
-- Pre-clean for `restore cluster --empty`. A pg_dumpall stream recreates roles
|
||||
-- and databases, so replaying it into a populated cluster dies on the first
|
||||
-- CREATE ROLE. Emitted as one DROP per row and run via \gexec so each executes
|
||||
-- as its own top-level statement: DROP DATABASE cannot run inside a
|
||||
-- transaction block, which rules out a single DO block.
|
||||
-- The phase column pins the order: databases must be gone before their owners
|
||||
-- can be dropped, and DROP OWNED BY releases what a role still holds in the
|
||||
-- control database. Template databases, the control database itself, the pg_*
|
||||
-- system roles and the connecting role are kept - the dump does not recreate
|
||||
-- them and dropping them would end the session.
|
||||
-- The sweep stays catalog-wide on purpose: a scoped one leaves databases that
|
||||
-- pin a dumped role in pg_shdepend, and phase 3 then fails after phase 1 has
|
||||
-- already dropped. assert_instance_matches_dump refuses before this runs.
|
||||
SELECT statement
|
||||
FROM (
|
||||
SELECT 1 AS phase,
|
||||
format('DROP DATABASE IF EXISTS %I', datname) AS statement
|
||||
FROM pg_database
|
||||
WHERE NOT datistemplate
|
||||
AND datname <> current_database()
|
||||
UNION ALL
|
||||
SELECT 2, format('DROP OWNED BY %I', rolname)
|
||||
FROM pg_roles
|
||||
WHERE NOT starts_with(rolname, 'pg_')
|
||||
AND rolname <> current_user
|
||||
UNION ALL
|
||||
SELECT 3, format('DROP ROLE IF EXISTS %I', rolname)
|
||||
FROM pg_roles
|
||||
WHERE NOT starts_with(rolname, 'pg_')
|
||||
AND rolname <> current_user
|
||||
) drops
|
||||
ORDER BY phase
|
||||
\gexec
|
||||
64
src/baudolo/restore/db/empty_preclean.sql
Normal file
64
src/baudolo/restore/db/empty_preclean.sql
Normal file
@@ -0,0 +1,64 @@
|
||||
-- Owner-filtered pre-clean for `restore --empty`. Emitted as one DROP per row and
|
||||
-- run via \gexec so each executes as its own top-level statement: a single DO-block
|
||||
-- would run every DROP in one transaction and exhaust max_locks_per_transaction on
|
||||
-- large schemas (e.g. gitlab). Also drops 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 the CASCADE fallout.
|
||||
SELECT format('DROP %s IF EXISTS public.%s CASCADE', obj.type, obj.name)
|
||||
FROM (
|
||||
SELECT format('%I', c.relname) AS name,
|
||||
CASE c.relkind
|
||||
WHEN 'v' THEN 'VIEW'
|
||||
WHEN 'm' THEN 'MATERIALIZED VIEW'
|
||||
WHEN 'f' THEN 'FOREIGN TABLE'
|
||||
ELSE 'TABLE'
|
||||
END AS type
|
||||
FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace
|
||||
WHERE n.nspname = 'public' AND c.relkind IN ('r', 'p', 'v', 'm', 'f')
|
||||
AND pg_get_userbyid(c.relowner) = current_user
|
||||
UNION ALL
|
||||
-- Overloaded functions share a proname; DROP needs the identity
|
||||
-- signature or psql aborts with "function name is not unique".
|
||||
SELECT format('%I(%s)', p.proname, pg_get_function_identity_arguments(p.oid)) AS name,
|
||||
CASE p.prokind WHEN 'p' THEN 'PROCEDURE' ELSE 'FUNCTION' END AS type
|
||||
FROM pg_proc p JOIN pg_namespace n ON n.oid = p.pronamespace
|
||||
WHERE n.nspname = 'public' AND p.prokind IN ('f', 'p', 'w')
|
||||
AND pg_get_userbyid(p.proowner) = current_user
|
||||
UNION ALL
|
||||
SELECT format('%I', c.relname) AS name, 'SEQUENCE' AS type
|
||||
FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace
|
||||
WHERE n.nspname = 'public' AND c.relkind = 'S'
|
||||
AND pg_get_userbyid(c.relowner) = current_user
|
||||
UNION ALL
|
||||
SELECT format('%I', t.typname) AS name, 'TYPE' AS type
|
||||
FROM pg_type t JOIN pg_namespace n ON n.oid = t.typnamespace
|
||||
WHERE n.nspname = 'public'
|
||||
AND pg_get_userbyid(t.typowner) = current_user
|
||||
AND (t.typtype IN ('e', 'd')
|
||||
OR (t.typtype = 'c' AND EXISTS (
|
||||
SELECT 1 FROM pg_class c2
|
||||
WHERE c2.oid = t.typrelid AND c2.relkind = 'c')))
|
||||
UNION ALL
|
||||
SELECT format('%I', col.collname) AS name, 'COLLATION' AS type
|
||||
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
|
||||
UNION ALL
|
||||
SELECT format('%I', ts.cfgname) AS name, 'TEXT SEARCH CONFIGURATION' AS type
|
||||
FROM pg_ts_config ts JOIN pg_namespace n ON n.oid = ts.cfgnamespace
|
||||
WHERE n.nspname = 'public'
|
||||
AND pg_get_userbyid(ts.cfgowner) = current_user
|
||||
UNION ALL
|
||||
SELECT format('%I', d.dictname) AS name, 'TEXT SEARCH DICTIONARY' AS type
|
||||
FROM pg_ts_dict d JOIN pg_namespace n ON n.oid = d.dictnamespace
|
||||
WHERE n.nspname = 'public'
|
||||
AND pg_get_userbyid(d.dictowner) = current_user
|
||||
) 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
|
||||
102
src/baudolo/restore/db/mariadb.py
Normal file
102
src/baudolo/restore/db/mariadb.py
Normal file
@@ -0,0 +1,102 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
from ..run import docker_exec, docker_exec_sh
|
||||
from .version import guard
|
||||
|
||||
|
||||
def _pick_client(container: str) -> str:
|
||||
"""
|
||||
Prefer 'mariadb', fallback to 'mysql'.
|
||||
Some MariaDB images no longer ship a 'mysql' binary, so we must not assume it exists.
|
||||
"""
|
||||
script = r"""
|
||||
set -eu
|
||||
if command -v mariadb >/dev/null 2>&1; then echo mariadb; exit 0; fi
|
||||
if command -v mysql >/dev/null 2>&1; then echo mysql; exit 0; fi
|
||||
exit 42
|
||||
"""
|
||||
try:
|
||||
out = docker_exec_sh(container, script, capture=True).stdout.decode().strip()
|
||||
if not out:
|
||||
raise RuntimeError("empty client detection output")
|
||||
return out
|
||||
except Exception:
|
||||
print(
|
||||
"ERROR: neither 'mariadb' nor 'mysql' found in container.", file=sys.stderr
|
||||
)
|
||||
raise
|
||||
|
||||
|
||||
def restore_mariadb_sql(
|
||||
*,
|
||||
container: str,
|
||||
db_name: str,
|
||||
user: str,
|
||||
password: str,
|
||||
sql_path: str,
|
||||
empty: bool,
|
||||
check_version: bool = True,
|
||||
) -> None:
|
||||
client = _pick_client(container)
|
||||
|
||||
if not os.path.isfile(sql_path):
|
||||
raise FileNotFoundError(sql_path)
|
||||
|
||||
if check_version:
|
||||
guard(
|
||||
sql_path=sql_path,
|
||||
engine="mariadb",
|
||||
container=container,
|
||||
user=user,
|
||||
password=password,
|
||||
client=client,
|
||||
)
|
||||
|
||||
if empty:
|
||||
# Do not hardcode 'mysql': MariaDB 11 images may not ship that binary.
|
||||
result = docker_exec(
|
||||
container,
|
||||
[
|
||||
client,
|
||||
"-u",
|
||||
user,
|
||||
f"--password={password}",
|
||||
"-N",
|
||||
"-e",
|
||||
f"SELECT table_name FROM information_schema.tables WHERE table_schema = '{db_name}';",
|
||||
],
|
||||
capture=True,
|
||||
)
|
||||
tables = result.stdout.decode().split()
|
||||
|
||||
if tables:
|
||||
# SET FOREIGN_KEY_CHECKS is session-scoped, so it must share one
|
||||
# client session with the DROPs or FK constraints still fire.
|
||||
drop_sql = (
|
||||
"SET FOREIGN_KEY_CHECKS=0; "
|
||||
+ " ".join(
|
||||
f"DROP TABLE IF EXISTS `{db_name}`.`{tbl}`;" for tbl in tables
|
||||
)
|
||||
+ " SET FOREIGN_KEY_CHECKS=1;"
|
||||
)
|
||||
docker_exec(
|
||||
container,
|
||||
[
|
||||
client,
|
||||
"-u",
|
||||
user,
|
||||
f"--password={password}",
|
||||
"-e",
|
||||
drop_sql,
|
||||
],
|
||||
)
|
||||
|
||||
with open(sql_path, "rb") as f:
|
||||
docker_exec(
|
||||
container, [client, "-u", user, f"--password={password}", db_name], stdin=f
|
||||
)
|
||||
|
||||
print(f"MariaDB/MySQL restore complete for db '{db_name}'.")
|
||||
99
src/baudolo/restore/db/postgres.py
Normal file
99
src/baudolo/restore/db/postgres.py
Normal file
@@ -0,0 +1,99 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
from collections.abc import Iterable, Iterator
|
||||
|
||||
from ..run import docker_exec
|
||||
from .version import guard
|
||||
|
||||
_SUPERUSER_ONLY_PREFIXES = (b"COMMENT ON EXTENSION", b"ALTER DEFAULT PRIVILEGES")
|
||||
_EMPTY_PRECLEAN_SQL = os.path.join(os.path.dirname(__file__), "empty_preclean.sql")
|
||||
|
||||
|
||||
def filter_superuser_only_lines(lines: Iterable[bytes]) -> Iterator[bytes]:
|
||||
"""Drop superuser-only statements an app-level psql replay cannot run.
|
||||
|
||||
Args:
|
||||
lines: dump lines including their trailing newlines.
|
||||
|
||||
Yields:
|
||||
Every line except top-level statements starting with a superuser-only
|
||||
prefix. Lines inside COPY ... FROM stdin data blocks are passed
|
||||
through untouched: a data row may legally start with the same bytes,
|
||||
and dropping it would silently corrupt the restored table.
|
||||
"""
|
||||
in_copy = False
|
||||
for line in lines:
|
||||
if in_copy:
|
||||
yield line
|
||||
if line.rstrip(b"\r\n") == b"\\.":
|
||||
in_copy = False
|
||||
continue
|
||||
if line.startswith(b"COPY ") and line.rstrip(b"\r\n").endswith(b"FROM stdin;"):
|
||||
in_copy = True
|
||||
yield line
|
||||
continue
|
||||
if line.startswith(_SUPERUSER_ONLY_PREFIXES):
|
||||
continue
|
||||
yield line
|
||||
|
||||
|
||||
def restore_postgres_sql(
|
||||
*,
|
||||
container: str,
|
||||
db_name: str,
|
||||
user: str,
|
||||
password: str,
|
||||
sql_path: str,
|
||||
empty: bool,
|
||||
check_version: bool = True,
|
||||
) -> None:
|
||||
if not os.path.isfile(sql_path):
|
||||
raise FileNotFoundError(sql_path)
|
||||
|
||||
if check_version:
|
||||
guard(
|
||||
sql_path=sql_path,
|
||||
engine="postgres",
|
||||
container=container,
|
||||
user=user,
|
||||
password=password,
|
||||
)
|
||||
|
||||
docker_env = {"PGPASSWORD": password}
|
||||
|
||||
if empty:
|
||||
with open(_EMPTY_PRECLEAN_SQL, encoding="utf-8") as preclean:
|
||||
drop_sql = preclean.read()
|
||||
docker_exec(
|
||||
container,
|
||||
["psql", "-v", "ON_ERROR_STOP=1", "-U", user, "-d", db_name],
|
||||
stdin=drop_sql.encode(),
|
||||
docker_env=docker_env,
|
||||
)
|
||||
|
||||
# Filter into a spooled temp file instead of building the whole dump in
|
||||
# memory: production dumps reach many GB and the previous read/splitlines/
|
||||
# join needed roughly three times the dump size in RSS.
|
||||
with open(sql_path, "rb") as src, tempfile.TemporaryFile() as filtered:
|
||||
for line in filter_superuser_only_lines(src):
|
||||
filtered.write(line)
|
||||
filtered.seek(0)
|
||||
docker_exec(
|
||||
container,
|
||||
[
|
||||
"psql",
|
||||
"--single-transaction",
|
||||
"-v",
|
||||
"ON_ERROR_STOP=1",
|
||||
"-U",
|
||||
user,
|
||||
"-d",
|
||||
db_name,
|
||||
],
|
||||
stdin=filtered,
|
||||
docker_env=docker_env,
|
||||
)
|
||||
|
||||
print(f"PostgreSQL restore complete for db '{db_name}'.")
|
||||
146
src/baudolo/restore/db/version.py
Normal file
146
src/baudolo/restore/db/version.py
Normal file
@@ -0,0 +1,146 @@
|
||||
"""Refuse a dump the target engine is too old to read.
|
||||
|
||||
A restore with ``--empty`` destroys before it replays: the pre-clean drops the
|
||||
schema in one session and the dump goes in the next, with no rollback across
|
||||
the two. A dump the engine cannot parse therefore does not fail harmlessly -
|
||||
it leaves an emptied database behind. Comparing the two versions first turns
|
||||
that into a refusal.
|
||||
|
||||
Both engines state their origin in the dump's own header, and they do not
|
||||
state it the same way. Postgres writes ``-- Dumped from database version``
|
||||
around line seven. MariaDB opens line two with ``-- MariaDB dump 10.19-11.8.8``,
|
||||
where the first number is mariadb-dump's own version, and names the server only
|
||||
further down on the tab-separated ``-- Server version`` line. Matching the first
|
||||
number in the header would read the tool on one engine and the server on the
|
||||
other, so each engine gets its own pattern.
|
||||
|
||||
A ``pg_dumpall`` cluster dump has no version line of its own: its header opens
|
||||
with the cluster banner and the roles section, and the first
|
||||
``-- Dumped from database version`` belongs to the first database's embedded
|
||||
``pg_dump`` output, arbitrarily far down. Hence the scan runs to
|
||||
``SCAN_LINES`` rather than to a header-sized handful.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
|
||||
from ..run import docker_exec, stdout_of
|
||||
|
||||
SCAN_LINES = 2000
|
||||
DUMP_VERSION = {
|
||||
"postgres": re.compile(r"^-- Dumped from database version (\S+)"),
|
||||
"mariadb": re.compile(r"^-- Server version\s+(\S+)"),
|
||||
}
|
||||
|
||||
|
||||
class VersionMismatch(Exception):
|
||||
"""The dump cannot be replayed into this engine."""
|
||||
|
||||
|
||||
def major_of(version: str) -> int:
|
||||
"""The major number of an engine version string.
|
||||
|
||||
Args:
|
||||
version: as the engine spells it, e.g. ``17.11`` or
|
||||
``11.8.8-MariaDB-ubu2404``.
|
||||
|
||||
Raises:
|
||||
VersionMismatch: the string does not start with a number.
|
||||
"""
|
||||
leading = re.match(r"(\d+)", version)
|
||||
if not leading:
|
||||
raise VersionMismatch(f"cannot read a major version from '{version}'")
|
||||
return int(leading.group(1))
|
||||
|
||||
|
||||
def dump_version(sql_path: str, engine: str) -> str:
|
||||
"""Read the engine version a dump was taken from, out of its own header.
|
||||
|
||||
Args:
|
||||
sql_path: the dump to read.
|
||||
engine: ``postgres`` or ``mariadb``.
|
||||
|
||||
Returns:
|
||||
The version string as the dump spells it.
|
||||
|
||||
Raises:
|
||||
VersionMismatch: no version line within the first ``SCAN_LINES``.
|
||||
"""
|
||||
pattern = DUMP_VERSION[engine]
|
||||
with open(sql_path, encoding="utf-8", errors="replace") as handle:
|
||||
for _ in range(SCAN_LINES):
|
||||
line = handle.readline()
|
||||
if not line:
|
||||
break
|
||||
found = pattern.search(line)
|
||||
if found:
|
||||
return found.group(1)
|
||||
raise VersionMismatch(
|
||||
f"{sql_path} carries no {engine} version header in its first {SCAN_LINES} lines"
|
||||
)
|
||||
|
||||
|
||||
def server_version(
|
||||
container: str, engine: str, user: str, password: str, client: str = ""
|
||||
) -> str:
|
||||
"""Ask the running engine which version it is."""
|
||||
if engine == "postgres":
|
||||
return stdout_of(
|
||||
docker_exec(
|
||||
container,
|
||||
["psql", "-U", user, "-tAc", "SHOW server_version"],
|
||||
capture=True,
|
||||
docker_env={"PGPASSWORD": password},
|
||||
)
|
||||
)
|
||||
return stdout_of(
|
||||
docker_exec(
|
||||
container,
|
||||
[
|
||||
client or "mariadb",
|
||||
"-u",
|
||||
user,
|
||||
f"--password={password}",
|
||||
"-N",
|
||||
"-B",
|
||||
"-e",
|
||||
"SELECT VERSION()",
|
||||
],
|
||||
capture=True,
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
def assert_replayable(sql_path: str, engine: str, dumped: str, serving: str) -> None:
|
||||
"""Refuse a dump from a newer major version than the target engine.
|
||||
|
||||
Restoring forward across a major version is the upgrade path and stays
|
||||
allowed; backward is refused, because a newer dump uses syntax an older
|
||||
server rejects and the pre-clean would already have dropped the schema.
|
||||
|
||||
Raises:
|
||||
VersionMismatch: the dump is newer than the engine.
|
||||
"""
|
||||
if major_of(dumped) > major_of(serving):
|
||||
raise VersionMismatch(
|
||||
f"{sql_path} came from {engine} {dumped} but {serving} is running; "
|
||||
"a newer dump does not replay into an older engine, and --empty "
|
||||
"would drop the schema before finding out"
|
||||
)
|
||||
|
||||
|
||||
def guard(
|
||||
*,
|
||||
sql_path: str,
|
||||
engine: str,
|
||||
container: str,
|
||||
user: str,
|
||||
password: str,
|
||||
client: str = "",
|
||||
) -> None:
|
||||
"""Compare the dump's origin against the running engine before replaying."""
|
||||
dumped = dump_version(sql_path, engine)
|
||||
serving = server_version(container, engine, user, password, client)
|
||||
assert_replayable(sql_path, engine, dumped, serving)
|
||||
print(f"OK: dump is from {engine} {dumped}, {serving} is serving.")
|
||||
62
src/baudolo/restore/files.py
Normal file
62
src/baudolo/restore/files.py
Normal file
@@ -0,0 +1,62 @@
|
||||
"""Restore a volume's file tree by writing into its mountpoint.
|
||||
|
||||
That shortcut only holds for a plain local volume, where the mountpoint *is*
|
||||
the storage. A volume with driver options - NFS, a bind device, tmpfs - keeps
|
||||
the same ``/var/lib/docker/volumes/<name>/_data`` path, but docker mounts the
|
||||
real backing store over it on demand and unmounts it again when the last
|
||||
consumer stops. Writing there while nothing has it mounted lands in the empty
|
||||
directory underneath, is hidden by the next mount, and rsync reports success.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
from .run import docker_volume_exists, run, stdout_of
|
||||
|
||||
INSPECT_FORMAT = (
|
||||
"{{ .Mountpoint }}|{{ .Driver }}|{{ if .Options }}opts{{ else }}plain{{ end }}"
|
||||
)
|
||||
|
||||
|
||||
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
|
||||
|
||||
if not docker_volume_exists(volume_name):
|
||||
print(f"Volume {volume_name} does not exist. Creating...")
|
||||
run(["docker", "volume", "create", volume_name])
|
||||
else:
|
||||
print(f"Volume {volume_name} already exists.")
|
||||
|
||||
cp = run(
|
||||
["docker", "volume", "inspect", "--format", INSPECT_FORMAT, volume_name],
|
||||
capture=True,
|
||||
)
|
||||
fields = stdout_of(cp).split("|")
|
||||
mountpoint = fields[0] if fields else ""
|
||||
if not mountpoint:
|
||||
print(
|
||||
f"ERROR: could not resolve mountpoint for volume {volume_name}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 2
|
||||
|
||||
driver, options = (fields + ["local", "plain"])[1:3]
|
||||
if (driver != "local" or options == "opts") and not os.path.ismount(mountpoint):
|
||||
print(
|
||||
f"ERROR: volume {volume_name} has a backing store of its own "
|
||||
f"(driver {driver}) but nothing has it mounted; writing to "
|
||||
f"{mountpoint} now would land under the mount and be lost. "
|
||||
"Start a container that mounts the volume, then restore again.",
|
||||
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
|
||||
33
src/baudolo/restore/paths.py
Normal file
33
src/baudolo/restore/paths.py
Normal file
@@ -0,0 +1,33 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from dataclasses import dataclass
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class BackupPaths:
|
||||
volume_name: str
|
||||
backup_hash: str
|
||||
version: str
|
||||
repo_name: str
|
||||
backups_dir: str = "/Backups"
|
||||
|
||||
def root(self) -> str:
|
||||
# Always build an absolute path under backups_dir
|
||||
return os.path.join(
|
||||
self.backups_dir,
|
||||
self.backup_hash,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.volume_name,
|
||||
)
|
||||
|
||||
def files_dir(self) -> str:
|
||||
return os.path.join(self.root(), "files")
|
||||
|
||||
def sql_file(self, db_name: str) -> str:
|
||||
return os.path.join(self.root(), "sql", f"{db_name}.backup.sql")
|
||||
|
||||
def cluster_file(self, instance: str) -> str:
|
||||
"""The pg_dumpall stream a `database = '*'` row produces."""
|
||||
return os.path.join(self.root(), "sql", f"{instance}.cluster.backup.sql")
|
||||
92
src/baudolo/restore/run.py
Normal file
92
src/baudolo/restore/run.py
Normal file
@@ -0,0 +1,92 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
|
||||
def run(
|
||||
cmd: list[str],
|
||||
*,
|
||||
stdin=None,
|
||||
capture: bool = False,
|
||||
env: dict | None = None,
|
||||
) -> subprocess.CompletedProcess:
|
||||
try:
|
||||
kwargs: dict = {
|
||||
"check": True,
|
||||
"capture_output": capture,
|
||||
"env": env,
|
||||
}
|
||||
|
||||
# If stdin is raw data (bytes/str), pass it via input=.
|
||||
# IMPORTANT: when using input=..., do NOT pass stdin=... as well.
|
||||
if isinstance(stdin, (bytes, str)):
|
||||
kwargs["input"] = stdin
|
||||
else:
|
||||
kwargs["stdin"] = stdin
|
||||
|
||||
return subprocess.run(cmd, **kwargs) # noqa: PLW1510 - check lives in kwargs
|
||||
|
||||
except subprocess.CalledProcessError as e:
|
||||
msg = f"ERROR: command failed ({e.returncode}): {' '.join(cmd)}"
|
||||
print(msg, file=sys.stderr)
|
||||
for stream in (e.stdout, e.stderr):
|
||||
if not stream:
|
||||
continue
|
||||
try:
|
||||
print(stream.decode(), file=sys.stderr)
|
||||
except (UnicodeDecodeError, AttributeError):
|
||||
print(stream, file=sys.stderr)
|
||||
raise
|
||||
|
||||
|
||||
def stdout_of(completed: subprocess.CompletedProcess) -> str:
|
||||
"""The captured stdout as stripped text, whether it came back bytes or str."""
|
||||
raw = completed.stdout or b""
|
||||
return (raw.decode() if isinstance(raw, bytes) else raw).strip()
|
||||
|
||||
|
||||
def docker_exec(
|
||||
container: str,
|
||||
argv: list[str],
|
||||
*,
|
||||
stdin=None,
|
||||
capture: bool = False,
|
||||
env: dict | None = None,
|
||||
docker_env: dict[str, str] | None = None,
|
||||
) -> subprocess.CompletedProcess:
|
||||
cmd: list[str] = ["docker", "exec", "-i"]
|
||||
if docker_env:
|
||||
for k, v in docker_env.items():
|
||||
cmd.extend(["-e", f"{k}={v}"])
|
||||
cmd.extend([container, *argv])
|
||||
return run(cmd, stdin=stdin, capture=capture, env=env)
|
||||
|
||||
|
||||
def docker_exec_sh(
|
||||
container: str,
|
||||
script: str,
|
||||
*,
|
||||
stdin=None,
|
||||
capture: bool = False,
|
||||
env: dict | None = None,
|
||||
docker_env: dict[str, str] | None = None,
|
||||
) -> subprocess.CompletedProcess:
|
||||
return docker_exec(
|
||||
container,
|
||||
["sh", "-lc", script],
|
||||
stdin=stdin,
|
||||
capture=capture,
|
||||
env=env,
|
||||
docker_env=docker_env,
|
||||
)
|
||||
|
||||
|
||||
def docker_volume_exists(volume: str) -> bool:
|
||||
p = subprocess.run(
|
||||
["docker", "volume", "inspect", volume],
|
||||
stdout=subprocess.DEVNULL,
|
||||
stderr=subprocess.DEVNULL,
|
||||
check=False,
|
||||
)
|
||||
return p.returncode == 0
|
||||
94
src/baudolo/seed/__main__.py
Normal file
94
src/baudolo/seed/__main__.py
Normal file
@@ -0,0 +1,94 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import os
|
||||
import sys
|
||||
|
||||
import pandas as pd
|
||||
from pandas.errors import EmptyDataError
|
||||
|
||||
from baudolo.databases import COLUMNS, DELIMITER, validate_database
|
||||
|
||||
|
||||
def _empty_df() -> pd.DataFrame:
|
||||
return pd.DataFrame(columns=list(COLUMNS))
|
||||
|
||||
|
||||
def check_and_add_entry(
|
||||
file_path: str,
|
||||
instance: str,
|
||||
database: str | None,
|
||||
username: str,
|
||||
password: str,
|
||||
) -> None:
|
||||
"""
|
||||
Add or update an entry in databases.csv.
|
||||
|
||||
The function enforces strict validation:
|
||||
- database MUST be set
|
||||
- database MUST be '*' or a valid database name
|
||||
"""
|
||||
database = validate_database(database, instance=instance)
|
||||
|
||||
if os.path.exists(file_path):
|
||||
try:
|
||||
df = pd.read_csv(
|
||||
file_path,
|
||||
sep=DELIMITER,
|
||||
dtype=str,
|
||||
keep_default_na=False,
|
||||
)
|
||||
except EmptyDataError:
|
||||
print(
|
||||
f"WARNING: databases.csv exists but is empty: {file_path}. Creating header columns.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
df = _empty_df()
|
||||
else:
|
||||
df = _empty_df()
|
||||
mask = (df["instance"] == instance) & (df["database"] == database)
|
||||
|
||||
if mask.any():
|
||||
print("Updating existing entry.")
|
||||
df.loc[mask, ["username", "password"]] = [username, password]
|
||||
else:
|
||||
print("Adding new entry.")
|
||||
new_entry = pd.DataFrame(
|
||||
[[instance, database, username, password]],
|
||||
columns=list(COLUMNS),
|
||||
)
|
||||
df = pd.concat([df, new_entry], ignore_index=True)
|
||||
|
||||
df.to_csv(file_path, sep=DELIMITER, index=False)
|
||||
|
||||
|
||||
def main() -> None:
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Seed or update databases.csv for backup configuration."
|
||||
)
|
||||
parser.add_argument("file", help="Path to databases.csv")
|
||||
parser.add_argument("instance", help="Instance name (e.g. bigbluebutton)")
|
||||
parser.add_argument(
|
||||
"database",
|
||||
help="Database name or '*' to dump all databases",
|
||||
)
|
||||
parser.add_argument("username", help="Database username")
|
||||
parser.add_argument("password", help="Database password")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
try:
|
||||
check_and_add_entry(
|
||||
file_path=args.file,
|
||||
instance=args.instance,
|
||||
database=args.database,
|
||||
username=args.username,
|
||||
password=args.password,
|
||||
)
|
||||
except Exception as exc: # noqa: BLE001 - CLI boundary: any failure becomes exit 1
|
||||
print(f"ERROR: {exc}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
0
tests/__init__.py
Normal file
0
tests/__init__.py
Normal file
0
tests/e2e/__init__.py
Normal file
0
tests/e2e/__init__.py
Normal file
90
tests/e2e/faithful_driver.py
Normal file
90
tests/e2e/faithful_driver.py
Normal file
@@ -0,0 +1,90 @@
|
||||
"""Show what a real snapshot holds for a volume that has its own storage.
|
||||
|
||||
Runs inside the privileged container that built the btrfs subject. Prints one
|
||||
PASS/FAIL line per assertion and exits non-zero on the first failure.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
sys.path.insert(0, "/src")
|
||||
|
||||
from baudolo.backup.snapshot import (
|
||||
SnapshotError,
|
||||
snapshot_source,
|
||||
unsnapshotted,
|
||||
volume_snapshot,
|
||||
)
|
||||
from baudolo.backup.volume import Backing
|
||||
|
||||
SUBJECT = sys.argv[1]
|
||||
|
||||
|
||||
def shell(command: list[str]) -> list[str]:
|
||||
proc = subprocess.run(command, capture_output=True, text=True, check=False)
|
||||
if proc.returncode != 0:
|
||||
raise SnapshotError(
|
||||
f"{' '.join(command)} exited {proc.returncode}: {proc.stderr.strip()}"
|
||||
)
|
||||
return proc.stdout.splitlines()
|
||||
|
||||
|
||||
def check(label: str, condition: bool) -> None:
|
||||
print(f"{'PASS' if condition else 'FAIL'} {label}", flush=True)
|
||||
if not condition:
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def volume(name: str, payload: str) -> Path:
|
||||
path = Path(SUBJECT) / "volumes" / name / "_data"
|
||||
path.mkdir(parents=True, exist_ok=True)
|
||||
(path / "state").write_text(payload)
|
||||
return path
|
||||
|
||||
|
||||
plain = volume("plain", "plain-payload")
|
||||
own = Path(SUBJECT) / "volumes" / "own" / "_data"
|
||||
own.mkdir(parents=True, exist_ok=True)
|
||||
shell(["mount", "-t", "tmpfs", "tmpfs", own])
|
||||
(own / "state").write_text("own-payload")
|
||||
|
||||
check("a plain volume is captured", unsnapshotted(Backing(str(plain)), SUBJECT) is None)
|
||||
check(
|
||||
"a volume on a mount of its own is not",
|
||||
unsnapshotted(Backing(str(own)), SUBJECT) is not None,
|
||||
)
|
||||
check(
|
||||
"a declared backing store is not, mounted or not",
|
||||
unsnapshotted(Backing(str(plain), options={"type": "nfs"}), SUBJECT) is not None,
|
||||
)
|
||||
check(
|
||||
"a foreign driver is not",
|
||||
unsnapshotted(Backing(str(plain), driver="rexray"), SUBJECT) is not None,
|
||||
)
|
||||
|
||||
with volume_snapshot("btrfs", SUBJECT, "e2e", run=shell) as resolve:
|
||||
frozen_plain = Path(resolve(str(plain)))
|
||||
frozen_own = Path(resolve(str(own)))
|
||||
|
||||
check(
|
||||
"the snapshot carries the plain volume",
|
||||
(frozen_plain / "state").read_text() == "plain-payload",
|
||||
)
|
||||
check(
|
||||
"the snapshot shows the other volume as an empty directory",
|
||||
frozen_own.is_dir() and not any(frozen_own.iterdir()),
|
||||
)
|
||||
|
||||
source, reason = snapshot_source(resolve, Backing(str(plain)), SUBJECT)
|
||||
check(
|
||||
"the plain volume is read from the snapshot",
|
||||
source is not None and source.rstrip("/") == str(frozen_plain),
|
||||
)
|
||||
|
||||
source, reason = snapshot_source(resolve, Backing(str(own)), SUBJECT)
|
||||
check(f"the other volume degrades to live: {reason[:60]}", source is None)
|
||||
|
||||
print("ALL OK", flush=True)
|
||||
4
tests/e2e/helpers/__init__.py
Normal file
4
tests/e2e/helpers/__init__.py
Normal file
@@ -0,0 +1,4 @@
|
||||
"""Shared e2e helpers, re-exported so tests import one name."""
|
||||
|
||||
from .fixtures import *
|
||||
from .process import *
|
||||
114
tests/e2e/helpers/fixtures.py
Normal file
114
tests/e2e/helpers/fixtures.py
Normal file
@@ -0,0 +1,114 @@
|
||||
"""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)
|
||||
156
tests/e2e/helpers/process.py
Normal file
156
tests/e2e/helpers/process.py
Normal file
@@ -0,0 +1,156 @@
|
||||
"""Process, docker and readiness helpers for the e2e suite."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import subprocess
|
||||
import time
|
||||
import uuid
|
||||
|
||||
|
||||
def run(
|
||||
cmd: list[str],
|
||||
*,
|
||||
capture: bool = True,
|
||||
check: bool = True,
|
||||
cwd: str | None = None,
|
||||
) -> subprocess.CompletedProcess:
|
||||
try:
|
||||
return subprocess.run(
|
||||
cmd,
|
||||
check=check,
|
||||
cwd=cwd,
|
||||
text=True,
|
||||
capture_output=capture,
|
||||
)
|
||||
except subprocess.CalledProcessError as e:
|
||||
# Print captured output so failing E2E tests are "live" / debuggable in CI logs
|
||||
print(">>> command failed:", " ".join(cmd))
|
||||
print(">>> exit code:", e.returncode)
|
||||
if e.stdout:
|
||||
print(">>> STDOUT:\n" + e.stdout)
|
||||
if e.stderr:
|
||||
print(">>> STDERR:\n" + e.stderr)
|
||||
raise
|
||||
|
||||
|
||||
def sh(
|
||||
cmd: str, *, capture: bool = True, check: bool = True
|
||||
) -> subprocess.CompletedProcess:
|
||||
return run(["sh", "-lc", cmd], capture=capture, check=check)
|
||||
|
||||
|
||||
def unique(prefix: str) -> str:
|
||||
return f"{prefix}-{uuid.uuid4().hex[:10]}"
|
||||
|
||||
|
||||
def require_docker() -> None:
|
||||
run(["docker", "version"], capture=True, check=True)
|
||||
|
||||
|
||||
def machine_hash() -> str:
|
||||
out = sh("sha256sum /etc/machine-id | awk '{print $1}'").stdout.strip()
|
||||
if len(out) < 16:
|
||||
raise RuntimeError("Could not determine machine hash from /etc/machine-id")
|
||||
return out
|
||||
|
||||
|
||||
def wait_for_log(container: str, pattern: str, timeout_s: int = 60) -> None:
|
||||
deadline = time.time() + timeout_s
|
||||
while time.time() < deadline:
|
||||
p = run(["docker", "logs", container], capture=True, check=False)
|
||||
if pattern in (p.stdout or ""):
|
||||
return
|
||||
time.sleep(1)
|
||||
raise TimeoutError(f"Timed out waiting for log pattern '{pattern}' in {container}")
|
||||
|
||||
|
||||
def wait_for_postgres(
|
||||
container: str, *, user: str = "postgres", timeout_s: int = 90
|
||||
) -> None:
|
||||
"""
|
||||
Docker-outside-of-Docker friendly readiness: check from inside the DB container.
|
||||
"""
|
||||
deadline = time.time() + timeout_s
|
||||
while time.time() < deadline:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f"pg_isready -U {user} -h localhost",
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
if p.returncode == 0:
|
||||
return
|
||||
time.sleep(1)
|
||||
raise TimeoutError(
|
||||
f"Timed out waiting for Postgres readiness in container {container}"
|
||||
)
|
||||
|
||||
|
||||
def wait_for_mariadb(
|
||||
container: str, *, root_password: str, timeout_s: int = 90
|
||||
) -> None:
|
||||
"""
|
||||
Liveness probe for MariaDB.
|
||||
|
||||
IMPORTANT (MariaDB 11):
|
||||
Root TCP auth is often restricted (unix_socket auth), so a TCP ping like
|
||||
`mariadb-admin -uroot -p... -h localhost ping` can fail even though the server is up.
|
||||
We therefore check readiness via a socket-based query.
|
||||
"""
|
||||
deadline = time.time() + timeout_s
|
||||
while time.time() < deadline:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
container,
|
||||
"sh",
|
||||
"-lc",
|
||||
'mariadb -uroot --protocol=socket -e "SELECT 1;"',
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
if p.returncode == 0:
|
||||
return
|
||||
time.sleep(1)
|
||||
raise TimeoutError(
|
||||
f"Timed out waiting for MariaDB readiness in container {container}"
|
||||
)
|
||||
|
||||
|
||||
def wait_for_mariadb_sql(
|
||||
container: str, *, user: str, password: str, timeout_s: int = 90
|
||||
) -> None:
|
||||
"""
|
||||
SQL login readiness for the *dedicated test user* over TCP.
|
||||
|
||||
This is separate from wait_for_mariadb(root) because root may be socket-only,
|
||||
while the tests use a normal user that should work via TCP.
|
||||
"""
|
||||
deadline = time.time() + timeout_s
|
||||
while time.time() < deadline:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'mariadb -h 127.0.0.1 -u{user} -p{password} -e "SELECT 1;"',
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
if p.returncode == 0:
|
||||
return
|
||||
time.sleep(1)
|
||||
raise TimeoutError(
|
||||
f"Timed out waiting for MariaDB SQL login readiness in container {container}"
|
||||
)
|
||||
43
tests/e2e/snapshot_db_driver.py
Normal file
43
tests/e2e/snapshot_db_driver.py
Normal file
@@ -0,0 +1,43 @@
|
||||
"""Copy a live database's volume out of a snapshot, using the real backup path.
|
||||
|
||||
Runs inside the privileged container built by test_e2e_snapshot_db.py, where a
|
||||
database is mid-write on a btrfs subvolume. Exercises volume_snapshot and
|
||||
backup_volume exactly as a backup run would.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, "/src")
|
||||
|
||||
from baudolo.backup.snapshot import SnapshotError, volume_snapshot
|
||||
from baudolo.backup.volume import backup_volume
|
||||
|
||||
SUBJECT = "/subject/docker"
|
||||
VOLUME = "mariadb_data"
|
||||
DATADIR = f"{SUBJECT}/volumes/{VOLUME}/_data"
|
||||
VERSIONS = "/backups"
|
||||
GENERATION = f"{VERSIONS}/20260731"
|
||||
|
||||
|
||||
def shell(command: list[str]) -> list[str]:
|
||||
proc = subprocess.run(command, capture_output=True, text=True, check=False)
|
||||
if proc.returncode != 0:
|
||||
raise SnapshotError(
|
||||
f"{' '.join(command)} exited {proc.returncode}: {proc.stderr.strip()}"
|
||||
)
|
||||
return proc.stdout.splitlines()
|
||||
|
||||
|
||||
with volume_snapshot("btrfs", SUBJECT, "dbtest", run=shell) as resolve:
|
||||
backup_volume(
|
||||
VERSIONS,
|
||||
VOLUME,
|
||||
f"{GENERATION}/{VOLUME}",
|
||||
authoritative=True,
|
||||
source=resolve(f"{DATADIR}/"),
|
||||
)
|
||||
|
||||
print("SNAPSHOT COPY DONE", flush=True)
|
||||
64
tests/e2e/snapshot_driver.py
Normal file
64
tests/e2e/snapshot_driver.py
Normal file
@@ -0,0 +1,64 @@
|
||||
"""Exercise volume_snapshot against a real filesystem, from inside a container.
|
||||
|
||||
Runs where loop devices exist. Prints one PASS/FAIL line per assertion and exits
|
||||
non-zero on the first failure, so the calling test can surface the reason.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
sys.path.insert(0, "/src")
|
||||
|
||||
from baudolo.backup.snapshot import SnapshotError, volume_snapshot
|
||||
|
||||
KIND = sys.argv[1]
|
||||
SUBJECT = sys.argv[2]
|
||||
EXPECT = sys.argv[3]
|
||||
|
||||
|
||||
def shell(command: list[str]) -> list[str]:
|
||||
proc = subprocess.run(command, capture_output=True, text=True, check=False)
|
||||
if proc.returncode != 0:
|
||||
raise SnapshotError(
|
||||
f"{' '.join(command)} exited {proc.returncode}: {proc.stderr.strip()}"
|
||||
)
|
||||
return proc.stdout.splitlines()
|
||||
|
||||
|
||||
def check(label: str, condition: bool) -> None:
|
||||
print(f"{'PASS' if condition else 'FAIL'} {label}", flush=True)
|
||||
if not condition:
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
volume = Path(SUBJECT) / "volumes" / "demo" / "_data"
|
||||
volume.mkdir(parents=True, exist_ok=True)
|
||||
(volume / "state").write_text("before\n")
|
||||
|
||||
if EXPECT == "unsupported":
|
||||
try:
|
||||
with volume_snapshot(KIND, SUBJECT, "e2e", run=shell):
|
||||
check("snapshot on an unsupported filesystem must not succeed", False)
|
||||
except SnapshotError as exc:
|
||||
check(f"refused loudly: {str(exc)[:60]}", True)
|
||||
sys.exit(0)
|
||||
|
||||
with volume_snapshot(KIND, SUBJECT, "e2e", run=shell) as resolve:
|
||||
frozen = Path(resolve(str(volume))) / "state"
|
||||
check("the snapshot exposes the volume", frozen.is_file())
|
||||
check("the snapshot carries the content", frozen.read_text() == "before\n")
|
||||
|
||||
(volume / "state").write_text("after\n")
|
||||
check("a later write does not reach the snapshot", frozen.read_text() == "before\n")
|
||||
check("the live tree did change", (volume / "state").read_text() == "after\n")
|
||||
|
||||
root = Path(resolve(SUBJECT))
|
||||
|
||||
check(
|
||||
"the snapshot is removed afterwards",
|
||||
not root.exists() or not (root / "volumes").exists(),
|
||||
)
|
||||
print("ALL OK", flush=True)
|
||||
33
tests/e2e/test_e2e_cli_contract_only_sql.py
Normal file
33
tests/e2e/test_e2e_cli_contract_only_sql.py
Normal file
@@ -0,0 +1,33 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import run
|
||||
|
||||
WITHDRAWN_FLAGS = ["--dump-only", "--dump-only-sql", "--everything"]
|
||||
|
||||
|
||||
class TestE2ECLIContractOnlySql(unittest.TestCase):
|
||||
def test_help_mentions_the_flag(self) -> None:
|
||||
cp = run(["baudolo", "--help"], capture=True, check=True)
|
||||
out = (cp.stdout or "") + "\n" + (cp.stderr or "")
|
||||
self.assertIn(
|
||||
"--only-sql",
|
||||
out,
|
||||
f"Expected '--only-sql' to appear in --help output. Output:\n{out}",
|
||||
)
|
||||
|
||||
def test_a_withdrawn_flag_is_rejected(self) -> None:
|
||||
for flag in WITHDRAWN_FLAGS:
|
||||
with self.subTest(flag=flag):
|
||||
cp = run(["baudolo", flag], capture=True, check=False)
|
||||
self.assertEqual(
|
||||
cp.returncode,
|
||||
2,
|
||||
f"Expected exitcode 2 for unknown args, got {cp.returncode}\n"
|
||||
f"STDOUT={cp.stdout}\nSTDERR={cp.stderr}",
|
||||
)
|
||||
err = (cp.stderr or "") + "\n" + (cp.stdout or "")
|
||||
# Argparse typically prints "unrecognized arguments"
|
||||
self.assertTrue(
|
||||
("unrecognized arguments" in err) or ("usage:" in err.lower()),
|
||||
f"Expected argparse-style error output. Output:\n{err}",
|
||||
)
|
||||
177
tests/e2e/test_e2e_engine_detection_by_tool.py
Normal file
177
tests/e2e/test_e2e_engine_detection_by_tool.py
Normal file
@@ -0,0 +1,177 @@
|
||||
"""The engine comes from the tools a container ships, not from its image name.
|
||||
|
||||
Two containers in one backup run, each lying in one direction:
|
||||
|
||||
* a real Postgres tagged `<prefix>-database`, the way a dedicated database is
|
||||
built inside an app's own stack - no engine token anywhere in the name;
|
||||
* an Alpine tagged `postgres:<prefix>`, carrying the token without shipping a
|
||||
single Postgres binary.
|
||||
|
||||
Reading the name gets both wrong, and the second one fatally: pg_dump exits 127
|
||||
inside Alpine and takes the whole run with it.
|
||||
"""
|
||||
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
IMPOSTOR_BASE_IMAGE = "alpine:3.20"
|
||||
MARKER = "engine-detection-by-tool"
|
||||
|
||||
|
||||
class TestE2EEngineDetectionByTool(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-engine-by-tool")
|
||||
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.engine_image = f"{cls.prefix}-database:17"
|
||||
cls.impostor_image = f"postgres:{cls.prefix}"
|
||||
|
||||
cls.engine_container = f"{cls.prefix}-engine"
|
||||
cls.impostor_container = f"{cls.prefix}-impostor"
|
||||
cls.engine_volume = f"{cls.prefix}-engine-vol"
|
||||
cls.impostor_volume = f"{cls.prefix}-impostor-vol"
|
||||
|
||||
cls.containers = [cls.engine_container, cls.impostor_container]
|
||||
cls.volumes = [cls.engine_volume, cls.impostor_volume]
|
||||
|
||||
run(["docker", "pull", POSTGRES_IMAGE])
|
||||
run(["docker", "pull", IMPOSTOR_BASE_IMAGE])
|
||||
run(["docker", "tag", POSTGRES_IMAGE, cls.engine_image])
|
||||
run(["docker", "tag", IMPOSTOR_BASE_IMAGE, cls.impostor_image])
|
||||
run(["docker", "volume", "create", cls.engine_volume])
|
||||
run(["docker", "volume", "create", cls.impostor_volume])
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.engine_container,
|
||||
"-e",
|
||||
"POSTGRES_PASSWORD=pgpw",
|
||||
"-e",
|
||||
"POSTGRES_DB=appdb",
|
||||
"-e",
|
||||
"POSTGRES_USER=postgres",
|
||||
"-v",
|
||||
f"{cls.engine_volume}:{POSTGRES_DATA_DIR}",
|
||||
cls.engine_image,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.engine_container, user="postgres", timeout_s=90)
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.engine_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
"psql -U postgres -d appdb -c "
|
||||
'"CREATE TABLE t (id int primary key, v text); '
|
||||
"INSERT INTO t VALUES (1,'ok');\""
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.impostor_container,
|
||||
"-v",
|
||||
f"{cls.impostor_volume}:/data",
|
||||
cls.impostor_image,
|
||||
"sh",
|
||||
"-lc",
|
||||
f"echo '{MARKER}' > /data/marker.txt && sleep 3600",
|
||||
]
|
||||
)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(
|
||||
cls.databases_csv,
|
||||
[
|
||||
(cls.engine_container, "appdb", "postgres", "pgpw"),
|
||||
(cls.impostor_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.engine_container, cls.impostor_container],
|
||||
images_no_stop_required=[cls.engine_image, cls.impostor_image],
|
||||
only_sql=True,
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
run(["docker", "rmi", cls.engine_image], check=False)
|
||||
run(["docker", "rmi", cls.impostor_image], check=False)
|
||||
|
||||
def _volume_dir(self, volume: str):
|
||||
return backup_path(self.backups_dir, self.repo_name, self.version, volume)
|
||||
|
||||
def test_an_engine_without_an_engine_name_is_still_dumped(self) -> None:
|
||||
dump = self._volume_dir(self.engine_volume) / "sql" / "appdb.backup.sql"
|
||||
self.assertTrue(
|
||||
dump.is_file(),
|
||||
f"a Postgres tagged '{self.engine_image}' produced no dump at {dump}",
|
||||
)
|
||||
self.assertIn("Dumped by pg_dump", dump.read_text(encoding="utf-8"))
|
||||
|
||||
def test_an_engine_name_without_an_engine_is_not_dumped(self) -> None:
|
||||
sql_dir = self._volume_dir(self.impostor_volume) / "sql"
|
||||
dumps = list(sql_dir.glob("*.sql")) if sql_dir.exists() else []
|
||||
self.assertEqual(
|
||||
dumps,
|
||||
[],
|
||||
f"'{self.impostor_image}' ships no Postgres yet was dumped: {dumps}",
|
||||
)
|
||||
|
||||
def test_the_recognised_engine_is_dumped_instead_of_copied(self) -> None:
|
||||
files = self._volume_dir(self.engine_volume) / "files"
|
||||
self.assertFalse(
|
||||
files.exists(),
|
||||
f"--only-sql still copied the engine's files to {files}",
|
||||
)
|
||||
|
||||
def test_the_impostor_falls_through_to_a_file_backup(self) -> None:
|
||||
files = self._volume_dir(self.impostor_volume) / "files"
|
||||
self.assertTrue(files.is_dir(), f"expected a file backup at {files}")
|
||||
self.assertEqual(
|
||||
(files / "marker.txt").read_text(encoding="utf-8").strip(), MARKER
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
105
tests/e2e/test_e2e_engine_detection_registry_prefix.py
Normal file
105
tests/e2e/test_e2e_engine_detection_registry_prefix.py
Normal file
@@ -0,0 +1,105 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
REGISTRY_HOST = "svc-db-mariadb-swarm-mgr-01:5000"
|
||||
|
||||
|
||||
class TestE2EEngineDetectionRegistryPrefix(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-registry-prefix")
|
||||
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.image = f"{REGISTRY_HOST}/postgres_custom:17-3.5"
|
||||
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", "pull", POSTGRES_IMAGE])
|
||||
run(["docker", "tag", POSTGRES_IMAGE, cls.image])
|
||||
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}",
|
||||
cls.image,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
"psql -U postgres -d appdb -c \"CREATE TABLE t (id int primary key, v text); INSERT INTO t VALUES (1,'ok');\"",
|
||||
]
|
||||
)
|
||||
|
||||
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=[cls.image],
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
run(["docker", "rmi", cls.image], check=False)
|
||||
|
||||
def test_the_registry_host_does_not_pick_the_engine(self) -> None:
|
||||
p = (
|
||||
backup_path(self.backups_dir, self.repo_name, self.version, self.pg_volume)
|
||||
/ "sql"
|
||||
/ "appdb.backup.sql"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected a pg_dump at: {p}")
|
||||
self.assertIn("Dumped by pg_dump", p.read_text(encoding="utf-8"))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
111
tests/e2e/test_e2e_files_full.py
Normal file
111
tests/e2e/test_e2e_files_full.py
Normal file
@@ -0,0 +1,111 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EFilesFull(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-files-full")
|
||||
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.volume_src = f"{cls.prefix}-vol-src"
|
||||
cls.volume_dst = f"{cls.prefix}-vol-dst"
|
||||
cls.containers = []
|
||||
cls.volumes = [cls.volume_src, cls.volume_dst]
|
||||
|
||||
run(["docker", "volume", "create", cls.volume_src])
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.volume_src}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"mkdir -p /data && echo 'hello' > /data/hello.txt",
|
||||
]
|
||||
)
|
||||
|
||||
# databases.csv (unused, but required by CLI)
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(cls.databases_csv, [])
|
||||
|
||||
backup_run(
|
||||
backups_dir=cls.backups_dir,
|
||||
repo_name=cls.repo_name,
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=["dummy-db"],
|
||||
images_no_stop_required=["alpine:3.20"],
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_files_backup_exists(self) -> None:
|
||||
p = (
|
||||
backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.volume_src,
|
||||
)
|
||||
/ "files"
|
||||
/ "hello.txt"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected backed up file at: {p}")
|
||||
|
||||
def test_restore_files_into_new_volume(self) -> None:
|
||||
# restore files from volume_src backup into volume_dst
|
||||
run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"files",
|
||||
self.volume_dst,
|
||||
self.hash,
|
||||
self.version,
|
||||
"--backups-dir",
|
||||
self.backups_dir,
|
||||
"--repo-name",
|
||||
self.repo_name,
|
||||
"--source-volume",
|
||||
self.volume_src,
|
||||
]
|
||||
)
|
||||
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{self.volume_dst}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"cat /data/hello.txt",
|
||||
]
|
||||
)
|
||||
self.assertEqual((p.stdout or "").strip(), "hello")
|
||||
118
tests/e2e/test_e2e_files_no_copy.py
Normal file
118
tests/e2e/test_e2e_files_no_copy.py
Normal file
@@ -0,0 +1,118 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EFilesNoCopy(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-files-nocopy")
|
||||
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.volume_src = f"{cls.prefix}-vol-src"
|
||||
cls.containers: list[str] = []
|
||||
cls.volumes = [cls.volume_src]
|
||||
|
||||
run(["docker", "volume", "create", cls.volume_src])
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.volume_src}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"echo 'hello' > /data/hello.txt",
|
||||
]
|
||||
)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(cls.databases_csv, [])
|
||||
|
||||
# only-sql => non-DB volumes are STILL backed up as files
|
||||
backup_run(
|
||||
backups_dir=cls.backups_dir,
|
||||
repo_name=cls.repo_name,
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=["dummy-db"],
|
||||
images_no_stop_required=["alpine:3.20"],
|
||||
only_sql=True,
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
# Wipe the volume to ensure restore actually restores something
|
||||
run(["docker", "volume", "rm", "-f", cls.volume_src])
|
||||
run(["docker", "volume", "create", cls.volume_src])
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_files_backup_present_for_non_db_volume(self) -> None:
|
||||
p = (
|
||||
backup_path(self.backups_dir, self.repo_name, self.version, self.volume_src)
|
||||
/ "files"
|
||||
)
|
||||
self.assertTrue(p.exists(), f"Expected files backup dir at: {p}")
|
||||
|
||||
def test_restore_files_succeeds_and_restores_content(self) -> None:
|
||||
p = run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"files",
|
||||
self.volume_src,
|
||||
self.hash,
|
||||
self.version,
|
||||
"--backups-dir",
|
||||
self.backups_dir,
|
||||
"--repo-name",
|
||||
self.repo_name,
|
||||
],
|
||||
check=False,
|
||||
)
|
||||
self.assertEqual(
|
||||
p.returncode,
|
||||
0,
|
||||
f"Expected exitcode 0, got {p.returncode}\nSTDOUT={p.stdout}\nSTDERR={p.stderr}",
|
||||
)
|
||||
|
||||
cp = run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{self.volume_src}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"cat /data/hello.txt",
|
||||
],
|
||||
capture=True,
|
||||
check=True,
|
||||
)
|
||||
self.assertEqual(
|
||||
cp.stdout.strip(),
|
||||
"hello",
|
||||
f"Unexpected restored content. STDOUT={cp.stdout}\nSTDERR={cp.stderr}",
|
||||
)
|
||||
123
tests/e2e/test_e2e_images_no_backup_required_early_skip.py
Normal file
123
tests/e2e/test_e2e_images_no_backup_required_early_skip.py
Normal file
@@ -0,0 +1,123 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EImagesNoBackupRequiredEarlySkip(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
|
||||
cls.prefix = unique("baudolo-e2e-early-skip-no-backup-required")
|
||||
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
|
||||
|
||||
# --- Docker resources ---
|
||||
cls.redis_container = f"{cls.prefix}-redis"
|
||||
cls.ignored_volume = f"{cls.prefix}-redis-vol"
|
||||
cls.normal_volume = f"{cls.prefix}-files-vol"
|
||||
|
||||
cls.containers = [cls.redis_container]
|
||||
cls.volumes = [cls.ignored_volume, cls.normal_volume]
|
||||
|
||||
run(["docker", "volume", "create", cls.ignored_volume])
|
||||
run(["docker", "volume", "create", cls.normal_volume])
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.redis_container,
|
||||
"-v",
|
||||
f"{cls.ignored_volume}:/data",
|
||||
"redis:alpine",
|
||||
]
|
||||
)
|
||||
|
||||
# Put deterministic content into the normal volume
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.normal_volume}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"mkdir -p /data && echo 'hello' > /data/hello.txt",
|
||||
]
|
||||
)
|
||||
|
||||
# databases.csv required by CLI (can be empty)
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(cls.databases_csv, [])
|
||||
|
||||
cmd = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--hard-restart-projects",
|
||||
"mailu",
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--databases-csv",
|
||||
cls.databases_csv,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--database-containers",
|
||||
"dummy-db",
|
||||
"--images-no-stop-required",
|
||||
"redis:alpine",
|
||||
"--images-no-backup-required",
|
||||
"redis:alpine",
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
cls.stdout = cp.stdout or ""
|
||||
cls.stderr = cp.stderr or ""
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_ignored_volume_has_no_backup_directory_at_all(self) -> None:
|
||||
p = backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.ignored_volume,
|
||||
)
|
||||
self.assertFalse(
|
||||
p.exists(),
|
||||
f"Expected NO backup directory to be created for ignored volume, but found: {p}",
|
||||
)
|
||||
|
||||
def test_normal_volume_is_still_backed_up(self) -> None:
|
||||
p = (
|
||||
backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.normal_volume,
|
||||
)
|
||||
/ "files"
|
||||
/ "hello.txt"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected backed up file at: {p}")
|
||||
165
tests/e2e/test_e2e_mariadb_anonymous_preemption.py
Normal file
165
tests/e2e/test_e2e_mariadb_anonymous_preemption.py
Normal file
@@ -0,0 +1,165 @@
|
||||
"""
|
||||
Bug-repro for: mariadb-dump fails with `ERROR 1045 Access denied for user
|
||||
'<u>'@'localhost' (using password: YES)` when only '<u>'@'%' is granted and a
|
||||
preempting ''@'localhost' user is present.
|
||||
|
||||
The fix forces TCP loopback in baudolo.backup.db so the dump matches the
|
||||
'<u>'@'%' grant instead of the socket->localhost auth row.
|
||||
|
||||
This file:
|
||||
- builds the exact preconditions that triggered the production failure,
|
||||
- as a NEGATIVE control, runs a socket-based mariadb-dump (== the old code path)
|
||||
and asserts that it fails with the literal 1045 / @'localhost' error,
|
||||
- as a POSITIVE proof, calls backup_database() (where the fix lives) against
|
||||
the same DB container and asserts the dump file is produced and contains the
|
||||
seed data.
|
||||
|
||||
Note: the volume-rsync stage of baudolo is intentionally NOT exercised here.
|
||||
That stage needs root on /var/lib/docker/volumes, which is provided by the
|
||||
DinD wrapper in `make test-e2e` but not by an on-host invocation. The bug we
|
||||
are verifying is in the DB-dump stage, so testing backup_database() directly
|
||||
keeps the assertion focused and the test runnable both on-host and in DinD.
|
||||
"""
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
import pandas
|
||||
|
||||
from baudolo.backup import db as db_mod
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_DATA_DIR,
|
||||
MARIADB_IMAGE,
|
||||
cleanup_docker,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_mariadb,
|
||||
wait_for_mariadb_sql,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EMariaDBAnonymousPreemption(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-mariadb-anon")
|
||||
cls.db_container = f"{cls.prefix}-mariadb"
|
||||
cls.db_volume = f"{cls.prefix}-mariadb-vol"
|
||||
cls.containers = [cls.db_container]
|
||||
cls.volumes = [cls.db_volume]
|
||||
|
||||
cls.db_name = "appdb"
|
||||
cls.db_user = "tcponly"
|
||||
cls.db_password = "tcponlypw"
|
||||
cls.root_password = "rootpw"
|
||||
|
||||
run(["docker", "volume", "create", cls.db_volume])
|
||||
|
||||
# Boot WITHOUT MARIADB_USER/MARIADB_PASSWORD/MARIADB_DATABASE so the
|
||||
# entrypoint does not auto-create '<u>'@'%'. We provision the user
|
||||
# explicitly below to mirror the SQL path used by svc-db-mariadb.
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.db_container,
|
||||
"-e",
|
||||
f"MARIADB_ROOT_PASSWORD={cls.root_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
|
||||
wait_for_mariadb(
|
||||
cls.db_container, root_password=cls.root_password, timeout_s=120
|
||||
)
|
||||
|
||||
# Provision: '<u>'@'%' (the app/backup grant) + anonymous ''@'localhost'
|
||||
# (the preemption trigger). Mirrors the production state that produced
|
||||
# `ERROR 1045 ... '<u>'@'localhost' (using password: YES)`.
|
||||
bootstrap_sql = (
|
||||
f"CREATE DATABASE {cls.db_name};"
|
||||
f"CREATE USER '{cls.db_user}'@'%' IDENTIFIED BY '{cls.db_password}';"
|
||||
f"GRANT ALL PRIVILEGES ON {cls.db_name}.* TO '{cls.db_user}'@'%';"
|
||||
f"CREATE USER ''@'localhost' IDENTIFIED BY 'anonpw-not-{cls.db_password}';"
|
||||
"FLUSH PRIVILEGES;"
|
||||
f"CREATE TABLE {cls.db_name}.t (id INT PRIMARY KEY, v VARCHAR(50));"
|
||||
f"INSERT INTO {cls.db_name}.t VALUES (1,'ok');"
|
||||
)
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'mariadb -uroot --protocol=socket -e "{bootstrap_sql}"',
|
||||
]
|
||||
)
|
||||
|
||||
# Sanity: '<u>' can log in over TCP (matches '%'). If THIS fails,
|
||||
# the precondition for the fix to even apply is broken.
|
||||
wait_for_mariadb_sql(
|
||||
cls.db_container, user=cls.db_user, password=cls.db_password, timeout_s=60
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_negative_control_socket_dump_fails_with_1045(self) -> None:
|
||||
# Reproduces the OLD code path (no -h/--protocol). MUST fail with 1045
|
||||
# under the configured preemption. If this ever starts passing, either
|
||||
# the MariaDB auth semantics changed or the anonymous-user setup did
|
||||
# not take effect — in both cases the positive test below loses its
|
||||
# ability to discriminate "fix works" vs "bug never reproduced".
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
self.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f"mariadb-dump -u{self.db_user} -p{self.db_password} {self.db_name}",
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
self.assertNotEqual(p.returncode, 0, "socket-based dump unexpectedly succeeded")
|
||||
self.assertIn("1045", (p.stderr or "") + (p.stdout or ""))
|
||||
self.assertIn("@'localhost'", (p.stderr or "") + (p.stdout or ""))
|
||||
|
||||
def test_backup_database_succeeds_with_tcp_fix(self) -> None:
|
||||
# Drives the function where the fix lives. No rsync, no privileged
|
||||
# paths — just the dump that the negative-control proved is failing
|
||||
# under the same preemption setup.
|
||||
with tempfile.TemporaryDirectory() as volume_dir:
|
||||
df = pandas.DataFrame(
|
||||
[(self.db_container, self.db_name, self.db_user, self.db_password)],
|
||||
columns=["instance", "database", "username", "password"],
|
||||
)
|
||||
produced = db_mod.backup_database(
|
||||
container=self.db_container,
|
||||
volume_dir=volume_dir,
|
||||
db_type="mariadb",
|
||||
dump_tool="mariadb-dump",
|
||||
databases_df=df,
|
||||
database_containers=[self.db_container],
|
||||
)
|
||||
self.assertTrue(produced, "backup_database did not produce a dump")
|
||||
dump_path = os.path.join(volume_dir, "sql", f"{self.db_name}.backup.sql")
|
||||
self.assertTrue(os.path.isfile(dump_path), f"expected dump at {dump_path}")
|
||||
with open(dump_path, "r", encoding="utf-8", errors="replace") as f:
|
||||
content = f.read()
|
||||
self.assertIn("INSERT INTO", content)
|
||||
self.assertIn("'ok'", content)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main(verbosity=2)
|
||||
172
tests/e2e/test_e2e_mariadb_full.py
Normal file
172
tests/e2e/test_e2e_mariadb_full.py
Normal file
@@ -0,0 +1,172 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_DATA_DIR,
|
||||
MARIADB_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_mariadb,
|
||||
wait_for_mariadb_sql,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EMariaDBFull(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-mariadb-full")
|
||||
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.db_container = f"{cls.prefix}-mariadb"
|
||||
cls.db_volume = f"{cls.prefix}-mariadb-vol"
|
||||
cls.containers = [cls.db_container]
|
||||
cls.volumes = [cls.db_volume]
|
||||
|
||||
cls.db_name = "appdb"
|
||||
cls.db_user = "test"
|
||||
cls.db_password = "testpw"
|
||||
cls.root_password = "rootpw"
|
||||
|
||||
run(["docker", "volume", "create", cls.db_volume])
|
||||
|
||||
# Start MariaDB with a dedicated TCP-capable user for tests.
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.db_container,
|
||||
"-e",
|
||||
f"MARIADB_ROOT_PASSWORD={cls.root_password}",
|
||||
"-e",
|
||||
f"MARIADB_DATABASE={cls.db_name}",
|
||||
"-e",
|
||||
f"MARIADB_USER={cls.db_user}",
|
||||
"-e",
|
||||
f"MARIADB_PASSWORD={cls.db_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
|
||||
# Liveness + actual SQL login readiness (TCP)
|
||||
wait_for_mariadb(
|
||||
cls.db_container, root_password=cls.root_password, timeout_s=90
|
||||
)
|
||||
wait_for_mariadb_sql(
|
||||
cls.db_container, user=cls.db_user, password=cls.db_password, timeout_s=90
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{cls.db_user} -p{cls.db_password} "
|
||||
f'-e "CREATE TABLE {cls.db_name}.t (id INT PRIMARY KEY, v VARCHAR(50)); '
|
||||
f"INSERT INTO {cls.db_name}.t VALUES (1,'ok');\""
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
# IMPORTANT: baudolo backup expects credentials for the DB dump.
|
||||
write_databases_csv(
|
||||
cls.databases_csv,
|
||||
[(cls.db_container, cls.db_name, cls.db_user, cls.db_password)],
|
||||
)
|
||||
|
||||
# Backup with file+dump
|
||||
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.db_container],
|
||||
images_no_stop_required=[MARIADB_IMAGE],
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
# Wipe DB via the dedicated user (TCP)
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{cls.db_user} -p{cls.db_password} "
|
||||
f'-e "DROP TABLE {cls.db_name}.t;"'
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
# Restore DB (uses baudolo-restore which execs mysql/mariadb inside the container)
|
||||
run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"mariadb",
|
||||
cls.db_volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--container",
|
||||
cls.db_container,
|
||||
"--db-name",
|
||||
cls.db_name,
|
||||
"--db-user",
|
||||
cls.db_user,
|
||||
"--db-password",
|
||||
cls.db_password,
|
||||
"--empty",
|
||||
]
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_dump_file_exists(self) -> None:
|
||||
p = (
|
||||
backup_path(self.backups_dir, self.repo_name, self.version, self.db_volume)
|
||||
/ "sql"
|
||||
/ f"{self.db_name}.backup.sql"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected dump file at: {p}")
|
||||
|
||||
def test_data_restored(self) -> None:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
self.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{self.db_user} -p{self.db_password} "
|
||||
f'-N -e "SELECT v FROM {self.db_name}.t WHERE id=1;"'
|
||||
),
|
||||
]
|
||||
)
|
||||
self.assertEqual((p.stdout or "").strip(), "ok")
|
||||
169
tests/e2e/test_e2e_mariadb_no_copy.py
Normal file
169
tests/e2e/test_e2e_mariadb_no_copy.py
Normal file
@@ -0,0 +1,169 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_DATA_DIR,
|
||||
MARIADB_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_mariadb,
|
||||
wait_for_mariadb_sql,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EMariaDBNoCopy(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-mariadb-nocopy")
|
||||
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.db_container = f"{cls.prefix}-mariadb"
|
||||
cls.db_volume = f"{cls.prefix}-mariadb-vol"
|
||||
cls.containers = [cls.db_container]
|
||||
cls.volumes = [cls.db_volume]
|
||||
|
||||
cls.db_name = "appdb"
|
||||
cls.db_user = "test"
|
||||
cls.db_password = "testpw"
|
||||
cls.root_password = "rootpw"
|
||||
|
||||
run(["docker", "volume", "create", cls.db_volume])
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.db_container,
|
||||
"-e",
|
||||
f"MARIADB_ROOT_PASSWORD={cls.root_password}",
|
||||
"-e",
|
||||
f"MARIADB_DATABASE={cls.db_name}",
|
||||
"-e",
|
||||
f"MARIADB_USER={cls.db_user}",
|
||||
"-e",
|
||||
f"MARIADB_PASSWORD={cls.db_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
|
||||
wait_for_mariadb(
|
||||
cls.db_container, root_password=cls.root_password, timeout_s=90
|
||||
)
|
||||
wait_for_mariadb_sql(
|
||||
cls.db_container, user=cls.db_user, password=cls.db_password, timeout_s=90
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{cls.db_user} -p{cls.db_password} "
|
||||
f'-e "CREATE TABLE {cls.db_name}.t (id INT PRIMARY KEY, v VARCHAR(50)); '
|
||||
f"INSERT INTO {cls.db_name}.t VALUES (1,'ok');\""
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(
|
||||
cls.databases_csv,
|
||||
[(cls.db_container, cls.db_name, cls.db_user, cls.db_password)],
|
||||
)
|
||||
|
||||
# only-sql => no files
|
||||
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.db_container],
|
||||
images_no_stop_required=[MARIADB_IMAGE],
|
||||
only_sql=True,
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
# Wipe table (TCP)
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{cls.db_user} -p{cls.db_password} "
|
||||
f'-e "DROP TABLE {cls.db_name}.t;"'
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
# Restore DB
|
||||
run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"mariadb",
|
||||
cls.db_volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--container",
|
||||
cls.db_container,
|
||||
"--db-name",
|
||||
cls.db_name,
|
||||
"--db-user",
|
||||
cls.db_user,
|
||||
"--db-password",
|
||||
cls.db_password,
|
||||
"--empty",
|
||||
]
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_files_backup_not_present(self) -> None:
|
||||
p = (
|
||||
backup_path(self.backups_dir, self.repo_name, self.version, self.db_volume)
|
||||
/ "files"
|
||||
)
|
||||
self.assertFalse(p.exists(), f"Did not expect files backup dir at: {p}")
|
||||
|
||||
def test_data_restored(self) -> None:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
self.db_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{self.db_user} -p{self.db_password} "
|
||||
f'-N -e "SELECT v FROM {self.db_name}.t WHERE id=1;"'
|
||||
),
|
||||
]
|
||||
)
|
||||
self.assertEqual((p.stdout or "").strip(), "ok")
|
||||
116
tests/e2e/test_e2e_only_files.py
Normal file
116
tests/e2e/test_e2e_only_files.py
Normal file
@@ -0,0 +1,116 @@
|
||||
"""--only-files backs a database up as a file tree and asks for no credentials.
|
||||
|
||||
The run deliberately passes no --databases-csv at all: a host that only copies
|
||||
files has no reason to hold database passwords, and requiring the file would
|
||||
make the flag useless there.
|
||||
"""
|
||||
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
)
|
||||
|
||||
MARKER = "only-files-marker"
|
||||
|
||||
|
||||
class TestE2EOnlyFiles(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-only-files")
|
||||
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"echo '{MARKER}' > {POSTGRES_DATA_DIR}/marker.txt",
|
||||
]
|
||||
)
|
||||
|
||||
cp = run(
|
||||
[
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--images-no-stop-required",
|
||||
POSTGRES_IMAGE,
|
||||
"--only-files",
|
||||
],
|
||||
capture=True,
|
||||
check=True,
|
||||
)
|
||||
cls.stdout = cp.stdout or ""
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def _volume_dir(self):
|
||||
return backup_path(
|
||||
self.backups_dir, self.repo_name, self.version, self.pg_volume
|
||||
)
|
||||
|
||||
def test_the_database_volume_is_backed_up_as_files(self) -> None:
|
||||
marker = self._volume_dir() / "files" / "marker.txt"
|
||||
self.assertTrue(marker.is_file(), f"expected a file backup at {marker}")
|
||||
self.assertEqual(marker.read_text(encoding="utf-8").strip(), MARKER)
|
||||
|
||||
def test_no_dump_is_written(self) -> None:
|
||||
sql_dir = self._volume_dir() / "sql"
|
||||
dumps = list(sql_dir.glob("*.sql")) if sql_dir.exists() else []
|
||||
self.assertEqual(dumps, [], f"did not expect any dump, found: {dumps}")
|
||||
|
||||
def test_the_missing_databases_csv_is_not_reported(self) -> None:
|
||||
self.assertNotIn("databases.csv", self.stdout)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
176
tests/e2e/test_e2e_only_sql_fallback_to_files.py
Normal file
176
tests/e2e/test_e2e_only_sql_fallback_to_files.py
Normal file
@@ -0,0 +1,176 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EOnlySqlFallbackToFiles(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-only-sql-fallback")
|
||||
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.restore_volume = f"{cls.prefix}-restore-vol"
|
||||
|
||||
cls.containers = [cls.pg_container]
|
||||
cls.volumes = [cls.pg_volume, cls.restore_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)
|
||||
|
||||
# Add a deterministic marker file into the volume
|
||||
cls.marker = "only-sql-fallback-marker"
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f"echo '{cls.marker}' > {POSTGRES_DATA_DIR}/marker.txt",
|
||||
]
|
||||
)
|
||||
|
||||
# databases.csv WITHOUT matching entry for this instance -> should skip dump
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(cls.databases_csv, []) # empty except header
|
||||
|
||||
# Run baudolo with --only-sql and a DB container present:
|
||||
# Expected: WARNING + FALLBACK to file backup (files/ must exist)
|
||||
cmd = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--hard-restart-projects",
|
||||
"mailu",
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--databases-csv",
|
||||
cls.databases_csv,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--database-containers",
|
||||
cls.pg_container,
|
||||
"--images-no-stop-required",
|
||||
POSTGRES_IMAGE,
|
||||
"--only-sql",
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
|
||||
cls.stdout = cp.stdout or ""
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
# Restore files into a fresh volume to prove file backup happened
|
||||
run(["docker", "volume", "create", cls.restore_volume])
|
||||
run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"files",
|
||||
cls.restore_volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--source-volume",
|
||||
cls.pg_volume,
|
||||
]
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_warns_about_missing_dump_in_dump_only_mode(self) -> None:
|
||||
self.assertIn(
|
||||
"WARNING: only-sql requested but no DB dump was produced",
|
||||
self.stdout,
|
||||
f"Expected warning in baudolo output. STDOUT:\n{self.stdout}",
|
||||
)
|
||||
|
||||
def test_files_backup_exists_due_to_fallback(self) -> None:
|
||||
p = (
|
||||
backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.pg_volume,
|
||||
)
|
||||
/ "files"
|
||||
)
|
||||
self.assertTrue(p.is_dir(), f"Expected files backup dir at: {p}")
|
||||
|
||||
def test_sql_dump_not_present(self) -> None:
|
||||
# There should be no sql dumps because databases.csv had no matching entry.
|
||||
sql_dir = (
|
||||
backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.pg_volume,
|
||||
)
|
||||
/ "sql"
|
||||
)
|
||||
# Could exist (dir created) in some edge cases, but should contain no *.sql dumps.
|
||||
if sql_dir.exists():
|
||||
dumps = list(sql_dir.glob("*.sql"))
|
||||
self.assertEqual(
|
||||
len(dumps),
|
||||
0,
|
||||
f"Did not expect SQL dump files, found: {dumps}",
|
||||
)
|
||||
|
||||
def test_restored_files_contain_marker(self) -> None:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{self.restore_volume}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"cat /data/marker.txt",
|
||||
]
|
||||
)
|
||||
self.assertEqual((p.stdout or "").strip(), self.marker)
|
||||
181
tests/e2e/test_e2e_only_sql_mixed_run.py
Normal file
181
tests/e2e/test_e2e_only_sql_mixed_run.py
Normal file
@@ -0,0 +1,181 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EOnlySqlMixedRun(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-only-sql-mixed-run")
|
||||
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
|
||||
|
||||
# --- Volumes ---
|
||||
cls.db_volume = f"{cls.prefix}-vol-db"
|
||||
cls.files_volume = f"{cls.prefix}-vol-files"
|
||||
|
||||
# Track for cleanup
|
||||
cls.containers: list[str] = []
|
||||
cls.volumes = [cls.db_volume, cls.files_volume]
|
||||
|
||||
run(["docker", "volume", "create", cls.db_volume])
|
||||
run(["docker", "volume", "create", cls.files_volume])
|
||||
|
||||
# Put a marker into the non-db volume
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.files_volume}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"echo 'hello-non-db' > /data/hello.txt",
|
||||
]
|
||||
)
|
||||
|
||||
# --- Start Postgres container using the DB volume ---
|
||||
cls.pg_container = f"{cls.prefix}-pg"
|
||||
cls.containers.append(cls.pg_container)
|
||||
|
||||
cls.pg_password = "postgres"
|
||||
cls.pg_db = "testdb"
|
||||
cls.pg_user = "postgres"
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.pg_container,
|
||||
"-e",
|
||||
f"POSTGRES_PASSWORD={cls.pg_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
|
||||
# Create deterministic content in DB so dump is non-empty
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'psql -U postgres -c "CREATE DATABASE {cls.pg_db};" || true',
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"psql -U postgres -d {cls.pg_db} -c "
|
||||
'"CREATE TABLE IF NOT EXISTS t (id INT PRIMARY KEY, v TEXT);'
|
||||
"INSERT INTO t(id,v) VALUES (1,'hello-db') "
|
||||
'ON CONFLICT (id) DO UPDATE SET v=EXCLUDED.v;"'
|
||||
),
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
|
||||
# databases.csv with an entry => dump should succeed
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(
|
||||
cls.databases_csv,
|
||||
[(cls.pg_container, cls.pg_db, cls.pg_user, cls.pg_password)],
|
||||
)
|
||||
|
||||
cmd = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--databases-csv",
|
||||
cls.databases_csv,
|
||||
"--database-containers",
|
||||
cls.pg_container,
|
||||
"--images-no-stop-required",
|
||||
POSTGRES_IMAGE,
|
||||
"--only-sql",
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
cls.stdout = cp.stdout
|
||||
cls.stderr = cp.stderr
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_db_volume_has_dump_and_no_files_dir(self) -> None:
|
||||
base = backup_path(
|
||||
self.backups_dir, self.repo_name, self.version, self.db_volume
|
||||
)
|
||||
|
||||
dumps = base / "sql"
|
||||
files = base / "files"
|
||||
|
||||
self.assertTrue(dumps.exists(), f"Expected dumps dir for DB volume at: {dumps}")
|
||||
self.assertFalse(
|
||||
files.exists(),
|
||||
f"Did not expect files dir for DB volume when dump succeeded at: {files}",
|
||||
)
|
||||
|
||||
# Optional: at least one dump file exists
|
||||
dump_files = list(dumps.glob("*.sql")) + list(dumps.glob("*.sql.gz"))
|
||||
self.assertTrue(
|
||||
dump_files,
|
||||
f"Expected at least one SQL dump file in {dumps}, found none.",
|
||||
)
|
||||
|
||||
def test_non_db_volume_has_files_dir(self) -> None:
|
||||
base = backup_path(
|
||||
self.backups_dir, self.repo_name, self.version, self.files_volume
|
||||
)
|
||||
files = base / "files"
|
||||
self.assertTrue(
|
||||
files.exists(),
|
||||
f"Expected files dir for non-DB volume at: {files}",
|
||||
)
|
||||
|
||||
def test_only_sql_does_not_disable_non_db_files_backup(self) -> None:
|
||||
# Regression guard: even with --only-sql, non-DB volumes must still be backed up as files
|
||||
base = backup_path(
|
||||
self.backups_dir, self.repo_name, self.version, self.files_volume
|
||||
)
|
||||
self.assertTrue(
|
||||
(base / "files").exists(),
|
||||
f"Expected non-DB volume files backup to exist at: {base / 'files'}",
|
||||
)
|
||||
215
tests/e2e/test_e2e_postgres_cluster_restore.py
Normal file
215
tests/e2e/test_e2e_postgres_cluster_restore.py
Normal file
@@ -0,0 +1,215 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
# One statement per entry: psql wraps a multi-statement -c in a transaction,
|
||||
# and CREATE DATABASE is forbidden inside one.
|
||||
SEED_SQL = (
|
||||
"CREATE ROLE app LOGIN PASSWORD 'apppw'",
|
||||
"CREATE DATABASE first OWNER app",
|
||||
"CREATE DATABASE second OWNER app",
|
||||
)
|
||||
SIBLING_SQL = (
|
||||
"CREATE ROLE neighbour LOGIN PASSWORD 'neighbourpw'",
|
||||
"CREATE DATABASE sibling OWNER neighbour",
|
||||
)
|
||||
SIBLING_PAYLOAD = "CREATE TABLE t (v text); INSERT INTO t VALUES ('sibling-payload');"
|
||||
FIRST_SQL = "CREATE TABLE t (v text); INSERT INTO t VALUES ('first-payload');"
|
||||
SECOND_SQL = "CREATE TABLE t (v text); INSERT INTO t VALUES ('second-payload');"
|
||||
|
||||
|
||||
class TestE2EPostgresClusterRestore(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-pg-cluster")
|
||||
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",
|
||||
"-v",
|
||||
f"{cls.pg_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres")
|
||||
|
||||
for statement in SEED_SQL:
|
||||
cls._psql("postgres", statement)
|
||||
cls._psql("first", FIRST_SQL)
|
||||
cls._psql("second", SECOND_SQL)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(
|
||||
cls.databases_csv, [(cls.pg_container, "*", "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)
|
||||
cls.dump = (
|
||||
backup_path(cls.backups_dir, cls.repo_name, cls.version, cls.pg_volume)
|
||||
/ "sql"
|
||||
/ f"{cls.pg_container}.cluster.backup.sql"
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"cluster",
|
||||
cls.pg_volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--container",
|
||||
cls.pg_container,
|
||||
"--instance",
|
||||
cls.pg_container,
|
||||
"--db-user",
|
||||
"postgres",
|
||||
"--db-password",
|
||||
"pgpw",
|
||||
"--empty",
|
||||
]
|
||||
)
|
||||
|
||||
for statement in SIBLING_SQL:
|
||||
cls._psql("postgres", statement)
|
||||
cls._psql("sibling", SIBLING_PAYLOAD)
|
||||
cls.refused = run(cls._restore_argv(), check=False)
|
||||
|
||||
@classmethod
|
||||
def _restore_argv(cls) -> list:
|
||||
return [
|
||||
"baudolo-restore",
|
||||
"cluster",
|
||||
cls.pg_volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--container",
|
||||
cls.pg_container,
|
||||
"--instance",
|
||||
cls.pg_container,
|
||||
"--db-user",
|
||||
"postgres",
|
||||
"--db-password",
|
||||
"pgpw",
|
||||
"--empty",
|
||||
]
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
@classmethod
|
||||
def _psql(cls, database: str, sql: str) -> str:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'psql -U postgres -d {database} -t -A -c "{sql}"',
|
||||
]
|
||||
)
|
||||
return (p.stdout or "").strip()
|
||||
|
||||
def test_the_backup_wrote_a_cluster_dump(self) -> None:
|
||||
self.assertTrue(self.dump.is_file(), f"no cluster dump at {self.dump}")
|
||||
|
||||
def test_the_preclean_really_dropped_a_populated_cluster(self) -> None:
|
||||
self.assertEqual(self._psql("first", "SELECT v FROM t"), "first-payload")
|
||||
|
||||
def test_a_second_empty_is_refused_once_a_foreign_database_exists(self) -> None:
|
||||
self.assertNotEqual(self.refused.returncode, 0, self.refused.stdout)
|
||||
self.assertIn("sibling", self.refused.stderr)
|
||||
|
||||
def test_the_refusal_left_the_foreign_database_alone(self) -> None:
|
||||
self.assertEqual(self._psql("sibling", "SELECT v FROM t"), "sibling-payload")
|
||||
|
||||
def test_the_refusal_dropped_nothing_of_its_own(self) -> None:
|
||||
self.assertEqual(self._psql("first", "SELECT v FROM t"), "first-payload")
|
||||
|
||||
def test_both_databases_are_back(self) -> None:
|
||||
listed = self._psql(
|
||||
"postgres",
|
||||
"SELECT datname FROM pg_database WHERE datname IN ('first','second') ORDER BY 1",
|
||||
)
|
||||
self.assertEqual(listed.split(), ["first", "second"])
|
||||
|
||||
def test_each_database_carries_its_own_payload(self) -> None:
|
||||
self.assertEqual(self._psql("first", "SELECT v FROM t"), "first-payload")
|
||||
self.assertEqual(self._psql("second", "SELECT v FROM t"), "second-payload")
|
||||
|
||||
def test_the_superusers_own_create_was_filtered(self) -> None:
|
||||
self.assertEqual(
|
||||
self._psql(
|
||||
"postgres", "SELECT rolsuper FROM pg_roles WHERE rolname = 'postgres'"
|
||||
),
|
||||
"t",
|
||||
)
|
||||
|
||||
def test_the_owning_role_is_back(self) -> None:
|
||||
self.assertEqual(
|
||||
self._psql(
|
||||
"postgres", "SELECT rolname FROM pg_roles WHERE rolname = 'app'"
|
||||
),
|
||||
"app",
|
||||
)
|
||||
|
||||
def test_ownership_survived(self) -> None:
|
||||
self.assertEqual(
|
||||
self._psql(
|
||||
"postgres",
|
||||
"SELECT pg_get_userbyid(datdba) FROM pg_database WHERE datname = 'first'",
|
||||
),
|
||||
"app",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
185
tests/e2e/test_e2e_postgres_empty_drop_hard.py
Normal file
185
tests/e2e/test_e2e_postgres_empty_drop_hard.py
Normal file
@@ -0,0 +1,185 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
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.
|
||||
# The f()/f(int) pair reproduces discourse's overload abort ("function name
|
||||
# is not unique") and english_stem_nostop reproduces taiga's text search
|
||||
# dictionary abort (duplicate pg_ts_dict_dictname_index).
|
||||
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 FUNCTION public.f(i int) RETURNS int LANGUAGE sql AS 'SELECT i';"
|
||||
"CREATE COLLATION public.c (locale = 'C');"
|
||||
"CREATE TEXT SEARCH DICTIONARY public.english_stem_nostop"
|
||||
" (Template = snowball, Language = english);"
|
||||
"CREATE TEXT SEARCH CONFIGURATION public.english_nostop (COPY = english);"
|
||||
"ALTER TEXT SEARCH CONFIGURATION public.english_nostop"
|
||||
" ALTER MAPPING FOR asciiword WITH public.english_stem_nostop;"
|
||||
)
|
||||
|
||||
|
||||
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",
|
||||
)
|
||||
|
||||
def test_overloaded_functions_restored_once_each(self) -> None:
|
||||
self.assertEqual(
|
||||
self._scalar("SELECT count(*) FROM pg_proc WHERE proname='f';"), "2"
|
||||
)
|
||||
self.assertEqual(self._scalar("SELECT public.f(41) + public.f();"), "42")
|
||||
|
||||
def test_text_search_dictionary_restored_once(self) -> None:
|
||||
self.assertEqual(
|
||||
self._scalar(
|
||||
"SELECT count(*) FROM pg_ts_dict WHERE dictname='english_stem_nostop';"
|
||||
),
|
||||
"1",
|
||||
)
|
||||
self.assertEqual(
|
||||
self._scalar(
|
||||
"SELECT count(*) FROM pg_ts_config WHERE cfgname='english_nostop';"
|
||||
),
|
||||
"1",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
143
tests/e2e/test_e2e_postgres_full.py
Normal file
143
tests/e2e/test_e2e_postgres_full.py
Normal file
@@ -0,0 +1,143 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EPostgresFull(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-postgres-full")
|
||||
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",
|
||||
"psql -U postgres -d appdb -c \"CREATE TABLE t (id int primary key, v text); INSERT INTO t VALUES (1,'ok');\"",
|
||||
]
|
||||
)
|
||||
|
||||
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)
|
||||
|
||||
# Wipe schema
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
'psql -U postgres -d appdb -c "DROP TABLE t;"',
|
||||
]
|
||||
)
|
||||
|
||||
# Restore
|
||||
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 test_dump_file_exists(self) -> None:
|
||||
p = (
|
||||
backup_path(self.backups_dir, self.repo_name, self.version, self.pg_volume)
|
||||
/ "sql"
|
||||
/ "appdb.backup.sql"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected dump file at: {p}")
|
||||
|
||||
def test_data_restored(self) -> None:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
self.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
'psql -U postgres -d appdb -t -c "SELECT v FROM t WHERE id=1;"',
|
||||
]
|
||||
)
|
||||
self.assertEqual((p.stdout or "").strip(), "ok")
|
||||
140
tests/e2e/test_e2e_postgres_no_copy.py
Normal file
140
tests/e2e/test_e2e_postgres_no_copy.py
Normal file
@@ -0,0 +1,140 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EPostgresNoCopy(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-postgres-nocopy")
|
||||
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",
|
||||
"psql -U postgres -d appdb -c \"CREATE TABLE t (id int primary key, v text); INSERT INTO t VALUES (1,'ok');\"",
|
||||
]
|
||||
)
|
||||
|
||||
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],
|
||||
only_sql=True,
|
||||
)
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
'psql -U postgres -d appdb -c "DROP TABLE t;"',
|
||||
]
|
||||
)
|
||||
|
||||
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 test_files_backup_not_present(self) -> None:
|
||||
p = (
|
||||
backup_path(self.backups_dir, self.repo_name, self.version, self.pg_volume)
|
||||
/ "files"
|
||||
)
|
||||
self.assertFalse(p.exists(), f"Did not expect files backup dir at: {p}")
|
||||
|
||||
def test_data_restored(self) -> None:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
self.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
'psql -U postgres -d appdb -t -c "SELECT v FROM t WHERE id=1;"',
|
||||
]
|
||||
)
|
||||
self.assertEqual((p.stdout or "").strip(), "ok")
|
||||
184
tests/e2e/test_e2e_postgres_single_transaction_live_writer.py
Normal file
184
tests/e2e/test_e2e_postgres_single_transaction_live_writer.py
Normal file
@@ -0,0 +1,184 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
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 discourse restore-drill race: `restore --empty` replays the dump into a
|
||||
# LIVE database while a background writer keeps touching a primary-key row
|
||||
# (discourse's mini_scheduler upserts scheduler_stats(id=1)). Without a
|
||||
# single-transaction replay, the pre-clean drops the table, the replay recreates
|
||||
# it and auto-commits, the writer wins the gap and inserts id=1, and the dump's
|
||||
# COPY of the same id then aborts with a duplicate-key violation under
|
||||
# ON_ERROR_STOP -> the whole restore fails. The --single-transaction replay keeps
|
||||
# the recreated table invisible until commit, so the writer can never insert the
|
||||
# racing row and the restore completes. A wide filler table makes the COPY slow
|
||||
# enough that the non-transactional variant loses the race deterministically.
|
||||
SEED_SQL = (
|
||||
"CREATE TABLE public.scheduler_stats (id int primary key, v text);"
|
||||
"INSERT INTO public.scheduler_stats VALUES (1, 'from-dump');"
|
||||
"CREATE TABLE public.filler (id serial primary key, blob text);"
|
||||
"INSERT INTO public.filler (blob)"
|
||||
" SELECT repeat('x', 512) FROM generate_series(1, 100000);"
|
||||
)
|
||||
|
||||
WRITER_LOOP = (
|
||||
"while true; do "
|
||||
"psql -h 127.0.0.1 -U postgres -d appdb "
|
||||
"-c \"INSERT INTO public.scheduler_stats(id, v) VALUES (1, 'live') "
|
||||
'ON CONFLICT (id) DO NOTHING;" >/dev/null 2>&1; '
|
||||
"done"
|
||||
)
|
||||
|
||||
|
||||
class TestE2EPostgresSingleTransactionLiveWriter(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-pg-single-txn")
|
||||
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.writer = f"{cls.prefix}-writer"
|
||||
cls.containers = [cls.pg_container, cls.writer]
|
||||
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 "{SEED_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)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.writer,
|
||||
"--network",
|
||||
f"container:{cls.pg_container}",
|
||||
"-e",
|
||||
"PGPASSWORD=pgpw",
|
||||
POSTGRES_IMAGE,
|
||||
"sh",
|
||||
"-lc",
|
||||
WRITER_LOOP,
|
||||
]
|
||||
)
|
||||
|
||||
cls.restore = 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",
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
|
||||
run(["docker", "rm", "-f", cls.writer], capture=True, check=False)
|
||||
|
||||
@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_restore_survived_the_live_writer(self) -> None:
|
||||
self.assertEqual(
|
||||
self.restore.returncode,
|
||||
0,
|
||||
f"restore aborted (duplicate-key race not contained):\n{self.restore.stderr}",
|
||||
)
|
||||
|
||||
def test_primary_key_row_restored(self) -> None:
|
||||
self.assertEqual(
|
||||
self._scalar("SELECT count(*) FROM public.scheduler_stats WHERE id=1;"),
|
||||
"1",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
120
tests/e2e/test_e2e_restore_files_backing_store.py
Normal file
120
tests/e2e/test_e2e_restore_files_backing_store.py
Normal file
@@ -0,0 +1,120 @@
|
||||
"""Restoring files into a volume that has a backing store of its own.
|
||||
|
||||
Docker keeps the same ``/var/lib/docker/volumes/<name>/_data`` path for such a
|
||||
volume and mounts the real storage over it only while a container holds it.
|
||||
Writing there unmounted lands in the empty directory underneath, is hidden by
|
||||
the next mount, and rsync reports success - so the restore has to refuse.
|
||||
"""
|
||||
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
from .helpers import (
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
ensure_empty_dir,
|
||||
machine_hash,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
)
|
||||
|
||||
MARKER = "restored-payload"
|
||||
VERSION = "20260817000000"
|
||||
|
||||
|
||||
def mountpoint_of(volume: str) -> Path:
|
||||
return Path("/var/lib/docker/volumes") / volume / "_data"
|
||||
|
||||
|
||||
def contents(directory: Path) -> list[str]:
|
||||
return sorted(p.name for p in directory.iterdir()) if directory.is_dir() else []
|
||||
|
||||
|
||||
class TestE2ERestoreFilesBackingStore(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-backing")
|
||||
cls.repo_name = cls.prefix
|
||||
cls.backups_dir = f"/tmp/{cls.prefix}/Backups"
|
||||
cls.backing = Path(f"/tmp/{cls.prefix}/backing")
|
||||
ensure_empty_dir(cls.backups_dir)
|
||||
ensure_empty_dir(str(cls.backing))
|
||||
|
||||
cls.bound_volume = f"{cls.prefix}-bound"
|
||||
cls.plain_volume = f"{cls.prefix}-plain"
|
||||
cls.volumes = [cls.bound_volume, cls.plain_volume]
|
||||
|
||||
for volume in cls.volumes:
|
||||
files = (
|
||||
backup_path(cls.backups_dir, cls.repo_name, VERSION, volume) / "files"
|
||||
)
|
||||
files.mkdir(parents=True, exist_ok=True)
|
||||
(files / "marker.txt").write_text(MARKER, encoding="utf-8")
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"volume",
|
||||
"create",
|
||||
"--driver",
|
||||
"local",
|
||||
"--opt",
|
||||
"type=none",
|
||||
"--opt",
|
||||
"o=bind",
|
||||
"--opt",
|
||||
f"device={cls.backing}",
|
||||
cls.bound_volume,
|
||||
]
|
||||
)
|
||||
run(["docker", "volume", "create", cls.plain_volume])
|
||||
|
||||
cls.refused = cls.restore(cls.bound_volume)
|
||||
cls.accepted = cls.restore(cls.plain_volume)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=[], volumes=cls.volumes)
|
||||
|
||||
@classmethod
|
||||
def restore(cls, volume: str):
|
||||
return run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
"files",
|
||||
volume,
|
||||
machine_hash(),
|
||||
VERSION,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
],
|
||||
check=False,
|
||||
)
|
||||
|
||||
def test_a_volume_with_its_own_backing_store_is_refused(self) -> None:
|
||||
self.assertEqual(self.refused.returncode, 2, self.refused.stdout)
|
||||
self.assertIn("backing store of its own", self.refused.stderr)
|
||||
|
||||
def test_nothing_was_written_into_the_backing_store(self) -> None:
|
||||
self.assertEqual(contents(self.backing), [])
|
||||
|
||||
def test_nothing_was_written_under_the_mount_either(self) -> None:
|
||||
self.assertEqual(
|
||||
contents(mountpoint_of(self.bound_volume)),
|
||||
[],
|
||||
"the copy landed in the directory the next mount hides",
|
||||
)
|
||||
|
||||
def test_a_plain_volume_is_still_restored(self) -> None:
|
||||
self.assertEqual(self.accepted.returncode, 0, self.accepted.stderr)
|
||||
restored = mountpoint_of(self.plain_volume) / "marker.txt"
|
||||
self.assertTrue(restored.is_file(), f"{restored} missing")
|
||||
self.assertEqual(restored.read_text(encoding="utf-8"), MARKER)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
230
tests/e2e/test_e2e_seed_star_and_db_entries_backup_postgres.py
Normal file
230
tests/e2e/test_e2e_seed_star_and_db_entries_backup_postgres.py
Normal file
@@ -0,0 +1,230 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_postgres,
|
||||
)
|
||||
|
||||
|
||||
class TestE2ESeedStarAndDbEntriesBackupPostgres(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
|
||||
cls.prefix = unique("baudolo-e2e-seed-star-and-db")
|
||||
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
|
||||
|
||||
# --- Volumes ---
|
||||
cls.db_volume = f"{cls.prefix}-vol-db"
|
||||
cls.files_volume = f"{cls.prefix}-vol-files"
|
||||
cls.volumes = [cls.db_volume, cls.files_volume]
|
||||
|
||||
run(["docker", "volume", "create", cls.db_volume])
|
||||
run(["docker", "volume", "create", cls.files_volume])
|
||||
|
||||
# Put a marker into the non-db volume
|
||||
cls.marker = "hello-non-db-seed-star"
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.files_volume}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
f"echo '{cls.marker}' > /data/hello.txt",
|
||||
]
|
||||
)
|
||||
|
||||
# --- Start Postgres container using the DB volume ---
|
||||
cls.pg_container = f"{cls.prefix}-pg"
|
||||
cls.containers = [cls.pg_container]
|
||||
|
||||
cls.pg_password = "postgres"
|
||||
cls.pg_user = "postgres"
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.pg_container,
|
||||
"-e",
|
||||
f"POSTGRES_PASSWORD={cls.pg_password}",
|
||||
"-v",
|
||||
f"{cls.db_volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.pg_container, user="postgres", timeout_s=90)
|
||||
|
||||
# Create two DBs and deterministic content, so pg_dumpall is meaningful
|
||||
cls.pg_db1 = "testdb1"
|
||||
cls.pg_db2 = "testdb2"
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f'psql -U {cls.pg_user} -c "CREATE DATABASE {cls.pg_db1};" || true; '
|
||||
f'psql -U {cls.pg_user} -c "CREATE DATABASE {cls.pg_db2};" || true; '
|
||||
),
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"psql -U {cls.pg_user} -d {cls.pg_db1} -c "
|
||||
'"CREATE TABLE IF NOT EXISTS t (id INT PRIMARY KEY, v TEXT);'
|
||||
"INSERT INTO t(id,v) VALUES (1,'hello-db1') "
|
||||
'ON CONFLICT (id) DO UPDATE SET v=EXCLUDED.v;"'
|
||||
),
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.pg_container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"psql -U {cls.pg_user} -d {cls.pg_db2} -c "
|
||||
'"CREATE TABLE IF NOT EXISTS t (id INT PRIMARY KEY, v TEXT);'
|
||||
"INSERT INTO t(id,v) VALUES (1,'hello-db2') "
|
||||
'ON CONFLICT (id) DO UPDATE SET v=EXCLUDED.v;"'
|
||||
),
|
||||
],
|
||||
check=True,
|
||||
)
|
||||
|
||||
# --- Seed databases.csv using CLI (star + concrete db) ---
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
|
||||
# IMPORTANT: because we pass --database-containers <container>,
|
||||
# get_instance() will use the container name as instance key.
|
||||
instance = cls.pg_container
|
||||
|
||||
# Seed star entry (pg_dumpall)
|
||||
run(
|
||||
[
|
||||
"baudolo-seed",
|
||||
cls.databases_csv,
|
||||
instance,
|
||||
"*",
|
||||
cls.pg_user,
|
||||
cls.pg_password,
|
||||
]
|
||||
)
|
||||
|
||||
# Seed concrete DB entry (pg_dump)
|
||||
run(
|
||||
[
|
||||
"baudolo-seed",
|
||||
cls.databases_csv,
|
||||
instance,
|
||||
cls.pg_db1,
|
||||
cls.pg_user,
|
||||
cls.pg_password,
|
||||
]
|
||||
)
|
||||
|
||||
cmd = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--databases-csv",
|
||||
cls.databases_csv,
|
||||
"--database-containers",
|
||||
cls.pg_container,
|
||||
"--images-no-stop-required",
|
||||
POSTGRES_IMAGE,
|
||||
"--only-sql",
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
cls.stdout = cp.stdout or ""
|
||||
cls.stderr = cp.stderr or ""
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_db_volume_has_cluster_dump_and_concrete_db_dump_and_no_files(self) -> None:
|
||||
base = backup_path(
|
||||
self.backups_dir, self.repo_name, self.version, self.db_volume
|
||||
)
|
||||
sql_dir = base / "sql"
|
||||
files_dir = base / "files"
|
||||
|
||||
self.assertTrue(sql_dir.exists(), f"Expected sql dir at: {sql_dir}")
|
||||
self.assertFalse(
|
||||
files_dir.exists(),
|
||||
f"Did not expect files dir for DB volume when only-sql succeeded: {files_dir}",
|
||||
)
|
||||
|
||||
# Cluster dump file produced by '*' entry
|
||||
cluster = sql_dir / f"{self.pg_container}.cluster.backup.sql"
|
||||
self.assertTrue(cluster.is_file(), f"Expected cluster dump file at: {cluster}")
|
||||
|
||||
# Concrete DB dump produced by normal entry
|
||||
db1 = sql_dir / f"{self.pg_db1}.backup.sql"
|
||||
self.assertTrue(db1.is_file(), f"Expected db dump file at: {db1}")
|
||||
|
||||
# Basic sanity: cluster dump usually contains CREATE DATABASE statements
|
||||
txt = cluster.read_text(encoding="utf-8", errors="ignore")
|
||||
self.assertIn(
|
||||
"CREATE DATABASE",
|
||||
txt,
|
||||
"Expected cluster dump to contain CREATE DATABASE statements",
|
||||
)
|
||||
|
||||
def test_non_db_volume_still_has_files_backup(self) -> None:
|
||||
base = backup_path(
|
||||
self.backups_dir, self.repo_name, self.version, self.files_volume
|
||||
)
|
||||
files_dir = base / "files"
|
||||
|
||||
self.assertTrue(
|
||||
files_dir.exists(), f"Expected files dir for non-DB volume at: {files_dir}"
|
||||
)
|
||||
|
||||
marker = files_dir / "hello.txt"
|
||||
self.assertTrue(marker.is_file(), f"Expected marker file at: {marker}")
|
||||
self.assertEqual(
|
||||
marker.read_text(encoding="utf-8").strip(),
|
||||
self.marker,
|
||||
)
|
||||
169
tests/e2e/test_e2e_snapshot.py
Normal file
169
tests/e2e/test_e2e_snapshot.py
Normal file
@@ -0,0 +1,169 @@
|
||||
"""Snapshot capture against real filesystems.
|
||||
|
||||
Loop devices are only available to a privileged container, so each case builds
|
||||
its filesystem inside one and drives snapshot_driver.py there. A filesystem
|
||||
without snapshot support must fail loudly rather than degrade to a live copy,
|
||||
which is the property that makes the mode safe to offer at all.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
from .helpers import require_docker, run, unique
|
||||
|
||||
REPO_SRC = Path(__file__).resolve().parents[2] / "src"
|
||||
DRIVER = Path(__file__).resolve().parent / "snapshot_driver.py"
|
||||
FAITHFUL_DRIVER = Path(__file__).resolve().parent / "faithful_driver.py"
|
||||
IMAGE = "alpine:3.20"
|
||||
PACKAGES = "apk add -q btrfs-progs e2fsprogs zfs python3 util-linux"
|
||||
ATTACH = (
|
||||
"LOOP=$(losetup -f | awk '{print $1}') "
|
||||
'&& { [ -b "$LOOP" ] || mknod "$LOOP" b 7 "${LOOP#/dev/loop}"; }; '
|
||||
'losetup "$LOOP" /img'
|
||||
)
|
||||
LOOP_FS = {
|
||||
"btrfs": "btrfs subvolume create /subject/docker >/dev/null",
|
||||
"ext4": "mkdir -p /subject/docker",
|
||||
}
|
||||
# A container carries no /lib/modules, so modprobe fails even on a loaded module.
|
||||
ZFS_READY = "{ [ -c /dev/zfs ] || modprobe zfs 2>/dev/null; }; [ -c /dev/zfs ]"
|
||||
|
||||
|
||||
def mount_script(fstype: str) -> str:
|
||||
"""Build a filesystem on a loop device and carve out the snapshot subject."""
|
||||
if fstype == "zfs":
|
||||
return (
|
||||
f"{PACKAGES} && {ZFS_READY} && truncate -s 400M /img "
|
||||
"&& zpool create -m none baudolo /img "
|
||||
"&& zfs create -o mountpoint=/subject/docker baudolo/docker"
|
||||
)
|
||||
return (
|
||||
f"{PACKAGES} && truncate -s 400M /img && mkfs.{fstype} -q /img "
|
||||
f'&& mkdir -p /subject && {ATTACH} && mount -t {fstype} "$LOOP" /subject '
|
||||
f"&& {LOOP_FS[fstype]}"
|
||||
)
|
||||
|
||||
|
||||
def zfs_usable() -> bool:
|
||||
"""Whether this host's kernel can serve zfs to a privileged container."""
|
||||
proc = run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"--privileged",
|
||||
IMAGE,
|
||||
"sh",
|
||||
"-lc",
|
||||
f"apk add -q zfs >/dev/null 2>&1 && {ZFS_READY}",
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
return proc.returncode == 0
|
||||
|
||||
|
||||
def required(fstype: str) -> bool:
|
||||
"""Whether this run must cover ``fstype`` instead of skipping it.
|
||||
|
||||
CI sets E2E_REQUIRE_FILESYSTEMS so a missing kernel module fails the build
|
||||
rather than passing it with a filesystem silently untested.
|
||||
"""
|
||||
demanded = os.environ.get("E2E_REQUIRE_FILESYSTEMS", "")
|
||||
return fstype in demanded.replace(",", " ").split()
|
||||
|
||||
|
||||
def stage(driver: Path) -> Path:
|
||||
"""Copy source and driver under /tmp, the only path the DinD daemon shares."""
|
||||
staged = Path("/tmp") / unique("baudolo-e2e-snapshot")
|
||||
shutil.copytree(REPO_SRC, staged / "src")
|
||||
shutil.copy(driver, staged / "driver.py")
|
||||
return staged
|
||||
|
||||
|
||||
def drive(fstype: str, arguments: str, *, driver: Path = DRIVER) -> str:
|
||||
staged = stage(driver)
|
||||
script = f"set -e; {mount_script(fstype)}; python3 /driver.py {arguments}"
|
||||
try:
|
||||
proc = run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"--privileged",
|
||||
"--name",
|
||||
staged.name,
|
||||
"-v",
|
||||
f"{staged / 'src'}:/src:ro",
|
||||
"-v",
|
||||
f"{staged / 'driver.py'}:/driver.py:ro",
|
||||
IMAGE,
|
||||
"sh",
|
||||
"-lc",
|
||||
script,
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
finally:
|
||||
shutil.rmtree(staged, ignore_errors=True)
|
||||
if proc.returncode != 0:
|
||||
raise AssertionError(
|
||||
f"{fstype} driver failed on {arguments}:\n{proc.stdout}\n{proc.stderr}"
|
||||
)
|
||||
return proc.stdout
|
||||
|
||||
|
||||
class TestE2ESnapshot(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
|
||||
def assert_freezes(self, fstype: str) -> None:
|
||||
output = drive(fstype, f"{fstype} /subject/docker supported")
|
||||
self.assertIn("PASS the snapshot exposes the volume", output)
|
||||
self.assertIn("PASS a later write does not reach the snapshot", output)
|
||||
self.assertIn("PASS the snapshot is removed afterwards", output)
|
||||
self.assertIn("ALL OK", output)
|
||||
|
||||
def test_btrfs_snapshot_freezes_the_volume(self) -> None:
|
||||
self.assert_freezes("btrfs")
|
||||
|
||||
def test_zfs_snapshot_freezes_the_volume(self) -> None:
|
||||
if not zfs_usable():
|
||||
if required("zfs"):
|
||||
self.fail(
|
||||
"E2E_REQUIRE_FILESYSTEMS demands zfs, but this kernel provides no "
|
||||
"zfs module; load it before running the suite"
|
||||
)
|
||||
self.skipTest(
|
||||
"this kernel provides no zfs module, so no pool can be created"
|
||||
)
|
||||
self.assert_freezes("zfs")
|
||||
|
||||
def test_ext4_has_no_snapshot_and_says_so(self) -> None:
|
||||
output = drive("ext4", "btrfs /subject/docker unsupported")
|
||||
self.assertIn("PASS refused loudly", output)
|
||||
|
||||
def test_an_unknown_kind_is_refused_before_touching_the_filesystem(self) -> None:
|
||||
output = drive("ext4", "lvm /subject/docker unsupported")
|
||||
self.assertIn("PASS refused loudly", output)
|
||||
|
||||
def test_a_volume_with_its_own_storage_is_copied_live_not_from_the_snapshot(
|
||||
self,
|
||||
) -> None:
|
||||
output = drive("btrfs", "/subject/docker", driver=FAITHFUL_DRIVER)
|
||||
self.assertIn(
|
||||
"PASS the snapshot shows the other volume as an empty directory", output
|
||||
)
|
||||
self.assertIn("PASS the other volume degrades to live", output)
|
||||
self.assertIn("PASS the plain volume is read from the snapshot", output)
|
||||
self.assertIn("ALL OK", output)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
112
tests/e2e/test_e2e_snapshot_db.py
Normal file
112
tests/e2e/test_e2e_snapshot_db.py
Normal file
@@ -0,0 +1,112 @@
|
||||
"""A live database survives being captured from a snapshot.
|
||||
|
||||
The database is written to while the snapshot is taken and keeps writing
|
||||
afterwards, so the copy can only be a point in time - never a clean shutdown.
|
||||
A second server is then started on that copy: it must recover on its own and
|
||||
still hold every row committed before the snapshot.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
from .helpers import require_docker, run, unique
|
||||
|
||||
REPO_SRC = Path(__file__).resolve().parents[2] / "src"
|
||||
DRIVER = Path(__file__).resolve().parent / "snapshot_db_driver.py"
|
||||
IMAGE = "alpine:3.20"
|
||||
SOCKET = "/tmp/live.sock"
|
||||
RESTORED_SOCKET = "/tmp/restored.sock"
|
||||
DATADIR = "/subject/docker/volumes/mariadb_data/_data"
|
||||
RESTORED = "/restored"
|
||||
|
||||
SCRIPT = f"""set -e
|
||||
apk add -q btrfs-progs util-linux python3 mariadb mariadb-client rsync
|
||||
truncate -s 900M /img
|
||||
mkfs.btrfs -q /img
|
||||
mkdir -p /subject
|
||||
LOOP=$(losetup -f | awk '{{print $1}}')
|
||||
{{ [ -b "$LOOP" ] || mknod "$LOOP" b 7 "${{LOOP#/dev/loop}}"; }}
|
||||
losetup "$LOOP" /img
|
||||
mount -t btrfs "$LOOP" /subject
|
||||
btrfs subvolume create /subject/docker >/dev/null
|
||||
mkdir -p {DATADIR}
|
||||
|
||||
mariadb-install-db --user=root --datadir={DATADIR} >/dev/null 2>&1
|
||||
mariadbd --user=root --datadir={DATADIR} --socket={SOCKET} --skip-networking &
|
||||
for i in $(seq 1 60); do mariadb-admin --socket={SOCKET} ping >/dev/null 2>&1 && break; sleep 1; done
|
||||
|
||||
mariadb --socket={SOCKET} -e "CREATE DATABASE demo;
|
||||
CREATE TABLE demo.t (id INT PRIMARY KEY, v VARCHAR(32)) ENGINE=InnoDB;
|
||||
INSERT INTO demo.t VALUES (1,'committed'),(2,'committed');"
|
||||
|
||||
mariadb --socket={SOCKET} -e "INSERT INTO demo.t VALUES (3,'committed');"
|
||||
python3 /driver.py
|
||||
mariadb --socket={SOCKET} -e "INSERT INTO demo.t VALUES (4,'after-snapshot');"
|
||||
|
||||
mkdir -p {RESTORED}
|
||||
rsync -a /backups/20260731/mariadb_data/files/ {RESTORED}/
|
||||
mariadbd --user=root --datadir={RESTORED} --socket={RESTORED_SOCKET} --skip-networking &
|
||||
for i in $(seq 1 60); do mariadb-admin --socket={RESTORED_SOCKET} ping >/dev/null 2>&1 && break; sleep 1; done
|
||||
|
||||
echo "RESTORED_ROWS=$(mariadb --socket={RESTORED_SOCKET} -N -B -e 'SELECT COUNT(*) FROM demo.t;')"
|
||||
echo "RESTORED_AFTER=$(mariadb --socket={RESTORED_SOCKET} -N -B -e \\
|
||||
"SELECT COUNT(*) FROM demo.t WHERE v='after-snapshot';")"
|
||||
echo DB_OK
|
||||
"""
|
||||
|
||||
|
||||
class TestE2ESnapshotDatabase(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
staged = Path("/tmp") / unique("baudolo-e2e-snapshot-db")
|
||||
shutil.copytree(REPO_SRC, staged / "src")
|
||||
shutil.copy(DRIVER, staged / "driver.py")
|
||||
try:
|
||||
proc = run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"--privileged",
|
||||
"--name",
|
||||
staged.name,
|
||||
"-v",
|
||||
f"{staged / 'src'}:/src:ro",
|
||||
"-v",
|
||||
f"{staged / 'driver.py'}:/driver.py:ro",
|
||||
IMAGE,
|
||||
"sh",
|
||||
"-lc",
|
||||
SCRIPT,
|
||||
],
|
||||
capture=True,
|
||||
check=False,
|
||||
)
|
||||
finally:
|
||||
shutil.rmtree(staged, ignore_errors=True)
|
||||
cls.output = proc.stdout + proc.stderr
|
||||
cls.returncode = proc.returncode
|
||||
|
||||
def test_the_run_completed(self) -> None:
|
||||
self.assertEqual(self.returncode, 0, self.output)
|
||||
self.assertIn("DB_OK", self.output)
|
||||
|
||||
def test_the_backup_came_from_the_snapshot(self) -> None:
|
||||
self.assertIn("SNAPSHOT COPY DONE", self.output)
|
||||
|
||||
def test_the_restored_server_recovered_on_its_own(self) -> None:
|
||||
self.assertIn("RESTORED_ROWS=3", self.output)
|
||||
|
||||
def test_writes_after_the_snapshot_are_absent(self) -> None:
|
||||
self.assertIn("RESTORED_AFTER=0", self.output)
|
||||
|
||||
def test_the_copy_was_an_unclean_state_the_engine_had_to_repair(self) -> None:
|
||||
self.assertRegex(self.output, r"(?i)crash recovery|rolling back|log sequence")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
194
tests/e2e/test_e2e_swarm_task_skip.py
Normal file
194
tests/e2e/test_e2e_swarm_task_skip.py
Normal file
@@ -0,0 +1,194 @@
|
||||
# Reproduces the swarm flake fixed on this branch: baudolo used to stop a
|
||||
# swarm task container around the volume file backup because its image was
|
||||
# not whitelisted; the orchestrator immediately replaced the stopped task and
|
||||
# the later `docker start` failed on the detached overlay network, killing
|
||||
# the backup run. With the fix the task container is skipped (backed up hot):
|
||||
# the backup succeeds, the very same container instance keeps running, and
|
||||
# the service never has to replace a task.
|
||||
import time
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
backup_path,
|
||||
backup_run,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
def _swarm_state() -> str:
|
||||
return run(
|
||||
["docker", "info", "--format", "{{.Swarm.LocalNodeState}}"]
|
||||
).stdout.strip()
|
||||
|
||||
|
||||
def _task_container_id(service: str, timeout_s: int = 60) -> str:
|
||||
deadline = time.time() + timeout_s
|
||||
while time.time() < deadline:
|
||||
out = run(
|
||||
[
|
||||
"docker",
|
||||
"ps",
|
||||
"--filter",
|
||||
f"label=com.docker.swarm.service.name={service}",
|
||||
"--format",
|
||||
"{{.ID}}",
|
||||
]
|
||||
).stdout.strip()
|
||||
if out:
|
||||
return out.splitlines()[0]
|
||||
time.sleep(2)
|
||||
raise RuntimeError(f"No running task container for service {service}")
|
||||
|
||||
|
||||
def _started_at(container_id: str) -> str:
|
||||
return run(
|
||||
["docker", "inspect", "--format", "{{.State.StartedAt}}", container_id]
|
||||
).stdout.strip()
|
||||
|
||||
|
||||
class TestE2ESwarmTaskSkip(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-swarm-skip")
|
||||
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.swarm_initted = False
|
||||
if _swarm_state() != "active":
|
||||
run(["docker", "swarm", "init", "--advertise-addr", "127.0.0.1"])
|
||||
cls.swarm_initted = True
|
||||
|
||||
cls.volume = f"{cls.prefix}-vol"
|
||||
cls.service = f"{cls.prefix}-svc"
|
||||
cls.volumes = [cls.volume]
|
||||
|
||||
run(["docker", "volume", "create", cls.volume])
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.volume}:/data",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"echo 'swarm-payload' > /data/payload.txt",
|
||||
]
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"service",
|
||||
"create",
|
||||
"--name",
|
||||
cls.service,
|
||||
"--replicas",
|
||||
"1",
|
||||
"--mount",
|
||||
f"type=volume,source={cls.volume},target=/data",
|
||||
"alpine:3.20",
|
||||
"sleep",
|
||||
"3600",
|
||||
]
|
||||
)
|
||||
cls.task_cid = _task_container_id(cls.service)
|
||||
cls.task_started_at = _started_at(cls.task_cid)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(cls.databases_csv, [])
|
||||
|
||||
# Whitelist that matches nothing: on main this forces a stop of every
|
||||
# container at the volume, i.e. exactly the flake; on this branch the
|
||||
# swarm task must be skipped instead. (An empty list would leave the
|
||||
# --images-no-stop-required flag without arguments and argparse-fail.)
|
||||
backup_run(
|
||||
backups_dir=cls.backups_dir,
|
||||
repo_name=cls.repo_name,
|
||||
compose_dir=cls.compose_dir,
|
||||
databases_csv=cls.databases_csv,
|
||||
database_containers=["dummy-db"],
|
||||
images_no_stop_required=["image-that-matches-nothing"],
|
||||
)
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
run(["docker", "service", "rm", cls.service], check=False)
|
||||
deadline = time.time() + 30
|
||||
while time.time() < deadline:
|
||||
out = run(
|
||||
[
|
||||
"docker",
|
||||
"ps",
|
||||
"-aq",
|
||||
"--filter",
|
||||
f"label=com.docker.swarm.service.name={cls.service}",
|
||||
],
|
||||
check=False,
|
||||
).stdout.strip()
|
||||
if not out:
|
||||
break
|
||||
time.sleep(2)
|
||||
for v in cls.volumes:
|
||||
run(["docker", "volume", "rm", "-f", v], check=False)
|
||||
if cls.swarm_initted:
|
||||
run(["docker", "swarm", "leave", "--force"], check=False)
|
||||
|
||||
def test_volume_backed_up_hot(self) -> None:
|
||||
p = (
|
||||
backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.volume,
|
||||
)
|
||||
/ "files"
|
||||
/ "payload.txt"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected backed up file at: {p}")
|
||||
|
||||
def test_task_container_never_stopped(self) -> None:
|
||||
out = run(
|
||||
["docker", "ps", "-q", "--no-trunc", "--filter", f"id={self.task_cid}"]
|
||||
).stdout.strip()
|
||||
self.assertTrue(
|
||||
out.startswith(self.task_cid) or self.task_cid.startswith(out.strip()[:12]),
|
||||
f"Task container {self.task_cid} is no longer running",
|
||||
)
|
||||
self.assertEqual(
|
||||
self.task_started_at,
|
||||
_started_at(self.task_cid),
|
||||
"Task container was restarted during the backup",
|
||||
)
|
||||
|
||||
def test_service_never_replaced_the_task(self) -> None:
|
||||
states = run(
|
||||
[
|
||||
"docker",
|
||||
"service",
|
||||
"ps",
|
||||
self.service,
|
||||
"--format",
|
||||
"{{.DesiredState}} {{.CurrentState}}",
|
||||
]
|
||||
).stdout.strip()
|
||||
lines = [line for line in states.splitlines() if line.strip()]
|
||||
self.assertEqual(
|
||||
len(lines), 1, f"Service task history shows replacements:\n{states}"
|
||||
)
|
||||
self.assertIn("Running", lines[0])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
283
tests/e2e/test_e2e_version_gate.py
Normal file
283
tests/e2e/test_e2e_version_gate.py
Normal file
@@ -0,0 +1,283 @@
|
||||
"""A dump from a newer engine must be refused before --empty destroys anything.
|
||||
|
||||
The pre-clean and the replay are two separate sessions with no rollback across
|
||||
them, so a dump the engine cannot parse leaves an emptied database behind. The
|
||||
decisive assertion here is not the non-zero exit - it is that the payload is
|
||||
still readable afterwards.
|
||||
"""
|
||||
|
||||
import re
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
from .helpers import (
|
||||
MARIADB_DATA_DIR,
|
||||
MARIADB_IMAGE,
|
||||
POSTGRES_DATA_DIR,
|
||||
POSTGRES_IMAGE,
|
||||
backup_path,
|
||||
backup_run,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
wait_for_mariadb,
|
||||
wait_for_mariadb_sql,
|
||||
wait_for_postgres,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
PAYLOAD = "gate-payload"
|
||||
FUTURE = "99.0"
|
||||
|
||||
|
||||
def rewrite_version(dump: Path, pattern: str, version: str) -> str:
|
||||
"""Make the dump claim ``version``; return what it claimed before."""
|
||||
text = dump.read_text(encoding="utf-8", errors="replace")
|
||||
found = re.search(pattern, text)
|
||||
if not found:
|
||||
raise AssertionError(f"{dump} carries no version header matching {pattern}")
|
||||
claimed = found.group(1)
|
||||
dump.write_text(
|
||||
text.replace(found.group(0), found.group(0).replace(claimed, version), 1),
|
||||
encoding="utf-8",
|
||||
)
|
||||
return claimed
|
||||
|
||||
|
||||
class GateCase:
|
||||
"""Drive one engine through refusal, escape hatch and truthful replay."""
|
||||
|
||||
engine = ""
|
||||
pattern = ""
|
||||
|
||||
@classmethod
|
||||
def restore(cls, *extra: str):
|
||||
return run(
|
||||
[
|
||||
"baudolo-restore",
|
||||
cls.engine,
|
||||
cls.volume,
|
||||
cls.hash,
|
||||
cls.version,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--container",
|
||||
cls.container,
|
||||
"--db-name",
|
||||
cls.db_name,
|
||||
"--db-user",
|
||||
cls.db_user,
|
||||
"--db-password",
|
||||
cls.db_password,
|
||||
"--empty",
|
||||
*extra,
|
||||
],
|
||||
check=False,
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def prepare(cls) -> None:
|
||||
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.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(
|
||||
cls.databases_csv,
|
||||
[(cls.container, cls.db_name, cls.db_user, cls.db_password)],
|
||||
)
|
||||
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.container],
|
||||
images_no_stop_required=[cls.image],
|
||||
)
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
cls.dump = (
|
||||
backup_path(cls.backups_dir, cls.repo_name, cls.version, cls.volume)
|
||||
/ "sql"
|
||||
/ f"{cls.db_name}.backup.sql"
|
||||
)
|
||||
|
||||
cls.truthful_version = rewrite_version(cls.dump, cls.pattern, FUTURE)
|
||||
cls.refused = cls.restore()
|
||||
cls.payload_after_refusal = cls.read_payload()
|
||||
|
||||
cls.forced = cls.restore("--no-version-check")
|
||||
cls.payload_after_force = cls.read_payload()
|
||||
|
||||
rewrite_version(cls.dump, cls.pattern, cls.truthful_version)
|
||||
cls.replayed = cls.restore()
|
||||
cls.payload_after_replay = cls.read_payload()
|
||||
|
||||
def test_the_dump_states_the_engine_it_came_from(self) -> None:
|
||||
self.assertRegex(self.truthful_version, r"^\d+")
|
||||
|
||||
def test_a_newer_dump_is_refused(self) -> None:
|
||||
self.assertNotEqual(self.refused.returncode, 0, self.refused.stdout)
|
||||
|
||||
def test_the_refusal_names_the_version_it_refused(self) -> None:
|
||||
self.assertIn(FUTURE, self.refused.stderr)
|
||||
self.assertIn("older engine", self.refused.stderr)
|
||||
|
||||
def test_the_refusal_left_the_data_untouched(self) -> None:
|
||||
self.assertEqual(
|
||||
self.payload_after_refusal,
|
||||
PAYLOAD,
|
||||
"--empty pre-cleaned before the version was checked",
|
||||
)
|
||||
|
||||
def test_the_escape_hatch_replays_anyway(self) -> None:
|
||||
self.assertEqual(self.forced.returncode, 0, self.forced.stderr)
|
||||
self.assertEqual(self.payload_after_force, PAYLOAD)
|
||||
|
||||
def test_a_truthful_dump_replays(self) -> None:
|
||||
self.assertEqual(self.replayed.returncode, 0, self.replayed.stderr)
|
||||
self.assertEqual(self.payload_after_replay, PAYLOAD)
|
||||
|
||||
|
||||
class TestE2EPostgresVersionGate(GateCase, unittest.TestCase):
|
||||
engine = "postgres"
|
||||
pattern = r"-- Dumped from database version (\S+)"
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-pg-gate")
|
||||
cls.container = f"{cls.prefix}-pg"
|
||||
cls.volume = f"{cls.prefix}-pg-vol"
|
||||
cls.image = POSTGRES_IMAGE
|
||||
cls.db_name = "appdb"
|
||||
cls.db_user = "postgres"
|
||||
cls.db_password = "pgpw"
|
||||
|
||||
run(["docker", "volume", "create", cls.volume])
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.container,
|
||||
"-e",
|
||||
f"POSTGRES_PASSWORD={cls.db_password}",
|
||||
"-v",
|
||||
f"{cls.volume}:{POSTGRES_DATA_DIR}",
|
||||
POSTGRES_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_postgres(cls.container, user=cls.db_user)
|
||||
cls.sql("postgres", f"CREATE DATABASE {cls.db_name}")
|
||||
cls.sql(
|
||||
cls.db_name,
|
||||
f"CREATE TABLE t (v text); INSERT INTO t VALUES ('{PAYLOAD}');",
|
||||
)
|
||||
cls.prepare()
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=[cls.container], volumes=[cls.volume])
|
||||
|
||||
@classmethod
|
||||
def sql(cls, database: str, statement: str) -> str:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.container,
|
||||
"sh",
|
||||
"-lc",
|
||||
f'psql -U {cls.db_user} -d {database} -t -A -c "{statement}"',
|
||||
],
|
||||
check=False,
|
||||
)
|
||||
return (p.stdout or "").strip()
|
||||
|
||||
@classmethod
|
||||
def read_payload(cls) -> str:
|
||||
return cls.sql(cls.db_name, "SELECT v FROM t")
|
||||
|
||||
|
||||
class TestE2EMariadbVersionGate(GateCase, unittest.TestCase):
|
||||
engine = "mariadb"
|
||||
pattern = r"-- Server version\s+(\S+)"
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
cls.prefix = unique("baudolo-e2e-mdb-gate")
|
||||
cls.container = f"{cls.prefix}-mdb"
|
||||
cls.volume = f"{cls.prefix}-mdb-vol"
|
||||
cls.image = MARIADB_IMAGE
|
||||
cls.db_name = "appdb"
|
||||
cls.db_user = "test"
|
||||
cls.db_password = "testpw"
|
||||
|
||||
run(["docker", "volume", "create", cls.volume])
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.container,
|
||||
"-e",
|
||||
"MARIADB_ROOT_PASSWORD=rootpw",
|
||||
"-e",
|
||||
f"MARIADB_DATABASE={cls.db_name}",
|
||||
"-e",
|
||||
f"MARIADB_USER={cls.db_user}",
|
||||
"-e",
|
||||
f"MARIADB_PASSWORD={cls.db_password}",
|
||||
"-v",
|
||||
f"{cls.volume}:{MARIADB_DATA_DIR}",
|
||||
MARIADB_IMAGE,
|
||||
]
|
||||
)
|
||||
wait_for_mariadb(cls.container, root_password="rootpw", timeout_s=90)
|
||||
wait_for_mariadb_sql(
|
||||
cls.container, user=cls.db_user, password=cls.db_password, timeout_s=90
|
||||
)
|
||||
cls.sql(
|
||||
f"CREATE TABLE {cls.db_name}.t (v VARCHAR(50)); "
|
||||
f"INSERT INTO {cls.db_name}.t VALUES ('{PAYLOAD}');"
|
||||
)
|
||||
cls.prepare()
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=[cls.container], volumes=[cls.volume])
|
||||
|
||||
@classmethod
|
||||
def sql(cls, statement: str) -> str:
|
||||
p = run(
|
||||
[
|
||||
"docker",
|
||||
"exec",
|
||||
cls.container,
|
||||
"sh",
|
||||
"-lc",
|
||||
(
|
||||
f"mariadb -h 127.0.0.1 -u{cls.db_user} -p{cls.db_password} "
|
||||
f'-N -B -e "{statement}"'
|
||||
),
|
||||
],
|
||||
check=False,
|
||||
)
|
||||
return (p.stdout or "").strip()
|
||||
|
||||
@classmethod
|
||||
def read_payload(cls) -> str:
|
||||
return cls.sql(f"SELECT v FROM {cls.db_name}.t")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
125
tests/e2e/test_e2e_volumes_no_backup_required_early_skip.py
Normal file
125
tests/e2e/test_e2e_volumes_no_backup_required_early_skip.py
Normal file
@@ -0,0 +1,125 @@
|
||||
import unittest
|
||||
|
||||
from .helpers import (
|
||||
backup_path,
|
||||
cleanup_docker,
|
||||
create_minimal_compose_dir,
|
||||
ensure_empty_dir,
|
||||
latest_version_dir,
|
||||
require_docker,
|
||||
run,
|
||||
unique,
|
||||
write_databases_csv,
|
||||
)
|
||||
|
||||
|
||||
class TestE2EVolumesNoBackupRequiredEarlySkip(unittest.TestCase):
|
||||
"""Both volumes hang off the same container, so an image-level exclusion
|
||||
could only drop both. Only the named one may disappear."""
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
require_docker()
|
||||
|
||||
cls.prefix = unique("baudolo-e2e-early-skip-no-backup-volume")
|
||||
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.container = f"{cls.prefix}-app"
|
||||
cls.excluded_volume = f"{cls.prefix}-derived-vol"
|
||||
cls.kept_volume = f"{cls.prefix}-state-vol"
|
||||
|
||||
cls.containers = [cls.container]
|
||||
cls.volumes = [cls.excluded_volume, cls.kept_volume]
|
||||
|
||||
run(["docker", "volume", "create", cls.excluded_volume])
|
||||
run(["docker", "volume", "create", cls.kept_volume])
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"--rm",
|
||||
"-v",
|
||||
f"{cls.excluded_volume}:/derived",
|
||||
"-v",
|
||||
f"{cls.kept_volume}:/state",
|
||||
"alpine:3.20",
|
||||
"sh",
|
||||
"-lc",
|
||||
"echo derived > /derived/derived.txt && echo state > /state/state.txt",
|
||||
]
|
||||
)
|
||||
|
||||
run(
|
||||
[
|
||||
"docker",
|
||||
"run",
|
||||
"-d",
|
||||
"--name",
|
||||
cls.container,
|
||||
"-v",
|
||||
f"{cls.excluded_volume}:/derived",
|
||||
"-v",
|
||||
f"{cls.kept_volume}:/state",
|
||||
"alpine:3.20",
|
||||
"sleep",
|
||||
"600",
|
||||
]
|
||||
)
|
||||
|
||||
cls.databases_csv = f"/tmp/{cls.prefix}/databases.csv"
|
||||
write_databases_csv(cls.databases_csv, [])
|
||||
|
||||
cmd = [
|
||||
"baudolo",
|
||||
"--compose-dir",
|
||||
cls.compose_dir,
|
||||
"--repo-name",
|
||||
cls.repo_name,
|
||||
"--databases-csv",
|
||||
cls.databases_csv,
|
||||
"--backups-dir",
|
||||
cls.backups_dir,
|
||||
"--images-no-stop-required",
|
||||
"alpine:3.20",
|
||||
"--volumes-no-backup-required",
|
||||
cls.excluded_volume,
|
||||
]
|
||||
cp = run(cmd, capture=True, check=True)
|
||||
cls.stdout = cp.stdout or ""
|
||||
cls.stderr = cp.stderr or ""
|
||||
|
||||
cls.hash, cls.version = latest_version_dir(cls.backups_dir, cls.repo_name)
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls) -> None:
|
||||
cleanup_docker(containers=cls.containers, volumes=cls.volumes)
|
||||
|
||||
def test_excluded_volume_has_no_backup_directory_at_all(self) -> None:
|
||||
p = backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.excluded_volume,
|
||||
)
|
||||
self.assertFalse(
|
||||
p.exists(),
|
||||
f"Expected NO backup directory for the excluded volume, but found: {p}",
|
||||
)
|
||||
|
||||
def test_sibling_volume_of_the_same_container_is_still_backed_up(self) -> None:
|
||||
p = (
|
||||
backup_path(
|
||||
self.backups_dir,
|
||||
self.repo_name,
|
||||
self.version,
|
||||
self.kept_volume,
|
||||
)
|
||||
/ "files"
|
||||
/ "state.txt"
|
||||
)
|
||||
self.assertTrue(p.is_file(), f"Expected backed up file at: {p}")
|
||||
0
tests/integration/__init__.py
Normal file
0
tests/integration/__init__.py
Normal file
213
tests/integration/test_seed_integration.py
Normal file
213
tests/integration/test_seed_integration.py
Normal file
@@ -0,0 +1,213 @@
|
||||
import csv
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def run_seed(
|
||||
csv_path: Path, instance: str, database: str, username: str, password: str
|
||||
) -> subprocess.CompletedProcess:
|
||||
"""
|
||||
Run the real CLI module (E2E-style) using subprocess.
|
||||
|
||||
Seed contract (current):
|
||||
- database must be "*" or a valid name (non-empty, matches allowed charset)
|
||||
- password is required
|
||||
- entry is keyed by (instance, database); username/password get updated
|
||||
"""
|
||||
cp = subprocess.run(
|
||||
[
|
||||
sys.executable,
|
||||
"-m",
|
||||
"baudolo.seed",
|
||||
str(csv_path),
|
||||
instance,
|
||||
database,
|
||||
username,
|
||||
password,
|
||||
],
|
||||
text=True,
|
||||
capture_output=True,
|
||||
check=False,
|
||||
)
|
||||
if cp.returncode != 0:
|
||||
raise AssertionError(
|
||||
"seed command failed unexpectedly.\n"
|
||||
f"returncode: {cp.returncode}\n"
|
||||
f"stdout:\n{cp.stdout}\n"
|
||||
f"stderr:\n{cp.stderr}\n"
|
||||
)
|
||||
return cp
|
||||
|
||||
|
||||
def run_seed_expect_fail(
|
||||
csv_path: Path, instance: str, database: str, username: str, password: str
|
||||
) -> subprocess.CompletedProcess:
|
||||
"""
|
||||
Same as run_seed, but expects non-zero exit. Returns CompletedProcess for inspection.
|
||||
"""
|
||||
return subprocess.run(
|
||||
[
|
||||
sys.executable,
|
||||
"-m",
|
||||
"baudolo.seed",
|
||||
str(csv_path),
|
||||
instance,
|
||||
database,
|
||||
username,
|
||||
password,
|
||||
],
|
||||
text=True,
|
||||
capture_output=True,
|
||||
check=False,
|
||||
)
|
||||
|
||||
|
||||
def read_csv_semicolon(path: Path) -> list[dict]:
|
||||
with path.open("r", encoding="utf-8", newline="") as f:
|
||||
reader = csv.DictReader(f, delimiter=";")
|
||||
return list(reader)
|
||||
|
||||
|
||||
def read_text(path: Path) -> str:
|
||||
return path.read_text(encoding="utf-8")
|
||||
|
||||
|
||||
class TestSeedIntegration(unittest.TestCase):
|
||||
def test_creates_file_and_adds_entry_when_missing(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
self.assertFalse(p.exists())
|
||||
|
||||
cp = run_seed(p, "docker.test", "appdb", "alice", "secret")
|
||||
|
||||
self.assertEqual(cp.returncode, 0)
|
||||
self.assertTrue(p.exists())
|
||||
|
||||
rows = read_csv_semicolon(p)
|
||||
self.assertEqual(len(rows), 1)
|
||||
self.assertEqual(rows[0]["instance"], "docker.test")
|
||||
self.assertEqual(rows[0]["database"], "appdb")
|
||||
self.assertEqual(rows[0]["username"], "alice")
|
||||
self.assertEqual(rows[0]["password"], "secret")
|
||||
|
||||
def test_replaces_existing_entry_same_instance_and_database_updates_username_and_password(
|
||||
self,
|
||||
) -> None:
|
||||
"""
|
||||
Replacement semantics:
|
||||
- Key is (instance, database)
|
||||
- username/password are updated in-place
|
||||
"""
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
run_seed(p, "docker.test", "appdb", "alice", "oldpw")
|
||||
rows = read_csv_semicolon(p)
|
||||
self.assertEqual(len(rows), 1)
|
||||
self.assertEqual(rows[0]["username"], "alice")
|
||||
self.assertEqual(rows[0]["password"], "oldpw")
|
||||
|
||||
run_seed(p, "docker.test", "appdb", "bob", "newpw")
|
||||
rows = read_csv_semicolon(p)
|
||||
|
||||
self.assertEqual(len(rows), 1, "Expected replacement, not a duplicate row")
|
||||
self.assertEqual(rows[0]["instance"], "docker.test")
|
||||
self.assertEqual(rows[0]["database"], "appdb")
|
||||
self.assertEqual(rows[0]["username"], "bob")
|
||||
self.assertEqual(rows[0]["password"], "newpw")
|
||||
|
||||
def test_allows_star_database_for_dump_all(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
cp = run_seed(p, "bigbluebutton", "*", "postgres", "pw")
|
||||
self.assertEqual(cp.returncode, 0)
|
||||
|
||||
rows = read_csv_semicolon(p)
|
||||
self.assertEqual(len(rows), 1)
|
||||
self.assertEqual(rows[0]["instance"], "bigbluebutton")
|
||||
self.assertEqual(rows[0]["database"], "*")
|
||||
self.assertEqual(rows[0]["username"], "postgres")
|
||||
self.assertEqual(rows[0]["password"], "pw")
|
||||
|
||||
def test_replaces_existing_star_entry(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
run_seed(p, "bigbluebutton", "*", "postgres", "pw1")
|
||||
run_seed(p, "bigbluebutton", "*", "postgres", "pw2")
|
||||
|
||||
rows = read_csv_semicolon(p)
|
||||
self.assertEqual(len(rows), 1)
|
||||
self.assertEqual(rows[0]["database"], "*")
|
||||
self.assertEqual(rows[0]["password"], "pw2")
|
||||
|
||||
def test_rejects_empty_database_value(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
cp = run_seed_expect_fail(p, "docker.test", "", "alice", "pw")
|
||||
self.assertNotEqual(cp.returncode, 0)
|
||||
|
||||
combined = ((cp.stdout or "") + "\n" + (cp.stderr or "")).lower()
|
||||
self.assertIn("error:", combined)
|
||||
self.assertIn("database", combined)
|
||||
self.assertIn("not empty", combined)
|
||||
|
||||
self.assertFalse(p.exists(), "Should not create file on invalid input")
|
||||
|
||||
def test_rejects_invalid_database_name_characters(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
cp = run_seed_expect_fail(p, "docker.test", "app db", "alice", "pw")
|
||||
self.assertNotEqual(cp.returncode, 0)
|
||||
|
||||
combined = ((cp.stdout or "") + "\n" + (cp.stderr or "")).lower()
|
||||
self.assertIn("error:", combined)
|
||||
self.assertIn("invalid database name", combined)
|
||||
|
||||
self.assertFalse(p.exists(), "Should not create file on invalid input")
|
||||
|
||||
def test_rejects_nan_database_name(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
cp = run_seed_expect_fail(p, "docker.test", "nan", "alice", "pw")
|
||||
self.assertNotEqual(cp.returncode, 0)
|
||||
|
||||
combined = ((cp.stdout or "") + "\n" + (cp.stderr or "")).lower()
|
||||
self.assertIn("error:", combined)
|
||||
self.assertIn("must not be 'nan'", combined)
|
||||
|
||||
self.assertFalse(p.exists(), "Should not create file on invalid input")
|
||||
|
||||
def test_accepts_hyphen_and_underscore_database_names(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
run_seed(p, "docker.test", "my_db-1", "alice", "pw")
|
||||
|
||||
rows = read_csv_semicolon(p)
|
||||
self.assertEqual(len(rows), 1)
|
||||
self.assertEqual(rows[0]["database"], "my_db-1")
|
||||
|
||||
def test_file_is_semicolon_delimited_and_has_header(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
p = Path(td) / "databases.csv"
|
||||
|
||||
run_seed(p, "docker.test", "appdb", "alice", "pw")
|
||||
|
||||
txt = read_text(p)
|
||||
self.assertTrue(
|
||||
txt.startswith("instance;database;username;password"),
|
||||
f"Unexpected header / delimiter in file:\n{txt}",
|
||||
)
|
||||
self.assertIn(";", txt)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
0
tests/unit/__init__.py
Normal file
0
tests/unit/__init__.py
Normal file
10
tests/unit/backup/__init__.py
Normal file
10
tests/unit/backup/__init__.py
Normal file
@@ -0,0 +1,10 @@
|
||||
"""The smallest argv the backup CLI accepts, shared by every test that drives it."""
|
||||
|
||||
REQUIRED_PAIRS = [
|
||||
("--compose-dir", "/compose"),
|
||||
("--backups-dir", "/backups"),
|
||||
("--repo-name", "stack"),
|
||||
("--databases-csv", "/etc/baudolo/databases.csv"),
|
||||
]
|
||||
REQUIRED = [arg for pair in REQUIRED_PAIRS for arg in pair]
|
||||
BASE_ARGV = ["baudolo", *REQUIRED]
|
||||
44
tests/unit/backup/compose_fixture.py
Normal file
44
tests/unit/backup/compose_fixture.py
Normal file
@@ -0,0 +1,44 @@
|
||||
"""Builds the on-disk compose directories the compose tests discover."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def touch(p: Path) -> None:
|
||||
p.parent.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# ".env/env" leaves ".env" behind as a directory, which blocks a later ".env" file.
|
||||
if p.exists() and p.is_dir():
|
||||
shutil.rmtree(p)
|
||||
|
||||
p.write_text("x", encoding="utf-8")
|
||||
|
||||
|
||||
def setup_compose_dir(
|
||||
tmp_path: Path,
|
||||
name: str = "mailu",
|
||||
*,
|
||||
compose_name: str = "docker-compose.yml",
|
||||
with_override: bool = False,
|
||||
with_ca_override: bool = False,
|
||||
env_layout: str | None = None, # None | ".env" | ".env/env"
|
||||
) -> Path:
|
||||
d = tmp_path / name
|
||||
d.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
touch(d / compose_name)
|
||||
|
||||
if with_override:
|
||||
touch(d / "docker-compose.override.yml")
|
||||
|
||||
if with_ca_override:
|
||||
touch(d / "docker-compose.ca.override.yml")
|
||||
|
||||
if env_layout == ".env":
|
||||
touch(d / ".env")
|
||||
elif env_layout == ".env/env":
|
||||
touch(d / ".env" / "env")
|
||||
|
||||
return d
|
||||
75
tests/unit/backup/test_app_databases_csv.py
Normal file
75
tests/unit/backup/test_app_databases_csv.py
Normal file
@@ -0,0 +1,75 @@
|
||||
import io
|
||||
import os
|
||||
import tempfile
|
||||
import unittest
|
||||
from contextlib import redirect_stderr
|
||||
|
||||
import pandas as pd
|
||||
|
||||
# Adjust if your package name/import path differs.
|
||||
from baudolo.backup.dumps import load_databases_df
|
||||
|
||||
EXPECTED_COLUMNS = ["instance", "database", "username", "password"]
|
||||
|
||||
|
||||
class TestLoadDatabasesDf(unittest.TestCase):
|
||||
def test_missing_csv_is_handled_with_warning_and_empty_df(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
missing_path = os.path.join(td, "does-not-exist.csv")
|
||||
|
||||
buf = io.StringIO()
|
||||
with redirect_stderr(buf):
|
||||
df = load_databases_df(missing_path)
|
||||
|
||||
stderr = buf.getvalue()
|
||||
self.assertIn("WARNING:", stderr)
|
||||
self.assertIn("databases.csv not found", stderr)
|
||||
|
||||
self.assertIsInstance(df, pd.DataFrame)
|
||||
self.assertListEqual(list(df.columns), EXPECTED_COLUMNS)
|
||||
self.assertTrue(df.empty)
|
||||
|
||||
def test_empty_csv_is_handled_with_warning_and_empty_df(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
empty_path = os.path.join(td, "databases.csv")
|
||||
with open(empty_path, "w", encoding="utf-8") as f:
|
||||
f.write("")
|
||||
|
||||
buf = io.StringIO()
|
||||
with redirect_stderr(buf):
|
||||
df = load_databases_df(empty_path)
|
||||
|
||||
stderr = buf.getvalue()
|
||||
self.assertIn("WARNING:", stderr)
|
||||
self.assertIn("exists but is empty", stderr)
|
||||
|
||||
self.assertIsInstance(df, pd.DataFrame)
|
||||
self.assertListEqual(list(df.columns), EXPECTED_COLUMNS)
|
||||
self.assertTrue(df.empty)
|
||||
|
||||
def test_valid_csv_loads_without_warning(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
csv_path = os.path.join(td, "databases.csv")
|
||||
|
||||
content = "instance;database;username;password\nmyapp;*;dbuser;secret\n"
|
||||
with open(csv_path, "w", encoding="utf-8") as f:
|
||||
f.write(content)
|
||||
|
||||
buf = io.StringIO()
|
||||
with redirect_stderr(buf):
|
||||
df = load_databases_df(csv_path)
|
||||
|
||||
stderr = buf.getvalue()
|
||||
self.assertEqual(stderr, "") # no warning expected
|
||||
|
||||
self.assertIsInstance(df, pd.DataFrame)
|
||||
self.assertListEqual(list(df.columns), EXPECTED_COLUMNS)
|
||||
self.assertEqual(len(df), 1)
|
||||
self.assertEqual(df.loc[0, "instance"], "myapp")
|
||||
self.assertEqual(df.loc[0, "database"], "*")
|
||||
self.assertEqual(df.loc[0, "username"], "dbuser")
|
||||
self.assertEqual(df.loc[0, "password"], "secret")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
65
tests/unit/backup/test_app_only_files.py
Normal file
65
tests/unit/backup/test_app_only_files.py
Normal file
@@ -0,0 +1,65 @@
|
||||
"""Contract of --only-files: no dump is attempted, every volume is copied."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup import app
|
||||
from baudolo.backup.volume import Backing
|
||||
|
||||
from . import REQUIRED_PAIRS
|
||||
|
||||
ARGV_WITHOUT_CSV = [
|
||||
"baudolo",
|
||||
*[arg for pair in REQUIRED_PAIRS if pair[0] != "--databases-csv" for arg in pair],
|
||||
"--only-files",
|
||||
]
|
||||
|
||||
|
||||
def drive(argv: list[str]) -> tuple[list[str], list, list]:
|
||||
backed_up: list[str] = []
|
||||
|
||||
def record_backup(versions_dir, volume_name, volume_dir, *, authoritative, source):
|
||||
backed_up.append(volume_name)
|
||||
|
||||
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") as load_csv,
|
||||
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") as dumps,
|
||||
mock.patch.object(app, "inspect_backing", return_value=Backing("/data")),
|
||||
mock.patch.object(app, "stamp_directory"),
|
||||
mock.patch.object(app, "handle_docker_compose_services"),
|
||||
mock.patch.object(app.os.path, "isdir", return_value=True),
|
||||
mock.patch.object(app, "backup_volume", side_effect=record_backup),
|
||||
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 backed_up, dumps.mock_calls, load_csv.mock_calls
|
||||
|
||||
|
||||
class TestOnlyFiles(unittest.TestCase):
|
||||
def test_no_dump_is_attempted(self) -> None:
|
||||
_backed_up, dumps, _load_csv = drive(ARGV_WITHOUT_CSV)
|
||||
self.assertEqual(dumps, [])
|
||||
|
||||
def test_the_databases_csv_is_never_read(self) -> None:
|
||||
"""It may legitimately be absent, so reading it would abort the run."""
|
||||
_backed_up, _dumps, load_csv = drive(ARGV_WITHOUT_CSV)
|
||||
self.assertEqual(load_csv, [])
|
||||
|
||||
def test_the_volume_is_still_copied(self) -> None:
|
||||
backed_up, _dumps, _load_csv = drive(ARGV_WITHOUT_CSV)
|
||||
self.assertEqual(backed_up, ["pgdata"])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
91
tests/unit/backup/test_app_snapshot.py
Normal file
91
tests/unit/backup/test_app_snapshot.py
Normal file
@@ -0,0 +1,91 @@
|
||||
"""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 import snapshot as snapshot_mod
|
||||
from baudolo.backup.snapshot import volume_snapshot
|
||||
from baudolo.backup.volume import Backing
|
||||
|
||||
from . import BASE_ARGV
|
||||
|
||||
|
||||
def stubbed_snapshot(kind: str, subject: str, tag: str):
|
||||
return volume_snapshot(kind, subject, tag, run=lambda command: [])
|
||||
|
||||
|
||||
ARGV = [
|
||||
*BASE_ARGV,
|
||||
"--snapshot",
|
||||
"btrfs",
|
||||
"--snapshot-subject",
|
||||
"/var/lib/docker",
|
||||
]
|
||||
|
||||
|
||||
def drive(*, present: bool = True, reason: str | None = None) -> 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,
|
||||
"inspect_backing",
|
||||
return_value=Backing("/var/lib/docker/volumes/vol/_data"),
|
||||
),
|
||||
mock.patch.object(snapshot_mod, "unsnapshotted", return_value=reason),
|
||||
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/docker/.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"])
|
||||
|
||||
def test_a_volume_with_its_own_backing_store_is_copied_live(self) -> None:
|
||||
call = drive(reason="it declares its own backing store")[0]
|
||||
self.assertEqual(call["source"], "/var/lib/docker/volumes/vol/_data/")
|
||||
self.assertFalse(
|
||||
call["authoritative"],
|
||||
"the snapshot holds an empty directory for it, not its data",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
81
tests/unit/backup/test_app_volumes_no_backup_required.py
Normal file
81
tests/unit/backup/test_app_volumes_no_backup_required.py
Normal file
@@ -0,0 +1,81 @@
|
||||
"""Contract of --volumes-no-backup-required: exclusion is per volume name,
|
||||
independent of which containers use it."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup import app
|
||||
from baudolo.backup.volume import Backing
|
||||
|
||||
from . import BASE_ARGV
|
||||
|
||||
ARGV = [
|
||||
*BASE_ARGV,
|
||||
"--volumes-no-backup-required",
|
||||
"derived",
|
||||
]
|
||||
|
||||
|
||||
def drive() -> tuple[list[str], list[str], list[str]]:
|
||||
backed_up: list[str] = []
|
||||
created: list[str] = []
|
||||
inspected: list[str] = []
|
||||
|
||||
def record_backup(versions_dir, volume_name, volume_dir, *, authoritative, source):
|
||||
backed_up.append(volume_name)
|
||||
|
||||
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",
|
||||
side_effect=lambda _version_dir, name: created.append(name) or "/gen/vol",
|
||||
),
|
||||
mock.patch.object(app, "load_databases_df", return_value=None),
|
||||
mock.patch.object(
|
||||
app, "docker_volume_names", return_value=["derived", "state"]
|
||||
),
|
||||
mock.patch.object(
|
||||
app,
|
||||
"containers_using_volume",
|
||||
side_effect=lambda name: inspected.append(name) or ["app"],
|
||||
),
|
||||
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, "inspect_backing", return_value=Backing("/data")),
|
||||
mock.patch.object(app, "stamp_directory"),
|
||||
mock.patch.object(app, "handle_docker_compose_services"),
|
||||
mock.patch.object(app.os.path, "isdir", return_value=True),
|
||||
mock.patch.object(app, "backup_volume", side_effect=record_backup),
|
||||
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 backed_up, created, inspected
|
||||
|
||||
|
||||
class TestVolumesNoBackupRequired(unittest.TestCase):
|
||||
def test_the_named_volume_is_never_backed_up(self) -> None:
|
||||
backed_up, _created, _inspected = drive()
|
||||
self.assertNotIn("derived", backed_up)
|
||||
|
||||
def test_a_sibling_volume_of_the_same_container_survives(self) -> None:
|
||||
backed_up, _created, _inspected = drive()
|
||||
self.assertEqual(backed_up, ["state"])
|
||||
|
||||
def test_no_generation_directory_is_created_for_it(self) -> None:
|
||||
_backed_up, created, _inspected = drive()
|
||||
self.assertEqual(created, ["state"])
|
||||
|
||||
def test_the_skip_precedes_the_container_inspection(self) -> None:
|
||||
_backed_up, _created, inspected = drive()
|
||||
self.assertEqual(inspected, ["state"])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
110
tests/unit/backup/test_cli.py
Normal file
110
tests/unit/backup/test_cli.py
Normal file
@@ -0,0 +1,110 @@
|
||||
"""Contract of the backup CLI, in particular the snapshot flag pairing."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup.cli import parse_args
|
||||
|
||||
from . import REQUIRED, REQUIRED_PAIRS
|
||||
|
||||
|
||||
def parse(*extra: str):
|
||||
with mock.patch("sys.argv", ["baudolo", *REQUIRED, *extra]):
|
||||
return parse_args()
|
||||
|
||||
|
||||
class TestSnapshotFlags(unittest.TestCase):
|
||||
def test_no_snapshot_by_default(self) -> None:
|
||||
args = parse()
|
||||
self.assertIsNone(args.snapshot)
|
||||
self.assertIsNone(args.snapshot_subject)
|
||||
|
||||
def test_both_flags_together_are_accepted(self) -> None:
|
||||
args = parse("--snapshot", "btrfs", "--snapshot-subject", "/var/lib/docker")
|
||||
self.assertEqual(args.snapshot, "btrfs")
|
||||
self.assertEqual(args.snapshot_subject, "/var/lib/docker")
|
||||
|
||||
def test_the_kind_alone_is_rejected(self) -> None:
|
||||
with self.assertRaises(SystemExit):
|
||||
parse("--snapshot", "btrfs")
|
||||
|
||||
def test_the_subject_alone_is_rejected(self) -> None:
|
||||
with self.assertRaises(SystemExit):
|
||||
parse("--snapshot-subject", "/var/lib/docker")
|
||||
|
||||
def test_an_unsupported_kind_is_rejected(self) -> None:
|
||||
with self.assertRaises(SystemExit):
|
||||
parse("--snapshot", "ext4", "--snapshot-subject", "/var/lib/docker")
|
||||
|
||||
def test_zfs_is_accepted(self) -> None:
|
||||
self.assertEqual(
|
||||
parse("--snapshot", "zfs", "--snapshot-subject", "/d").snapshot, "zfs"
|
||||
)
|
||||
|
||||
def test_shutdown_is_rejected_because_nothing_is_stopped(self) -> None:
|
||||
with self.assertRaises(SystemExit):
|
||||
parse("--snapshot", "btrfs", "--snapshot-subject", "/d", "--shutdown")
|
||||
|
||||
def test_shutdown_stays_available_without_a_snapshot(self) -> None:
|
||||
self.assertTrue(parse("--shutdown").shutdown)
|
||||
|
||||
def test_hard_restart_is_rejected_because_nothing_is_stopped(self) -> None:
|
||||
with self.assertRaises(SystemExit):
|
||||
parse(
|
||||
"--snapshot",
|
||||
"btrfs",
|
||||
"--snapshot-subject",
|
||||
"/d",
|
||||
"--hard-restart-projects",
|
||||
"mailu",
|
||||
)
|
||||
|
||||
def test_hard_restart_stays_available_without_a_snapshot(self) -> None:
|
||||
self.assertEqual(
|
||||
parse("--hard-restart-projects", "mailu").hard_restart_projects, ["mailu"]
|
||||
)
|
||||
|
||||
|
||||
class TestRequiredFlags(unittest.TestCase):
|
||||
def test_no_flag_falls_back_to_a_default(self) -> None:
|
||||
for omitted, _ in REQUIRED_PAIRS:
|
||||
argv = [a for pair in REQUIRED_PAIRS if pair[0] != omitted for a in pair]
|
||||
with (
|
||||
self.subTest(omitted=omitted),
|
||||
mock.patch("sys.argv", ["baudolo", *argv]),
|
||||
self.assertRaises(SystemExit),
|
||||
):
|
||||
parse_args()
|
||||
|
||||
|
||||
class TestBackupScope(unittest.TestCase):
|
||||
"""--only-sql and --only-files name the two halves a generation can hold."""
|
||||
|
||||
def test_both_halves_by_default(self) -> None:
|
||||
args = parse()
|
||||
self.assertFalse(args.only_sql)
|
||||
self.assertFalse(args.only_files)
|
||||
|
||||
def test_either_half_alone_is_accepted(self) -> None:
|
||||
self.assertTrue(parse("--only-sql").only_sql)
|
||||
self.assertTrue(parse("--only-files").only_files)
|
||||
|
||||
def test_asking_for_both_halves_alone_is_rejected(self) -> None:
|
||||
with self.assertRaises(SystemExit):
|
||||
parse("--only-sql", "--only-files")
|
||||
|
||||
def test_only_files_needs_no_databases_csv(self) -> None:
|
||||
argv = [
|
||||
arg
|
||||
for pair in REQUIRED_PAIRS
|
||||
if pair[0] != "--databases-csv"
|
||||
for arg in pair
|
||||
]
|
||||
with mock.patch("sys.argv", ["baudolo", *argv, "--only-files"]):
|
||||
self.assertIsNone(parse_args().databases_csv)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
212
tests/unit/backup/test_compose.py
Normal file
212
tests/unit/backup/test_compose.py
Normal file
@@ -0,0 +1,212 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest.mock import patch
|
||||
|
||||
from .compose_fixture import setup_compose_dir as _setup_compose_dir
|
||||
|
||||
|
||||
class TestCompose(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls) -> None:
|
||||
from baudolo.backup import compose as mod
|
||||
|
||||
cls.compose_mod = mod
|
||||
|
||||
def test_find_compose_file_supports_all_valid_names_case_insensitive(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
tmp_path = Path(td)
|
||||
|
||||
variants = [
|
||||
"compose.yml",
|
||||
"compose.yaml",
|
||||
"docker-compose.yml",
|
||||
"docker-compose.yaml",
|
||||
"docker-compose.yAml",
|
||||
]
|
||||
|
||||
for i, name in enumerate(variants):
|
||||
d = _setup_compose_dir(
|
||||
tmp_path,
|
||||
name=f"project{i}",
|
||||
compose_name=name,
|
||||
)
|
||||
found = self.compose_mod._find_compose_file(str(d))
|
||||
self.assertIsNotNone(found)
|
||||
self.assertEqual(found.name, name)
|
||||
|
||||
def test_find_compose_file_returns_none_when_missing(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
tmp_path = Path(td)
|
||||
d = tmp_path / "empty"
|
||||
d.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
found = self.compose_mod._find_compose_file(str(d))
|
||||
self.assertIsNone(found)
|
||||
|
||||
def test_build_cmd_uses_wrapper_when_present(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
tmp_path = Path(td)
|
||||
d = _setup_compose_dir(
|
||||
tmp_path,
|
||||
with_override=True,
|
||||
with_ca_override=True,
|
||||
env_layout=".env",
|
||||
)
|
||||
|
||||
def fake_which(name: str):
|
||||
if name == "compose":
|
||||
return "/usr/local/bin/compose"
|
||||
return None
|
||||
|
||||
with patch.object(self.compose_mod.shutil, "which", fake_which):
|
||||
cmd = self.compose_mod._build_compose_cmd(str(d), ["up", "-d"])
|
||||
|
||||
self.assertEqual(
|
||||
cmd,
|
||||
[
|
||||
"/usr/local/bin/compose",
|
||||
"--chdir",
|
||||
str(d.resolve()),
|
||||
"--",
|
||||
"up",
|
||||
"-d",
|
||||
],
|
||||
)
|
||||
|
||||
def test_build_cmd_fallback_uses_plain_docker_compose_chdir(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
tmp_path = Path(td)
|
||||
d = _setup_compose_dir(
|
||||
tmp_path,
|
||||
with_override=True,
|
||||
with_ca_override=True,
|
||||
env_layout=".env",
|
||||
)
|
||||
|
||||
def fake_which(name: str):
|
||||
if name == "compose":
|
||||
return None
|
||||
if name == "docker":
|
||||
return "/usr/bin/docker"
|
||||
return None
|
||||
|
||||
with patch.object(self.compose_mod.shutil, "which", fake_which):
|
||||
cmd = self.compose_mod._build_compose_cmd(
|
||||
str(d), ["up", "-d", "--force-recreate"]
|
||||
)
|
||||
|
||||
expected: list[str] = [
|
||||
"/usr/bin/docker",
|
||||
"compose",
|
||||
"--chdir",
|
||||
str(d.resolve()),
|
||||
"up",
|
||||
"-d",
|
||||
"--force-recreate",
|
||||
]
|
||||
self.assertEqual(cmd, expected)
|
||||
|
||||
def test_hard_restart_calls_run_twice_with_correct_cmds_wrapper(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
tmp_path = Path(td)
|
||||
d = _setup_compose_dir(tmp_path, name="mailu", env_layout=".env")
|
||||
|
||||
def fake_which(name: str):
|
||||
if name == "compose":
|
||||
return "/usr/local/bin/compose"
|
||||
return None
|
||||
|
||||
with patch.object(self.compose_mod.shutil, "which", fake_which):
|
||||
calls = []
|
||||
|
||||
def fake_run(cmd, check: bool):
|
||||
calls.append((cmd, check))
|
||||
return 0
|
||||
|
||||
with patch.object(self.compose_mod.subprocess, "run", fake_run):
|
||||
self.compose_mod.hard_restart_docker_services(str(d))
|
||||
|
||||
self.assertEqual(
|
||||
calls,
|
||||
[
|
||||
(
|
||||
[
|
||||
"/usr/local/bin/compose",
|
||||
"--chdir",
|
||||
str(d.resolve()),
|
||||
"--",
|
||||
"down",
|
||||
],
|
||||
True,
|
||||
),
|
||||
(
|
||||
[
|
||||
"/usr/local/bin/compose",
|
||||
"--chdir",
|
||||
str(d.resolve()),
|
||||
"--",
|
||||
"up",
|
||||
"-d",
|
||||
],
|
||||
True,
|
||||
),
|
||||
],
|
||||
)
|
||||
|
||||
def test_hard_restart_calls_run_twice_with_correct_cmds_fallback(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as td:
|
||||
tmp_path = Path(td)
|
||||
d = _setup_compose_dir(
|
||||
tmp_path,
|
||||
name="mailu",
|
||||
with_override=True,
|
||||
with_ca_override=True,
|
||||
env_layout=".env/env",
|
||||
)
|
||||
|
||||
def fake_which(name: str):
|
||||
if name == "compose":
|
||||
return None
|
||||
if name == "docker":
|
||||
return "/usr/bin/docker"
|
||||
return None
|
||||
|
||||
with patch.object(self.compose_mod.shutil, "which", fake_which):
|
||||
calls = []
|
||||
|
||||
def fake_run(cmd, check: bool):
|
||||
calls.append((cmd, check))
|
||||
return 0
|
||||
|
||||
with patch.object(self.compose_mod.subprocess, "run", fake_run):
|
||||
self.compose_mod.hard_restart_docker_services(str(d))
|
||||
|
||||
self.assertEqual(
|
||||
calls,
|
||||
[
|
||||
(
|
||||
[
|
||||
"/usr/bin/docker",
|
||||
"compose",
|
||||
"--chdir",
|
||||
str(d.resolve()),
|
||||
"down",
|
||||
],
|
||||
True,
|
||||
),
|
||||
(
|
||||
[
|
||||
"/usr/bin/docker",
|
||||
"compose",
|
||||
"--chdir",
|
||||
str(d.resolve()),
|
||||
"up",
|
||||
"-d",
|
||||
],
|
||||
True,
|
||||
),
|
||||
],
|
||||
)
|
||||
45
tests/unit/backup/test_compose_hard_restart.py
Normal file
45
tests/unit/backup/test_compose_hard_restart.py
Normal file
@@ -0,0 +1,45 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
from . import BASE_ARGV
|
||||
|
||||
|
||||
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 = [
|
||||
*BASE_ARGV,
|
||||
"--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"])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main(verbosity=2)
|
||||
105
tests/unit/backup/test_db_mariadb_dump.py
Normal file
105
tests/unit/backup/test_db_mariadb_dump.py
Normal file
@@ -0,0 +1,105 @@
|
||||
import tempfile
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
import pandas
|
||||
|
||||
from baudolo.backup import db as db_mod
|
||||
|
||||
|
||||
def _df(rows):
|
||||
return pandas.DataFrame(
|
||||
rows, columns=["instance", "database", "username", "password"]
|
||||
)
|
||||
|
||||
|
||||
def _capture_dumps(*, db_type, rows, container, dump_tool="mariadb-dump"):
|
||||
"""Every (argv, env) the dump path would have run."""
|
||||
captured = []
|
||||
|
||||
def _capture(command, out_file, *, env=None):
|
||||
captured.append((list(command), env))
|
||||
|
||||
with (
|
||||
tempfile.TemporaryDirectory() as td,
|
||||
patch.object(db_mod, "execute_to_file", side_effect=_capture),
|
||||
):
|
||||
db_mod.backup_database(
|
||||
container=container,
|
||||
volume_dir=td,
|
||||
db_type=db_type,
|
||||
dump_tool=dump_tool,
|
||||
databases_df=_df(rows),
|
||||
database_containers=[container],
|
||||
)
|
||||
return captured
|
||||
|
||||
|
||||
class TestMariaDBDumpUsesTCP(unittest.TestCase):
|
||||
# Regression guard for 'Access denied for user <user>@localhost' when only
|
||||
# '<user>'@'%' is granted: the in-container mariadb-dump MUST force TCP so
|
||||
# the connection is auth-matched against '%' instead of socket->localhost.
|
||||
|
||||
def test_mariadb_dump_forces_tcp_loopback(self):
|
||||
captured = _capture_dumps(
|
||||
db_type="mariadb",
|
||||
rows=[("mariadb", "appdb", "appuser", "s3cret")],
|
||||
container="mariadb",
|
||||
)
|
||||
self.assertEqual(len(captured), 1, f"expected one dump, got: {captured}")
|
||||
|
||||
argv, env = captured[0]
|
||||
self.assertEqual(argv[:3], ["docker", "exec", "mariadb"])
|
||||
self.assertIn("--protocol=tcp", argv)
|
||||
self.assertEqual(argv[argv.index("-h") + 1], "127.0.0.1")
|
||||
self.assertEqual(argv[argv.index("-u") + 1], "appuser")
|
||||
self.assertIn("-ps3cret", argv)
|
||||
self.assertEqual(argv[-1], "appdb")
|
||||
self.assertIsNone(env)
|
||||
|
||||
def test_the_probed_client_is_the_one_invoked(self):
|
||||
captured = _capture_dumps(
|
||||
db_type="mariadb",
|
||||
rows=[("mariadb", "appdb", "appuser", "s3cret")],
|
||||
container="mariadb",
|
||||
dump_tool="mysqldump",
|
||||
)
|
||||
argv, _env = captured[0]
|
||||
self.assertIn("mysqldump", argv)
|
||||
self.assertNotIn("mariadb-dump", argv)
|
||||
|
||||
def test_postgres_dump_unaffected(self):
|
||||
captured = _capture_dumps(
|
||||
db_type="postgres",
|
||||
rows=[("pg", "appdb", "appuser", "s3cret")],
|
||||
container="pg",
|
||||
)
|
||||
argv, _env = captured[0]
|
||||
self.assertIn("pg_dump", argv)
|
||||
self.assertNotIn("--protocol=tcp", argv)
|
||||
|
||||
def test_the_password_travels_in_the_environment_not_the_argv(self):
|
||||
"""A process listing shows argv; PGPASSWORD must not be in it."""
|
||||
captured = _capture_dumps(
|
||||
db_type="postgres",
|
||||
rows=[("pg", "appdb", "appuser", "s3cret")],
|
||||
container="pg",
|
||||
)
|
||||
argv, env = captured[0]
|
||||
self.assertEqual(env, {"PGPASSWORD": "s3cret"})
|
||||
self.assertNotIn("s3cret", argv)
|
||||
|
||||
|
||||
class TestNoShellReachesTheDump(unittest.TestCase):
|
||||
def test_a_hostile_database_name_never_reaches_a_command(self):
|
||||
"""validate_database refuses it, so no argv is built at all."""
|
||||
with self.assertRaises(ValueError):
|
||||
_capture_dumps(
|
||||
db_type="postgres",
|
||||
rows=[("pg", "app;rm -rf /", "appuser", "s3cret")],
|
||||
container="pg",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main(verbosity=2)
|
||||
53
tests/unit/backup/test_docker_swarm.py
Normal file
53
tests/unit/backup/test_docker_swarm.py
Normal file
@@ -0,0 +1,53 @@
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
from baudolo.backup import docker as docker_mod
|
||||
from baudolo.backup.shell import BackupException
|
||||
|
||||
|
||||
class TestIsSwarmTask(unittest.TestCase):
|
||||
@patch.object(docker_mod, "execute_shell_command", return_value=["task-id-123"])
|
||||
def test_true_when_task_label_present(self, _mock) -> None:
|
||||
self.assertTrue(docker_mod.is_swarm_task("c1"))
|
||||
|
||||
@patch.object(docker_mod, "execute_shell_command", return_value=[""])
|
||||
def test_false_when_label_empty(self, _mock) -> None:
|
||||
self.assertFalse(docker_mod.is_swarm_task("c1"))
|
||||
|
||||
@patch.object(docker_mod, "execute_shell_command", return_value=[])
|
||||
def test_false_when_no_output(self, _mock) -> None:
|
||||
self.assertFalse(docker_mod.is_swarm_task("c1"))
|
||||
|
||||
@patch.object(
|
||||
docker_mod,
|
||||
"execute_shell_command",
|
||||
side_effect=[BackupException("gone"), []],
|
||||
)
|
||||
def test_vanished_container_counts_as_not_stoppable(self, _mock) -> None:
|
||||
# A container removed between listing and inspect must not abort the
|
||||
# whole backup run; treating it as a swarm task keeps it out of every
|
||||
# stop/start and image-inspect path.
|
||||
self.assertTrue(docker_mod.is_swarm_task("gone-container"))
|
||||
|
||||
@patch.object(
|
||||
docker_mod,
|
||||
"execute_shell_command",
|
||||
side_effect=[BackupException("daemon hiccup"), ["still-here"]],
|
||||
)
|
||||
def test_inspect_failure_on_existing_container_still_fails(self, _mock) -> None:
|
||||
# If the container still exists, an inspect failure must keep failing
|
||||
# the run: silently skipping the stop would back up a hot volume and
|
||||
# report green without the stop guarantee.
|
||||
with self.assertRaises(BackupException):
|
||||
docker_mod.is_swarm_task("still-here")
|
||||
|
||||
|
||||
class TestFilterStoppable(unittest.TestCase):
|
||||
@patch.object(docker_mod, "is_swarm_task", side_effect=[False, True, False])
|
||||
def test_mixed_list_keeps_order_and_drops_tasks(self, _mock) -> None:
|
||||
result = docker_mod.filter_stoppable(["plain-1", "swarm-task", "plain-2"])
|
||||
self.assertEqual(result, ["plain-1", "plain-2"])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
44
tests/unit/backup/test_docker_tool_probe.py
Normal file
44
tests/unit/backup/test_docker_tool_probe.py
Normal file
@@ -0,0 +1,44 @@
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
from baudolo.backup import docker as docker_mod
|
||||
from baudolo.backup.shell import BackupException
|
||||
|
||||
|
||||
class TestImageId(unittest.TestCase):
|
||||
def test_the_id_is_returned_without_surrounding_whitespace(self) -> None:
|
||||
with patch.object(
|
||||
docker_mod, "execute_shell_command", return_value=["sha256:abc \n"]
|
||||
):
|
||||
self.assertEqual(docker_mod.image_id("c1"), "sha256:abc")
|
||||
|
||||
|
||||
class TestHasTool(unittest.TestCase):
|
||||
def test_a_tool_that_runs_is_present(self) -> None:
|
||||
with patch.object(docker_mod, "execute_shell_command", return_value=[]):
|
||||
self.assertTrue(docker_mod.has_tool("c1", "pg_dumpall"))
|
||||
|
||||
def test_a_tool_that_exits_non_zero_is_absent(self) -> None:
|
||||
with patch.object(
|
||||
docker_mod, "execute_shell_command", side_effect=BackupException("127")
|
||||
):
|
||||
self.assertFalse(docker_mod.has_tool("c1", "mariadb-dump"))
|
||||
|
||||
def test_the_probe_needs_no_shell_in_the_image(self) -> None:
|
||||
"""A distroless database ships no shell; `sh -c` would deny every tool."""
|
||||
captured = []
|
||||
|
||||
def _capture(cmd):
|
||||
captured.append(cmd)
|
||||
return []
|
||||
|
||||
with patch.object(docker_mod, "execute_shell_command", side_effect=_capture):
|
||||
docker_mod.has_tool("c1", "pg_dumpall")
|
||||
|
||||
self.assertEqual(
|
||||
captured, [["docker", "exec", "c1", "pg_dumpall", "--version"]]
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
138
tests/unit/backup/test_dumps_engine_detection.py
Normal file
138
tests/unit/backup/test_dumps_engine_detection.py
Normal file
@@ -0,0 +1,138 @@
|
||||
import unittest
|
||||
from unittest.mock import patch
|
||||
|
||||
import pandas
|
||||
|
||||
from baudolo.backup import dumps as dumps_mod
|
||||
|
||||
|
||||
def _df(rows):
|
||||
return pandas.DataFrame(
|
||||
rows, columns=["instance", "database", "username", "password"]
|
||||
)
|
||||
|
||||
|
||||
class _Probe:
|
||||
def __init__(self, available, image="sha256:aaa"):
|
||||
self.available = set(available)
|
||||
self.image = image
|
||||
self.calls = []
|
||||
|
||||
def has_tool(self, container, tool):
|
||||
self.calls.append((container, tool))
|
||||
return tool in self.available
|
||||
|
||||
def image_id(self, container):
|
||||
return self.image if isinstance(self.image, str) else self.image[container]
|
||||
|
||||
|
||||
def _detect(probe, container="c1"):
|
||||
dumps_mod._ENGINE_BY_IMAGE.clear()
|
||||
with (
|
||||
patch.object(dumps_mod, "has_tool", probe.has_tool),
|
||||
patch.object(dumps_mod, "image_id", probe.image_id),
|
||||
):
|
||||
return dumps_mod.container_engine(container)
|
||||
|
||||
|
||||
class TestContainerEngine(unittest.TestCase):
|
||||
def test_a_postgres_is_found_by_its_dump_tool(self):
|
||||
self.assertEqual(_detect(_Probe(["pg_dumpall"])), ("postgres", "pg_dumpall"))
|
||||
|
||||
def test_a_mariadb_is_found_by_its_dump_tool(self):
|
||||
self.assertEqual(_detect(_Probe(["mariadb-dump"])), ("mariadb", "mariadb-dump"))
|
||||
|
||||
def test_an_image_with_only_mysqldump_is_dumped_with_mysqldump(self):
|
||||
self.assertEqual(_detect(_Probe(["mysqldump"])), ("mariadb", "mysqldump"))
|
||||
|
||||
def test_a_container_without_either_tool_is_no_database(self):
|
||||
self.assertIsNone(_detect(_Probe([])))
|
||||
|
||||
def test_the_probe_stops_at_the_first_tool_it_finds(self):
|
||||
probe = _Probe(["pg_dumpall", "mariadb-dump"])
|
||||
_detect(probe)
|
||||
self.assertEqual(probe.calls, [("c1", "pg_dumpall")])
|
||||
|
||||
def test_the_image_name_does_not_decide_the_engine(self):
|
||||
"""The trap the old substring test fell into, from both directions."""
|
||||
probe = _Probe(["pg_dumpall"], image="svc-db-mariadb-mgr-01:5000/pg_custom")
|
||||
self.assertEqual(_detect(probe), ("postgres", "pg_dumpall"))
|
||||
|
||||
probe = _Probe(["mariadb-dump"], image="discourse-database:17")
|
||||
self.assertEqual(_detect(probe), ("mariadb", "mariadb-dump"))
|
||||
|
||||
|
||||
class TestProbeCache(unittest.TestCase):
|
||||
def test_replicas_of_one_image_are_probed_once(self):
|
||||
probe = _Probe(["pg_dumpall"])
|
||||
dumps_mod._ENGINE_BY_IMAGE.clear()
|
||||
with (
|
||||
patch.object(dumps_mod, "has_tool", probe.has_tool),
|
||||
patch.object(dumps_mod, "image_id", probe.image_id),
|
||||
):
|
||||
first = dumps_mod.container_engine("replica-1")
|
||||
second = dumps_mod.container_engine("replica-2")
|
||||
self.assertEqual(first, second)
|
||||
self.assertEqual(len(probe.calls), 1)
|
||||
|
||||
def test_a_second_image_is_probed_separately(self):
|
||||
probe = _Probe(["pg_dumpall"], image={"pg": "sha256:aaa", "app": "sha256:bbb"})
|
||||
dumps_mod._ENGINE_BY_IMAGE.clear()
|
||||
with (
|
||||
patch.object(dumps_mod, "has_tool", probe.has_tool),
|
||||
patch.object(dumps_mod, "image_id", probe.image_id),
|
||||
):
|
||||
self.assertEqual(
|
||||
dumps_mod.container_engine("pg"), ("postgres", "pg_dumpall")
|
||||
)
|
||||
probe.available = set()
|
||||
self.assertIsNone(dumps_mod.container_engine("app"))
|
||||
|
||||
|
||||
class TestBackupDispatch(unittest.TestCase):
|
||||
def test_the_probed_tool_reaches_the_dump(self):
|
||||
probe = _Probe(["mysqldump"])
|
||||
seen = {}
|
||||
|
||||
def _fake_backup_database(**kwargs):
|
||||
seen.update(kwargs)
|
||||
return True
|
||||
|
||||
dumps_mod._ENGINE_BY_IMAGE.clear()
|
||||
with (
|
||||
patch.object(dumps_mod, "has_tool", probe.has_tool),
|
||||
patch.object(dumps_mod, "image_id", probe.image_id),
|
||||
patch.object(dumps_mod, "backup_database", _fake_backup_database),
|
||||
):
|
||||
is_db, dumped = dumps_mod.backup_mariadb_or_postgres(
|
||||
container="c1",
|
||||
volume_dir="/tmp",
|
||||
databases_df=_df([("c1", "appdb", "u", "p")]),
|
||||
database_containers=["c1"],
|
||||
)
|
||||
|
||||
self.assertTrue(is_db)
|
||||
self.assertTrue(dumped)
|
||||
self.assertEqual(seen["db_type"], "mariadb")
|
||||
self.assertEqual(seen["dump_tool"], "mysqldump")
|
||||
|
||||
def test_a_non_database_container_is_left_to_the_file_backup(self):
|
||||
probe = _Probe([])
|
||||
dumps_mod._ENGINE_BY_IMAGE.clear()
|
||||
with (
|
||||
patch.object(dumps_mod, "has_tool", probe.has_tool),
|
||||
patch.object(dumps_mod, "image_id", probe.image_id),
|
||||
):
|
||||
self.assertEqual(
|
||||
dumps_mod.backup_mariadb_or_postgres(
|
||||
container="c1",
|
||||
volume_dir="/tmp",
|
||||
databases_df=_df([]),
|
||||
database_containers=[],
|
||||
),
|
||||
(False, False),
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
53
tests/unit/backup/test_layout.py
Normal file
53
tests/unit/backup/test_layout.py
Normal file
@@ -0,0 +1,53 @@
|
||||
"""Contract of where a backup run puts its directories."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup import layout as mod
|
||||
from baudolo.backup.shell import BackupException
|
||||
|
||||
|
||||
class TestVersionDirectory(unittest.TestCase):
|
||||
def test_it_creates_the_generation_directory(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
created = mod.create_version_directory(tmp, "20260731020304")
|
||||
self.assertTrue(Path(created).is_dir())
|
||||
self.assertEqual(Path(created).name, "20260731020304")
|
||||
|
||||
def test_it_refuses_a_generation_another_run_already_claimed(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
mod.create_version_directory(tmp, "20260731")
|
||||
with self.assertRaises(BackupException) as caught:
|
||||
mod.create_version_directory(tmp, "20260731")
|
||||
self.assertIn("20260731", str(caught.exception))
|
||||
|
||||
def test_it_creates_missing_parents(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
nested = str(Path(tmp) / "machine" / "repo")
|
||||
created = mod.create_version_directory(nested, "20260731")
|
||||
self.assertTrue(Path(created).is_dir())
|
||||
|
||||
|
||||
class TestVolumeDirectory(unittest.TestCase):
|
||||
def test_it_nests_the_volume_under_the_generation(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
created = mod.create_volume_directory(tmp, "postgres_data")
|
||||
self.assertEqual(Path(created).parent, Path(tmp))
|
||||
self.assertTrue(Path(created).is_dir())
|
||||
|
||||
|
||||
class TestMachineId(unittest.TestCase):
|
||||
def test_it_takes_the_hash_without_the_filename(self) -> None:
|
||||
digest = "a" * 64
|
||||
with mock.patch.object(
|
||||
mod, "execute_shell_command", return_value=[f"{digest} /etc/machine-id"]
|
||||
):
|
||||
self.assertEqual(mod.get_machine_id(), digest)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
68
tests/unit/backup/test_policy.py
Normal file
68
tests/unit/backup/test_policy.py
Normal file
@@ -0,0 +1,68 @@
|
||||
"""Contract of the rules deciding what is backed up and what must stop."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup import policy as mod
|
||||
|
||||
|
||||
class TestIsImageIgnored(unittest.TestCase):
|
||||
def test_an_empty_whitelist_ignores_nothing(self) -> None:
|
||||
self.assertFalse(mod.is_image_ignored("c1", []))
|
||||
|
||||
def test_a_listed_image_is_ignored(self) -> None:
|
||||
with mock.patch.object(mod, "get_image_info", return_value="alpine:3.20"):
|
||||
self.assertTrue(mod.is_image_ignored("c1", ["alpine:3.20"]))
|
||||
|
||||
def test_matching_is_exact(self) -> None:
|
||||
with mock.patch.object(mod, "get_image_info", return_value="alpine:3.21"):
|
||||
self.assertFalse(mod.is_image_ignored("c1", ["alpine:3.20"]))
|
||||
|
||||
|
||||
class TestVolumeIsFullyIgnored(unittest.TestCase):
|
||||
def test_a_volume_without_containers_is_kept(self) -> None:
|
||||
self.assertFalse(mod.volume_is_fully_ignored([], ["alpine:3.20"]))
|
||||
|
||||
def test_it_needs_every_container_to_be_ignored(self) -> None:
|
||||
with mock.patch.object(mod, "get_image_info", side_effect=["a", "b"]):
|
||||
self.assertFalse(mod.volume_is_fully_ignored(["c1", "c2"], ["a"]))
|
||||
|
||||
def test_all_ignored_skips_the_volume(self) -> None:
|
||||
with mock.patch.object(mod, "get_image_info", side_effect=["a", "a"]):
|
||||
self.assertTrue(mod.volume_is_fully_ignored(["c1", "c2"], ["a"]))
|
||||
|
||||
|
||||
class TestRequiresStop(unittest.TestCase):
|
||||
def test_no_containers_means_no_stop(self) -> None:
|
||||
self.assertFalse(mod.requires_stop([], []))
|
||||
|
||||
def test_a_swarm_task_never_forces_a_stop(self) -> None:
|
||||
with mock.patch.object(mod, "is_swarm_task", return_value=True):
|
||||
self.assertFalse(mod.requires_stop(["c1"], []))
|
||||
|
||||
def test_a_whitelisted_image_does_not_force_a_stop(self) -> None:
|
||||
with (
|
||||
mock.patch.object(mod, "is_swarm_task", return_value=False),
|
||||
mock.patch.object(mod, "get_image_info", return_value="alpine:3.20"),
|
||||
):
|
||||
self.assertFalse(mod.requires_stop(["c1"], ["alpine:3.20"]))
|
||||
|
||||
def test_an_unlisted_image_forces_a_stop(self) -> None:
|
||||
with (
|
||||
mock.patch.object(mod, "is_swarm_task", return_value=False),
|
||||
mock.patch.object(mod, "get_image_info", return_value="postgres:17"),
|
||||
):
|
||||
self.assertTrue(mod.requires_stop(["c1"], ["alpine:3.20"]))
|
||||
|
||||
def test_one_unlisted_container_is_enough(self) -> None:
|
||||
with (
|
||||
mock.patch.object(mod, "is_swarm_task", return_value=False),
|
||||
mock.patch.object(mod, "get_image_info", side_effect=["alpine:3.20", "x"]),
|
||||
):
|
||||
self.assertTrue(mod.requires_stop(["c1", "c2"], ["alpine:3.20"]))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
164
tests/unit/backup/test_snapshot.py
Normal file
164
tests/unit/backup/test_snapshot.py
Normal file
@@ -0,0 +1,164 @@
|
||||
"""Contract of the filesystem snapshot used to capture volumes atomically."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
|
||||
from baudolo.backup.shell import BackupException
|
||||
from baudolo.backup.snapshot import SnapshotError, volume_snapshot
|
||||
|
||||
|
||||
class Runner:
|
||||
def __init__(self, replies: dict[str, list[str]] | None = None) -> None:
|
||||
self.calls: list[list[str]] = []
|
||||
self.replies = replies or {}
|
||||
|
||||
def __call__(self, command: list[str]) -> list[str]:
|
||||
self.calls.append(list(command))
|
||||
for prefix, reply in self.replies.items():
|
||||
if " ".join(command).startswith(prefix):
|
||||
return reply
|
||||
return []
|
||||
|
||||
|
||||
class TestBtrfs(unittest.TestCase):
|
||||
def test_it_creates_a_read_only_snapshot_inside_the_subject(self) -> None:
|
||||
run = Runner()
|
||||
with volume_snapshot("btrfs", "/var/lib/docker", "20260731", run=run):
|
||||
pass
|
||||
self.assertEqual(
|
||||
run.calls[0],
|
||||
[
|
||||
"btrfs",
|
||||
"subvolume",
|
||||
"snapshot",
|
||||
"-r",
|
||||
"/var/lib/docker",
|
||||
"/var/lib/docker/.baudolo-20260731",
|
||||
],
|
||||
)
|
||||
|
||||
def test_it_removes_the_snapshot_afterwards(self) -> None:
|
||||
run = Runner()
|
||||
with volume_snapshot("btrfs", "/var/lib/docker", "20260731", run=run):
|
||||
pass
|
||||
self.assertEqual(
|
||||
run.calls[-1],
|
||||
["btrfs", "subvolume", "delete", "/var/lib/docker/.baudolo-20260731"],
|
||||
)
|
||||
|
||||
def test_it_maps_a_volume_path_into_the_snapshot(self) -> None:
|
||||
run = Runner()
|
||||
with volume_snapshot(
|
||||
"btrfs", "/var/lib/docker", "20260731", run=run
|
||||
) as resolve:
|
||||
self.assertEqual(
|
||||
resolve("/var/lib/docker/volumes/postgres_data/_data"),
|
||||
"/var/lib/docker/.baudolo-20260731/volumes/postgres_data/_data",
|
||||
)
|
||||
|
||||
def test_it_keeps_the_trailing_slash_rsync_reads_as_contents(self) -> None:
|
||||
run = Runner()
|
||||
with volume_snapshot(
|
||||
"btrfs", "/var/lib/docker", "20260731", run=run
|
||||
) as resolve:
|
||||
self.assertEqual(
|
||||
resolve("/var/lib/docker/volumes/postgres_data/_data/"),
|
||||
"/var/lib/docker/.baudolo-20260731/volumes/postgres_data/_data/",
|
||||
)
|
||||
|
||||
def test_it_removes_the_snapshot_even_when_the_body_raises(self) -> None:
|
||||
run = Runner()
|
||||
with (
|
||||
self.assertRaises(ZeroDivisionError),
|
||||
volume_snapshot("btrfs", "/var/lib/docker", "20260731", run=run),
|
||||
):
|
||||
raise ZeroDivisionError
|
||||
self.assertEqual(run.calls[-1][:3], ["btrfs", "subvolume", "delete"])
|
||||
|
||||
|
||||
class TestZfs(unittest.TestCase):
|
||||
def _run(self) -> Runner:
|
||||
return Runner({"zfs list": ["tank/docker"]})
|
||||
|
||||
def test_it_snapshots_the_dataset_mounted_at_the_subject(self) -> None:
|
||||
run = self._run()
|
||||
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run):
|
||||
pass
|
||||
self.assertIn(["zfs", "snapshot", "tank/docker@baudolo-20260731"], run.calls)
|
||||
|
||||
def test_it_destroys_the_snapshot_afterwards(self) -> None:
|
||||
run = self._run()
|
||||
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run):
|
||||
pass
|
||||
self.assertEqual(
|
||||
run.calls[-1], ["zfs", "destroy", "tank/docker@baudolo-20260731"]
|
||||
)
|
||||
|
||||
def test_it_maps_a_volume_path_through_the_dot_zfs_directory(self) -> None:
|
||||
run = self._run()
|
||||
with volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run) as resolve:
|
||||
self.assertEqual(
|
||||
resolve("/var/lib/docker/volumes/postgres_data/_data"),
|
||||
"/var/lib/docker/.zfs/snapshot/baudolo-20260731/volumes/postgres_data/_data",
|
||||
)
|
||||
|
||||
def test_an_unmounted_dataset_is_an_error(self) -> None:
|
||||
run = Runner({"zfs list": [""]})
|
||||
with (
|
||||
self.assertRaises(SnapshotError),
|
||||
volume_snapshot("zfs", "/var/lib/docker", "20260731", run=run),
|
||||
):
|
||||
pass
|
||||
|
||||
|
||||
class TestRejections(unittest.TestCase):
|
||||
def test_an_unknown_kind_is_rejected(self) -> None:
|
||||
run = Runner()
|
||||
with (
|
||||
self.assertRaises(SnapshotError),
|
||||
volume_snapshot("ext4", "/var/lib/docker", "20260731", run=run),
|
||||
):
|
||||
pass
|
||||
self.assertEqual(run.calls, [])
|
||||
|
||||
def test_a_path_outside_the_subject_is_rejected(self) -> None:
|
||||
run = Runner()
|
||||
with (
|
||||
volume_snapshot("btrfs", "/var/lib/docker", "20260731", run=run) as resolve,
|
||||
self.assertRaises(SnapshotError),
|
||||
):
|
||||
resolve("/etc/passwd")
|
||||
|
||||
def test_the_subject_itself_resolves_to_the_snapshot_root(self) -> None:
|
||||
run = Runner()
|
||||
with volume_snapshot(
|
||||
"btrfs", "/var/lib/docker", "20260731", run=run
|
||||
) as resolve:
|
||||
self.assertEqual(
|
||||
resolve("/var/lib/docker"), "/var/lib/docker/.baudolo-20260731"
|
||||
)
|
||||
|
||||
|
||||
class Busy(Runner):
|
||||
def __call__(self, command: list[str]) -> list[str]:
|
||||
if command[:3] == ["btrfs", "subvolume", "delete"]:
|
||||
raise BackupException("target is busy")
|
||||
return super().__call__(command)
|
||||
|
||||
|
||||
class TestRemovalFailure(unittest.TestCase):
|
||||
def test_a_failed_removal_does_not_fail_a_completed_run(self) -> None:
|
||||
with volume_snapshot("btrfs", "/var/lib/docker", "20260731", run=Busy()):
|
||||
pass
|
||||
|
||||
def test_a_failed_removal_does_not_mask_the_body(self) -> None:
|
||||
with (
|
||||
self.assertRaises(ZeroDivisionError),
|
||||
volume_snapshot("btrfs", "/var/lib/docker", "20260731", run=Busy()),
|
||||
):
|
||||
raise ZeroDivisionError
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
126
tests/unit/backup/test_snapshot_faithfulness.py
Normal file
126
tests/unit/backup/test_snapshot_faithfulness.py
Normal file
@@ -0,0 +1,126 @@
|
||||
"""Which volumes a snapshot of the subject actually contains.
|
||||
|
||||
The failure this guards against is silent: a volume with a backing store of
|
||||
its own is present inside the snapshot as an empty directory, so rsync
|
||||
succeeds, the generation is stamped complete, and the volume is empty in it.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup.snapshot import SnapshotError, snapshot_source, unsnapshotted
|
||||
from baudolo.backup.volume import Backing
|
||||
|
||||
|
||||
class TestUnsnapshotted(unittest.TestCase):
|
||||
def setUp(self) -> None:
|
||||
self.subject = tempfile.mkdtemp()
|
||||
self.mountpoint = os.path.join(self.subject, "volumes", "app", "_data")
|
||||
os.makedirs(self.mountpoint)
|
||||
|
||||
def backing(self, **kwargs) -> Backing:
|
||||
return Backing(kwargs.pop("mountpoint", self.mountpoint), **kwargs)
|
||||
|
||||
def test_a_plain_local_volume_is_captured(self) -> None:
|
||||
self.assertIsNone(unsnapshotted(self.backing(), self.subject))
|
||||
|
||||
def test_a_foreign_driver_is_not(self) -> None:
|
||||
reason = unsnapshotted(self.backing(driver="rexray"), self.subject)
|
||||
self.assertIn("rexray", reason)
|
||||
|
||||
def test_declared_driver_options_are_not(self) -> None:
|
||||
reason = unsnapshotted(
|
||||
self.backing(options={"type": "nfs", "device": ":/exports/app"}),
|
||||
self.subject,
|
||||
)
|
||||
self.assertIn("backing store", reason)
|
||||
|
||||
def test_the_declaration_decides_not_the_mount_table(self) -> None:
|
||||
"""Docker unmounts an NFS volume when its last container stops."""
|
||||
with mock.patch.object(os.path, "ismount", return_value=False):
|
||||
reason = unsnapshotted(self.backing(options={"type": "nfs"}), self.subject)
|
||||
self.assertIsNotNone(reason)
|
||||
|
||||
def test_a_volume_without_a_mountpoint_is_not(self) -> None:
|
||||
reason = unsnapshotted(Backing(""), self.subject)
|
||||
self.assertIn("no mountpoint", reason)
|
||||
|
||||
def test_an_own_mount_is_not(self) -> None:
|
||||
with mock.patch.object(os.path, "ismount", return_value=True):
|
||||
reason = unsnapshotted(self.backing(), self.subject)
|
||||
self.assertIn("own mount", reason)
|
||||
|
||||
def test_a_filesystem_boundary_is_not(self) -> None:
|
||||
real = os.stat
|
||||
|
||||
def crossing(path, *args, **kwargs):
|
||||
info = real(path, *args, **kwargs)
|
||||
if os.path.realpath(path) == os.path.realpath(self.mountpoint):
|
||||
return os.stat_result(
|
||||
(info.st_mode, info.st_ino, info.st_dev + 1, *tuple(info)[3:])
|
||||
)
|
||||
return info
|
||||
|
||||
with mock.patch.object(os, "stat", side_effect=crossing):
|
||||
reason = unsnapshotted(self.backing(), self.subject)
|
||||
self.assertIn("filesystem boundary", reason)
|
||||
|
||||
def test_an_unreadable_mountpoint_is_not(self) -> None:
|
||||
reason = unsnapshotted(
|
||||
self.backing(mountpoint=os.path.join(self.subject, "gone")), self.subject
|
||||
)
|
||||
self.assertIn("could not be read", reason)
|
||||
|
||||
|
||||
class TestSnapshotSource(unittest.TestCase):
|
||||
def setUp(self) -> None:
|
||||
self.subject = tempfile.mkdtemp()
|
||||
self.mountpoint = os.path.join(self.subject, "volumes", "app", "_data")
|
||||
os.makedirs(self.mountpoint)
|
||||
self.snapshot = os.path.join(
|
||||
self.subject, ".baudolo-tag", "volumes", "app", "_data"
|
||||
)
|
||||
os.makedirs(self.snapshot)
|
||||
self.backing = Backing(self.mountpoint)
|
||||
|
||||
def test_a_captured_volume_reads_from_the_snapshot(self) -> None:
|
||||
source, reason = snapshot_source(
|
||||
lambda path: self.snapshot + "/", self.backing, self.subject
|
||||
)
|
||||
self.assertEqual(source, self.snapshot + "/")
|
||||
self.assertEqual(reason, "")
|
||||
|
||||
def test_an_uncaptured_volume_is_refused_before_the_resolver_runs(self) -> None:
|
||||
def resolve(path):
|
||||
raise AssertionError("must not resolve a volume the snapshot misses")
|
||||
|
||||
source, reason = snapshot_source(
|
||||
resolve, Backing(self.mountpoint, options={"type": "nfs"}), self.subject
|
||||
)
|
||||
self.assertIsNone(source)
|
||||
self.assertIn("backing store", reason)
|
||||
|
||||
def test_a_volume_outside_the_subject_degrades_instead_of_raising(self) -> None:
|
||||
def resolve(path):
|
||||
raise SnapshotError(f"{path} lies outside the snapshot subject")
|
||||
|
||||
source, reason = snapshot_source(resolve, self.backing, self.subject)
|
||||
self.assertIsNone(source)
|
||||
self.assertIn("lies outside", reason)
|
||||
|
||||
def test_a_volume_created_after_the_snapshot_degrades(self) -> None:
|
||||
source, reason = snapshot_source(
|
||||
lambda path: os.path.join(self.subject, "absent") + "/",
|
||||
self.backing,
|
||||
self.subject,
|
||||
)
|
||||
self.assertIsNone(source)
|
||||
self.assertIn("created after", reason)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
95
tests/unit/backup/test_volume.py
Normal file
95
tests/unit/backup/test_volume.py
Normal file
@@ -0,0 +1,95 @@
|
||||
"""Contract of the rsync invocation that copies a volume."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from baudolo.backup import volume as mod
|
||||
|
||||
|
||||
class TestBackupVolume(unittest.TestCase):
|
||||
def copy(self, **kwargs) -> str:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
defaults = {
|
||||
"versions_dir": tmp,
|
||||
"volume_name": "demo",
|
||||
"volume_dir": str(Path(tmp) / "gen" / "demo"),
|
||||
"authoritative": False,
|
||||
"source": "/var/lib/docker/volumes/demo/_data/",
|
||||
}
|
||||
defaults.update(kwargs)
|
||||
with mock.patch.object(mod, "execute_shell_command") as run:
|
||||
mod.backup_volume(
|
||||
defaults.pop("versions_dir"),
|
||||
defaults.pop("volume_name"),
|
||||
defaults.pop("volume_dir"),
|
||||
**defaults,
|
||||
)
|
||||
return run.call_args[0][0]
|
||||
|
||||
def test_the_quick_check_pass_carries_no_checksum(self) -> None:
|
||||
self.assertNotIn("--checksum", self.copy(authoritative=False))
|
||||
|
||||
def test_the_authoritative_pass_compares_by_content(self) -> None:
|
||||
self.assertIn("--checksum", self.copy(authoritative=True))
|
||||
|
||||
def test_it_reads_from_the_given_source(self) -> None:
|
||||
command = self.copy(source="/snapshot/volumes/demo/_data/")
|
||||
self.assertIn("/snapshot/volumes/demo/_data/", command)
|
||||
|
||||
def test_it_always_deletes_what_the_source_no_longer_has(self) -> None:
|
||||
self.assertIn("--delete", self.copy())
|
||||
|
||||
def test_it_carries_no_kernel_objects_into_a_generation(self) -> None:
|
||||
self.assertIn("--no-D", self.copy())
|
||||
|
||||
def test_it_keeps_no_twin_of_what_the_second_pass_replaces(self) -> None:
|
||||
command = self.copy(authoritative=True)
|
||||
self.assertEqual(command[:2], ["rsync", "-aP"])
|
||||
self.assertNotIn("--backup", command)
|
||||
|
||||
def test_it_creates_the_destination(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
dest = Path(tmp) / "gen" / "demo"
|
||||
with mock.patch.object(mod, "execute_shell_command"):
|
||||
mod.backup_volume(
|
||||
tmp, "demo", str(dest), authoritative=False, source="/src/"
|
||||
)
|
||||
self.assertTrue((dest / "files").is_dir())
|
||||
|
||||
def test_source_is_required(self) -> None:
|
||||
with self.assertRaises(TypeError):
|
||||
mod.backup_volume("/v", "demo", "/d", authoritative=False)
|
||||
|
||||
def test_authoritative_is_required(self) -> None:
|
||||
with self.assertRaises(TypeError):
|
||||
mod.backup_volume("/v", "demo", "/d", source="/src/")
|
||||
|
||||
|
||||
class TestLastBackupDir(unittest.TestCase):
|
||||
def test_it_ignores_the_generation_being_written(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
current = Path(tmp) / "20260101" / "demo" / "files"
|
||||
current.mkdir(parents=True)
|
||||
found = mod.get_last_backup_dir(tmp, "demo", str(current) + "/")
|
||||
self.assertIsNone(found)
|
||||
|
||||
def test_it_finds_the_previous_generation(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
older = Path(tmp) / "20260101" / "demo" / "files"
|
||||
older.mkdir(parents=True)
|
||||
current = Path(tmp) / "20260102" / "demo" / "files"
|
||||
current.mkdir(parents=True)
|
||||
found = mod.get_last_backup_dir(tmp, "demo", str(current) + "/")
|
||||
self.assertEqual(found, str(older) + "/")
|
||||
|
||||
def test_a_first_run_has_no_predecessor(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
self.assertIsNone(mod.get_last_backup_dir(tmp, "demo", f"{tmp}/x/"))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
0
tests/unit/restore/__init__.py
Normal file
0
tests/unit/restore/__init__.py
Normal file
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user