Files
computer-playbook/plugins/lookup/sso.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

62 lines
2.1 KiB
Python

"""Ansible lookup: unified SSO state for a consumer role.
API (STRICT):
- {{ lookup('sso', application_id) }} → full dict
- {{ lookup('sso', application_id, 'is_enabled') }} → bool
- {{ lookup('sso', application_id, 'is_proxy_gated') }} → bool
- {{ lookup('sso', application_id, 'is_oidc_native') }} → bool
- {{ lookup('sso', application_id, 'flavor') }} → str
- {{ lookup('sso', application_id, 'enabled') }} → bool
- {{ lookup('sso', application_id, 'shared') }} → bool
Wraps ``utils.roles.applications.services.sso.get_sso_config`` so
templates and tasks share one source of truth with Python callers
(notably ``plugins/filter/compose_volumes.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.roles.applications.services.sso import get_sso_config
class LookupModule(LookupBase):
def run(
self,
terms: list[Any],
variables: dict[str, Any] | None = None,
**kwargs: Any,
) -> list[Any]:
terms = terms or []
if len(terms) not in (1, 2):
raise AnsibleError("sso: requires application_id [, want_path]")
application_id = str(terms[0]).strip()
if not application_id:
raise AnsibleError("sso: application_id must not be empty")
want = str(terms[1]).strip() if len(terms) == 2 else "all"
if not want:
want = "all"
vars_ = variables or self._templar.available_variables
applications = lookup_loader.get(
"applications", loader=self._loader, templar=getattr(self, "_templar", None)
).run([], variables=vars_)[0]
resolved = get_sso_config(applications, application_id)
if want == "all":
return [resolved]
if want not in resolved:
raise AnsibleError(
f"sso: unknown want_path '{want}'. "
f"Valid: {sorted(resolved.keys())} or 'all'."
)
return [resolved[want]]