mirror of
https://github.com/kevinveenbirkenbach/docker-volume-backup.git
synced 2026-08-20 21:22:54 +00:00
Kevin Veen-Birkenbach
2129c5e362
ruff was never wired into this repository: no target, no CI step, no pin. It reported 45 findings across sources and tests, so nothing enforced what the codebase already mostly followed. Adds `make ruff` (check + format --check), `make ruff-fix`, and `make lint` as its alias, and makes `make test` run lint as a fourth parallel spur. The CI workflow calls `make test`, so it is covered there too. The linter is pinned in a `lint` extra: a ruff minor bump changes which rules fire, and with the suite gating on a clean run an unpinned linter would fail it on an unrelated day. The 45 findings are fixed rather than configured away. Three needed a decision instead of the mechanical fix: - The generation timestamp keeps its local wall clock (DTZ005 waived). Generations sort by that name, and UTC would order new ones before the existing ones wherever the offset is positive - "newest generation" is what every restore path selects on. - The per-volume `copy` closure now binds volume_name and vol_dir as default arguments (B023). It only worked because it is called inside the same iteration. - The two CLI top-level handlers keep their blind except (BLE001 waived): turning any failure into exit 1 is what a CLI boundary is for. The two in run.py did not need it and were narrowed to what they actually catch. Also drops the comments that restate the code: the section banners in restore/__main__.py, the filename repeated as line 1 of nine test files, step narration above the statement it narrates, and a block in app.py documenting parameters that had moved to another module. What names a trip-wire stays - the snapshot destination rule, the mysql-binary absence in MariaDB 11 images, the session-scoped FOREIGN_KEY_CHECKS, the spooled temp file for multi-GB dumps, and the negative control that loses its discriminating power if it ever passes. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
213 lines
6.7 KiB
Python
213 lines
6.7 KiB
Python
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,
|
|
),
|
|
],
|
|
)
|