Files
computer-playbook/cli/administration/deploy/development/exec.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

64 lines
1.9 KiB
Python

from __future__ import annotations
import argparse
import os
from .common import make_compose
def add_parser(sub: argparse._SubParsersAction) -> None:
p = sub.add_parser("exec", help="Execute a command inside the infinito container.")
p.add_argument(
"--env",
action="append",
default=[],
metavar="KEY=VALUE",
help=(
"Inject KEY=VALUE into the container environment for this "
"exec call. Repeatable. Lets bash callers pass per-run "
"context (INVENTORY_FILE, APPS, ...) into in-container "
"helper scripts without inlining heredocs."
),
)
p.add_argument(
"cmd",
nargs=argparse.REMAINDER,
help="Command to execute (use `--` to separate).",
)
p.set_defaults(_handler=handler)
def _parse_env_pairs(pairs: list[str]) -> dict[str, str]:
parsed: dict[str, str] = {}
for pair in pairs:
if "=" not in pair:
raise SystemExit(f"--env expects KEY=VALUE; got {pair!r} without '='")
key, value = pair.split("=", 1)
key = key.strip()
if not key:
raise SystemExit(f"--env KEY is empty in {pair!r}")
parsed[key] = value
return parsed
def handler(args: argparse.Namespace) -> int:
compose = make_compose()
cmd = list(args.cmd or [])
if cmd and cmd[0] == "--":
cmd = cmd[1:]
if not cmd:
raise SystemExit("exec requires a command (e.g. exec -- sh -lc 'whoami')")
extra_env: dict[str, str] = {}
services_disabled = os.environ.get("SERVICES_DISABLED", "")
if services_disabled:
extra_env["SERVICES_DISABLED"] = services_disabled
# Caller-supplied --env entries win over implicit ones (current convention
# in the dev CLI: explicit user input overrides implicit defaults).
extra_env.update(_parse_env_pairs(args.env or []))
r = compose.exec(cmd, check=False, extra_env=extra_env or None)
return int(r.returncode)