ansible/hacking
Zhikang Zhang b578bf9e20 Fix test-module failing to validate args (#41004)
* Fix test-module failing to validate args

The test-module pass a wrong argument _ansible_tmp cause the validation failed.
Change the argument _ansible_tmp to _ansible_tmpdir to fix this.

* Add a integration test for test-module.

Prior to this change, we don't have a test for test-module.

This change ensure the correctness of test-module script.
2018-06-01 12:02:56 -07:00
..
aws_config Add two missing VPC permissions (#37896) 2018-05-25 06:31:54 -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
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 hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01: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 Fix test-module failing to validate args (#41004) 2018-06-01 12:02:56 -07:00
update_bundled.py

'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.