ansible-module-audit

Ansible Module Audit

Audits a single Ansible module for quality and completeness across five dimensions. Platform-agnostic — works on any Ansible collection (Windows/PowerShell, cloud/REST, network/CLI, Linux/command).

Usage

/ansible-module-audit scvmm_cloud
/ansible-module-audit ec2_instance
/ansible-module-audit ios_config

The argument is a module name from the collection in the current working directory.

When to Use

• After implementing a module — to verify completeness before PR
• During code review — to assess module quality objectively
• Before release — to audit modules for gaps

Execution Steps

Follow these steps exactly. Do NOT ask clarifying questions — research autonomously.

Step 0: Resolve Paths and Detect Platform

Extract the module name from the user's argument. Determine the collection root from the current working directory. Read galaxy.yml to get the collection namespace and name.

Locate module files:

find plugins/modules/ -name "<module_name>.*" -type f

Determine the module type from what exists:

Files found	Module type	Platform
.py + .ps1	PowerShell module	Windows (SCVMM, AD, Exchange, etc.)
.py only	Python module	Cloud, network, Linux, or any non-Windows

Read ALL module files found.

Locate shared utilities:

find plugins/module_utils/ -type f \( -name "*.py" -o -name "*.psm1" -o -name "*.ps1" \)

Read all module_utils files to catalog available shared functions/classes.

Locate integration tests:

Check these paths in order for a test target:

1. tests/integration/targets/<module_name>/ — exact match
2. tests/integration/targets/<base_name>/ — for _info modules, try the base name (e.g., ec2_instance for ec2_instance_info)
3. If neither exists, mark tests as missing (dimensions 3-5 score 0).

If a test target is found, read all YAML files under it recursively.

Identify the platform's API surface type: