mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-12-09 10:56:01 +00:00
Kevin Veen-Birkenbach
e09f561f0b
- Replace legacy utils/run_once.yml with the new helpers utils/once_flag.yml and utils/once_finalize.yml - Introduce utils/compose_up.yml to ensure docker-compose stacks are up and to flush handlers safely without coupling to run-once flags - Migrate all affected roles (desk-*, dev-*, sys-ctl-*, sys-svc-*, web-app-*, web-svc-*, util-*) to the new run-once helpers - Rework sys-svc-msmtp to auto-load Mailu once per deploy, check reachability, and reuse the running stack instead of requiring multiple playbook passes - Adjust web-app-mailu to integrate cert deployment, handler flushing, and run-once handling so Mailu is fully initialized in a single deploy - Improve Matomo, CDN, logout and CSP/health-check related roles to cooperate with the new compose_up / once_* pattern - Simplify alarm/backup/timer/service orchestration (sys-ctl-alm-*, sys-bkp-provider, sys-timer-cln-bkps, etc.) by moving run-once logic into dedicated 01_core.yml files - Update integration tests so utils/once_flag.yml and utils/once_finalize.yml are recognised as valid run-once providers, keeping the global run_once_* guarantees consistent - Align frontend injection and service dependencies so Mastodon- and Mailu-related services can be brought up coherently within a single deployment cycle rather than several iterations
85 lines
3.2 KiB
Python
85 lines
3.2 KiB
Python
import os
|
|
import re
|
|
import unittest
|
|
import glob
|
|
import yaml
|
|
|
|
|
|
def find_role_task_yml_files(root_dir):
|
|
"""
|
|
Find all .yml or .yaml files under roles/*/tasks directories from project root.
|
|
"""
|
|
pattern_yml = os.path.join(root_dir, 'roles', '*', 'tasks', '*.yml')
|
|
pattern_yaml = os.path.join(root_dir, 'roles', '*', 'tasks', '*.yaml')
|
|
return glob.glob(pattern_yml) + glob.glob(pattern_yaml)
|
|
|
|
|
|
class RunOnceInclusionTest(unittest.TestCase):
|
|
"""
|
|
Ensure that every Ansible block in roles/*/tasks with a when condition matching
|
|
either the dynamic Jinja scheme or a literal run_once_<role_name> is not defined,
|
|
and containing an include_role/import_role also ends with
|
|
include_tasks: utils/once_finalize.yml as its last task.
|
|
"""
|
|
WHEN_PATTERN = re.compile(
|
|
r"(?:run_once_\+\s*\(role_name\s*\|\s*lower\s*\|\s*replace\('\-','\_'\)\)\s*is\s*(?:not\s+)?defined"
|
|
r"|run_once_[a-z0-9_]+\s*is\s*(?:not\s+)?defined)",
|
|
re.IGNORECASE
|
|
)
|
|
|
|
def test_run_once_blocks(self):
|
|
# tests/integration -> tests -> project root
|
|
project_root = os.path.abspath(
|
|
os.path.join(os.path.dirname(__file__), '..', '..')
|
|
)
|
|
violations = []
|
|
|
|
for filepath in find_role_task_yml_files(project_root):
|
|
with open(filepath, 'r') as f:
|
|
try:
|
|
docs = list(yaml.safe_load_all(f))
|
|
except yaml.YAMLError as e:
|
|
self.fail(f"Failed to parse YAML file {filepath}: {e}")
|
|
|
|
for doc in docs:
|
|
# Determine tasks list
|
|
tasks = None
|
|
if isinstance(doc, dict) and isinstance(doc.get('tasks'), list):
|
|
tasks = doc['tasks']
|
|
elif isinstance(doc, list):
|
|
tasks = doc
|
|
if not tasks:
|
|
continue
|
|
|
|
for item in tasks:
|
|
if not isinstance(item, dict) or 'block' not in item:
|
|
continue
|
|
when = item.get('when')
|
|
if not isinstance(when, str) or not self.WHEN_PATTERN.search(when):
|
|
continue
|
|
|
|
block = item['block']
|
|
# Check for include_role or import_role within block
|
|
has_role_include = any(
|
|
isinstance(t, dict) and ('include_role' in t or 'import_role' in t)
|
|
for t in block
|
|
)
|
|
# Check that last task is include_tasks: utils/once_finalize.yml
|
|
last_task = block[-1] if block else None
|
|
has_run_once_include = (
|
|
isinstance(last_task, dict)
|
|
and last_task.get('include_tasks') == 'utils/once_finalize.yml'
|
|
)
|
|
|
|
if has_role_include and not has_run_once_include:
|
|
violations.append(
|
|
f"{filepath}: block with when='{when}' missing final include_tasks: utils/once_finalize.yml"
|
|
)
|
|
|
|
if violations:
|
|
self.fail("Run-once blocks missing include_tasks:\n" + "\n".join(violations))
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|