ansible/hacking
Brian Coca b606bcec04 Doc directives (#22524)
* draft docs for directives

* updated to document directives
2017-03-15 11:29:58 -04:00
..
templates Doc directives (#22524) 2017-03-15 11:29:58 -04:00
tests PEP 8 indent cleanup. (#20800) 2017-01-29 07:28:53 +00:00
authors.sh removed merges from count 2015-07-18 22:49:50 -04:00
cherrypick.py Whitelist the hacking/cherrypick script's use of python3 2017-01-05 10:20:58 -08:00
dump_playbook_attributes.py Doc directives (#22524) 2017-03-15 11:29:58 -04:00
env-setup Add test/runner to $PATH in hacking/env-setup. (#22387) 2017-03-07 16:31:53 -08:00
env-setup.fish Fish hacking setup fix (#18084) 2016-10-24 10:35:00 -07:00
get_library.py Change to python3 syntax 2015-08-31 02:35:14 +02:00
metadata-tool.py New metadata 1.0 (#22587) 2017-03-14 09:07:22 -07:00
module_formatter.py Legacy pep8 clean fixes for contrib and hacking (#21081) 2017-02-07 09:49:55 -06:00
README.md Switch tests to pytest and ansible-test. 2017-01-11 12:34:59 -08:00
test-module Update test-module (#20737) 2017-01-31 20:05:53 -08:00
update.sh Move update.sh to hacking repository ,see #10081 2015-01-30 14:19:47 +08:00
update_bundled.py Clean up shebangs for various files. 2016-11-02 17:00:27 -07:00
yamlcheck.py Clean up shebangs for various files. 2016-11-02 17:00:27 -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 pytest 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/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.