summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdam Miller <admiller@redhat.com>2020-02-14 16:57:24 -0600
committerGitHub <noreply@github.com>2020-02-14 16:57:24 -0600
commit98c1fc9d3a8c45b88704bfe485b9433648210042 (patch)
tree24e587c56fce47065b0cff304cffbf1bc529f36f /docs
parent9b28f1f5d931b727f2a06270314f2c2a8a5494bb (diff)
downloadansible-98c1fc9d3a8c45b88704bfe485b9433648210042.tar.gz
add a testing section to collections dev guide (#67370)
Signed-off-by: Adam Miller <admiller@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/docsite/rst/dev_guide/developing_collections.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst
index 35ae7aa980..9b4d21fd16 100644
--- a/docs/docsite/rst/dev_guide/developing_collections.rst
+++ b/docs/docsite/rst/dev_guide/developing_collections.rst
@@ -171,7 +171,22 @@ TBD.
tests directory
----------------
-TBD. Expect tests for the collection itself to reside here.
+Ansible Collections are tested much like Ansible itself, by using the
+`ansible-test` utility which is released as part of Ansible, version 2.9.0 and
+newer. Because Ansible Collections are tested using the same tooling as Ansible
+itself, via `ansible-test`, all Ansible developer documentation for testing is
+applicable for authoring Collections Tests with one key concept to keep in mind.
+
+When reading the :ref:`developing_testing` documentation, there will be content
+that applies to running Ansible from source code via a git clone, which is
+typical of an Ansible developer. However, it's not always typical for an Ansible
+Collection author to be running Ansible from source but instead from a stable
+release, and to create Collections it is not necessary to run Ansible from
+source. Therefore, when references of dealing with `ansible-test` binary paths,
+command completion, or environment variables are presented throughout the
+:ref:`developing_testing` documentation; keep in mind that it is not needed for
+Ansible Collection Testing because the act of installing the stable release of
+Ansible containing `ansible-test` is expected to setup those things for you.
.. _creating_collections: