Skip to content

Commit

Permalink
Update integration test guide docker flag usage (#1731)
Browse files Browse the repository at this point in the history
* Update integration test guide docker flag usage

The integration guide linked to a file in the devel branch that gets out-of-sync with the actual supported images on the user's system.
Instead, we now instruct the user to run the help flag to get the list of supported images that are actually present on their system.

* Point users to the right section in ansible-test integration --help
  • Loading branch information
MatthiasKunnen authored Aug 7, 2024
1 parent a8036fa commit e2137b1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docsite/rst/dev_guide/testing_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ outside of those test subdirectories. They will also not reconfigure or bounce

.. note:: Running integration tests within containers

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 ubuntu2004``. See the `list of supported container 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).
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 ubuntu2204``. Get the list of supported container images by running ``ansible-test integration --help``. You can find them in the *target docker images* section of the output. The ``default`` image is used for sanity and unit tests, as well as for platform independent integration tests such as those for cloud modules.

Run as follows for all POSIX platform tests executed by our CI system in a Fedora 34 container:

Expand Down Expand Up @@ -245,4 +245,4 @@ Where to find out more
======================

If you'd like to know more about the plans for improving testing Ansible, join the
`Ansible community forum <https://forum.ansible.com/>`_
`Ansible community forum <https://forum.ansible.com/>`_

0 comments on commit e2137b1

Please sign in to comment.