ansible/hacking
Matthew Davis 4ee9f40e62 Add aws_acm module (#60552)
* convert aws_acm_facts to AnsibleAWSModule

* factor aws_acm_facts into module_utils

* add more filtering options for aws_acm_info

* add aws_acm module and tests

* uncomment aws_acm test

* fix linting for aws_acm

* fix __future__ linting for aws_acm

* fix linting for aws_acm

* fix linting for aws_acm

* fix linting for aws_acm

* fix linting for aws_acm

* fix aws_acm_info arg type

* remove test for old module name aws_acm_facts

* simplify AWS ACM client creation

* fix indent typo in aws_acm test

* catch BotoCoreError in aws_acm

* fix indent typo in aws_acm test

* tighten AWS ACM test policy resource

* move aws acm int test to venv

* remove errant file

* fix AWS ACM int test perms

* undo copyright addition to wrong file

* fix invalid log message in aws_acm

Co-Authored-By: Jill R <4121322+jillr@users.noreply.github.com>

* rephrase aws_acm_info doc from facts to information

Co-Authored-By: Jill R <4121322+jillr@users.noreply.github.com>

* rename aws_facts var to aws_info

* remove case insensitivity for aws_acm pem compare

* add no_log for aws_acm credential setting

* add per-test prefix to aws_acm test resource names

* make aws_acm use crypto module_util

* clarify copyright for aws_acm

* make aws_acm int test clearer

* add explicit crypto dependency to aws_acm

* change requests for aws_acm pr

* fix wrong copyright owner aws_acm test

* fix wrong copyright owner aws_acm test

* rewrite aws_acm cert chain compare with regex, no dependency

* fix linting for aws_acm unit test

* fix linting for aws_acm unit test

* fix linting and duplicate ignore

* fix failed cert chain split in aws_acm, add more tests

* remove errant file

* more linting fixes for aws_acm

* fix sanity ignore

* rewrite cert compare in aws_acm to use base64 decode

* improve regex for pem cert chain split in aws_acm

* undo changes to crypto module util for aws_acm

* increment ansible version for new aws_acm module

* convert aws_acm return(x) to return x

* increment version added for aws_acm_info new features

* fix linting

* fix bugs with AWS ACM

* fix bad rebase

* disable AWS ACM integration test, due to AWS account limit issue

* remove aws acm integration test from shippable group
2019-11-05 11:57:08 -07:00
..
aws_config Add aws_acm module (#60552) 2019-11-05 11:57:08 -07:00
build_library update too old version to 2.4 (#64167) 2019-10-31 19:44:53 -05:00
tests Get minor version number for CentOS and Debian (#57814) 2019-06-28 19:21:35 -04:00
ticket_stubs Reword the ticket stub for collections (#63917) 2019-10-24 12:39:08 -05:00
ansible-profile Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
build-ansible.py create-deprecated-issues script can now add to a specified project (#61901) 2019-09-09 17:28:52 -07:00
cgroup_perf_recap_graph.py Perf graphing (#46346) 2019-01-08 13:29:22 -05:00
deprecated_issue_template.md Fix deprecated issue creator (#55327) 2019-04-15 15:28:25 -05:00
env-setup Make ansible-test available in the bin directory. (#45876) 2018-09-19 17:58:55 -07:00
env-setup.fish Do not set ANSIBLE_LIBRARY in env-setup.fish (#63688) 2019-10-18 10:56:19 -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
README.md Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
report.py Include version_added in report.py (#61857) 2019-09-09 11:40:38 -05:00
return_skeleton_generator.py Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
test-module Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
test-module.py Support relative imports in AnsiballZ. (#61196) 2019-08-27 18:11:21 -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.py

'test-module.py' 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.py -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.py -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.