mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 02:54:26 +00:00
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>
14 lines
717 B
Markdown
14 lines
717 B
Markdown
# Role Utilities 🧩
|
|
|
|
Helpers under `utils/roles/` operate on Ansible role artefacts and the dictionaries that mirror them at runtime.
|
|
|
|
## Scope 📋
|
|
|
|
Modules in `utils/roles/` MUST stay focused on data that originates from `roles/<role>/` (`meta/services.yml`, `meta/main.yml`, `vars/`, `defaults/`) or the runtime dictionary that mirrors those files (`applications`).
|
|
|
|
Modules in `utils/roles/` MUST NOT depend on Ansible plugin loader internals at import time so the same code can be imported from filter plugins, lookup plugins, library modules, the CLI, and tests.
|
|
|
|
## Subpackages 📦
|
|
|
|
- [applications/](applications/README.md) helpers around the central `applications` dict and the role config that feeds it.
|