ansible/hacking
Rafael Driutti c68838fb13 AWS Redshift: port module to boto3 and fix parameters check (#37052)
* fix parameters check and port module to boto3

* begin with integration tests

* allow redshift iam policy

* Wait for cluster to be created before moving on to delete it

* Allow sts credentials so this can be run in CI

Don't log credentials

ensure cluster can be removed

* - Replace DIY waiters with boto3 waiters
- test multi node cluster

* catch specific boto3 error codes

* remove wait from test

* add missing alias for shippable

* - Rework modify function.
- Default unavailable parameters to none.
- Add cluster modify test

* Ensure resources are cleaned up if tests fail

* Ensure all botocore ClientError and BotoCoreError exceptions are handled
2019-02-21 17:04:42 -06:00
..
aws_config AWS Redshift: port module to boto3 and fix parameters check (#37052) 2019-02-21 17:04:42 -06:00
tests Port from plaform.dist to ansible.module_utils.distro.linux_distribution 2018-12-17 11:01:01 -08:00
ticket_stubs Add a ticket stub for guiding GitHub newcomers 2018-09-11 17:51:54 +02:00
ansible_profile
cgroup_perf_recap_graph.py Perf graphing (#46346) 2019-01-08 13:29:22 -05:00
create_deprecated_issues.py pylint plugin to catch due/past-due deprecated calls (#44143) 2018-09-25 10:31:41 -05:00
deprecated_issue_template.md pylint plugin to catch due/past-due deprecated calls (#44143) 2018-09-25 10:31:41 -05:00
env-setup Make ansible-test available in the bin directory. (#45876) 2018-09-19 17:58:55 -07:00
env-setup.fish Make ansible-test available in the bin directory. (#45876) 2018-09-19 17:58:55 -07:00
fix_test_syntax.py
get_library.py
metadata-tool.py
README.md
report.py Don't require requests in hacking/report.py (#45350) 2018-09-07 11:51:41 -05:00
return_skeleton_generator.py
test-module Update bare exceptions to specify Exception. 2018-12-16 15:03:19 -08: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.