diff options
| author | Andrew Klychkov <aaklychkov@mail.ru> | 2020-04-07 17:17:44 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-07 09:17:44 -0500 |
| commit | 598ead965dd0ed1db9a554e8a02c8fcc693ffdd8 (patch) | |
| tree | f588fcd1276d4375f784eabacef8c88660414c44 | |
| parent | 13aef3c2e591631440830b6a023e90292a11392b (diff) | |
| download | ansible-598ead965dd0ed1db9a554e8a02c8fcc693ffdd8.tar.gz | |
Dev guide: add notes about different image types for integration and unit/sanity tests (#68663)
* Dev guide: add notes about different image types for integration and unit/sanity tests
* Update docs/docsite/rst/dev_guide/testing_integration.rst
Co-authored-by: Matt Clay <matt@mystile.com>
| -rw-r--r-- | docs/docsite/rst/dev_guide/testing_integration.rst | 2 | ||||
| -rw-r--r-- | docs/docsite/rst/dev_guide/testing_sanity.rst | 4 | ||||
| -rw-r--r-- | docs/docsite/rst/dev_guide/testing_units.rst | 4 |
3 files changed, 9 insertions, 1 deletions
diff --git a/docs/docsite/rst/dev_guide/testing_integration.rst b/docs/docsite/rst/dev_guide/testing_integration.rst index 7f3a594b65..ecd3c78fbe 100644 --- a/docs/docsite/rst/dev_guide/testing_integration.rst +++ b/docs/docsite/rst/dev_guide/testing_integration.rst @@ -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 diff --git a/docs/docsite/rst/dev_guide/testing_sanity.rst b/docs/docsite/rst/dev_guide/testing_sanity.rst index 7395d24e9f..bdedd0a48c 100644 --- a/docs/docsite/rst/dev_guide/testing_sanity.rst +++ b/docs/docsite/rst/dev_guide/testing_sanity.rst @@ -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 diff --git a/docs/docsite/rst/dev_guide/testing_units.rst b/docs/docsite/rst/dev_guide/testing_units.rst index 9d7b26b2bc..4cc07face0 100644 --- a/docs/docsite/rst/dev_guide/testing_units.rst +++ b/docs/docsite/rst/dev_guide/testing_units.rst @@ -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 |