Files
computer-playbook/tests/unit/cli/administration/deploy/dedicated/test_command_passthrough.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

79 lines
2.6 KiB
Python

from __future__ import annotations
import unittest
import unittest.mock
from cli.administration.deploy.dedicated import command as dedicated_command
class TestDedicatedCommandPassthrough(unittest.TestCase):
@unittest.mock.patch(
"cli.administration.deploy.dedicated.command.validate_application_ids"
)
@unittest.mock.patch(
"cli.administration.deploy.dedicated.command.run_ansible_playbook"
)
@unittest.mock.patch(
"cli.administration.deploy.dedicated.command.load_modes_from_yaml"
)
@unittest.mock.patch(
"cli.administration.deploy.dedicated.command.add_dynamic_mode_args"
)
@unittest.mock.patch(
"cli.administration.deploy.dedicated.command.build_modes_from_args"
)
def test_main_passes_unknown_ansible_args_through(
self,
mock_build_modes_from_args,
mock_add_dynamic_mode_args,
mock_load_modes_from_yaml,
mock_run_ansible_playbook,
mock_validate_application_ids,
):
# Make dynamic modes a no-op for this test
mock_load_modes_from_yaml.return_value = []
mock_add_dynamic_mode_args.return_value = {}
mock_build_modes_from_args.return_value = {}
argv = [
"/etc/inventories/github-ci/devices.yml",
"--diff",
# passthrough args (unknown to wrapper parser)
"--tags",
"deploy",
"--check",
"-e",
"FOO=bar",
]
rc = dedicated_command.main(argv)
self.assertEqual(rc, 0)
# validate_application_ids should be called with inventory + ids (empty list here)
mock_validate_application_ids.assert_called_once()
called_inventory, called_ids = mock_validate_application_ids.call_args.args
self.assertEqual(called_inventory, "/etc/inventories/github-ci/devices.yml")
self.assertEqual(called_ids, [])
# run_ansible_playbook must be called once with ansible_args passthrough
mock_run_ansible_playbook.assert_called_once()
kwargs = mock_run_ansible_playbook.call_args.kwargs
self.assertEqual(kwargs["inventory"], "/etc/inventories/github-ci/devices.yml")
self.assertTrue(kwargs["diff"])
self.assertIn("modes", kwargs)
# Ensure old MODE_LOGS is not reintroduced
self.assertNotIn("MODE_LOGS", kwargs["modes"])
# Passthrough args must be preserved in order
self.assertEqual(
kwargs["ansible_args"],
["--tags", "deploy", "--check", "-e", "FOO=bar"],
)
if __name__ == "__main__":
unittest.main()