ansible/hacking
Clint Byrum 284f26303c Add support for ECR Lifecycle Policies to ecs_ecr (#48997)
* Fix copy/pasta for ecs_ecr test names

* Add support for lifecycle policies to ecs_ecr

New feature for ecs_ecr to support [ECR Lifecycle Policies][].

Fixes #32003

 [ECR Lifecycle Policies]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html

* Improve error message for ecs_ecr parsing errors

Replaces the exception and stack trace with a description of what's
actually going wrong from a user perspective.

* Rename delete policy to purge policy

Marks the `delete_policy` parameter as deprecated, to be removed in
Ansible 2.6.

* Add version_added to purge_policy

* Remove changing results based on verbosity

What I really want is --diff support, and changing results based on
verbosity is abnormal.

* Ensure repository name is lowercase

* Fix deprecation cycle to 4 releases

* Use a YAML anchor for credentials

* Remove filters from assertions

* Add minimal permissions needed

* Updating version_added and deprecation cycle

The original PR sat while a few releases happened.

* Bumping version added and deprecation version

We missed the 2.8 release.

* Removing bare except:

This is not allowed and is generally bad practice.

* Fix lint errors

* update ansible release metadata

* Use the new alias deprecation scheme

This was added in the time the PR has been in development, so rework
things to use it.

* Add test coverage

This makes sure that lifecycle_policy is produced when passed in.

*Also a minor suggestion for simplification from PR.

* Restore changes from 62871 lost in rebase

* Add changelog

* Remove version_added for new purge_policy option

Per sanity test fail.
2019-12-19 11:41:41 -07:00
..
aws_config Add support for ECR Lifecycle Policies to ecs_ecr (#48997) 2019-12-19 11:41:41 -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 Use https for links to ansible.com domains. 2018-04-23 11:33:56 -07:00
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.