Hunter release documentation
[doctor.git] / docs / development / overview / testing.rst
index 98be43e..663d4c3 100644 (file)
@@ -29,6 +29,20 @@ 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'
+    #Use Fenix in maintenance testing instead of sample admin_tool
+    export ADMIN_TOOL_TYPE='fenix'
+    #Run both tests cases
+    export TEST_CASE='all'
+
 Run Python Test Script
 ~~~~~~~~~~~~~~~~~~~~~~
 
@@ -45,6 +59,17 @@ 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
+
+    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
 ==================
 
@@ -64,7 +89,8 @@ Functest container. You can run the Doctor test with the following steps:
 
 See `Functest Userguide`_ for more information.
 
-.. _Functest Userguide: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
+.. _Functest Userguide: :doc:`<functest:testing/user/userguide>`
+
 
 For testing with stable version, change DOCKER_TAG to 'stable' or other release
 tag identifier.