ansible/hacking
Max Riveiro 9f7342d46d
Add tesing deps installation into hacking/README
Signed-off-by: Max Riveiro <kavu13@gmail.com>
2014-03-23 00:42:51 +04:00
..
templates Basic docsite formatting fixups 2014-01-02 17:36:52 -05:00
authors.sh
env-setup Allow hacking/env-setup module path to use config file library path 2014-02-12 12:06:57 +10:00
env-setup.fish
get_library.py Allow hacking/env-setup module path to use config file library path 2014-02-12 12:06:57 +10:00
module_formatter.py Micro-optimization: replace s.find(x)!=-1 with x in s 2014-03-16 13:10:28 -04:00
README.md Add tesing deps installation into hacking/README 2014-03-23 00:42:51 +04:00
test-module Support for -a to accept a file with test-module 2014-02-07 13:09:47 -06: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 library/commands/shell -a "echo hi"

This is a good way to insert a breakpoint into a module, for instance.

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.