Files
computer-playbook/plugins/lookup/tls.py
T
kevinveenbirkenbachandClaude Opus 5.5 44aaa68924 refactor(tls): add url.origin and use it wherever url.base lost its trailing slash
lookup('tls', app, 'url.base') always ends in '/', and 39 call sites in 25 files rebuilt the slash-less form by hand with regex_replace('/$', ''), regex_replace('/+$', ''), trim('/') or .rstrip('/'), directly or on a variable holding url.base. The lookup now returns that value as url.origin (scheme://host, url.base minus its final '/'), and every call site reads it; two sites that stripped the slash only to append it again now take url.base as is, and GITLAB_URL and DASHBOARD_JS_CDN_URL lost their last consumer.

test_url_base_no_double_slash gains the rule url-base-strip, so url.origin stays the only way to the slash-less URL; it flags all nine HEAD sites probed and none after the change. The same lint keeps url-base-double-slash and url-base-addon-value, which put the nine Nextcloud integration URLs, the Mattermost and SuiteCRM facts and the XWiki instance on the slash-less form, drop the stray '/' before Joomla's index.php callback, and give BBB its api.url as [base, suffix] | url_join plus the trailing '/' its client appends 'api/<call>' to; bbb.spec.js now requires exactly that form.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-28 17:21:53 +01:00

121 lines
3.9 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,
align_domain_to_consumer,
as_str,
collect_domains_for_app,
norm_domain,
redirect_targets,
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 {}
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,
redirects=redirect_targets(variables),
forced_mode=forced_mode,
err_prefix="tls",
)
if forced_mode == "app" or (forced_mode == "auto" and "." not in term):
primary_domain = norm_domain(
align_domain_to_consumer(
domains,
app_id,
primary_domain,
variables=variables,
templar=templar,
)
)
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), primary_domain=primary_domain
)
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
origin = f"{web_protocol}://{primary_domain}"
base_url = f"{origin}/"
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, "origin": origin},
}
if want:
return [want_get(resolved, want)]
return [resolved]