diff options
| -rw-r--r-- | docs/userguide/index.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/runfunctest.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/troubleshooting.rst | 64 |
3 files changed, 58 insertions, 12 deletions
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index dcfca16e0..790343b08 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -24,12 +24,12 @@ It is assumed that Functest container has been properly installed `[1]`_. The different scenarios are described in the section hereafter. VIM (Virtualized Infrastructure Manager) ---- +---------------------------------------- vPing_SSH ^^^^^^^^^ -Given the script 'ping.sh':: +Given the script **ping.sh**:: #!/bin/sh while true; do diff --git a/docs/userguide/runfunctest.rst b/docs/userguide/runfunctest.rst index 573664acc..8e4e48494 100644 --- a/docs/userguide/runfunctest.rst +++ b/docs/userguide/runfunctest.rst @@ -4,7 +4,6 @@ Executing the functest suites ============================= - Manual testing -------------- @@ -93,7 +92,6 @@ do a direct call to the desired test script. For example: python $repos_dir/functest/testcases/vPing/vPing.py -d - Automated testing ----------------- diff --git a/docs/userguide/troubleshooting.rst b/docs/userguide/troubleshooting.rst index 44d3aef99..7fb2abab6 100644 --- a/docs/userguide/troubleshooting.rst +++ b/docs/userguide/troubleshooting.rst @@ -7,7 +7,7 @@ Troubleshooting This section gives some guidelines about how to troubleshoot the test cases owned by Functest. -IMPORTANT: The steps defined below must be executed inside the Functest Docker +**IMPORTANT**: The steps defined below must be executed inside the Functest Docker container and after sourcing the OpenStack credentials:: . $creds @@ -16,19 +16,19 @@ or:: source /home/opnfv/functest/conf/openstack.creds - - VIM --- +This section covers the test cases related to the VIM (vPing, Tempest, Rally). + vPing common ^^^^^^^^^^^^ For both vPing test cases (vPing_SSH, and vPing_userdata), the first steps are similar: - * Create Glance image - * Create Network - * Create Security Group - * Create instances +* Create Glance image +* Create Network +* Create Security Group +* Create instances After these actions, the test cases differ and will be explained in their section. @@ -231,7 +231,55 @@ related Rally deployment folder. Rally ^^^^^ -Same error causes than for Tempest mentioned above may lead to error in Rally. +Same error causes than for Tempest mentioned above may lead to errors in Rally. + +It is possible to run only one Rally scenario, instead of the whole suite. +To do that, call the python script (instead of *run_tests.sh*) as follows:: + + python $repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/run_rally-cert.py -h + usage: run_rally-cert.py [-h] [-d] [-r] [-s] [-v] [-n] test_name + + positional arguments: + test_name Module name to be tested. Possible values are : [ + authenticate | glance | cinder | heat | keystone | neutron | + nova | quotas | requests | vm | all ] The 'all' value + performs all possible test scenarios + + optional arguments: + -h, --help show this help message and exit + -d, --debug Debug mode + -r, --report Create json result file + -s, --smoke Smoke test mode + -v, --verbose Print verbose info about the progress + -n, --noclean Don't clean the created resources for this test. + +For example, to run the Glance scenario with debug information:: + + python $repos_dir/functest/testcases/VIM/OpenStack/CI/libraries/run_rally-cert.py -d glance + +Possible scenarios are: + * authenticate + * glance + * cinder + * heat + * keystone + * neutron + * nova + * quotas + * requests + * vm + +To know more about what those scenarios are doing, they are defined in: +*$repos_dir/functest/testcases/VIM/OpenStack/CI/suites*. For more info about +Rally scenario definition please refer to the Rally official documentation. + +If the flag *all* is specified, it will run all the scenarios one by one. Please +note that this might take some time (~1,5hr), taking around 1 hour to complete the +Nova scenario. + +To check any possible problems with rally, the logs are stored under +*/home/opnfv/functest/results/rally/* in the Functest container. + Controllers ----------- |