8000 ansible/hacking at devel · alahmadics/ansible · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
 
 

hacking

README.md

'Hacking' directory tools

env-setup

The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using a supported Python version.

First, set up your environment to run from the checkout:

source ./hacking/env-setup

You will need some basic prerequisites installed. If yo 3F29 u do not already have them and do not wish to install them from your operating system package manager, you can install them from pip

python -Im ensurepip  # 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.

0