mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
Module moves (with imports, paths, argv literals, scripts, docs, and
parents[N] formulas updated in lockstep):
- cli/deploy -> cli/administration/deploy
- cli/validate/inventory -> cli/administration/inventory/validate
- cli/vault -> cli/administration/secrets/vault
- cli/administration/inventory/encrypt -> cli/administration/secrets/seal
- cli/mirror -> cli/contributing/mirror
The new cli/administration/secrets cluster collocates the whole-file
ansible-vault wrapper next to the inventory-aware per-field sealer.
The user-facing CLI subcommand paths follow the package layout, e.g.
"infinito administration deploy dedicated <inv>" and
"infinito administration inventory validate <inv>".
Help system redesign in cli/core/{discovery,help,app}.py:
- Discovery now distinguishes runnable commands (directories with
__main__.py) from category folders (directories that only group
further commands). Empty support packages are filtered out.
- Each category folder MAY carry a README.md; its H1 heading is used
as the title and its first paragraph as the one-line description in
the help output.
- "infinito" / "infinito --help" prints only the top-level entries
(one level deep). "infinito <category>" navigates into a folder and
shows its sub-folders and commands one level deep, with the README
title as the page heading and the invocation as a dim subtitle.
- New "--tree [N]" flag walks the tree under the (optional) path
prefix recursively. N caps the depth (1-based); omit N for an
unbounded walk. The output uses Unicode tree connectors, an emoji
per entry (folder for categories, gear for commands), a globally
aligned description column, and multi-line wrapped descriptions
with tree-continuity bars on continuation lines.
- Category and command listings use the full invocation
("infinito meta callorder") rather than the bare leaf name, so the
output is copy-pasteable.
Convention doc + 17 CLI READMEs:
- New docs/contributing/artefact/files/cli/readme_md.md describes the
H1+paragraph layout the help system reads, and how it differs from
role/docs READMEs.
- README.md added for cli/{administration, build, contributing, meta}
and their immediate sub-folders, plus cli/meta/roles/applications
and its resolution sub-folder. Each follows the "title with trailing
emoji + single descriptive paragraph" convention.
Mirror resolver/sync description strings (the help system reads them
from argparse --help output) added so they no longer surface as
"options:" in the global index. cli/mirror/cleanup already had a
description and is unchanged.
Fixes uncovered by the move:
- import unittest.mock added to four dedicated-deploy tests so
unittest.mock.patch resolves under stdlib unittest discovery
(Python 3.13 no longer surfaces unittest.mock through "import
unittest" alone).
- parents[N] index in the new
cli/administration/inventory/validate/__init__.py corrected from
3 to 4 to match the deeper layout.
- test_paths.INVENTORY_VALIDATOR_PATH assertion and test_runner
substring assertions updated to match the new validator path.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
91 lines
2.6 KiB
Python
91 lines
2.6 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import shlex
|
|
from pathlib import Path
|
|
|
|
CONTAINER_REPO_ROOT = Path("/opt/src/infinito")
|
|
|
|
|
|
def _require_env(name: str) -> str:
|
|
val = os.environ.get(name)
|
|
if val is None or not str(val).strip():
|
|
raise RuntimeError(f"Required environment variable is missing or empty: {name}")
|
|
return str(val).strip()
|
|
|
|
|
|
def _require_bool_env(name: str) -> bool:
|
|
raw = _require_env(name)
|
|
if raw == "true":
|
|
return True
|
|
if raw == "false":
|
|
return False
|
|
raise RuntimeError(
|
|
f"Environment variable {name} must be 'true' or 'false', got {raw!r}"
|
|
)
|
|
|
|
|
|
def should_use_mirrors_on_ci() -> bool:
|
|
"""
|
|
Mirrors are enabled strictly based on RUNNING_ON_GITHUB.
|
|
"""
|
|
return _require_bool_env("RUNNING_ON_GITHUB")
|
|
|
|
|
|
def _exec_env() -> dict[str, str]:
|
|
"""
|
|
All variables are mandatory. No fallbacks.
|
|
"""
|
|
return {
|
|
"RUNNING_ON_GITHUB": _require_env("RUNNING_ON_GITHUB"),
|
|
"GITHUB_REPOSITORY_OWNER": _require_env("GITHUB_REPOSITORY_OWNER"),
|
|
"GITHUB_REPOSITORY": _require_env("GITHUB_REPOSITORY"),
|
|
"INFINITO_GHCR_MIRROR_PREFIX": _require_env("INFINITO_GHCR_MIRROR_PREFIX"),
|
|
}
|
|
|
|
|
|
def generate_ci_mirrors_file(compose, *, inventory_dir: str) -> str:
|
|
"""
|
|
Generate mirrors.yml inside the container using cli.contributing.mirror.resolver.
|
|
|
|
Writes:
|
|
<inventory_dir>/mirrors.yml
|
|
"""
|
|
inv_root = str(inventory_dir).rstrip("/")
|
|
if not inv_root:
|
|
raise RuntimeError("inventory_dir must not be empty")
|
|
|
|
env = _exec_env()
|
|
ghcr_namespace = env["GITHUB_REPOSITORY_OWNER"].lower()
|
|
ghcr_repository = env["GITHUB_REPOSITORY"].split("/", 1)[-1].lower()
|
|
ghcr_prefix = env["INFINITO_GHCR_MIRROR_PREFIX"].strip().strip("/")
|
|
if not ghcr_prefix:
|
|
raise RuntimeError("INFINITO_GHCR_MIRROR_PREFIX must not be empty")
|
|
|
|
mirrors_path = f"{inv_root}/mirrors.yml"
|
|
repo_root = str(CONTAINER_REPO_ROOT)
|
|
|
|
cmd = [
|
|
"bash",
|
|
"-lc",
|
|
"set -euo pipefail; "
|
|
f"mkdir -p {shlex.quote(inv_root)}; "
|
|
'"${PYTHON:-python3}" -m cli.contributing.mirror.resolver '
|
|
f"--repo-root {shlex.quote(repo_root)} "
|
|
f"--ghcr-namespace {shlex.quote(ghcr_namespace)} "
|
|
f"--ghcr-repository {shlex.quote(ghcr_repository)} "
|
|
f"--ghcr-prefix {shlex.quote(ghcr_prefix)} "
|
|
f"> {shlex.quote(mirrors_path)}; "
|
|
f"echo '[init] mirrors generated:' {shlex.quote(mirrors_path)}; "
|
|
f"wc -l {shlex.quote(mirrors_path)}",
|
|
]
|
|
|
|
compose.exec(
|
|
cmd,
|
|
check=True,
|
|
workdir=repo_root,
|
|
extra_env=env,
|
|
)
|
|
|
|
return mirrors_path
|