Files
computer-playbook/utils/templating/README.md
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

1.2 KiB

Templating Utilities 🧩

Strict Jinja renderers used by lookup plugins, library modules, and the YAML cache layer.

Scope 📋

Modules in utils/templating/ MUST limit themselves to rendering {{ ... }} and {% ... %} constructs found in YAML values, lookups, and templated config strings.

Both renderers fail loudly when Jinja markers cannot be resolved so generated configs never silently leak unrendered placeholders.

Modules 📦

Module Engine When to use
ansible.py Ansible's internal Templar (with TrustedAsTemplate tagging for Ansible 2.19+) When the caller already has Ansible's variable stack and wants tag-aware rendering with shortcuts for lookup('env', ...), simple var.path lookups, and literal coercion.
jinja.py Standalone jinja2.Environment When the caller runs in a context where Templar can silently leave markers untouched (some lookup plugin entry points). Renders multiple passes so nested vars (A.x = "{{ B.y }}", B.y = "{{ C.z }}") collapse fully.

Example Imports ✍️

from utils.templating.ansible import render_ansible_strict
from utils.templating.jinja import render_strict