ansible/hacking
Will Thames 60e3af42d5 sns_topic boto3 port (#39292)
* Port sns_topic to boto3 and add tests
2018-08-23 21:04:18 -04:00
..
aws_config sns_topic boto3 port (#39292) 2018-08-23 21:04:18 -04:00
tests Facts distribution clear linux 31501 (#32453) 2018-01-20 15:05:53 -05:00
ticket_stubs 2.6 changelog gen/version/root dir cleanup (#40421) 2018-05-21 16:14:53 -07:00
ansible_profile start of 'profiling utils' 2017-05-31 14:00:12 -04:00
env-setup Fix path handling in hacking/env-setup. 2018-08-10 23:36:56 -07:00
env-setup.fish Improve fish environment setup (#26151) 2017-08-01 09:41:21 -04:00
fix_test_syntax.py Fix shebangs and file modes and update tests. (#40563) 2018-05-22 14:25:36 -07:00
get_library.py Surround top-level function and class definitions with two blank lines. 2018-07-31 12:06:56 -07:00
metadata-tool.py Use https for links to ansible.com domains. 2018-04-23 11:33:56 -07:00
README.md 2.6 changelog gen/version/root dir cleanup (#40421) 2018-05-21 16:14:53 -07: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 Remove use of simplejson throughout code base (#43548) 2018-08-10 11:13:29 -05:00
update_bundled.py Update additional pypi.python.org URLs to pypi.org (#41373) 2018-06-17 14:01:18 +02: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 -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.

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.