Merge "Fix typos in test_details.rst and test_overview.rst"

[functest.git] / docs / testing / user / userguide / troubleshooting.rst

diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst
index 29facc2..becc24a 100644 (file)
--- 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.
 
 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 run_tests -t tempest_custom
+

 
 Rally
 ^^^^^
 
 Rally
 ^^^^^


@@ -338,4 +375,4 @@ described in the following table:
 Please note that this test case requires resources (8 VM (2Go) + 1 VM (4Go)), it
 is there fore not recommended to run it on a light configuration.
 
 Please note that this test case requires resources (8 VM (2Go) + 1 VM (4Go)), it
 is there fore not recommended to run it on a light configuration.
 

-.. _`OPNFV Functest Developer Guide`:  http://artifacts.opnfv.org/functest/docs/devguide/#
+.. _`OPNFV Functest Developer Guide`:  http://artifacts.opnfv.org/functest/docs/testing_developer_devguide/index.html#