History

Ed Costello d16bc1c3f4 New aws_ses_identity module to manage AWS Simple Email Service Identity (#31140 ) * Add aws_ses_identity module * Update CI alias, add BotoCoreError exception handling. * Add SES and SNS permissions to hacking/aws_config to run aws_ses_identity integration tests		2018-01-29 15:35:49 -05:00
..
aws_config	New aws_ses_identity module to manage AWS Simple Email Service Identity (#31140 )	2018-01-29 15:35:49 -05:00
tests	Facts distribution clear linux 31501 (#32453 )	2018-01-20 15:05:53 -05:00
ansible_profile	start of 'profiling utils'	2017-05-31 14:00:12 -04:00
authors.sh
cherrypick.py	Python 2.6 `str.format()` compatibility fixes.	2018-01-10 14:08:11 -08:00
env-setup
env-setup.fish	Improve fish environment setup (#26151 )	2017-08-01 09:41:21 -04:00
fix_test_syntax.py	Fix failure to adjust my name when doing copy pasta (#33322 )	2017-11-27 19:09:05 -06:00
get_library.py
metadata-tool.py	Python 2.6 `str.format()` compatibility fixes.	2018-01-10 14:08:11 -08:00
README.md	Deprecate tests used as filters (#32361 )	2017-11-27 17:58:08 -05:00
report.py	Replace exit() with sys.exit()	2017-12-14 22:03:08 -05:00
return_skeleton_generator.py	Use JSON returns values to create RETURN docs	2017-09-11 14:33:11 -07:00
test-module	hacking/test-module: fix Python 3 compatibility (#33069 )	2017-11-20 08:03:55 +01:00
update.sh
update_bundled.py
yamlcheck.py

README.md

'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 -r requirements.txt

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/command.py -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"}]}}'

return_skeleton_generator.py

return_skeleton_generator.py helps in generating the RETURNS section of a module. It takes JSON output of a module provided either as a file argument or via stdin.

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.

fix_test_syntax.py

A script to assist in the conversion for tests using filter syntax to proper jinja test syntax. This script has been used to convert all of the Ansible integration tests to the correct format for the 2.5 release. There are a few limitations documented, and all changes made by this script should be evaluated for correctness before executing the modified playbooks.

Authors

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