Files
computer-playbook/roles/sys-svc-compose/files/python/swarm/registry_sync.py
kevinveenbirkenbachandClaude Opus 5 575a5a87ac refactor(layout): sort shipped scripts by language and split the unit suite
Every script a role ships now lives under `files/<language>/`, and the unit
suite is split the same way: `tests/unit/python/` beside new sibling trees for
the other languages. `tests/lint/filesystem/test_role_files_layout.py` keeps it
that way; directories whose shape is dictated from outside carry a `.nocheck`
naming the constraint (Docker build contexts, WordPress mu-plugins, the Joomla
extension, Odoo addons, Playwright suites, the `files/test/test.sh` harness
that `test-e2e-cli` resolves generically).

This cannot be applied in halves. Moving a file and repointing what names it
are the same change: 14 references resolve only at deploy time, so the tree is
green either before or after, never between.

Those 14 were found by static resolution over every reference class, not by the
test suite -- a full `make quality-high` was green while all of them were
broken:

  * 7 `src:` values built from a role variable holding a bare filename
    (svc-bkp-remote-2-local, decidim, espocrm, friendica, joomla, pixelfed x2).
    The variable doubles as the destination name inside the container, so the
    language segment belongs at the call site, not in the variable.
  * `sys-service/tasks/04_base.yml` resolved every consumer's systemd script
    through `first_found(..., errors='strict')` over `files/script.{sh,py}`.
    18 roles ship exactly that and have no template fallback: the play would
    have died on each.
  * `sys-front-inj-javascript` fell back to `<role>/files/javascript.js`; the
    interface now reads `files/javascript/javascript.js`.
  * `sys-front-inj-logout/templates/head_sub.j2` built the cache-busting mtime
    path through `path_absolute(... 'files', ...)`.
  * 4 `ansible.builtin.script:` invocations naming a bare command
    (pull.py, prune.sh, set_postgres_superuser_password.sh, ganesha-serve.sh).
  * `dev-python/files/shell/install.sh` pointed at a sibling role's script.

Depth-dependent paths inside the moved trees were bumped accordingly: 59
`parents[N]` computations, 12 relative climbs, and the per-role recover CLI,
whose path `cli/administration/recover/recoverers.py` still assembled from the
pre-move location.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 01:31:09 +02:00

156 lines
4.9 KiB
Python
Executable File

#!/usr/bin/env python3
from __future__ import annotations
import argparse
import subprocess
import sys
from pathlib import Path
import yaml
PULL_TIMEOUT = 1800
def run(cmd: list[str], timeout: int = 600) -> int:
print(f">>> {' '.join(cmd)}", file=sys.stderr)
try:
return subprocess.run(cmd, check=False, timeout=timeout).returncode
except subprocess.TimeoutExpired:
print(f">>> TIMEOUT after {timeout}s: {' '.join(cmd)}", file=sys.stderr)
return 124
def manifest_exists(image: str) -> bool:
# Exception: manifest inspect ignores the daemon's insecure-registries
# list, so without --insecure every manifest on the plain-HTTP swarm
# registry reads as "no such manifest" and the push skip never triggers.
rc = subprocess.run(
["docker", "manifest", "inspect", "--insecure", image],
check=False,
stdout=subprocess.DEVNULL,
stderr=subprocess.DEVNULL,
).returncode
return rc == 0
def sync(*, compose_file: Path, prefix: str) -> int:
with compose_file.open() as f:
doc = yaml.safe_load(f) # nocheck: direct-yaml
services = (doc or {}).get("services") or {}
if not isinstance(services, dict):
return 0
targets: list[str] = []
pulled: list[tuple[str, str]] = []
changed = False
locally_built = {
svc["image"].removeprefix(prefix)
for svc in services.values()
if isinstance(svc, dict)
and "build" in svc
and isinstance(svc.get("image"), str)
}
for svc in services.values():
if not isinstance(svc, dict):
continue
image = svc.get("image")
if not isinstance(image, str) or not image:
continue
if image.startswith(prefix):
targets.append(image)
upstream = image[len(prefix) :]
if "build" in svc or manifest_exists(image) or upstream in locally_built:
continue
rc = run(["docker", "pull", upstream], timeout=PULL_TIMEOUT)
if rc != 0:
raise RuntimeError(f"docker pull {upstream} failed (rc={rc})")
rc = run(["docker", "tag", upstream, image])
if rc != 0:
raise RuntimeError(f"docker tag {upstream} {image} failed (rc={rc})")
pulled.append((upstream, image))
continue
if "build" in svc:
new_image = f"{prefix}{image}"
rc = run(["docker", "tag", image, new_image])
if rc != 0:
raise RuntimeError(f"docker tag {image} {new_image} failed (rc={rc})")
svc["image"] = new_image
targets.append(new_image)
changed = True
continue
new_image = f"{prefix}{image}"
svc["image"] = new_image
targets.append(new_image)
changed = True
if manifest_exists(new_image):
continue
rc = run(["docker", "pull", image], timeout=PULL_TIMEOUT)
if rc != 0:
raise RuntimeError(f"docker pull {image} failed (rc={rc})")
rc = run(["docker", "tag", image, new_image])
if rc != 0:
raise RuntimeError(f"docker tag {image} {new_image} failed (rc={rc})")
pulled.append((image, new_image))
if changed:
with compose_file.open("w") as f:
yaml.safe_dump(
doc, f, sort_keys=False, default_flow_style=False
) # nocheck: direct-yaml
for image in targets:
if manifest_exists(image):
print(f">>> skip push (already in registry): {image}", file=sys.stderr)
continue
rc = run(["docker", "push", image])
if rc != 0:
raise RuntimeError(f"docker push {image} failed (rc={rc})")
for upstream, image in dict.fromkeys(pulled):
run(["docker", "rmi", image, upstream])
return 0
def main() -> int:
ap = argparse.ArgumentParser(
description=(
"Cache upstream images and retag locally-built compose images "
"with the swarm registry prefix, push them, and rewrite "
"compose.yml so subsequent `docker stack deploy "
"--resolve-image never` references the registry-qualified names."
)
)
ap.add_argument("--chdir", required=True, help="Compose instance directory")
ap.add_argument(
"--registry-prefix",
required=True,
help='Registry host with trailing slash, e.g. "host:5000/"',
)
args = ap.parse_args()
prefix = args.registry_prefix
if not prefix:
return 0
compose_file = Path(args.chdir) / "compose.yml"
if not compose_file.is_file():
raise RuntimeError(f"compose.yml not found at {compose_file}")
return sync(compose_file=compose_file, prefix=prefix)
if __name__ == "__main__":
try:
rc = main()
except Exception as exc:
print(f"[ERROR] {exc}", file=sys.stderr)
raise SystemExit(1) from exc
raise SystemExit(rc)