mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
kevinveenbirkenbachandClaude Opus 4.7
a26bfc4e94
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>
86 lines
2.5 KiB
Python
86 lines
2.5 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
from pathlib import Path
|
|
from typing import TYPE_CHECKING
|
|
|
|
from . import PROJECT_ROOT
|
|
from .common import cache_env_overrides, compose_file_args, resolve_distro
|
|
from .profile import Profile
|
|
|
|
if TYPE_CHECKING:
|
|
import argparse
|
|
|
|
CI_DOCKER_ROOT = Path("/mnt/docker")
|
|
CI_DOCKER_ROOT_STR = str(CI_DOCKER_ROOT)
|
|
|
|
|
|
def _base_env(*, distro: str) -> dict[str, str]:
|
|
env = dict(os.environ)
|
|
env["INFINITO_DISTRO"] = distro
|
|
env.update(cache_env_overrides())
|
|
return env
|
|
|
|
|
|
def _compose_run(*, repo_root: Path, distro: str, args: list[str]) -> None:
|
|
cmd = ["docker", "compose", "--env-file", "env.ci"]
|
|
env_development = repo_root / "env.development"
|
|
if env_development.exists():
|
|
cmd += ["--env-file", "env.development"]
|
|
|
|
cmd += compose_file_args()
|
|
cmd += Profile().args()
|
|
cmd += list(args)
|
|
env = _base_env(distro=distro)
|
|
env.setdefault("NIX_CONFIG", "")
|
|
subprocess.run(cmd, cwd=repo_root, env=env, check=True, text=True)
|
|
|
|
|
|
def _cleanup_docker_root() -> None:
|
|
docker_root = CI_DOCKER_ROOT
|
|
|
|
if os.environ.get("RUNNING_ON_GITHUB") != "true":
|
|
print(f">>> Not on GitHub - No bind volumes will be deleted: {docker_root}")
|
|
return
|
|
|
|
docker_root_env = os.environ.get("INFINITO_DOCKER_VOLUME", "").strip().rstrip("/")
|
|
|
|
if docker_root_env and docker_root_env != CI_DOCKER_ROOT_STR:
|
|
raise RuntimeError(
|
|
"SECURITY VIOLATION: "
|
|
f"INFINITO_DOCKER_VOLUME={docker_root_env} is not allowed on GitHub runner. "
|
|
f"Only {CI_DOCKER_ROOT_STR} is permitted."
|
|
)
|
|
|
|
if not docker_root.exists():
|
|
print(f">>> Docker root does not exist, nothing to clean: {docker_root}")
|
|
return
|
|
|
|
print(f">>> CI cleanup: wiping Docker root: {docker_root}")
|
|
shutil.rmtree(docker_root, ignore_errors=True)
|
|
docker_root.mkdir(parents=True, exist_ok=True)
|
|
|
|
|
|
def down_stack(*, repo_root: Path, distro: str) -> None:
|
|
print(">>> Stopping compose stack and removing volumes")
|
|
try:
|
|
_compose_run(
|
|
repo_root=repo_root,
|
|
distro=distro,
|
|
args=["down", "--remove-orphans", "-v"],
|
|
)
|
|
finally:
|
|
_cleanup_docker_root()
|
|
|
|
|
|
def add_parser(sub: argparse._SubParsersAction) -> None:
|
|
p = sub.add_parser("down", help="Stop compose stack and remove volumes.")
|
|
p.set_defaults(_handler=handler)
|
|
|
|
|
|
def handler(args: argparse.Namespace) -> int:
|
|
down_stack(repo_root=PROJECT_ROOT, distro=resolve_distro())
|
|
return 0
|