ansible/hacking
2016-02-26 16:27:10 -05:00
..
templates fixes to playbooks_directives generation 2016-02-26 16:18:55 -05:00
authors.sh removed merges from count 2015-07-18 22:49:50 -04:00
dump_playbook_attributes.py added missing : 2016-02-26 16:27:10 -05:00
env-setup Replace -delete with portable -exec rm {} \; 2015-12-02 11:06:09 +01:00
env-setup.fish Use find ... -delete instead of non-portable globbing 2015-09-02 17:05:16 -04:00
get_library.py Change to python3 syntax 2015-08-31 02:35:14 +02:00
module_formatter.py now check for description and listify if needed 2016-02-08 12:34:26 -05:00
README.md More complex example of using test-module 2015-05-28 14:43:25 -04:00
test-module Update check mode argument 2015-11-08 20:55:10 -06:00
update.sh Move update.sh to hacking repository ,see #10081 2015-01-30 14:19:47 +08:00
update_bundled.py Bundle a new version of python-six for compatibility along with some code to make it easy for distributions to override the bunndled copy if they have a new enough version. 2015-10-16 08:21:28 -07:00

'Hacking' directory tools

Env-setup

The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using python 2.6+. (You may not use python 3 at this time).

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 pyyaml jinja2 nose passlib pycrypto

From there, follow ansible instructions on docs.ansible.com as normal.

Test-module

'test-module' 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 -m lib/ansible/modules/core/commands/shell -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 -m module \
    -a "{"parent": {"child": [{"item": "first", "val": "foo"}, {"item": "second", "val": "bar"}]}}"

Module-formatter

The module formatter is a script used to generate manpages and online module documentation. This is used by the system makefiles and rarely needs to be run directly.

Authors

'authors' is a simple script that generates a list of everyone who has contributed code to the ansible repository.