kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2025-12-08 18:35:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor deploy CLI into cli/deploy/dedicated.py, add package inits, and update unit tests (see ChatGPT conversation: https://chatgpt.com/share/6931af9e-dad0-800f-9a8f-6d01c373de87)

Browse Source
This commit is contained in:
Kevin Veen-Birkenbach
2025-12-04 16:59:13 +01:00
parent 86dd36930f
commit 8c64f91a6d
4 changed files with 233 additions and 207 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
tests/unit/cli/deploy/__init__.py Normal file
View File

176
tests/unit/cli/test_deploy.py → tests/unit/cli/deploy/test_dedicated.py
View File

@@ -1,15 +1,12 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import os
import tempfile
import unittest
from typing import Any, Dict, List
from unittest import mock
import cli.deploy as deploy
import subprocess
from cli.deploy import dedicated as deploy
class TestParseBoolLiteral(unittest.TestCase):
def test_true_values(self):
@@ -32,13 +29,13 @@ class TestParseBoolLiteral(unittest.TestCase):
class TestLoadModesFromYaml(unittest.TestCase):
def test_load_modes_basic(self):
# Create a temporary "01_modes.yml"-like file
content = """\
MODE_CLEANUP: true # cleanup before deploy
MODE_DEBUG: false # enable debug
MODE_ASSERT: null # explicitly set via CLI
INVALID_KEY: true # ignored because no MODE_ prefix
MODE_CLEANUP: true # cleanup before deploy
MODE_DEBUG: false # debug output
MODE_ASSERT: null # inventory assertion
OTHER_KEY: true # should be ignored (no MODE_ prefix)
"""
with tempfile.NamedTemporaryFile("w+", delete=False, encoding="utf-8") as f:
path = f.name
f.write(content)
@@ -49,7 +46,6 @@ INVALID_KEY: true # ignored because no MODE_ prefix
finally:
os.unlink(path)
# We expect 3 MODE_* entries, INVALID_KEY is ignored
self.assertEqual(len(modes), 3)
by_name = {m["name"]: m for m in modes}
@@ -63,10 +59,29 @@ INVALID_KEY: true # ignored because no MODE_ prefix
self.assertIsNone(by_name["MODE_ASSERT"]["default"])
self.assertEqual(by_name["MODE_CLEANUP"]["help"], "cleanup before deploy")
def test_load_modes_ignores_non_mode_keys(self):
content = """\
FOO: true
BAR: false
MODE_FOO: true
"""
with tempfile.NamedTemporaryFile("w+", delete=False, encoding="utf-8") as f:
path = f.name
f.write(content)
f.flush()
try:
modes = deploy.load_modes_from_yaml(path)
finally:
os.unlink(path)
self.assertEqual(len(modes), 1)
self.assertEqual(modes[0]["name"], "MODE_FOO")
class TestDynamicModes(unittest.TestCase):
def setUp(self):
# Simple meta as if parsed from 01_modes.yml
self.modes_meta = [
{"name": "MODE_CLEANUP", "default": True, "help": "Cleanup before run"},
{"name": "MODE_DEBUG", "default": False, "help": "Debug output"},
@@ -74,59 +89,62 @@ class TestDynamicModes(unittest.TestCase):
]
def test_add_dynamic_mode_args_and_build_modes_defaults(self):
parser = unittest.mock.MagicMock()
# Use a real ArgumentParser for build_modes_from_args
from argparse import ArgumentParser
real_parser = ArgumentParser()
spec = deploy.add_dynamic_mode_args(real_parser, self.modes_meta)
# We expect three entries
self.assertIn("MODE_CLEANUP", spec)
self.assertIn("MODE_DEBUG", spec)
self.assertIn("MODE_ASSERT", spec)
# No flags given: use defaults (True/False/None)
# No flags passed → defaults apply
args = real_parser.parse_args([])
modes = deploy.build_modes_from_args(spec, args)
self.assertTrue(modes["MODE_CLEANUP"]) # default True
self.assertFalse(modes["MODE_DEBUG"]) # default False
self.assertNotIn("MODE_ASSERT", modes) # default None → not present
self.assertNotIn("MODE_ASSERT", modes) # explicit, not set
def test_add_dynamic_mode_args_and_build_modes_flags(self):
def test_add_dynamic_mode_args_and_build_modes_flags_true(self):
from argparse import ArgumentParser
parser = ArgumentParser()
spec = deploy.add_dynamic_mode_args(parser, self.modes_meta)
# CLI: --skip-cleanup → MODE_CLEANUP=False
# --debug → MODE_DEBUG=True
# --assert true → MODE_ASSERT=True
args = parser.parse_args(
["--skip-cleanup", "--debug", "--assert", "true"]
)
# MODE_CLEANUP: true → --skip-cleanup sets it to False
# MODE_DEBUG: false → --debug sets it to True
# MODE_ASSERT: None → --assert true sets it to True
args = parser.parse_args(["--skip-cleanup", "--debug", "--assert", "true"])
modes = deploy.build_modes_from_args(spec, args)
self.assertFalse(modes["MODE_CLEANUP"])
self.assertTrue(modes["MODE_DEBUG"])
self.assertTrue(modes["MODE_ASSERT"])
def test_add_dynamic_mode_args_and_build_modes_flags_false_explicit(self):
from argparse import ArgumentParser
parser = ArgumentParser()
spec = deploy.add_dynamic_mode_args(parser, self.modes_meta)
# explicit false for MODE_ASSERT
args = parser.parse_args(["--assert", "false"])
modes = deploy.build_modes_from_args(spec, args)
self.assertTrue(modes["MODE_CLEANUP"]) # still default True
self.assertFalse(modes["MODE_DEBUG"]) # still default False
self.assertIn("MODE_ASSERT", modes)
self.assertFalse(modes["MODE_ASSERT"])
class TestValidateApplicationIds(unittest.TestCase):
def test_no_ids_does_nothing(self):
"""
When no application_ids are passed, the function should just return
without trying to validate anything.
"""
# Should not raise
deploy.validate_application_ids("inventories/github-ci/servers.yml", [])
@mock.patch("module_utils.valid_deploy_id.ValidDeployId")
def test_invalid_ids_raise_system_exit(self, mock_vdi_cls):
"""
When ValidDeployId reports invalid IDs, validate_application_ids should
print an error and exit with code 1.
"""
instance = mock_vdi_cls.return_value
instance.validate.return_value = {
"web-app-foo": {"allowed": False, "in_inventory": True},
@@ -153,20 +171,18 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
ansible_rc: int = 0,
):
"""
side_effect for subprocess.run that:
- Records every command into calls_store
- Returns 'ansible_rc' for ansible-playbook
- Returns rc=0 for all other commands (make, validation, etc.)
Side effect for subprocess.run that:
- records all commands to calls_store
- returns a CompletedProcess with ansible_rc for ansible-playbook
- returns success (rc=0) for all other commands
"""
def _side_effect(cmd, *args, **kwargs):
# Normalize into a list for easier assertions
if isinstance(cmd, list):
calls_store.append(cmd)
else:
calls_store.append([cmd])
# Special handling for ansible-playbook
if isinstance(cmd, list) and cmd and cmd[0] == "ansible-playbook":
return subprocess.CompletedProcess(
cmd,
@@ -175,28 +191,19 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
stderr="ANSIBLE_STDERR\n",
)
# Everything else (make, python inventory) is treated as success
return subprocess.CompletedProcess(cmd, 0, stdout="", stderr="")
return _side_effect
@mock.patch("subprocess.run")
def test_run_ansible_playbook_builds_correct_command(self, mock_run):
"""
Happy-path test:
- MODE_CLEANUP=True → 'make clean' is executed
- build/test phases are executed
- ansible-playbook is called with expected arguments
- commands are fully mocked (no real execution)
"""
calls: List[List[str]] = []
mock_run.side_effect = self._fake_run_side_effect(calls, ansible_rc=0)
modes: Dict[str, Any] = {
"MODE_CLEANUP": True,
"MODE_ASSERT": True,
"MODE_DEBUG": True, # should enforce at least -vvv
"MODE_DEBUG": True,
}
inventory_path = "inventories/github-ci/servers.yml"
@@ -210,16 +217,14 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
limit=limit,
allowed_applications=allowed_apps,
password_file=password_file,
verbose=1, # explicitly set, then raised by MODE_DEBUG
verbose=1,
skip_build=False,
skip_tests=False,
logs=False,
diff=True,
)
# We expect at least: make clean, make messy-build, make messy-test,
# plus the ansible-playbook invocation. Inventory validation is also
# done via python ... inventory.py but we do not assert the full path.
# Cleanup, build, tests
self.assertTrue(
any(call == ["make", "clean"] for call in calls),
"Expected 'make clean' when MODE_CLEANUP is true",
@@ -241,12 +246,12 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
"Expected inventory validation call (... inventory.py ...)",
)
# Last command should be ansible-playbook
# The last call should be ansible-playbook
self.assertGreaterEqual(len(calls), 1)
last_cmd = calls[-1]
self.assertEqual(last_cmd[0], "ansible-playbook")
# Check inventory and playbook args
# Inventory and playbook ordering: -i <inventory> <playbook>
self.assertIn("-i", last_cmd)
self.assertIn(inventory_path, last_cmd)
@@ -254,22 +259,22 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
self.assertGreater(len(last_cmd), idx_inv + 1)
playbook_arg = last_cmd[idx_inv + 1]
self.assertTrue(
playbook_arg.endswith(os.path.join("", "playbook.yml")),
playbook_arg.endswith("playbook.yml"),
f"playbook argument should end with 'playbook.yml', got: {playbook_arg}",
)
# Check --limit / -l
# Limit handling
self.assertIn("-l", last_cmd)
self.assertIn(limit, last_cmd)
# allowed_applications extra var
# Allowed applications extra var
last_cmd_str = " ".join(last_cmd)
self.assertIn(
"allowed_applications=web-app-foo,web-app-bar",
last_cmd_str,
)
# Modes passed as -e
# MODE_* variables
self.assertIn("MODE_CLEANUP=true", last_cmd_str)
self.assertIn("MODE_ASSERT=true", last_cmd_str)
self.assertIn("MODE_DEBUG=true", last_cmd_str)
@@ -278,27 +283,22 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
self.assertIn("--vault-password-file", last_cmd)
self.assertIn(password_file, last_cmd)
# --diff should be present
# Diff flag
self.assertIn("--diff", last_cmd)
# Verbosity: MODE_DEBUG enforces at least -vvv regardless of initial -v
# Verbosity should be at least -vvv when MODE_DEBUG=True
self.assertTrue(
any(arg.startswith("-vvv") for arg in last_cmd),
"Expected at least -vvv because MODE_DEBUG=True",
)
# Verify that for ansible-playbook, we asked for text+capture_output
# Ensure we did not accidentally set text/capture_output in the final run
last_call = mock_run.call_args_list[-1]
# In streaming mode we no longer pass text/capture_output to subprocess.run
self.assertNotIn("text", last_call.kwargs)
self.assertNotIn("capture_output", last_call.kwargs)
@mock.patch("subprocess.run")
def test_run_ansible_playbook_failure_exits_with_code(self, mock_run):
"""
If ansible-playbook returns non-zero, run_ansible_playbook should exit
with the same code. All external commands are mocked.
"""
def test_run_ansible_playbook_failure_exits_with_code_and_skips_phases(self, mock_run):
calls: List[List[str]] = []
mock_run.side_effect = self._fake_run_side_effect(calls, ansible_rc=4)
@@ -327,6 +327,46 @@ class TestRunAnsiblePlaybook(unittest.TestCase):
any(call and call[0] == "ansible-playbook" for call in calls),
"ansible-playbook should have been invoked once in the error path",
)
# No cleanup, no build, no tests, no inventory validation
self.assertFalse(any(call == ["make", "clean"] for call in calls))
self.assertFalse(any(call == ["make", "messy-build"] for call in calls))
self.assertFalse(any(call == ["make", "messy-test"] for call in calls))
self.assertFalse(
any(
isinstance(call, list)
and any("inventory.py" in part for part in call)
for call in calls
)
)
@mock.patch("subprocess.run")
def test_run_ansible_playbook_cleanup_with_logs_uses_clean_keep_logs(self, mock_run):
calls: List[List[str]] = []
mock_run.side_effect = self._fake_run_side_effect(calls, ansible_rc=0)
modes: Dict[str, Any] = {
"MODE_CLEANUP": True,
"MODE_ASSERT": False,
"MODE_DEBUG": False,
}
deploy.run_ansible_playbook(
inventory="inventories/github-ci/servers.yml",
modes=modes,
limit=None,
allowed_applications=None,
password_file=None,
verbose=0,
skip_build=True,
skip_tests=True,
logs=True,
diff=False,
)
self.assertTrue(
any(call == ["make", "clean-keep-logs"] for call in calls),
"Expected 'make clean-keep-logs' when MODE_CLEANUP=true and logs=True",
)
if __name__ == "__main__":