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>
75 lines
1.7 KiB
Python
75 lines
1.7 KiB
Python
from __future__ import annotations
|
|
|
|
import subprocess
|
|
import sys
|
|
import threading
|
|
from typing import TextIO
|
|
|
|
|
|
def _drain_stream(
|
|
stream: TextIO,
|
|
*,
|
|
sink: TextIO,
|
|
) -> None:
|
|
"""
|
|
Read a text stream line-by-line and write to sink.
|
|
"""
|
|
try:
|
|
for line in iter(stream.readline, ""):
|
|
sink.write(line)
|
|
sink.flush()
|
|
finally:
|
|
try:
|
|
stream.close()
|
|
except Exception as exc:
|
|
sys.stderr.write(f"Warning: failed to close stream {stream!r}: {exc}\n")
|
|
sys.stderr.flush()
|
|
|
|
|
|
def run_streaming(
|
|
cmd: list[str],
|
|
*,
|
|
cwd,
|
|
env: dict[str, str],
|
|
text: bool = True,
|
|
) -> subprocess.CompletedProcess:
|
|
"""
|
|
Run a subprocess and stream stdout/stderr live to the terminal.
|
|
"""
|
|
p = subprocess.Popen(
|
|
cmd,
|
|
cwd=cwd,
|
|
env=env,
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE,
|
|
text=text,
|
|
bufsize=1, # line buffered (best effort)
|
|
)
|
|
|
|
# Type-narrowing asserts so the type checker sees the streams as
|
|
# non-None below (PIPE was passed); these never fire at runtime.
|
|
assert p.stdout is not None # noqa: S101
|
|
assert p.stderr is not None # noqa: S101
|
|
|
|
t_out = threading.Thread(
|
|
target=_drain_stream,
|
|
kwargs={"stream": p.stdout, "sink": sys.stdout},
|
|
)
|
|
t_err = threading.Thread(
|
|
target=_drain_stream,
|
|
kwargs={"stream": p.stderr, "sink": sys.stderr},
|
|
)
|
|
|
|
t_out.daemon = True
|
|
t_err.daemon = True
|
|
t_out.start()
|
|
t_err.start()
|
|
|
|
rc = p.wait()
|
|
|
|
# Process is finished; drain threads should finish quickly too.
|
|
t_out.join()
|
|
t_err.join()
|
|
|
|
return subprocess.CompletedProcess(cmd, rc)
|