Files
computer-playbook/cli/administration/deploy/dedicated/runner.py
T
kevinveenbirkenbachandClaude Opus 5 92615e2176 fix(deploy): pass the execution modes as JSON so a false mode is false
The deploy CLI shipped every mode as -e KEY=value, which ansible-playbook parses as a string at the highest precedence. MODE_DEBUG=false therefore arrived as the non-empty, and so truthy, string false. Every when: MODE_X | bool was unaffected because the filter maps it back, but four sites read a flag bare and silently inverted: openldap wrote LDAP attributes with state exact on every deploy instead of only under MODE_CLEANUP, SYS_SERVICE_DEFAULT_STATE was restarted where it should have been omit, SYS_SERVICE_RUNNER_STATE was never started, and mailu always logged at DEBUG.

Send the modes as one JSON extra-var, which keeps the declared type, and give those four sites the | bool they were missing so the meaning of a flag no longer depends on how its value reached Ansible. A lint pins the rule: a MODE_* read in a truthiness position carries the filter or a nocheck naming a genuine string comparison.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-02 00:07:36 +02:00

149 lines
4.6 KiB
Python

from __future__ import annotations
import datetime
import json
import os
import subprocess
import sys
from pathlib import Path
from typing import Any
from cli.administration.inventory.provision.services_disabler import (
ServicesDisabledConflictError,
assert_services_disabled_inventory_consistency_from_env,
)
from cli.meta.roles.services.called import verify as verify_required_system_services
from .proc import run, run_make
def run_ansible_playbook(
*,
repo_root: str,
playbook_path: str,
inventory_validator_path: str,
inventory: str,
modes: dict[str, Any],
limit: str | None = None,
allowed_applications: list[str] | None = None,
password_file: str | None = None,
verbose: int = 0,
skip_build: bool = False,
diff: bool = False,
ansible_args: list[str] | None = None,
) -> None:
"""Run ansible-playbook with the given parameters and execution modes."""
start_time = datetime.datetime.now(tz=datetime.UTC)
print(f"\n▶️ Script started at: {start_time.isoformat()}\n")
if modes.get("MODE_CLEANUP", False):
print("\n🧹 Cleaning up...\n", flush=True)
run_make(repo_root, "clean")
else:
print("\n🧹 Cleanup skipped (MODE_CLEANUP not set or False)\n")
if not skip_build:
print("\n🛠️ Running project build (make setup)...\n")
run_make(repo_root, "setup")
else:
print("\n🛠️ Build skipped (--skip-build)\n")
try:
assert_services_disabled_inventory_consistency_from_env(
inventory_dir=Path(inventory).resolve().parent,
roles_dir=Path(repo_root).resolve() / "roles",
)
except ServicesDisabledConflictError as exc:
print(f"\n[ERROR] {exc}\n", file=sys.stderr)
sys.exit(1)
if modes.get("MODE_ASSERT") is False:
print("\n🔍 Inventory assertion explicitly disabled (MODE_ASSERT=false)\n")
else:
print("\n🔍 Validating inventory before deployment...\n")
try:
run(
[sys.executable, inventory_validator_path, str(Path(inventory).parent)],
cwd=repo_root,
check=True,
)
except subprocess.CalledProcessError:
print(
"\n[ERROR] Inventory validation failed. Aborting deployment.\n",
file=sys.stderr,
)
sys.exit(1)
cmd: list[str] = ["ansible-playbook", "-i", inventory, playbook_path]
if limit:
cmd.extend(["-l", limit])
if allowed_applications:
joined = ",".join(allowed_applications)
cmd.extend(["-e", f"APPLICATIONS_WHITELIST={joined}"])
if modes:
cmd.extend(["-e", json.dumps(modes)])
if password_file:
cmd.extend(["--vault-password-file", password_file])
if diff:
cmd.append("--diff")
if modes.get("MODE_DEBUG", False):
verbose = max(verbose, 3)
if verbose:
cmd.append("-" + "v" * verbose)
if ansible_args:
cmd.extend(ansible_args)
ansible_log_path = (
os.environ.get("ANSIBLE_LOG_PATH") or "/tmp/infinito-deploy.log" # noqa: S108
)
os.environ["ANSIBLE_LOG_PATH"] = ansible_log_path
try:
log_offset_before = Path(ansible_log_path).stat().st_size
except OSError:
log_offset_before = 0
print("\n🚀 Launching Ansible Playbook...\n")
result = subprocess.run(cmd, cwd=repo_root, check=False)
if result.returncode != 0:
print(
f"\n[ERROR] ansible-playbook exited with status {result.returncode}\n",
file=sys.stderr,
)
sys.exit(result.returncode)
if allowed_applications:
ok, missing = verify_required_system_services(
roles_dir=Path(repo_root) / "roles",
log_path=ansible_log_path,
log_byte_offset=log_offset_before,
deployed_role_ids=allowed_applications,
)
if not ok:
print(
f"\n[ERROR] required role(s) did not execute for deploy "
f"{allowed_applications}:",
file=sys.stderr,
)
for role in missing:
print(f" - {role}", file=sys.stderr)
print(
" See `required_by` declarations in roles/*/meta/services.yml — "
"the role(s) above must run on every deploy whose primaries match.",
file=sys.stderr,
)
sys.exit(2)
end_time = datetime.datetime.now(tz=datetime.UTC)
print(f"\n✅ Script ended at: {end_time.isoformat()}\n")
print(f"⏱️ Total execution time: {end_time - start_time}\n")