Skip to content

Commit

Permalink
Add note about integration tests for new modules to the dev guide (an…
Browse files Browse the repository at this point in the history
  • Loading branch information
Andersson007 committed Aug 20, 2020
1 parent 705c666 commit b82889e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/docsite/rst/dev_guide/developing_modules_general.rst
Expand Up @@ -163,6 +163,10 @@ Testing your newly-created module
The following two examples will get you started with testing your module code. Please review our :ref:`testing <developing_testing>` section for more detailed
information, including instructions for :ref:`testing module documentation <testing_module_documentation>`, adding :ref:`integration tests <testing_integration>`, and more.

.. note::
Every new module and plugin should have integration tests, even if the tests cannot be run on Ansible CI infrastructure.
In this case, the tests should be marked with the ``unsupported`` alias in `aliases file <https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/integration-aliases.html>`_.

Performing sanity tests
-----------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/docsite/rst/dev_guide/testing_integration.rst
Expand Up @@ -16,6 +16,10 @@ Some tests may require credentials. Credentials may be specified with `credenti

Some tests may require root.

.. note::
Every new module and plugin should have integration tests, even if the tests cannot be run on Ansible CI infrastructure.
In this case, the tests should be marked with the ``unsupported`` alias in `aliases file <https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/integration-aliases.html>`_.

Quick Start
===========

Expand Down

0 comments on commit b82889e

Please sign in to comment.