mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-08 19:56:53 +00:00
kevinveenbirkenbach
24616b2d35
- Move get_docker_paths() implementation from filter_plugins to module_utils to make it reusable by filters and lookup plugins (single source of truth) - Adapt filter_plugins/get_docker_paths.py to re-export the shared util - Add new lookup plugin "database" resolving DB settings from applications config - Fix unit test patching: patch module_utils.docker_paths_utils.get_entity_name instead of filter module, because imports are now bound at util level - Add comprehensive unit tests for database lookup covering all helper-variable cases https://chatgpt.com/share/6983b526-00dc-800f-b3a0-b71e4104d0fc
Shared Utility Code (module_utils/) for Infinito.Nexus
This directory contains shared Python utility code (also known as "library code") for use by custom Ansible modules, plugins, or roles in the Infinito.Nexus project.
When to Use module_utils
- Shared logic: Use
module_utilsto define functions, classes, or helpers that are shared across multiple custom modules, plugins, or filter/lookups in your project. - Reduce duplication: Centralize code such as API clients, input validation, complex calculations, or protocol helpers.
- Maintainability: If you find yourself repeating code in different custom modules/plugins, refactor it into
module_utils/.
Examples
- Shared HTTP(S) connection handler for multiple modules.
- Common validation or transformation functions for user input.
- Utility functions for interacting with Docker, LDAP, etc.
Usage Example
In a custom Ansible module or plugin:
from ansible.module_utils.infinito_utils import my_shared_function
When not to Use module_utils
- Do not place standalone Ansible modules or plugins here—those go into
library/,filter_plugins/, orlookup_plugins/respectively. - Only use for code that will be imported by other plugins or modules.