Files
computer-playbook/plugins/lookup/tls.py
T
kevinveenbirkenbachandClaude Opus 4.8 238bc285c7 refactor(lookups): reach merged config via the lookup-loader SPOT
Consumer lookup plugins now reach the merged config through the Ansible
lookup loader instead of importing get_merged_applications /
get_merged_domains from utils.cache. The merge stays one cached
implementation surfaced via the applications/config/domains/users lookups;
consumers call lookup_loader.get(...).run() (the compose_networks idiom).

- get_merged_applications walks the whole meta/ tree recursively
  (meta/**/*.yml to applications.<app>.<path>, addons and any depth) and
  folds the raw meta/volumes.yml subtree onto applications.<app>.volumes
  after the templar render so the Jinja source: strings stay unrendered.
- 31 consumer lookups rerouted; providers (applications/config/
  applications_current_play/users/domains) and the raw-volume accessors
  (volume/nginx) keep the cache import behind # nocheck: lookup-cache-import.
- New lint test_no_cache_imports_in_lookups enforces the contract.
- nfs_flavor is now the flavor SPOT (svc-storage-nfs-server + nfs_client_src
  resolve via lookup('nfs_flavor')); removed the unused STORAGE_NFS_FLAVOR
  group_var. Extracted extract_default_credentials to
  utils/cache/schema_credentials.py to keep applications.py under the cap.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-28 18:35:06 +02:00

105 lines
3.5 KiB
Python

# STRICT TLS resolver (without SAN/cert identity planning).
#
# Certificate identity planning (SAN list, cert/key paths) is moved to:
# lookup_plugins/cert.py
from __future__ import annotations
from typing import Any
from ansible.errors import AnsibleError
from ansible.plugins.loader import lookup_loader
from ansible.plugins.lookup import LookupBase
from utils.tls_common import (
AVAILABLE_FLAVORS,
as_str,
collect_domains_for_app,
require,
resolve_enabled,
resolve_mode,
resolve_term,
uniq_preserve,
want_get,
)
class LookupModule(LookupBase):
def run(self, terms, variables: dict | None = None, **kwargs):
variables = variables or {}
# New API: want-path is the 2nd positional term.
# Legacy 'want=' kwarg is ignored (no error) to keep tasks noise-free.
if not terms or len(terms) not in (1, 2):
raise AnsibleError(
"tls: one or two terms required: (domain|application_id[, want_path])"
)
templar = getattr(self, "_templar", None)
term = as_str(templar.template(terms[0]) if templar else terms[0])
if not term:
raise AnsibleError("tls: term is empty")
want = as_str(terms[1]).strip() if len(terms) == 2 else ""
domains = lookup_loader.get(
"domains", loader=self._loader, templar=getattr(self, "_templar", None)
).run([], variables=variables)[0]
applications = lookup_loader.get(
"applications", loader=self._loader, templar=getattr(self, "_templar", None)
).run([], variables=variables)[0]
enabled_default = require(variables, "TLS_ENABLED", (bool, int))
mode_default = as_str(require(variables, "TLS_MODE", str))
if mode_default not in AVAILABLE_FLAVORS:
raise AnsibleError(
f"tls: TLS_MODE must be one of {sorted(AVAILABLE_FLAVORS)}, got '{mode_default}'"
)
forced_mode = as_str(kwargs.get("mode", "auto")).lower()
app_id, primary_domain = resolve_term(
term,
domains=domains,
applications=applications,
forced_mode=forced_mode,
err_prefix="tls",
)
all_domains = collect_domains_for_app(domains, app_id, err_prefix="tls")
all_domains = (
uniq_preserve([primary_domain, *all_domains])
if all_domains
else [primary_domain]
)
app = applications.get(app_id, {})
if not isinstance(app, dict):
app = {}
enabled = resolve_enabled(app, bool(enabled_default))
mode = resolve_mode(app, enabled, mode_default, err_prefix="tls")
if mode not in {"off"} | AVAILABLE_FLAVORS:
raise AnsibleError(f"tls: unsupported mode '{mode}' for app '{app_id}'")
web_protocol = "https" if enabled else "http"
websocket_protocol = "wss" if enabled else "ws"
web_port = 443 if enabled else 80
base_url = f"{web_protocol}://{primary_domain}/"
resolved: dict[str, Any] = {
"application_id": app_id,
"domain": primary_domain,
"enabled": enabled,
"mode": mode,
"domains": {"primary": primary_domain, "all": all_domains},
"protocols": {"web": web_protocol, "websocket": websocket_protocol},
"ports": {"web": web_port},
"url": {"base": base_url},
}
if want:
return [want_get(resolved, want)]
return [resolved]