Files
computer-playbook/plugins/lookup/active_alertmanager_channels.py
T
kevinveenbirkenbachandClaude Opus 4.7 85f1caccc7 refactor(utils): consolidate role-scoped helpers under utils/roles and split templating
Tighten the utils namespace so each subpackage owns one concern:

- utils/applications/* moves under utils/roles/applications/* (helpers
  that operate on the runtime applications dict and meta/services.yml).
- utils/service_registry.py and utils/database_service.py move under
  utils/roles/applications/services/ as registry.py and database.py.
- utils/entity_name_utils.py becomes utils/roles/entity_name.py.
- utils/invokable.py, utils/valid_deploy_id.py, and the existing
  utils/roles/resource_validation.py group under utils/roles/validation/
  as invokable.py, deploy_id.py, and resources.py.
- utils/templating.py and utils/jinja_strict.py split into
  utils/templating/ansible.py (Templar + TrustedAsTemplate, lookup-env
  shortcut) and utils/templating/jinja.py (vanilla Jinja2 Environment,
  multi-pass strict render).

Every caller in utils, cli, plugins, roles/<role>/{filter,lookup}_plugins,
tests, and the docs that link to the moved files is updated to the new
import paths. Test files mirror the new source layout
(tests/unit/utils/{roles,templating}/...).

New READMEs at utils/cleanup/, utils/roles/, utils/roles/applications/services/,
utils/roles/validation/, and utils/templating/ follow the
documentation.md and readme_md.md guidelines.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-08 03:53:43 +02:00

61 lines
1.9 KiB
Python

from __future__ import annotations
from typing import Any
from ansible.plugins.lookup import LookupBase
from utils.cache.applications import get_merged_applications
from utils.roles.applications.config import get as get_app_conf
class LookupModule(LookupBase):
"""
Return a sorted list of communication-channel app IDs that are deployed on
this host.
Deployment check : app ID must appear in group_names.
Channel check : app must declare services.prometheus.communication.channel: true
in its own role config — the self-declaration pattern (SPOT per app,
no hardcoded list anywhere).
Usage in a template:
{% set _comm_channels = lookup('active_alertmanager_channels') %}
'applications' is obtained via get_merged_applications — the same merged view
that backs lookup('applications').
"""
def run(
self,
terms: list[Any],
variables: dict[str, Any] | None = None,
**kwargs: Any,
) -> list[list[str]]:
vars_ = variables or getattr(self._templar, "available_variables", {}) or {}
applications = get_merged_applications(
variables=vars_,
roles_dir=kwargs.get("roles_dir"),
templar=getattr(self, "_templar", None),
)
group_names: list[str] = vars_.get("group_names", [])
result: list[str] = []
for app_id in sorted(applications.keys()):
if app_id not in group_names:
continue
is_channel = get_app_conf(
applications=applications,
application_id=app_id,
config_path="services.prometheus.communication.channel",
strict=False,
default=False,
skip_missing_app=True,
)
if is_channel:
result.append(app_id)
return [result]