ansible/hacking
Will Thames 63df0adc17 [cloud] Update RDS parameter group for boto3 (#25345)
* Update RDS parameter group for boto3

* Update to boto3
* Update to latest ansible standards
* Remove choices list for valid engines (See #19221 for context)
* Allow tagging
* Return some useful information, and document that information

* Add tests for rds_param_group

* Improve testing of rds_param_group

* Add purge_tags option for rds_param_group

* Fix remaining broken rds_param_group tests

* Ensure the group name is lowercased. Fixes integration tests when run on OSX
2017-08-28 12:52:22 -04:00
..
aws_config [cloud] Update RDS parameter group for boto3 (#25345) 2017-08-28 12:52:22 -04:00
tests hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01:00
ansible_profile start of 'profiling utils' 2017-05-31 14:00:12 -04:00
authors.sh
cherrypick.py hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01:00
env-setup Speed up env-setup (#24133) 2017-05-01 09:54:50 -05:00
env-setup.fish Improve fish environment setup (#26151) 2017-08-01 09:41:21 -04:00
get_library.py hacking/: PEP8 compliancy (#24683) 2017-05-16 18:52:07 +01:00
metadata-tool.py metadata 1.1 2017-08-15 23:12:08 -07:00
README.md bring comments and docs up-to-date for invoking hacking/test-module (#20940) 2017-08-18 09:46:15 -04:00
report.py Initial version of source/testing report tool. 2017-07-15 00:15:04 -07:00
test-module bring comments and docs up-to-date for invoking hacking/test-module (#20940) 2017-08-18 09:46:15 -04:00
update.sh
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 -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"}]}}'

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.