Files
computer-playbook/scripts/meta/env/inventory.sh
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

42 lines
1.3 KiB
Bash
Executable File

#!/usr/bin/env bash
# shellcheck shell=bash
#
# Resolve inventory path.
set -euo pipefail
if [[ "${INFINITO_ENV_INVENTORY_LOADED:-}" == "1" ]]; then
return 0
fi
export INFINITO_ENV_INVENTORY_LOADED="1"
: "${RUNNING_ON_ACT:=false}"
: "${RUNNING_ON_GITHUB:=false}"
if [[ -z "${INVENTORY_DIR:-}" ]]; then
INVENTORY_DIR="$(
RUNNING_ON_ACT="${RUNNING_ON_ACT}" \
RUNNING_ON_GITHUB="${RUNNING_ON_GITHUB}" \
HOME="${HOME:-}" \
bash scripts/inventory/resolve.sh
)"
fi
export INVENTORY_DIR
# SPOT: canonical path to the generated inventory devices file.
INVENTORY_FILE="${INVENTORY_DIR}/devices.yml"
export INVENTORY_FILE
# SPOT: canonical path to the host_vars file for localhost.
HOST_VARS_FILE="${INVENTORY_DIR}/host_vars/localhost.yml"
export HOST_VARS_FILE
# SPOT: canonical repo-relative path to the development vars file that
# `infinito administration inventory provision --vars-file <...>` consumes. Anything that
# would otherwise hard-code "inventories/development/default.yml" MUST
# read this variable instead. The Python side mirrors this default in
# cli.administration.deploy.development.common.DEV_INVENTORY_VARS_FILE; a unit test
# locks both literals together so they cannot silently drift.
INVENTORY_VARS_FILE="${INVENTORY_VARS_FILE:-inventories/development/default.yml}"
export INVENTORY_VARS_FILE