Skip to content

Sanity testing requirements

Collections must pass ansible-test sanity checks for certification.

Python boilerplate

All Python files in plugins and modules must include the standard boilerplate:

from __future__ import absolute_import, division, print_function
__metaclass__ = type

Missing boilerplate triggers future-import-boilerplate or metaclass-boilerplate errors.

Sanity ignore files

Sanity ignore files must only contain entries that are permitted by the Ansible Lint sanity rules. Invalid entries trigger sanity[cannot-ignore] errors and must be removed.

Pylint checks

Ansible enforces pylint rules that differ from general Python conventions:

  • disallowed-name: Using _ as a variable name to capture unused return values is a common Python pattern but is not permitted in Ansible plugins and modules. See this discussion for background.
  • unused-import: Remove unused imports from plugin and module code.

Python version support

Python 2.7 is no longer supported by Red Hat Ansible Automation Platform and is not required for certified collections. To declare the minimum Python version for your collection, add a tests/config.yml file with a python_requires setting. See the ansible.utils example for the expected format.

Shell script checks

The shellcheck sanity test flags issues in shell scripts. Address these issues where possible, or add them to your sanity ignore files if they cannot be resolved.

Additional reference