Add docs for setting up ansible-test #83034
Labels
affects_2.16
docs
This issue/PR relates to or includes documentation.
P3
Priority 3 - Approved, No Time Limitation
Summary
The current docs that describe how to use
ansible-test
for unit testing collections, assumes that the user will/can use Docker for delegating the test behaviour to. This can not always be done (ie: in the case of a limited build environment without direct access to a Docker daemon). Further, it is not clear from the docs how to set up your build environment to work WITHOUT Docker. For example, when I ranansible-test
for the first time on a simple hello-world collection I created, I first got errors complaining aboutpytest
package being missing. Then, after installing that package, I ended up with a cryptic error which looked like this:this error didn't provide sufficient information for me to deduce how to proceed next. After I did some considerable digging was able to discover that I needed several additional Python packages installed (ie:
pytest-xdist
andpytest-mock
) to get the simple test suite working. It would have saved me considerable time and effort if this information was just provided in the docs somewhere.Issue Type
Documentation Report
Component Name
ansible-test
Ansible Version
ansible [core 2.16.5]
Configuration
na
OS / Environment
na
Additional Information
na
Code of Conduct
The text was updated successfully, but these errors were encountered: