From: Tomi Juvonen <tomi.juvonen@nokia.com>
Date: Mon, 6 Aug 2018 10:12:31 +0000 (+0300)
Subject: Add tox and test case to testing document
X-Git-Tag: opnfv-7.0.0~10^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=doctor.git;a=commitdiff_plain;h=a39f73774b2f819ff8d8a84abad1cae6a2d50b82

Add tox and test case to testing document

Change-Id: I105bd1e92fb70c8dc4a5c239b6574b73bf1b3154
Signed-off-by: Tomi Juvonen <tomi.juvonen@nokia.com>
---

diff --git a/docs/development/overview/testing.rst b/docs/development/overview/testing.rst
index 98be43e9..ba0546eb 100644
--- a/docs/development/overview/testing.rst
+++ b/docs/development/overview/testing.rst
@@ -29,6 +29,18 @@ OpenStack services.
 
 .. _OpenStackClient Configuration: https://docs.openstack.org/python-openstackclient/latest/configuration/index.html
 
+Doctor now supports different test cases and for that you might want to
+export TEST_CASE with different values:
+
+.. code-block:: bash
+
+    #Fault management (default)
+    export TEST_CASE='fault_management'
+    #Maintenance (requires 3 compute nodes)
+    export TEST_CASE='maintenance'
+    #Run both tests cases
+    export TEST_CASE='all'
+
 Run Python Test Script
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -45,6 +57,18 @@ environment and then run the test.
 
 .. _doctor.sample.conf: https://git.opnfv.org/doctor/tree/etc/doctor.sample.conf
 
+In OPNFV Apex jumphost you can run Doctor testing as follows using tox:
+
+.. code-block:: bash
+
+    #Before Gambia: overcloudrc.v3
+    source overcloudrc
+    export INSTALLER_IP=${INSTALLER_IP}
+    export INSTALLER_TYPE=${INSTALLER_TYPE}
+    git clone https://gerrit.opnfv.org/gerrit/doctor
+    cd doctor
+    sudo -E tox
+
 Run Functest Suite
 ==================