ansible/hacking
Sam Doran cf8639ff62 Fish hacking setup fix (#18084)
* Remove old egg-info files before creating new ones

Currently, setup.py generates egg files then they are deleted. This change
fixes this behavior and matches that in env-setup.

* Do not try to move ansible*egg-info to lib/

setup.py creates the ansible.egg-info in lib/ so this step is unnecessary. Matches env-setup behavior.

* Better test for number of arguments in argv

This prevents an erronous error message from being thrown since set -q returns an error code with the number of variables not defined, resulting in a non-zero exit if no arguments are passed.

Indent case statement within switch statement.
2016-10-24 10:35:00 -07:00
..
templates fixed typo 2016-02-29 17:52:55 -05:00
tests gen_distribution_version_testcase.py should fail if ansible run fails (#17693) 2016-09-26 15:35:36 -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 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
module_formatter.py Move uses of to_bytes, to_text, to_native to use the module_utils version (#17423) 2016-09-06 22:54:17 -07:00
README.md
test-module test-module _ansible_selinux_special_fs arg added 2016-10-23 16:34:53 -07:00
unify_repos.sh added script to unify repos 2016-10-03 22:55:38 -04:00
update.sh
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.