64 lines
1.5 KiB
Markdown
64 lines
1.5 KiB
Markdown
'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.10.
|
|
|
|
First, set up your environment to run from the checkout:
|
|
|
|
```shell
|
|
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
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
./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:
|
|
|
|
```yaml
|
|
parent:
|
|
child:
|
|
- item: first
|
|
val: foo
|
|
- item: second
|
|
val: boo
|
|
```
|
|
|
|
Use:
|
|
|
|
```shell
|
|
./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.
|