cloud-init-dev team mailing list archive

[Joshua Powers <josh.powers@xxxxxxxxxxxxx>]

Joshua Powers has proposed merging ~powersj/cloud-init:update_cii_tox_docs into cloud-init:master.

Commit message:
doc: add dependencies and tox instructions for integration tests

Add instructions on how to run the cii tests via tox as well
as the basic system dependencies for running the cii tests.

Requested reviews:
  cloud init development team (cloud-init-dev)

For more details, see:
https://code.launchpad.net/~powersj/cloud-init/+git/cloud-init/+merge/319617
-- 
Your team cloud init development team is requested to review the proposed merge of ~powersj/cloud-init:update_cii_tox_docs into cloud-init:master.

diff --git a/doc/rtd/topics/tests.rst b/doc/rtd/topics/tests.rst
index 00c63c6..c487867 100644
--- a/doc/rtd/topics/tests.rst
+++ b/doc/rtd/topics/tests.rst
@@ -182,6 +182,18 @@ Executing tests has three options:
 * ``verify`` given a directory of test data, run the Python unit tests on
   it to generate results.
 
+Dependencies
+-------------------
+In order to execute the integration tests the following must available:
+
+* tox
+
+or
+
+* python3
+* lxd
+* pylxd version 2.1.3
+
 Run
 ---
 The first example will provide a complete end-to-end run of data
@@ -238,6 +250,20 @@ without the more lengthy collect process. This can be done by running:
 The above command will run the verify scripts on the data discovered in
 `/tmp/collection`.
 
+Run via tox
+-----------
+In order to avoid the need for dependencies and ease the setup and
+configuration users can run the integration tests via tox:
+
+.. code-block:: bash
+
+    $ tox -e citest -- run [integration test arguments]
+    $ tox -e citest -- run -v -n zesty --deb=cloud-init_all.deb
+    $ tox -e citest -- run -t module/user_groups.yaml
+
+Users need to invoke the citest enviornment and then pass any additional
+arguments.
+
 
 Architecture
 ============