Merge "Fix typos in test_details.rst and test_overview.rst"
[functest.git] / docs / testing / user / userguide / test_details.rst
index c9ef63d..97c4688 100644 (file)
@@ -36,8 +36,8 @@ Neutron and Nova and may perform some simple queries. When the config value of
 snaps.use_keystone is True, functest must have access to the cloud's private
 network. This suite consists in 49 tests (test duration < 2 minutes).
 
 snaps.use_keystone is True, functest must have access to the cloud's private
 network. This suite consists in 49 tests (test duration < 2 minutes).
 
-snaps_health_check creates instance, allocate floating IP, connect to the VM.
-This test replaced the previous Colorado healthcheck test.
+Snaps_health_check creates a VM with a single port with an IPv4 address that
+is assigned by DHCP and then validates the expected IP with the actual.
 
 Self-obviously, successful completion of the 'healthcheck' testcase is a
 necessary pre-requisite for the execution of all other test Tiers.
 
 Self-obviously, successful completion of the 'healthcheck' testcase is a
 necessary pre-requisite for the execution of all other test Tiers.
@@ -110,28 +110,28 @@ As vPing_ssh, it checks that 2 instances can talk to
 each other on a Private Tenant network::
 
  vPing_userdata test case
 each other on a Private Tenant network::
 
  vPing_userdata test case
- +-------------+                    +-------------+
- |             |                    |             |
- |             | Boot VM1 with IP1  |             |
- |             +------------------->|             |
- |             |                    |             |
- |             | Boot VM2 with      |             |
- |             | ping.sh as userdata|             |
- |             | with IP1 as $1.    |             |
- |             +------------------->|             |
- |   Tester    |                    |   System    |
- |             | VM2 exeutes ping.sh|    Under    |
- |             | (ping IP1)         |     Test    |
- |             +------------------->|             |
- |             |                    |             |
- |             | Monitor nova       |             |
- |             |  console-log VM 2  |             |
- |             |    If ping:        |             |
- |             |      exit OK       |             |
- |             |    else (timeout)  |             |
- |             |      exit Failed   |             |
- |             |                    |             |
- +-------------+                    +-------------+
+ +-------------+                     +-------------+
+ |             |                     |             |
+ |             | Boot VM1 with IP1   |             |
+ |             +-------------------->|             |
+ |             |                     |             |
+ |             | Boot VM2 with       |             |
+ |             | ping.sh as userdata |             |
+ |             | with IP1 as $1.     |             |
+ |             +-------------------->|             |
+ |   Tester    |                     |   System    |
+ |             | VM2 executes ping.sh|    Under    |
+ |             | (ping IP1)          |     Test    |
+ |             +-------------------->|             |
+ |             |                     |             |
+ |             | Monitor nova        |             |
+ |             |  console-log VM 2   |             |
+ |             |    If ping:         |             |
+ |             |      exit OK        |             |
+ |             |    else (timeout)   |             |
+ |             |      exit Failed    |             |
+ |             |                     |             |
+ +-------------+                     +-------------+
 
 When the second VM boots it will execute the script passed as userdata
 automatically. The ping will be detected by periodically capturing the output
 
 When the second VM boots it will execute the script passed as userdata
 automatically. The ping will be detected by periodically capturing the output
@@ -426,28 +426,34 @@ The Clearwater architecture is described as follows:
    :align: center
    :alt: vIMS architecture
 
    :align: center
    :alt: vIMS architecture
 
- cloudify_ims_perf
- ^^^^^^^^^^^^
- This testcase extends the cloudify_ims test case.
- 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.
-
- 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
-       blocking: false
-       description: ''
-       dependencies:
-           installer: ''
-           scenario: 'o'
-       run:
-           module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf'
-           class: 'CloudifyImsPerf'
+
+cloudify_ims_perf
+^^^^^^^^^^^^^^^^^
+This testcase extends the cloudify_ims test case.
+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 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::
+
+  -
+      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'
 
 orchestra_openims
 ^^^^^^^^^^^^^^^^^
 
 orchestra_openims
 ^^^^^^^^^^^^^^^^^
@@ -459,15 +465,8 @@ orchestra_clearwaterims
 Orchestra test case deals with the deployment of Clearwater vIMS with OpenBaton
 orchestrator.
 
 Orchestra test case deals with the deployment of Clearwater vIMS with OpenBaton
 orchestrator.
 
-parser
-^^^^^^
-
-See parser user guide for details.
-
-
 vyos-vrouter
 ^^^^^^^^^^^^
 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.
 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.
@@ -485,30 +484,6 @@ The Workflow is as follows:
 
 The vyos-vrouter architecture is described in `[14]`_
 
 
 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
 
 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html