Files
computer-playbook/utils/roles/applications/services/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

25 lines
1.2 KiB
Markdown

# Application Service Helpers 🧩
Helpers that resolve and reason about per-application service declarations from `roles/<role>/meta/services.yml`.
## Scope 📋
Modules in `utils/roles/applications/services/` MUST limit themselves to the service-graph derived from `meta/services.yml`: registry construction, dependency resolution between provider and consumer roles, and database backend selection per application.
Modules in `utils/roles/applications/services/` MUST NOT take over wider application-config concerns that belong to the sibling `config` module (path-driven `applications.<id>.<dotted>` reads, schema validation).
## Modules 📦
- [registry.py](registry.py) builds the service registry from roles and resolves shared-service auto-include edges (`services.<X>.enabled` AND `services.<X>.shared`) to provider role names.
- [database.py](database.py) resolves the active database backend for an application (`mariadb`, `postgres`, ...) from its services map.
## Example Import ✍️
```python
from utils.roles.applications.services.registry import (
build_service_registry_from_roles_dir,
resolve_service_dependency_roles_from_config,
)
from utils.roles.applications.services.database import resolve_database_service_key
```