Files
computer-playbook/cli/administration/deploy/dedicated/runner.py
T
kevinveenbirkenbachandClaude Opus 4.7 a26bfc4e94 refactor(cli): reorg admin/contributing tree + per-folder help system
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>
2026-05-08 20:17:09 +02:00

132 lines
4.4 KiB
Python

from __future__ import annotations
import datetime
import subprocess
import sys
from pathlib import Path
from typing import Any
from cli.administration.inventory.provision.services_disabler import (
ServicesDisabledConflictError,
assert_services_disabled_inventory_consistency_from_env,
)
from .proc import run, run_make
def run_ansible_playbook(
*,
repo_root: str,
playbook_path: str,
inventory_validator_path: str,
inventory: str,
modes: dict[str, Any],
limit: str | None = None,
allowed_applications: list[str] | None = None,
password_file: str | None = None,
verbose: int = 0,
skip_build: bool = False,
diff: bool = False,
ansible_args: list[str] | None = None,
) -> None:
"""Run ansible-playbook with the given parameters and execution modes."""
start_time = datetime.datetime.now(tz=datetime.UTC)
print(f"\n▶️ Script started at: {start_time.isoformat()}\n")
# ---------------------------------------------------------
# 1) Cleanup Phase (wrapper-level)
# ---------------------------------------------------------
if modes.get("MODE_CLEANUP", False):
print("\n🧹 Cleaning up...\n", flush=True)
run_make(repo_root, "clean")
else:
print("\n🧹 Cleanup skipped (MODE_CLEANUP not set or False)\n")
# ---------------------------------------------------------
# 2) Build Phase
# ---------------------------------------------------------
if not skip_build:
print("\n🛠️ Running project build (make setup)...\n")
run_make(repo_root, "setup")
else:
print("\n🛠️ Build skipped (--skip-build)\n")
# ---------------------------------------------------------
# 3) SERVICES_DISABLED consistency guard
# ---------------------------------------------------------
try:
assert_services_disabled_inventory_consistency_from_env(
inventory_dir=Path(inventory).resolve().parent,
roles_dir=Path(repo_root).resolve() / "roles",
)
except ServicesDisabledConflictError as exc:
print(f"\n[ERROR] {exc}\n", file=sys.stderr)
sys.exit(1)
# ---------------------------------------------------------
# 4) Inventory Validation Phase
# ---------------------------------------------------------
if modes.get("MODE_ASSERT") is False:
print("\n🔍 Inventory assertion explicitly disabled (MODE_ASSERT=false)\n")
else:
print("\n🔍 Validating inventory before deployment...\n")
try:
run(
[sys.executable, inventory_validator_path, str(Path(inventory).parent)],
cwd=repo_root,
check=True,
)
except subprocess.CalledProcessError:
print(
"\n[ERROR] Inventory validation failed. Aborting deployment.\n",
file=sys.stderr,
)
sys.exit(1)
# ---------------------------------------------------------
# 5) Build ansible-playbook command
# ---------------------------------------------------------
cmd: list[str] = ["ansible-playbook", "-i", inventory, playbook_path]
if limit:
cmd.extend(["-l", limit])
# Wrapper-provided extra-vars first; user can override via passthrough -e later.
if allowed_applications:
joined = ",".join(allowed_applications)
cmd.extend(["-e", f"allowed_applications={joined}"])
for key, value in modes.items():
val = str(value).lower() if isinstance(value, bool) else str(value)
cmd.extend(["-e", f"{key}={val}"])
if password_file:
cmd.extend(["--vault-password-file", password_file])
if diff:
cmd.append("--diff")
if modes.get("MODE_DEBUG", False):
verbose = max(verbose, 3)
if verbose:
cmd.append("-" + "v" * verbose)
# Native ansible-playbook flags passthrough (must come last for override behavior)
if ansible_args:
cmd.extend(ansible_args)
print("\n🚀 Launching Ansible Playbook...\n")
result = subprocess.run(cmd, cwd=repo_root, check=False)
if result.returncode != 0:
print(
f"\n[ERROR] ansible-playbook exited with status {result.returncode}\n",
file=sys.stderr,
)
sys.exit(result.returncode)
end_time = datetime.datetime.now(tz=datetime.UTC)
print(f"\n✅ Script ended at: {end_time.isoformat()}\n")
print(f"⏱️ Total execution time: {end_time - start_time}\n")