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

78 lines
2.8 KiB
Python

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.config import get
from utils.roles.applications.services.sso import get_sso_config
_APPLICATION_ID = "web-app-nextcloud"
class LookupModule(LookupBase):
"""
lookup('sso_oidc_plugin')
Resolves the effective OIDC plugin flavor for the Nextcloud role.
Resolution order:
1. "" if services.sso.enabled is falsy (no OIDC plugin should be
active when the OIDC service itself is disabled — otherwise
Nextcloud would still hand off to Keycloak using a redirect_uri
that the client no longer whitelists).
2. An explicit string value at applications['web-app-nextcloud']
.services.sso.oidc.plugin (inventory override).
3. "oidc_login" if services.ldap.enabled is truthy
(pulsejet/nextcloud-oidc-login, proxy-LDAP capable).
4. "sociallogin" otherwise (nextcloud/sociallogin).
Mirrors the former `_applications_nextcloud_oidc_flavor` group_vars helper
that was removed in commit 77a0e16ea.
"""
def run(self, terms, variables: dict[str, Any] | None = None, **kwargs):
if terms:
raise AnsibleError("lookup('sso_oidc_plugin') takes no positional terms.")
templar = getattr(self, "_templar", None)
variables = variables or getattr(self._templar, "available_variables", {}) or {}
# Use the same merged+rendered applications payload that lookup('config')
# consumes. The raw `variables["applications"]` that Ansible hands the
# lookup is the pre-merge override slice, so nested defaults like
# services.ldap.enabled are not yet visible there and the flavor
# would silently fall back to 'sociallogin'.
applications = lookup_loader.get(
"applications", loader=self._loader, templar=templar
).run([], variables=variables)[0]
if not get_sso_config(applications, _APPLICATION_ID)["is_enabled"]:
return [""]
explicit = get(
applications=applications,
application_id=_APPLICATION_ID,
config_path="services.sso.oidc.plugin",
strict=False,
default=None,
skip_missing_app=True,
)
if isinstance(explicit, str) and explicit.strip():
return [explicit.strip()]
ldap_enabled = bool(
get(
applications=applications,
application_id=_APPLICATION_ID,
config_path="services.ldap.enabled",
strict=False,
default=False,
skip_missing_app=True,
)
)
return ["oidc_login" if ldap_enabled else "sociallogin"]