be4c7259aa
* WIP tagger session for nox * First pass tagging nox session * Formatting fixup * Adding removal of tmpdir as per discussion * tag session checks for, and uses, existing ansible checkout if it exists, removes tmpdir if it created one. * isort fixup * Working out suggested changes. * Linting cleanup on changes * Different approach to noted chagnes * Reducing tagging session to a bare bones wrapper around the script, leaving all repo management alone * Staging deletion per discussion * Adding tag session to dependency update job * after removing hacking/tagger/requirements.txt moved "gitpython" here for the typing test session requiremnts. * Adding that here didd not accomplish what I'd expected. Removing it and revisiting how to do that. * I think this is where the call needed added to get the tags dependencies automatically updated * remove gitpython, add tag.txt, add blank line * Comment cleanup per OraNod * doc README: document nox tag session instead of manual mode * Update tests/typing.in Per suggestion from @webnjaz Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua> --------- Co-authored-by: Maxwell G <maxwell@gtmx.me> Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <wk.cvs.github@sydorenko.org.ua>
'Hacking' directory tools
env-setup
The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using python >= 3.8.
First, set up your environment to run from the checkout:
$ source ./hacking/env-setup
You will need some basic prerequisites installed. If you do not already have them and do not wish to install them from your operating system package manager, you can install them from pip
$ easy_install pip # if pip is not already available
$ pip install -r requirements.txt
From there, follow ansible instructions on docs.ansible.com as normal.
test-module.py
'test-module.py' is a simple program that allows module developers (or testers) to run a module outside of the ansible program, locally, on the current machine.
Example:
$ ./hacking/test-module.py -m lib/ansible/modules/command.py -a "echo hi"
This is a good way to insert a breakpoint into a module, for instance.
For more complex arguments such as the following yaml:
parent:
child:
- item: first
val: foo
- item: second
val: boo
Use:
$ ./hacking/test-module.py -m module \
-a '{"parent": {"child": [{"item": "first", "val": "foo"}, {"item": "second", "val": "bar"}]}}'
return_skeleton_generator.py
return_skeleton_generator.py helps in generating the RETURNS section of a module. It takes JSON output of a module provided either as a file argument or via stdin.
fix_test_syntax.py
A script to assist in the conversion for tests using filter syntax to proper jinja test syntax. This script has been used to convert all of the Ansible integration tests to the correct format for the 2.5 release. There are a few limitations documented, and all changes made by this script should be evaluated for correctness before executing the modified playbooks.