ansible/hacking
Michael Scherer 619f3d13ef Add detection of python3 to hacking/env-setup (#17357)
People can still override the detection using PYTHON_BIN
2016-09-02 12:11:38 -07:00
..
templates fixed typo 2016-02-29 17:52:55 -05:00
tests Dist version fix for Red Hat and more tests (#15663) 2016-04-29 13:18:50 -07:00
authors.sh removed merges from count 2015-07-18 22:49:50 -04:00
dump_playbook_attributes.py Fewer deps for 'make webdocs' from top level 2016-06-28 11:01:42 -04:00
env-setup Add detection of python3 to hacking/env-setup (#17357) 2016-09-02 12:11:38 -07:00
env-setup.fish Do not corrupt $MANPATH when it's not present (#16300) 2016-06-15 11:41:14 -04:00
get_library.py Change to python3 syntax 2015-08-31 02:35:14 +02:00
module_formatter.py Make 'required' optional in module docs (#15906) 2016-05-18 16:57:36 -07:00
README.md More complex example of using test-module 2015-05-28 14:43:25 -04:00
test-module Find places where ziploader is used and change them to ansiballz so that people aren't confused when they google for information.information (#16715) 2016-07-21 10:58:24 -07: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
yamlcheck.py quick yaml syntax checker 2016-05-18 18:15:12 -04: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.