mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-09 12:17:13 +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>
176 lines
5.6 KiB
Python
176 lines
5.6 KiB
Python
from __future__ import annotations
|
|
|
|
import json
|
|
import os
|
|
import unittest
|
|
import urllib.error
|
|
from typing import Self
|
|
from unittest.mock import patch
|
|
|
|
import cli.contributing.mirror.cleanup.__main__ as cleanup_main
|
|
|
|
|
|
class _FakeResponse:
|
|
def __init__(self, payload: bytes = b"[]"):
|
|
self._payload = payload
|
|
|
|
def read(self) -> bytes:
|
|
return self._payload
|
|
|
|
def __enter__(self) -> Self:
|
|
return self
|
|
|
|
def __exit__(self, exc_type, exc, tb) -> bool:
|
|
return False
|
|
|
|
|
|
def _org_probe_ok() -> _FakeResponse:
|
|
return _FakeResponse(b"[]")
|
|
|
|
|
|
def _org_probe_404() -> _FakeResponse:
|
|
raise urllib.error.HTTPError("url", 404, "Not Found", {}, None)
|
|
|
|
|
|
class TestCleanupMain(unittest.TestCase):
|
|
def _pkg(self, name: str, visibility: str = "private") -> dict:
|
|
return {"name": name, "visibility": visibility}
|
|
|
|
@patch.dict(os.environ, {"GITHUB_TOKEN": "tok"}, clear=False)
|
|
def test_dry_run_does_not_delete(self) -> None:
|
|
packages = [self._pkg("mirror/foo")]
|
|
responses = [
|
|
_org_probe_ok(),
|
|
_FakeResponse(json.dumps(packages).encode()),
|
|
_FakeResponse(b"[]"),
|
|
]
|
|
with (
|
|
patch(
|
|
"cli.contributing.mirror.cleanup.__main__.urllib.request.urlopen",
|
|
side_effect=responses,
|
|
) as mock_open,
|
|
patch("sys.argv", ["cleanup", "--ghcr-namespace", "acme", "--dry-run"]),
|
|
):
|
|
result = cleanup_main.main()
|
|
|
|
self.assertEqual(result, 0)
|
|
delete_calls = [
|
|
c for c in mock_open.call_args_list if c[0][0].get_method() == "DELETE"
|
|
]
|
|
self.assertEqual(delete_calls, [])
|
|
|
|
@patch.dict(os.environ, {"GITHUB_TOKEN": "tok"}, clear=False)
|
|
def test_matching_private_package_is_deleted(self) -> None:
|
|
packages = [self._pkg("mirror/bar", "private")]
|
|
call_count = 0
|
|
|
|
def fake_urlopen(req):
|
|
nonlocal call_count
|
|
call_count += 1
|
|
if req.get_method() == "DELETE":
|
|
return _FakeResponse(b"")
|
|
if call_count == 1:
|
|
return _org_probe_ok()
|
|
return _FakeResponse(
|
|
json.dumps(packages if call_count == 2 else []).encode()
|
|
)
|
|
|
|
with (
|
|
patch(
|
|
"cli.contributing.mirror.cleanup.__main__.urllib.request.urlopen",
|
|
side_effect=fake_urlopen,
|
|
),
|
|
patch("sys.argv", ["cleanup", "--ghcr-namespace", "acme"]),
|
|
):
|
|
result = cleanup_main.main()
|
|
|
|
self.assertEqual(result, 0)
|
|
|
|
@patch.dict(os.environ, {"GITHUB_TOKEN": "tok"}, clear=False)
|
|
def test_package_outside_prefix_is_ignored(self) -> None:
|
|
packages = [self._pkg("other/foo", "private")]
|
|
responses = [
|
|
_org_probe_ok(),
|
|
_FakeResponse(json.dumps(packages).encode()),
|
|
_FakeResponse(b"[]"),
|
|
]
|
|
with (
|
|
patch(
|
|
"cli.contributing.mirror.cleanup.__main__.urllib.request.urlopen",
|
|
side_effect=responses,
|
|
) as mock_open,
|
|
patch("sys.argv", ["cleanup", "--ghcr-namespace", "acme"]),
|
|
):
|
|
result = cleanup_main.main()
|
|
|
|
self.assertEqual(result, 0)
|
|
delete_calls = [
|
|
c for c in mock_open.call_args_list if c[0][0].get_method() == "DELETE"
|
|
]
|
|
self.assertEqual(delete_calls, [])
|
|
|
|
@patch.dict(os.environ, {}, clear=True)
|
|
def test_missing_token_returns_error(self) -> None:
|
|
with patch("sys.argv", ["cleanup", "--ghcr-namespace", "acme"]):
|
|
result = cleanup_main.main()
|
|
self.assertEqual(result, 1)
|
|
|
|
@patch.dict(os.environ, {"GITHUB_TOKEN": "tok"}, clear=False)
|
|
def test_delete_failure_reports_and_exits_nonzero(self) -> None:
|
|
packages = [self._pkg("mirror/bad", "private")]
|
|
call_count = 0
|
|
|
|
def fake_urlopen(req):
|
|
nonlocal call_count
|
|
call_count += 1
|
|
if req.get_method() == "DELETE":
|
|
raise urllib.error.HTTPError("url", 403, "Forbidden", {}, None)
|
|
if call_count == 1:
|
|
return _org_probe_ok()
|
|
return _FakeResponse(
|
|
json.dumps(packages if call_count == 2 else []).encode()
|
|
)
|
|
|
|
with (
|
|
patch(
|
|
"cli.contributing.mirror.cleanup.__main__.urllib.request.urlopen",
|
|
side_effect=fake_urlopen,
|
|
),
|
|
patch("sys.argv", ["cleanup", "--ghcr-namespace", "acme"]),
|
|
):
|
|
result = cleanup_main.main()
|
|
|
|
self.assertEqual(result, 1)
|
|
|
|
@patch.dict(os.environ, {"GITHUB_TOKEN": "tok"}, clear=False)
|
|
def test_user_account_uses_user_endpoint(self) -> None:
|
|
packages = [self._pkg("mirror/foo", "private")]
|
|
call_count = 0
|
|
|
|
def fake_urlopen(req):
|
|
nonlocal call_count
|
|
call_count += 1
|
|
if call_count == 1:
|
|
raise urllib.error.HTTPError("url", 404, "Not Found", {}, None)
|
|
if req.get_method() == "DELETE":
|
|
self.assertIn("/user/packages/", req.full_url)
|
|
return _FakeResponse(b"")
|
|
return _FakeResponse(
|
|
json.dumps(packages if call_count == 2 else []).encode()
|
|
)
|
|
|
|
with (
|
|
patch(
|
|
"cli.contributing.mirror.cleanup.__main__.urllib.request.urlopen",
|
|
side_effect=fake_urlopen,
|
|
),
|
|
patch("sys.argv", ["cleanup", "--ghcr-namespace", "bob"]),
|
|
):
|
|
result = cleanup_main.main()
|
|
|
|
self.assertEqual(result, 0)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|