Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev guide: add notes about different image types for integration and unit/sanity tests #68663

Merged
merged 4 commits into from
Apr 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docsite/rst/dev_guide/testing_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ outside of those test subdirectories. They will also not reconfigure or bounce

.. note:: Running integration tests within Docker

To protect your system from any potential changes caused by integration tests, and to ensure a sensible set of dependencies are available we recommend that you always run integration tests with the ``--docker`` option. See the `list of supported docker images <https://github.com/ansible/ansible/blob/devel/test/lib/ansible_test/_data/completion/docker.txt>`_ for options.
To protect your system from any potential changes caused by integration tests, and to ensure a sensible set of dependencies are available we recommend that you always run integration tests with the ``--docker`` option, for example ``--docker centos8``. See the `list of supported docker images <https://github.com/ansible/ansible/blob/devel/test/lib/ansible_test/_data/completion/docker.txt>`_ for options (the ``default`` image is used for sanity and unit tests, as well as for platform independent integration tests such as those for cloud modules).

.. note:: Avoiding pulling new Docker images

Expand Down
4 changes: 4 additions & 0 deletions docs/docsite/rst/dev_guide/testing_sanity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ All available tests are run unless the ``--test`` option is used.
How to run
==========

.. note::
To run sanity tests using docker, always use the default docker image
by passing the ``--docker`` or ``--docker default`` argument.

.. code:: shell

source hacking/env-setup
Expand Down
4 changes: 4 additions & 0 deletions docs/docsite/rst/dev_guide/testing_units.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ structure of the tests matches that of ``lib/ansible/``.
Running Tests
=============

.. note::
To run unit tests using docker, always use the default docker image
by passing the ``--docker`` or ``--docker default`` argument.

The Ansible unit tests can be run across the whole code base by doing:

.. code:: shell
Expand Down