Skip to content

Latest commit

 

History

History
140 lines (107 loc) · 7.71 KB

CONTRIBUTING.md

File metadata and controls

140 lines (107 loc) · 7.71 KB
Raw

Contributing

AWS Collections

There are two related collections containing AWS content (modules and plugins).

amazon.aws

This collection contains the module_utils (shared libraries) used by both collections. Content in this collection is included downstream in Red Hat Ansible Automation Platform.

Code standards, test coverage, and other supportability criteria may be higher in this collection.

The amazon.aws collection is an Ansible-maintained collection.

community.aws

This collection contains modules and plugins contributed and maintained by the Ansible AWS community. The community.aws collection is tested and generally assured to work in conjunction with amazon.aws.

New modules and plugins developed by the community should be proposed to community.aws. Content in this collection that is stable and meets other acceptance criteria has the potential to be promoted and migrated into amazon.aws.

Submitting Issues

All software has bugs, and the amazon.aws collection is no exception. When you find a bug, you can help tremendously by telling us about it.

If you should discover that the bug you're trying to file already exists in an issue, you can help by verifying the behavior of the reported bug with a comment in that issue, or by reporting any additional information

Writing New Code

New modules should be submitted to the community.aws collection.

For new features and bug fixes on existing modules, clone this repository and try to run unit tests and integration tests by following these instructions. When you get to this part:

ansible-test integration name_of_test_subdirectory --docker -v

Run this from the tests directory of this repository. Substitute name_of_test_subdirectory for the name of the relevant directory within tests/integration/targets. You'll get this error:

WARNING: Excluding tests marked "cloud/aws" which require config
(see "/home/dev/ansible/ansible/test/lib/ansible_test/config/cloud-config-aws.ini.template"): ec2_group

This is because the unit tests don't automatically detect the AWS credentials on your machine unlike plain boto3 and the aws cli. (Typically because they're run inside Docker, which can't access ~/.aws/credentials. But even when running tests outside docker, the tests ignore ~/.aws/credentials.) You need to explicitly create credentials and load them in to an Ansible-specific file. To do this, copy the file mentioned in that error message, into the clone of this repo, under tests/integration/cloud-config-aws.ini. Modify the @ variables, pasting in an IAM secret credential. If you don't need the secret_token (most IAM users don't), comment that line out.

You can use an AWS account that already has unrelated resources in it. The tests should not touch pre-existing resources, and should tidy up after themselves. (Of course for security reasons you may want to run in a dedicated AWS account.)

If you're only writing a pull request for one AWS service you are able to create credentials only with permissions required for that test. For example, to test the Lambda modules, you only need Lambda permissions, and permissions to create IAM roles. You could also deploy the policies used by the CI.

All modules MUST have integration tests for new features. Bug fixes for modules that currently have integration tests SHOULD have tests added.

Once you're able to run integration tests for the existing code, now start by adding tests in tests/integration/targets for your new feature or tests for the bug(s) you're about to fix.

Expected test criteria:

  • Resource creation under check mode
  • Resource creation
  • Resource creation again (idempotency) under check mode
  • Resource creation again (idempotency)
  • Resource modification under check mode
  • Resource modification
  • Resource modification again (idempotency) under check mode
  • Resource modification again (idempotency)
  • Resource deletion under check mode
  • Resource deletion
  • Resource deletion (of a non-existent resource) under check mode
  • Resource deletion (of a non-existent resource)

Where modules have multiple parameters we recommend running through the 4-step modification cycle for each parameter the module accepts, as well as a modification cycle where as most, if not all, parameters are modified at the same time.

After writing the tests, now write/modify the module code, typically in plugins/modules. Don't forget to add a changelog entry. Then create a pull request.

If you're struggling with running integration tests locally, don't worry. After creating a pull request the GitHub Actions will automatically test for you.

More information about contributing

General information about setting up your Python environment, testing modules, Ansible coding styles, and more can be found in the Ansible Community Guide.

Information about AWS SDK library usage, module utils, testing, and more can be found in the AWS Guidelines documentation.

For general information on running the integration tests see this page and Integration Tests page of the Module Development Guide. Ignore the part about source hacking/env-setup. That's only applicable for working on ansible-core. You should be able to use the ansible-test that's installed with Ansible generally. Look at the section on configuration for cloud tests. For questions about writing tests the Ansible AWS community can be found on Libera.Chat IRC as detailed below.

Code of Conduct

The amazon.aws collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

IRC

Our IRC channels may require you to register your nickname. If you receive an error when you connect, see Libera.Chat's Nickname Registration guide for instructions.

The #ansible-aws channel on irc.libera.chat is the main and official place to discuss use and development of the amazon.aws collection.