From e7a7c7ec03880f42411efd9e6703b16930b2372d Mon Sep 17 00:00:00 2001
From: Jose Lausuch <jalausuch@suse.com>
Date: Tue, 10 Oct 2017 16:17:15 +0200
Subject: [PATCH] Include tempest_custom in the documentation

Change-Id: I86300fff399d1bc73eeeed76b5057e3f6d2f85f3
Signed-off-by: Jose Lausuch <jalausuch@suse.com>
(cherry picked from commit 832bb86db4fba9f65aebf09c058592d28e418134)
---
 docs/testing/user/userguide/index.rst           | 13 ---------
 docs/testing/user/userguide/test_overview.rst   |  3 --
 docs/testing/user/userguide/troubleshooting.rst | 37 +++++++++++++++++++++++++
 3 files changed, 37 insertions(+), 16 deletions(-)

diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index c0c763651..2addfaea8 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -10,19 +10,6 @@ Functest User Guide
 .. toctree::
    :maxdepth: 2
 
-Version history
-===============
-+------------+----------+------------------+----------------------------------+
-| **Date**   | **Ver.** | **Author**       | **Comment**                      |
-|            |          |                  |                                  |
-+------------+----------+------------------+----------------------------------+
-| 2016-08-17 | 1.0.0    | Juha Haapavirta  | Colorado release                 |
-|            |          | Column Gaynor    |                                  |
-+------------+----------+------------------+----------------------------------+
-| 2017-01-23 | 1.0.1    | Morgan Richomme  | Adaptations for Danube           |
-+------------+----------+------------------+----------------------------------+
-| 2017-08-16 | 1.0.2    | Morgan Richomme  | Adaptations for Euphrates        |
-+------------+----------+------------------+----------------------------------+
 
 
 Introduction
diff --git a/docs/testing/user/userguide/test_overview.rst b/docs/testing/user/userguide/test_overview.rst
index 2fca325a2..a23df02db 100644
--- a/docs/testing/user/userguide/test_overview.rst
+++ b/docs/testing/user/userguide/test_overview.rst
@@ -77,9 +77,6 @@ validate the scenario for the release.
 |             |               | rally_full     | Run the OpenStack testing tool   |
 |             |               |                | benchmarking OpenStack modules   |
 |             |               |                | See the Rally documents `[3]`_   |
-|             |               +----------------+----------------------------------+
-|             |               | tempest_custom | Allow to run a customized list   |
-|             |               |                | of Tempest cases                 |
 +-------------+---------------+----------------+----------------------------------+
 | Controllers | smoke         | odl            | Opendaylight Test suite          |
 |             |               |                | Limited test suite to check the  |
diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst
index 29facc294..3ceb914ca 100644
--- a/docs/testing/user/userguide/troubleshooting.rst
+++ b/docs/testing/user/userguide/troubleshooting.rst
@@ -249,6 +249,43 @@ related REST API requests/responses are output to the console. More detailed deb
 information can be found from tempest.log file stored into related Rally deployment
 folder.
 
+Functest offers a possibility to test a customized list of Tempest test cases.
+To enable that, add a new entry in docker/components/testcases.yaml on the "components" container
+with the following content::
+
+    -
+        case_name: tempest_custom
+        project_name: functest
+        criteria: 100
+        blocking: false
+        description: >-
+            The test case allows running a customized list of tempest
+            test cases
+        dependencies:
+            installer: ''
+            scenario: ''
+        run:
+            module: 'functest.opnfv_tests.openstack.tempest.tempest'
+            class: 'TempestCustom'
+
+Also, a list of the Tempest test cases must be provided to the container or modify
+the existing one in
+/usr/lib/python2.7/site-packages/functest/opnfv_tests/openstack/tempest/custom_tests/test_list.txt
+
+Example of custom list of tests 'my-custom-tempest-tests.txt'::
+
+    tempest.scenario.test_server_basic_ops.TestServerBasicOps.test_server_basic_ops[compute,id-7fff3fb3-91d8-4fd0-bd7d-0204f1f180ba,network,smoke]
+    tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops[compute,id-f323b3ba-82f8-4db7-8ea6-6a895869ec49,network,smoke]
+
+This is an example of running a customized list of Tempest tests in Functest::
+
+  sudo docker run --env-file env \
+      -v $(pwd)/openstack.creds:/home/opnfv/functest/conf/openstack.creds  \
+      -v $(pwd)/images:/home/opnfv/functest/images  \
+      -v $(pwd)/my-custom-testcases.yaml:/usr/lib/python2.7/site-packages/functest/ci/testcases.yaml  \
+      -v $(pwd)/my-custom-tempest-tests.txt:/usr/lib/python2.7/site-packages/functest/opnfv_tests/openstack/tempest/custom_tests/test_list.txt  \
+      opnfv/functest-components /bin/bash -c "prepare_env start && run_tests -t tempest_custom"
+
 
 Rally
 ^^^^^
-- 
2.16.6