Internal Test Tools Collection

This collection provides useful test tools for other collections. It is NOT aimed at Ansible users, but at collection developers!

Please note that this collection does not support Windows targets.

Code of Conduct

We follow Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior violating the Ansible Code of Conduct, please refer to the policy violations section of the Code of Conduct for information on how to raise a complaint.

Communication

• Join the Ansible forum:

  • Tag internal-test-tools: discuss the collection and the test tools it provides.
  • Collection Development: discuss development and testing of collections. Please add the internal-test-tools tag when starting new discussions involving this collection.
  • Social Spaces: gather and interact with fellow enthusiasts.
  • News & Announcements: track project-wide announcements including social events.

• The Ansible Bullhorn newsletter: used to announce releases and important changes.

For more information about communication, see the Ansible communication guide.

Tested with Ansible

Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12, ansible-core 2.13, ansible-core 2.14, ansible-core 2.15, ansible-core 2.16, ansible-core 2.17, and ansible-core 2.18 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.

Collection Documentation

We publish latest commit collection documentation which shows docs for the latest commit in the main branch.

Included content

• tests/unit/compat/ package
• tests/unit/mock/ package
• tests/unit/plugins/modules/utils.py
• tests/unit/utils/fetch_url_module_framework.py
• tests/unit/utils/open_url_framework.py
• extra sanity test runner

Contributing to this collection

Please create issues to report problems or request new features, and create PRs to fix bugs or add new features. If you want to do a refactoring PR, please create an issue first to discuss the refactoring.

Please follow the general Ansible contributor guidelines; see the Ansible Community Guide.

Release notes

A changelog can be found in the GitHub repository.

Releasing, Deprecation and Versioning

We release new versions once there are new features or bugfixes. Deprecations can happen, and we try to announce them a long time in advance. We currently do not plan breaking changes, so there will be no new major release anytime soon, except maybe a version 1.0.0.

More information

• Ansible Developer guide
• Developing Collections section in the Developer guide
• Ansible Community code of conduct

Licensing

This collection is primarily licensed and distributed as a whole under the GNU General Public License v3.0 or later.

See LICENSES/GPL-3.0-or-later.txt for the full text.

All files have a machine readable SDPX-License-Identifier: comment denoting its respective license(s) or an equivalent entry in an accompanying .license file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in .reuse/dep5. This conforms to the REUSE specification.