| name | ansible-test |
| description | Run ansible-test sanity on module/plugin changes from the project virtualenv. Run after modifying any file under plugins/. |
ansible-test
Run sanity after any change under plugins/. It catches DOCUMENTATION/RETURN/EXAMPLES
drift, argspec mismatches, and import errors — the same suite CI runs. Also run black and
ruff.
Pre-checks
Cheap checks from the primary checkout, before running sanity:
git diff --check
venv/bin/python -m compileall -q plugins
The checkout
Sanity only runs from a real checkout of the collection at
ansible_collections/{{ namespace }}/{{ name }}/ (from galaxy.yml):
- Not the primary checkout, and not via symlink.
- This repo uses a git-ignored, on-demand checkout at
venv/ansible_collections/{{ namespace }}/{{ name }}.
Create it once, if git worktree list / ls doesn't show it, as a detached worktree — it must
be detached since the branch is checked out in the primary tree:
git worktree add --detach venv/ansible_collections/{{ namespace }}/{{ name }}
A plain copy works too (sanity doesn't need git), but then sync the full tree, not just plugins/.
Run
Sync your edits in (always --delete, so removed/renamed files don't linger), then run from
inside the checkout:
rsync -a --delete plugins/ venv/ansible_collections/{{ namespace }}/{{ name }}/plugins/
cd venv/ansible_collections/{{ namespace }}/{{ name }}
../../../bin/ansible-test sanity --python "$(cat .python-version)" plugins/modules/{{ file }}.py
- Add
--test validate-modules for just doc/argspec checks.
- Drop the path argument for the full suite (what CI runs).
- A clean run exits
0.
- Fix failures in the primary checkout, then re-sync and re-run — the checkout is a scratch
copy.
Dependencies
