mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-09 20:26:33 +00:00
Adds ``[tool.ruff.lint]`` with ``select = ["E", "F", "I", "B", "UP"]``
and ``target-version = "py311"``. ``E501`` is ignored because
``ruff format`` already reflows what it can; the remaining long lines
are unsplittable string literals / URLs.
Auto-fixed (2753 issues, behavior-preserving):
- UP006/UP035: ``List[X]`` → ``list[X]``, ``Dict[X]`` → ``dict[X]``,
``from typing import …`` redirected where superseded by builtins.
- UP045: ``Optional[X]`` → ``X | None``.
- UP010/UP009/UP015: dropped Python-2-era pragmas (``from __future__
import absolute_import, division, print_function``,
``# -*- coding: utf-8 -*-``), redundant ``open(..., "r")`` mode.
- UP004: dropped implicit ``class X(object):``.
- UP022/UP008/UP032: stdlib idiom modernization (``capture_output``,
super-call simplification, etc.).
- B905: ``zip(...)`` → ``zip(..., strict=False)`` (preserves prior
behavior; switching to ``strict=True`` is a separate semantic
choice not made here).
- I001: import-block ordering.
Hand-fixed (66 issues):
- B904 × 54: appended ``from <bound>`` (when the enclosing ``except``
binds a name) or ``from None`` (when it doesn't) so chained
exceptions stay distinguishable from errors-during-exception-
handling. Applied via a small AST-aware script that walked back to
the enclosing ``except`` clause and matched the binding.
- B017 × 4: narrowed broad ``assertRaises(Exception)`` to the actual
``AnsibleError`` / ``AnsibleFilterError`` raised by the code under
test.
- B023 × 2: bound captured loop variables via default args
(``def _record(name, *, _path_real=path_real, ...)``) so each
closure gets its own snapshot.
- B007 × 2: unused loop control variables renamed to ``_`` /
rewritten to ``.values()``.
- UP007 × 2: ``Union[X, Y]`` → ``X | Y`` (plus dropping the now-unused
``from typing import Union``).
- B018 × 1: Odoo addon manifests are bare dict expressions at module
level by design — suppressed with an inline ``# noqa: B018`` and
rationale comment.
- UP031 × 1: printf-style format → f-string.
The 65 ``# noqa: …`` markers introduced by the auto-fixer all carry
real ruff codes (``B018``, ``E402``, ``F401``, etc.), so
``test_noqa_only_ruff_codes`` stays green.
Verification
============
- ``ruff check .`` → All checks passed
- ``ruff format --check .`` → 894 files already formatted
- ``tests.lint.repository.{test_project_root_import,
test_no_direct_yaml_calls, test_noqa_only_ruff_codes}`` and
``tests.unit.utils.annotations.test_suppress`` → 20 tests OK
- 1621 unit tests → all pass
- Integration suite: 44 failures (pre-existing baseline, none from
this change), 1 skipped.
Going forward, the new rules block regressions on E (style), F
(pyflakes), I (import order), B (likely-bug patterns), and UP
(modernization to py311) for any new code.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
365 lines
12 KiB
Python
365 lines
12 KiB
Python
from __future__ import annotations
|
|
|
|
import argparse
|
|
import os
|
|
import sys
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
from .credentials_generator import generate_credentials_for_roles
|
|
from .filters import filter_dynamic_inventory, parse_roles_list
|
|
from .host_vars import (
|
|
apply_vars_overrides,
|
|
apply_vars_overrides_from_file,
|
|
ensure_become_password,
|
|
ensure_host_vars_file,
|
|
)
|
|
from .inventory_generator import generate_dynamic_inventory
|
|
from .mirror_overrides import apply_mirror_overrides
|
|
from .passwords import generate_random_password
|
|
from .project import build_env_with_project_root, detect_project_root
|
|
from .services_disabler import apply_services_disabled_from_env
|
|
from .yaml_io import dump_yaml, load_yaml
|
|
|
|
|
|
def _fatal(msg: str) -> None:
|
|
raise SystemExit(f"[FATAL] {msg}")
|
|
|
|
|
|
def _resolve_inventory_file(
|
|
inventory_dir: Path, inventory_file_arg: str | None
|
|
) -> Path:
|
|
if inventory_file_arg:
|
|
return Path(inventory_file_arg).resolve()
|
|
return (inventory_dir / "devices.yml").resolve()
|
|
|
|
|
|
def _resolve_roles_dir(project_root: Path, roles_dir_arg: str | None) -> Path:
|
|
return (
|
|
Path(roles_dir_arg) if roles_dir_arg else (project_root / "roles")
|
|
).resolve()
|
|
|
|
|
|
def _resolve_categories_file(roles_dir: Path, categories_file_arg: str | None) -> Path:
|
|
return (
|
|
Path(categories_file_arg)
|
|
if categories_file_arg
|
|
else (roles_dir / "categories.yml")
|
|
).resolve()
|
|
|
|
|
|
def _resolve_mirrors_file(project_root: Path, mirror_arg: str | None) -> Path | None:
|
|
"""
|
|
--mirror can be used in two ways:
|
|
- --mirror -> uses <repo-root>/mirrors.yml
|
|
- --mirror /path/file -> uses the given path
|
|
|
|
If mirror_arg is None, mirroring is disabled.
|
|
"""
|
|
if mirror_arg is None:
|
|
return None
|
|
|
|
# argparse uses const="mirrors.yml" when flag is present without value
|
|
candidate = Path(mirror_arg)
|
|
if not candidate.is_absolute():
|
|
candidate = (project_root / candidate).resolve()
|
|
|
|
return candidate.resolve()
|
|
|
|
|
|
def main(argv: list[str] | None = None) -> int:
|
|
parser = argparse.ArgumentParser(
|
|
description=(
|
|
"Create or update a full inventory for a host and generate credentials "
|
|
"for all selected applications."
|
|
)
|
|
)
|
|
parser.add_argument(
|
|
"inventory_dir", help="Inventory directory (e.g. inventories/galaxyserver)."
|
|
)
|
|
parser.add_argument(
|
|
"--host",
|
|
default="localhost",
|
|
help="Hostname to use in the inventory (default: localhost).",
|
|
)
|
|
parser.add_argument(
|
|
"--primary-domain",
|
|
default=None,
|
|
help="Primary domain for this host (optional).",
|
|
)
|
|
parser.add_argument(
|
|
"--ssl-disabled",
|
|
action="store_true",
|
|
help="Disable SSL for this host (sets TLS_ENABLED: false).",
|
|
)
|
|
parser.add_argument(
|
|
"--become-password", default=None, help="Optional become password (vaulted)."
|
|
)
|
|
parser.add_argument(
|
|
"--vars",
|
|
required=False,
|
|
help=(
|
|
"Optional JSON object string with additional values for host_vars/<host>.yml. "
|
|
"Merged and overwrites existing values."
|
|
),
|
|
)
|
|
parser.add_argument(
|
|
"--ip4", default="127.0.0.1", help="IPv4 address for networks.internet.ip4."
|
|
)
|
|
parser.add_argument(
|
|
"--ip6", default="::1", help="IPv6 address for networks.internet.ip6."
|
|
)
|
|
parser.add_argument(
|
|
"--inventory-file",
|
|
default=None,
|
|
help="Inventory YAML file path (default: <inventory-dir>/devices.yml).",
|
|
)
|
|
|
|
parser.add_argument(
|
|
"--roles",
|
|
nargs="+",
|
|
help="Legacy include list (used only if neither --include nor --exclude is set).",
|
|
)
|
|
parser.add_argument(
|
|
"--include",
|
|
nargs="+",
|
|
help="Only include these application_ids (mutually exclusive with --exclude).",
|
|
)
|
|
parser.add_argument(
|
|
"--exclude",
|
|
nargs="+",
|
|
help="Exclude these application_ids (mutually exclusive with --include).",
|
|
)
|
|
|
|
parser.add_argument(
|
|
"--vault-password-file",
|
|
default=None,
|
|
help="Vault password file path. Default: <inventory-dir>/.password",
|
|
)
|
|
parser.add_argument(
|
|
"--roles-dir", default=None, help="Path to roles/ (default: <repo-root>/roles)."
|
|
)
|
|
parser.add_argument(
|
|
"--categories-file",
|
|
default=None,
|
|
help="Path to roles/categories.yml (default: <roles-dir>/categories.yml).",
|
|
)
|
|
parser.add_argument(
|
|
"--workers",
|
|
type=int,
|
|
default=4,
|
|
help="Worker threads for credentials generation (default: 4).",
|
|
)
|
|
parser.add_argument(
|
|
"--vars-file",
|
|
default=None,
|
|
help=(
|
|
"Optional YAML file with additional values for host_vars/<host>.yml. "
|
|
"Merged and overwrites existing values."
|
|
),
|
|
)
|
|
|
|
# New: mirroring support
|
|
parser.add_argument(
|
|
"--mirror",
|
|
nargs="?",
|
|
const="mirrors.yml",
|
|
default=None,
|
|
help=(
|
|
"Apply docker image mirror overrides to host_vars "
|
|
"applications.*.services.* and images_overrides.*.* "
|
|
"(image/version). If used without value, defaults to <repo-root>/mirrors.yml. "
|
|
"If a value is provided, it is treated as a path to the mirrors YAML/JSON file."
|
|
),
|
|
)
|
|
|
|
args = parser.parse_args(argv)
|
|
|
|
include_filter = parse_roles_list(args.include)
|
|
exclude_filter = parse_roles_list(args.exclude)
|
|
legacy_roles_filter = parse_roles_list(args.roles)
|
|
|
|
if include_filter and exclude_filter:
|
|
_fatal(
|
|
"Options --include and --exclude are mutually exclusive. Use only one of them."
|
|
)
|
|
|
|
project_root = detect_project_root(Path(__file__).resolve())
|
|
env = build_env_with_project_root(project_root)
|
|
|
|
roles_dir = _resolve_roles_dir(project_root, args.roles_dir)
|
|
categories_file = _resolve_categories_file(roles_dir, args.categories_file)
|
|
mirrors_file = _resolve_mirrors_file(project_root, args.mirror)
|
|
|
|
inventory_dir = Path(args.inventory_dir).resolve()
|
|
inventory_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
inventory_file = _resolve_inventory_file(inventory_dir, args.inventory_file)
|
|
host_vars_file = (inventory_dir / "host_vars" / f"{args.host}.yml").resolve()
|
|
|
|
# Vault password file
|
|
if args.vault_password_file:
|
|
vault_password_file = Path(args.vault_password_file).resolve()
|
|
else:
|
|
vault_password_file = (inventory_dir / ".password").resolve()
|
|
if not vault_password_file.exists():
|
|
print(
|
|
f"[INFO] No --vault-password-file provided. Creating {vault_password_file} ..."
|
|
)
|
|
vault_password_file.parent.mkdir(parents=True, exist_ok=True)
|
|
password = generate_random_password()
|
|
fd = os.open(
|
|
str(vault_password_file), os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600
|
|
)
|
|
with os.fdopen(fd, "w", encoding="utf-8") as f:
|
|
f.write(password + "\n")
|
|
try:
|
|
vault_password_file.chmod(0o600)
|
|
except PermissionError:
|
|
print(
|
|
f"[WARN] Could not set permissions to 0o600 on {vault_password_file}.",
|
|
file=sys.stderr,
|
|
)
|
|
else:
|
|
print(f"[INFO] Using existing vault password file: {vault_password_file}")
|
|
|
|
tmp_inventory = (inventory_dir / "_inventory_full_tmp.yml").resolve()
|
|
|
|
print(
|
|
"[INFO] Generating dynamic inventory via python -m cli.build.inventory.full ..."
|
|
)
|
|
dyn_inv = generate_dynamic_inventory(
|
|
host=args.host,
|
|
roles_dir=roles_dir,
|
|
categories_file=categories_file,
|
|
tmp_inventory=tmp_inventory,
|
|
project_root=project_root,
|
|
env=env,
|
|
)
|
|
|
|
dyn_inv = filter_dynamic_inventory(
|
|
dyn_inv,
|
|
include_filter=include_filter,
|
|
exclude_filter=exclude_filter,
|
|
legacy_roles_filter=legacy_roles_filter,
|
|
)
|
|
|
|
dyn_children = (dyn_inv.get("all", {}) or {}).get("children", {}) or {}
|
|
application_ids = sorted(dyn_children.keys())
|
|
|
|
# Merge inventory file
|
|
if inventory_file.exists():
|
|
print(f"[INFO] Merging into existing inventory: {inventory_file}")
|
|
base_inv = load_yaml(inventory_file)
|
|
else:
|
|
print(f"[INFO] Creating new inventory file: {inventory_file}")
|
|
base_inv = {}
|
|
|
|
merged_inv = _merge_inventories(base_inv, dyn_inv, host=args.host)
|
|
dump_yaml(inventory_file, merged_inv)
|
|
|
|
# Host vars
|
|
print(f"[INFO] Ensuring host_vars for host '{args.host}' at {host_vars_file}")
|
|
ensure_host_vars_file(
|
|
host_vars_file=host_vars_file,
|
|
host=args.host,
|
|
primary_domain=args.primary_domain,
|
|
ssl_disabled=args.ssl_disabled,
|
|
ip4=args.ip4,
|
|
ip6=args.ip6,
|
|
)
|
|
|
|
print(f"[INFO] Ensuring ansible_become_password for host '{args.host}'")
|
|
ensure_become_password(
|
|
host_vars_file=host_vars_file,
|
|
vault_password_file=vault_password_file,
|
|
become_password=args.become_password,
|
|
)
|
|
|
|
# Credentials
|
|
if application_ids:
|
|
print(
|
|
f"[INFO] Generating credentials for {len(application_ids)} applications..."
|
|
)
|
|
generate_credentials_for_roles(
|
|
application_ids=application_ids,
|
|
roles_dir=roles_dir,
|
|
host_vars_file=host_vars_file,
|
|
vault_password_file=vault_password_file,
|
|
project_root=project_root,
|
|
env=env,
|
|
workers=args.workers,
|
|
)
|
|
else:
|
|
print(
|
|
"[WARN] No application_ids found after filtering. Skipping credentials generation."
|
|
)
|
|
|
|
if args.vars_file:
|
|
print(
|
|
f"[INFO] Applying YAML overrides to host_vars for host '{args.host}' via --vars-file"
|
|
)
|
|
apply_vars_overrides_from_file(
|
|
host_vars_file=host_vars_file, vars_file=Path(args.vars_file).resolve()
|
|
)
|
|
|
|
if args.vars:
|
|
print(
|
|
f"[INFO] Applying JSON overrides to host_vars for host '{args.host}' via --vars"
|
|
)
|
|
apply_vars_overrides(host_vars_file=host_vars_file, json_str=args.vars)
|
|
|
|
# Mirror overrides should win (requested behavior: "überschreiben")
|
|
if mirrors_file is not None:
|
|
print(f"[INFO] Applying mirror overrides from: {mirrors_file}")
|
|
apply_mirror_overrides(host_vars_file=host_vars_file, mirrors_file=mirrors_file)
|
|
|
|
# Disable services listed in SERVICES_DISABLED env var (space- or comma-separated).
|
|
# Also removes the provider roles from the inventory.
|
|
apply_services_disabled_from_env(
|
|
host_vars_file=host_vars_file,
|
|
inventory_file=inventory_file,
|
|
roles_dir=roles_dir,
|
|
)
|
|
|
|
print(
|
|
"[INFO] Done. Inventory and host_vars updated without deleting existing values."
|
|
)
|
|
return 0
|
|
|
|
|
|
def _merge_inventories(
|
|
base: dict[str, Any], new: dict[str, Any], host: str
|
|
) -> dict[str, Any]:
|
|
"""
|
|
Merge `new` inventory into `base` inventory without deleting existing groups/hosts/vars.
|
|
|
|
For each group in `new`:
|
|
- ensure the group exists in `base`
|
|
- ensure `hosts` exists
|
|
- ensure the given `host` is present in that group's `hosts`
|
|
"""
|
|
base_all = base.setdefault("all", {})
|
|
base_children = base_all.setdefault("children", {})
|
|
|
|
new_all = new.get("all", {})
|
|
new_children = (
|
|
(new_all.get("children", {}) or {}) if isinstance(new_all, dict) else {}
|
|
)
|
|
|
|
for group_name, group_data in new_children.items():
|
|
base_group = base_children.setdefault(group_name, {})
|
|
base_hosts = base_group.setdefault("hosts", {})
|
|
|
|
new_hosts = (group_data or {}).get("hosts", {}) or {}
|
|
host_vars: dict[str, Any] = {}
|
|
if isinstance(new_hosts, dict) and host in new_hosts:
|
|
hv = new_hosts.get(host) or {}
|
|
if isinstance(hv, dict):
|
|
host_vars = hv
|
|
|
|
if host not in base_hosts:
|
|
base_hosts[host] = host_vars or {}
|
|
|
|
return base
|