mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-11 21:26:44 +00:00
Adds `test_semver_pinning.py` under `tests/lint/ansible/services/`. Recursively walks every `roles/*/meta/services.yml`, surfaces a warning for every `image:`+`version:` pair and every `repository:`+`ref:` pair whose value is not semver-compatible. Output via the shared annotations helper (GitHub Actions `::warning::` plus pytest's `warnings.warn`), with a single trailing suppression hint when any finding fires. Never fails the test session. Suppression reuses the existing markers: - `# nocheck: docker-version` for `version:` pins - `# nocheck: repository-version` for `ref:` pins Both accept same-line or line-above placement. The existing external update checks (`utils/update/docker.suppressed_services` and `utils/update/repository.suppressed_ref_lines`) are loosened from strict `line-above` to the default `same-or-above` for consistent marker semantics across all three consumers. Updates `docs/contributing/actions/testing/suppression.md` so the catalog lists both consumers per marker and adds the previously missing `repository-version` row. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Shared Utilities (utils/)
This directory contains shared Python helpers used by custom modules and plugins.
Purpose
Use utils/ for reusable code that should not be duplicated across:
library/modules,plugins/action/,plugins/filter/,plugins/lookup/.
Typical shared utilities:
- API clients,
- validation/conversion helpers,
- path and configuration helpers,
- cross-plugin/module domain logic.
- Shared HTTP(S) connection handler for multiple modules.
- Common validation or transformation functions for user input.
- Utility functions for interacting with Docker, LDAP, etc.
- Grouped helper packages such as
utils/domains/for related domain logic.
Design Guidelines
- Keep helpers focused and composable.
- Avoid side effects during import.
- Prefer explicit function/class APIs over implicit globals.
- Keep dependencies minimal so modules/plugins stay lightweight.
Example Import
from utils.domains.primary_domain import get_primary_domain
What Does Not Belong Here
- Standalone executable modules (put in
library/). - Ansible plugin entrypoints (put in
plugins/*).
References
- Module utilities: https://docs.ansible.com/ansible/latest/dev_guide/developing_module_utilities.html
- Plugin development: https://docs.ansible.com/ansible/latest/dev_guide/developing_plugins.html