Update userguide and configguide

Mainly remove the duplicated declaration of cloudify_ims_perf.

Change-Id: Ic23cee0e2dbb863cfddc98b08eabdab7d52e0476
Signed-off-by: Linda Wang <wangwulin@huawei.com>
(cherry picked from commit e12d4f14b65ba08904a65e188db17992478d67a7)

diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst
index e41700b..b82376d 100644 (file)
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -360,6 +360,7 @@ The structure of functest repo can be described as follows::
   |-- api
   |  `-- apidoc
   |-- build.sh
+  |-- commons
   |-- docker
   |  |-- Dockerfile
   |  |-- Dockerfile.aarch64.patch
@@ -483,11 +484,10 @@ The structure of functest repo can be described as follows::
 We may distinguish several directories, the first level has 5 directories:
 
 * **api**: This directory is dedicated to the API (framework) documentations.
-* **commons**: This directory is dedicated for storage of traffic
-  profile or any other test inputs that could be reused by any test
-  project.
+* **commons**: This directory is dedicated for storage of traffic profile or
+  any other test inputs that could be reused by any test project.
 * **docker**: This directory includes the needed files and tools to
-  build the Functest Docker image.
+  build the Functest Docker images.
 * **docs**: This directory includes documentation: Release Notes,
   User Guide, Configuration Guide and Developer Guide.
 * **functest**: This directory contains all the code needed to run
@@ -495,8 +495,7 @@ We may distinguish several directories, the first level has 5 directories:
 
 Functest directory has 7 sub-directories, which is located under
 /usr/lib/python2.7/site-packages/functest:
-  * **api**: This directory is dedicated for the internal Functest API and the
-    API (framework) documentations.
+  * **api**: This directory is dedicated for the internal Functest API.
   * **ci**: This directory contains test structure definition files
     (e.g <filename>.yaml) and bash shell/python scripts used to
     configure and execute Functional tests. The test execution script
@@ -508,7 +507,7 @@ Functest directory has 7 sub-directories, which is located under
       the integration of internal, feature or vnf cases.
   * **opnfv_tests**: This directory includes the scripts required by
     Functest internal test cases and other feature projects test cases.
-  * **tests**: This directory includes the functest unit tests
+  * **tests**: This directory includes the functest unit tests.
   * **utils**: this directory holds Python source code for some general
     purpose helper utilities, which testers can also re-use in their
     own test code. See for an example the Openstack helper utility:

diff --git a/docs/testing/user/userguide/test_details.rst b/docs/testing/user/userguide/test_details.rst
index 56cdd3b..33af31b 100644 (file)
--- a/docs/testing/user/userguide/test_details.rst
+++ b/docs/testing/user/userguide/test_details.rst
@@ -434,18 +434,23 @@ The first part is similar but the testing part is different.
 The testing part consists in automating a realistic signaling load on the vIMS
 using an Ixia loader (proprietary tools)
  - You need to have access to an Ixia licence server defined in the configuration
- file.
+    file and have ixia image locally.
+
+This test case is available but not declared in testcases.yaml. The declaration
+of the testcase is simple, connect to your functest-vnf docker, add the following
+section in /usr/lib/python2.7/site-packacges/functest/ci/testcases.yaml::
 
-To start this test you need to have access to an Ixia licence server and have ixia image locally
   -
       case_name: cloudify_ims_perf
       project_name: functest
-      criteria: 100
+      criteria: 80
       blocking: false
-      description: ''
+      description: >-
+          Stress tests based on Cloudify. Ixia loader images and access to Ixia
+          server license.
       dependencies:
           installer: ''
-          scenario: ''
+          scenario: 'os-nosdn-nofeature-ha'
       run:
           module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf'
           class: 'CloudifyImsPerf'
@@ -460,15 +465,8 @@ orchestra_clearwaterims
 Orchestra test case deals with the deployment of Clearwater vIMS with OpenBaton
 orchestrator.
 
-parser
-^^^^^^
-
-See parser user guide for details.
-
-
 vyos-vrouter
 ^^^^^^^^^^^^
-
 This test case deals with the deployment and the test of vyos vrouter with
 Cloudify orchestrator. The test case can do testing for interchangeability of
 BGP Protocol using vyos.
@@ -486,30 +484,6 @@ The Workflow is as follows:
 
 The vyos-vrouter architecture is described in `[14]`_
 
-cloudify_ims_perf
-^^^^^^^^^^^^^^^^^
-
-This test case is available but not declared in testcases.yaml. If you want to
-run it you need to get the Ixia loader images and have access to an Ixia license
-server.
-
-The declaration of the testcase is simple, connect to your functest-vnf docker,
-add the following section in /usr/lib/python2.7/site-packacges/functest/ci/testcases.yaml::
-
-  case_name: cloudify_ims_perf
-  project_name: functest
-  criteria: 80
-  blocking: false
-  description: >-
-      Stress tests based on Cloudify. Ixia loader images and access to Ixia
-      server license.
-  dependencies:
-      installer: ''
-      scenario: 'os-nosdn-nofeature-ha'
-  run:
-      module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf'
-      class: 'CloudifyImsPerf'
-
 
 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html

diff --git a/docs/testing/user/userguide/test_results.rst b/docs/testing/user/userguide/test_results.rst
index 6129ef3..3941ba0 100644 (file)
--- a/docs/testing/user/userguide/test_results.rst
+++ b/docs/testing/user/userguide/test_results.rst
@@ -37,8 +37,10 @@ at the end of the job and can be described as follow::
  |         rally_sanity         |     functest     |        smoke        |      15:16       |      PASS      |
  |       refstack_defcore       |     functest     |        smoke        |      15:55       |      PASS      |
  |         snaps_smoke          |     functest     |        smoke        |      26:45       |      FAIL      |
- |         cloudify_ims         |     functest     |         vnf         |      83:33       |      FAIL      |
- |        orchestra_ims         |     functest     |         vnf         |      11:32       |      FAIL      |
+ |           cloudify_ims       |     functest     |         vnf         |      23:56       |      PASS      |
+ |        orchestra_openims     |     orchestra    |         vnf         |      15:07       |      PASS      |
+ |     orchestra_clearwaterims  |     orchestra    |         vnf         |      19:10       |      PASS      |
+ |           vyos_vrouter       |     functest     |         vnf         |      00:00       |      SKIP      |
  +------------------------------+------------------+---------------------+------------------+----------------+
 
 Results are automatically pushed to the test results database, some additional

diff --git a/docs/testing/user/userguide/troubleshooting.rst b/docs/testing/user/userguide/troubleshooting.rst
index 3ceb914..20879bf 100644 (file)
--- a/docs/testing/user/userguide/troubleshooting.rst
+++ b/docs/testing/user/userguide/troubleshooting.rst
@@ -280,10 +280,10 @@ Example of custom list of tests 'my-custom-tempest-tests.txt'::
 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  \
+      -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"