Merge "[Fuel] Skip test_server_basic_ops tempest test"
[functest.git] / docs / userguide / index.rst
index 89e3ef1..6140f60 100644 (file)
@@ -1,33 +1,60 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
 =========================
 OPNFV FUNCTEST user guide
 =========================
 
 .. toctree::
-   :numbered:
    :maxdepth: 2
 
 
 Introduction
 ============
 
-The goal of this documents is to describe the Functest test cases as well as
-provide a procedure about how to execute them.
+The goal of this document is to describe the OPNFV Functest test cases and to
+provide a procedure to execute them. In the OPNFV Colorado system release,
+a Functest CLI utility is introduced for easier execution of test procedures.
+
+A overview presentation has been created for the first OPNFV Summit `[4]`_.
 
-A presentation has been created for the first OPNFV Summit `[4]`_.
+This document is a continuation of the OPNFV Functest Configuration Guide `[1]`_.
 
-It is assumed that Functest container has been properly installed `[1]`_.
+**IMPORTANT**: It is assumed here that the Functest Docker container is already
+properly deployed and that all instructions described in this guide are to be
+performed from *inside* the deployed Functest Docker container.
 
-.. include:: ./description.rst
+.. include:: ./introduction.rst
 
-The different scenarios are described in the section hereafter.
+The different test cases are described in the remaining sections of this document.
 
 VIM (Virtualized Infrastructure Manager)
----
+----------------------------------------
+
+Healthcheck
+^^^^^^^^^^^
+In Colorado release a new Tier 'healthcheck' with one testcase 'healthcheck'
+is introduced. The healthcheck testcase verifies that some basic IP connectivity
+and  essential operations of OpenStack functionality over the command line are
+working correctly.
+
+In particular, the following verifications are performed:
+
+  * DHCP agent functionality for IP address allocation
+  * Openstack Authentication management functionality via the Keystone API
+  * OpenStack Image management functionality via the Glance API
+  * OpenStack Block Storage management functionality via the Cinder API
+  * OpenStack Networking management functionality via the Neutron API
+  * Openstack Compute management functionality via the NOVA API
+
+Self-obviously, successful completion of the 'healthcheck' testcase is a
+necessary pre-requisite for the execution of all other test Tiers.
+
 
-vPing
-^^^^^
+vPing_ssh
+^^^^^^^^^
 
-Given the script 'ping.sh'::
+Given the script **ping.sh**::
 
     #!/bin/sh
     while true; do
@@ -42,9 +69,12 @@ Given the script 'ping.sh'::
     sleep 1
     done
 
-The goal of this test is described as follows::
 
- vPing test case
+The goal of this test is to establish an SSH connection using a floating IP
+on the Public/External network and verify that 2 instances can talk over a Private
+Tenant network::
+
+ vPing_ssh test case
  +-------------+                    +-------------+
  |             |                    |             |
  |             | Boot VM1 with IP1  |             |
@@ -60,7 +90,7 @@ The goal of this test is described as follows::
  |             | to VM2             |             |
  |             +------------------->|             |
  |             |                    |             |
- |             | Stablish SSH       |             |
+ |             | Establish SSH      |             |
  |             | connection to VM2  |             |
  |             | through floating IP|             |
  |             +------------------->|             |
@@ -74,18 +104,22 @@ The goal of this test is described as follows::
  |             |                    |             |
  |             |    If ping:        |             |
  |             |      exit OK       |             |
- |             |    else (timeout)  |             |
+ |             |    else (timeout): |             |
  |             |      exit Failed   |             |
  |             |                    |             |
  +-------------+                    +-------------+
 
 This test can be considered as an "Hello World" example.
-It is the first basic use case which shall work on any deployment.
+It is the first basic use case which **must** work on any deployment.
 
 vPing_userdata
 ^^^^^^^^^^^^^^
 
-The goal of this test can be described as follows::
+This test case is similar to vPing_ssh but without the use of Floating IPs
+and the Public/External network to transfer the ping script.
+Instead, it uses Nova metadata service to pass it to the instance at booting time.
+As vPing_ssh, it checks that 2 instances can talk to
+each other on a Private Tenant network::
 
  vPing_userdata test case
  +-------------+                    +-------------+
@@ -111,10 +145,9 @@ The goal of this test can be described as follows::
  |             |                    |             |
  +-------------+                    +-------------+
 
-This scenario is similar to the previous one but it uses cloud-init (nova
-metadata service) instead of floating IPs and SSH connection. When the second VM
-boots it will execute the script automatically and the ping will be detected
-capturing periodically the output in the console-log of the second VM.
+When the second VM boots it will execute the script passed as userdata
+automatically. The ping will be detected by periodically capturing the output
+in the console-log of the second VM.
 
 
 Tempest
@@ -122,46 +155,49 @@ Tempest
 
 Tempest `[2]`_ is the reference OpenStack Integration test suite.
 It is a set of integration tests to be run against a live OpenStack cluster.
-Tempest has batteries of tests for:
+Tempest has suites of tests for:
 
   * OpenStack API validation
   * Scenarios
   * Other specific tests useful in validating an OpenStack deployment
 
 Functest uses Rally `[3]`_ to run the Tempest suite.
-Rally generates automatically the Tempest configuration file (tempest.conf).
-Before running the actual test cases, Functest creates the needed resources and
-updates the appropriate parameters to the configuration file.
+Rally generates automatically the Tempest configuration file **tempest.conf**.
+Before running the actual test cases,
+Functest creates the needed resources (user, tenant) and
+updates the appropriate parameters into the configuration file.
+
 When the Tempest suite is executed, each test duration is measured and the full
-console output is stored in the tempest.log file for further analysis.
+console output is stored to a *log* file for further analysis.
 
-As an addition of Arno, Brahmaputra runs a customized set of Tempest test cases.
-The list is specificed through *--tests-file* when running Rally.
-This option has been introduced in Rally in version 0.1.2.
+The Tempest testcases are distributed accross two
+Tiers:
 
-The customized test list is available in the Functest repo `[4]`_.
-This list contains more than 200 Tempest test cases and can be divided
-into two main sections:
+  * Smoke Tier - Test Case 'tempest_smoke_serial'
+  * Openstack Tier - Test case 'tempest_full_parallel'
 
-  1) Set of tempest smoke test cases
-  2) Set of test cases from DefCore list `[8]`_
+NOTE: Test case 'tempest_smoke_serial' executes a defined set of tempest smoke
+tests with a single thread (i.e. serial mode). Test case 'tempest_full_parallel'
+executes all defined Tempest tests using several concurrent threads
+(i.e. parallel mode). The number of threads activated corresponds to the number
+of available logical CPUs.
 
-The goal of the Tempest test suite is to check the basic functionalities of
-different OpenStack components on an OPNFV fresh installation using
-the corresponding REST API interfaces.
+The goal of the Tempest test suite is to check the basic functionalities of the
+different OpenStack components on an OPNFV fresh installation, using the
+corresponding REST API interfaces.
 
 
 Rally bench test suites
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Rally `[3]`_ is a benchmarking tool that answers the question::
+Rally `[3]`_ is a benchmarking tool that answers the question:
 
- “How does OpenStack work at scale?”.
+*How does OpenStack work at scale?*
 
-The goal of this test suite is to benchmark the different OpenStack modules and
+The goal of this test suite is to benchmark all the different OpenStack modules and
 get significant figures that could help to define Telco Cloud KPIs.
 
-The OPNFV scenarios are based on the collection of the existing Rally scenarios:
+The OPNFV Rally scenarios are based on the collection of the actual Rally scenarios:
 
  * authenticate
  * cinder
@@ -173,18 +209,24 @@ The OPNFV scenarios are based on the collection of the existing Rally scenarios:
  * quotas
  * requests
 
-A basic SLA (stop test on errors) have been implemented.
+A basic SLA (stop test on errors) has been implemented.
+
+The Rally testcases are distributed accross two Tiers:
+
+  * Smoke Tier - Test Case 'rally_sanity'
+  * Openstack Tier - Test case 'rally_full'
+
+NOTE: Test case 'rally_sanity' executes a limited number of Rally smoke test
+cases. Test case 'rally_full' executes the full defined set of Rally tests.
 
 
 SDN Controllers
 ---------------
 
-Brahmaputra introduces new SDN controllers.
-There are currently 3 possible controllers:
+There are currently 2 available controllers:
 
  * OpenDaylight (ODL)
  * ONOS
- * OpenContrail (OCL)
 
 OpenDaylight
 ^^^^^^^^^^^^
@@ -196,42 +238,41 @@ OpenDaylight and Neutron.
 
 The list of tests can be described as follows:
 
- * Restconf.basic: Get the controller modules via Restconf
- * Neutron.Networks
-
-   * Check OpenStack Networks :: Checking OpenStack Neutron for known networks
-   * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API
-   * Create Network :: Create new network in OpenStack
-   * Check Network :: Check Network created in OpenDaylight
-   * Neutron.Networks :: Checking Network created in OpenStack are pushed
-
- * Neutron.Subnets
+ * Basic Restconf test cases
+   * Connect to Restconf URL
+   * Check the HTTP code status
 
-   * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets
-   * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API
-   * Create New subnet :: Create new subnet in OpenStack
-   * Check New subnet :: Check new subnet created in OpenDaylight
-   * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed
+ * Neutron Reachability test cases
+   * Get the complete list of neutron resources (networks, subnets, ports)
 
- * Neutron.Ports
+ * Neutron Network test cases
+   * Check OpenStack networks
+   * Check OpenDaylight networks
+   * Create a new network via OpenStack and check the HTTP status code returned by Neutron
+   * Check that the network has also been successfully created in OpenDaylight
 
  * Check OpenStack ports :: Checking OpenStack Neutron for known ports
-   * Check OpenDaylight ports :: Checking OpenDaylight Neutron API
-   * Create New Port :: Create new port in OpenStack
-   * Check New Port :: Check new subnet created in OpenDaylight
-   * Neutron.Ports :: Checking Port created in OpenStack are pushed
* Neutron Subnet test cases
+   * Check OpenStack subnets
+   * Check OpenDaylight subnets
+   * Create a new subnet via OpenStack and check the HTTP status code returned by Neutron
+   * Check that the subnet has also been successfully created in OpenDaylight
 
- * Delete Ports
+ * Neutron Port test cases
+   * Check OpenStack Neutron for known ports
+   * Check OpenDaylight ports
+   * Create a new port via OpenStack and check the HTTP status code returned by Neutron
+   * Check that the new port has also been successfully created in OpenDaylight
 
-   * Delete previously created subnet in OpenStack
-   * Check subnet deleted in OpenDaylight
-   * Check subnet deleted in OpenStack
+ * Delete operations
+   * Delete the port previously created via OpenStack
+   * Check that the port has been also succesfully deleted in OpenDaylight
+   * Delete previously subnet created via OpenStack
+   * Check that the subnet has also been successfully deleted in OpenDaylight
+   * Delete the network created via OpenStack
+   * Check that the network has also been succesfully deleted in OpenDaylight
 
- * Delete network
-
-   * Delete previously created network in OpenStack
-   * Check network deleted in OpenDaylight
-   * Check network deleted in OpenStack
+Note: the checks in OpenDaylight are based on the returned HTTP status
+code returned by OpenDaylight.
 
 
 ONOS
@@ -241,7 +282,7 @@ TestON Framework is used to test the ONOS SDN controller functions.
 The test cases deal with L2 and L3 functions.
 The ONOS test suite can be run on any ONOS compliant scenario.
 
-The test cases may be described as follows:
+The test cases are described as follows:
 
  * onosfunctest: The main executable file contains the initialization of
    the docker environment and functions called by FUNCvirNetNB and
@@ -262,600 +303,194 @@ The test cases may be described as follows:
 
  * FUNCvirNetNBL3
 
-   * Create Router: Post dataes for create Router and check it in ONOS
+   * Create Router: Post data for create Router and check it in ONOS
    * Update Router: Update the Router and compare it in ONOS
-   * Delete Router: Delete the Router dataes and check it in ONOS
-   * Create RouterInterface: Post RouterInterface data to an exist Router
+   * Delete Router: Delete the Router data and check it in ONOS
+   * Create RouterInterface: Post Router Interface data to an existing Router
      and check it in ONOS
    * Delete RouterInterface: Delete the RouterInterface and check the Router
-   * Create FloatingIp: Post dataes for create FloatingIp and check it in
-     ONOS
+   * Create FloatingIp: Post data for create FloatingIp and check it in ONOS
    * Update FloatingIp: Update the FloatingIp and compare it in ONOS
-   * Delete FloatingIp: Delete the FloatingIp and check if it's NULL in
-     ONOS  or not
-   * Create External Gateway: Post dataes for create External Gateway to an
-     exit Router and check it
-   * Update External Gateway: Update the External Gateway and compare it
-   * Delete External Gateway: Delete the External Gateway and check if it's
-     NULL in ONOS or not
-
-
-OpenContrail
-^^^^^^^^^^^^
-TODO OVNO
-
+   * Delete FloatingIp: Delete the FloatingIp and check that it is 'NULL' in
+     ONOS
+   * Create External Gateway: Post data to create an External Gateway for an
+     existing Router and check it in ONOS
+   * Update External Gateway: Update the External Gateway and compare the change
+   * Delete External Gateway: Delete the External Gateway and check that it is
+     'NULL' in ONOS
 
 
 Features
 --------
 
-vIMS
-^^^^
-The goal of this test suite consists of:
-
- * deploy a VNF orchestrator (Cloudify)
- * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this
-   orchestrator based on a TOSCA blueprint defined in `[5]`_
- * run suite of signaling tests on top of this VNF
-
-The Clearwater architecture is described as follows:
-
-.. figure:: ../images/clearwater-architecture.png
-   :align: center
-   :alt: vIMS architecture
-
-Two types of information are stored in the Test Database:
-
- * the duration of each step (orchestion deployment, VNF deployment and test)
- * the test results
-
-The deployment of a complete functional VNF allows the test of most of the
-essential functions needed for a NFV platform.
-
-Promise
-^^^^^^^
-
-Promise provides a basic set of test cases as part of Brahmaputra.
+Most of the features have been developped by feature projects.
+Security_scan has been initiated in Functest repository but should soon
+be declared in its own repository as well.
 
-The available 33 test cases can be grouped into 7 test suites:
+Please refer to the dedicated feature user guides for details:
 
-    #. Add a new OpenStack provider into resource pool: Registers
-       OpenStack into a new resource pool and adds more capacity associated
-       with this pool.
+ * bgpvpn: ** TODO link **
+ * copper: ** TODO link **
+ * doctor: http://artifacts.opnfv.org/doctor/colorado/userguide/index.html
+ * domino: ** TODO link **
+ * moon: ** TODO link **
+ * multisites: ** TODO link **
+ * onos-sfc: ** TODO link **
+ * odl-sfc: ** TODO link **
+ * promise: http://artifacts.opnfv.org/promise/colorado/userguide/index.html
 
-    #. Allocation without reservation: Creates a new server in OpenStack
-       and adds a new allocation record in Promise shim-layer.
+security_scan
+^^^^^^^^^^^^^
 
-    #. Allocation using reservation for immediate use: Creates a resource
-       reservation record with no start/end time and immediately creates a new
-       server in OpenStack and add a new allocation record in Promise
-       shim-layer.
+Security Scanning, is a project to insure security compliance and vulnerability
+checks, as part of an automated CI / CD platform delivery process.
 
-    #. Reservation for future use: Creates a resource reservation record
-       for a future start time, queries, modifies and cancels the newly created
-       reservation.
+The project makes use of the existing SCAP format[6] to perform deep scanning of
+NFVi nodes, to insure they are hardened and free of known CVE reported vulnerabilities.
 
-    #. Capacity planning: Decreases and increases the available capacity
-       from a provider in the future and queries the available collections and
-       utilizations.
+The SCAP content itself, is then consumed and run using an upstream opensource tool
+known as OpenSCAP[7].
 
-    #. Reservation with conflict: Tries to create reservations for
-       immediate and future use with conflict.
+The OPNFV Security Group have developed the code that will called by the OPNFV Jenkins
+build platform, to perform a complete scan. Resulting reports are then copied to the
+OPNFV functest dashboard.
 
-    #. Cleanup test allocations: Destroys all allocations in OpenStack.
+The current work flow is as follows:
 
+  * Jenkins Build Initiated
+  * security_scan.py script is called, and a config file is passed to the script as
+    an argument.
+  * The IP addresses of each NFVi node (compute / control), is gathered.
+  * A scan profile is matched to the node type.
+  * The OpenSCAP application is remotely installed onto each target node gathered
+    on step 3, using upstream packaging (rpm and .deb).
+  * A scan is made against each node gathered within step 3.
+  * HTML Reports are downloaded for rendering on a dashboard.
+  * If the config file value 'clean' is set to 'True' then the application installed in
+    step 5 is removed, and all reports created at step 6 are deleted.
 
-The specific parameters for Promise can be found in config_functest.yaml and
-include::
+At present, only the Apex installer is supported, with support for other installers due
+within D-release.
 
-   promise:
-     general:
-         tenant_name: Name of the OpenStack tenant/project (e.g. promise)
-         tenant_description: Description of the OpenStack tenant (e.g. promise Functionality Testing)
-         user_name: Name of the user tenant (e.g. promiser)
-         user_pwd: Password of the user tenant (e.g. test)
-         image_name: Name of the software image (e.g. promise-img)
-         flavor_name: Name of the flavor (e.g. promise-flavor with 1 vCPU and 512 MB RAM)
-         flavor_vcpus: 1
-         flavor_ram: 512
-         flavor_disk: 0
 
-However, these parameters must not be changed, as they are the values expected
-by the Promise test suite.
-
-.. include:: ./runfunctest.rst
-
-Test results
-============
 
-VIM
+VNF
 ---
 
-vPing
-^^^^^
-
-vPing test case output is displayed in the console::
-
-  FUNCTEST.info: Running vPing test...
-  2016-01-23 03:18:20,153 - vPing- INFO - Creating neutron network vping-net...
-  2016-01-23 03:18:35,476 - vPing- INFO - Flavor found 'm1.small'
-  2016-01-23 03:18:36,350 - vPing- INFO - vPing Start Time:'2016-01-23 03:18:36'
-  2016-01-23 03:18:38,571 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
-  2016-01-23 03:18:53,716 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
-  2016-01-23 03:18:55,239 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
-  2016-01-23 03:19:15,593 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
-  2016-01-23 03:19:15,593 - vPing- INFO - Creating floating IP for the second VM...
-  2016-01-23 03:19:18,017 - vPing- INFO - Floating IP created: '10.2.65.6'
-  2016-01-23 03:19:18,017 - vPing- INFO - Associating floating ip: '10.2.65.6' to VM2
-  2016-01-23 03:19:37,839 - vPing- INFO - SCP ping script to VM2...
-  2016-01-23 03:19:37,839 - vPing- INFO - Waiting for ping...
-  2016-01-23 03:19:40,130 - vPing- INFO - vPing detected!
-  2016-01-23 03:19:40,130 - vPing- INFO - vPing duration:'63.8'
-  2016-01-23 03:19:40,130 - vPing- INFO - Cleaning up...
-  2016-01-23 03:20:06,574 - vPing- INFO - Deleting network 'vping-net'...
-  2016-01-23 03:20:13,587 - vPing- INFO - vPing OK
-
-
-
-
-vPing_userdata
-^^^^^^^^^^^^^^
-
-vPing_userdata results are displayed in the console::
-
-    2016-01-06 16:06:20,550 - vPing- INFO - Creating neutron network vping-net...
-    2016-01-06 16:06:23,867 - vPing- INFO - Flavor found 'm1.small'
-    2016-01-06 16:06:24,457 - vPing- INFO - vPing Start Time:'2016-01-06 16:06:24'
-    2016-01-06 16:06:24,626 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
-    2016-01-06 16:06:39,351 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
-    2016-01-06 16:06:39,650 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
-    2016-01-06 16:06:53,330 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
-    2016-01-06 16:06:53,330 - vPing- INFO - Waiting for ping...
-    2016-01-06 16:06:58,669 - vPing- INFO - vPing detected!
-    2016-01-06 16:06:58,669 - vPing- INFO - vPing duration:'34.2'
-    2016-01-06 16:06:58,670 - vPing- INFO - Cleaning up...
-    2016-01-06 16:07:12,661 - vPing- INFO - Deleting network 'vping-net'...
-    2016-01-06 16:07:14,748 - vPing- INFO - vPing OK
-
-Tempest
-^^^^^^^
-
-The Tempest results are displayed in the console::
-
-  FUNCTEST.info: Running Tempest tests...
-  2016-01-28 07:56:55,380 - run_tempest - INFO - Creating tenant and user for Tempest suite
-  2016-01-28 07:56:56.127 23795 INFO rally.verification.tempest.tempest [-] Starting: Creating configuration file for Tempest.
-  2016-01-28 07:56:59.512 23795 INFO rally.verification.tempest.tempest [-] Completed: Creating configuration file for Tempest.
-  16-01-28 07:57:00,597 - run_tempest - INFO - Starting Tempest test suite: '--tests-file /home/opnfv/repos/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt'.
-  Total results of verification:
-  .
-  +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
-  | UUID                                 | Deployment UUID                      | Set name | Tests | Failures | Created at                 | Status   |
-  +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
-  | e0bf7770-2c0f-4c63-913c-cd51a6edd96d | 16582e1e-7b01-4d5d-9c13-a26db8567b7b |          | 144   | 30       | 2016-01-28 07:57:01.044856 | finished |
-  +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
-  .
-  Tests:
-  .
-  +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
-  | name                                                                                                                                     | time      | status  |
-  +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
-  | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor                                                               | 0.29804   | success |
-  | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors                                                             | 0.06289   | success |
-  | tempest.api.compute.images.test_images.ImagesTestJSON.test_delete_saving_image                                                           | 9.21756   | success |
-  | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_delete_image                                        | 8.65376   | success |
-  | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_image_specify_multibyte_character_image_name        | 9.10993   | success |
-  | tempest.api.compute.images.test_list_image_filters.ListImageFiltersTestJSON.test_list_images_filter_by_changes_since                     | 0.19585   | success |
-  ...........................................
-  2016-01-28 08:19:32,132 - run_tempest - INFO - Results: {'timestart': '2016-01-2807:57:01.044856', 'duration': 1350, 'tests': 144, 'failures': 30}
-  2016-01-28 08:19:32,133 - run_tempest - INFO - Pushing results to DB: 'http://testresults.opnfv.org/testapi/results'.
-  2016-01-28 08:19:32,278 - run_tempest - INFO - Deleting tenant and user for Tempest suite)
-
-In order to check all the available test cases related debug information, inspect
-tempest.log file stored under */home/opnfv/functest/results/tempest/*.
-
-
-Rally
-^^^^^
-
-The Rally results are displayed in the console, each module is run one after the
-other. Tables are displayed::
-
-  +-------------------------------------------------------------------------------------------+
-  |                                   Response Times (sec)                                    |
-  +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
-  | action               | min   | median | 90%ile | 95%ile | max   | avg   | success | count |
-  +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
-  | keystone.create_role | 0.358 | 0.572  | 0.772  | 0.811  | 1.106 | 0.603 | 100.0%  | 20    |
-  | keystone.add_role    | 0.32  | 0.436  | 0.846  | 0.903  | 1.018 | 0.51  | 100.0%  | 20    |
-  | keystone.list_roles  | 0.102 | 0.185  | 0.253  | 0.275  | 0.347 | 0.188 | 100.0%  | 20    |
-  | total                | 0.845 | 1.223  | 1.821  | 1.822  | 1.823 | 1.302 | 100.0%  | 20    |
-  +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
-  Load duration: 7.13633608818
-  Full duration: 36.7863121033
-  ..............
-  +------------------------------------------------------------------------------------------+
-  |                                   Response Times (sec)                                   |
-  +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
-  | action              | min   | median | 90%ile | 95%ile | max   | avg   | success | count |
-  +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
-  | nova.create_keypair | 1.005 | 1.784  | 3.025  | 3.636  | 4.373 | 2.004 | 100.0%  | 20    |
-  | nova.delete_keypair | 0.199 | 0.699  | 1.007  | 1.244  | 3.014 | 0.79  | 100.0%  | 20    |
-  | total               | 1.249 | 2.625  | 4.259  | 4.845  | 5.131 | 2.794 | 100.0%  | 20    |
-  +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
-  Load duration: 14.9231169224
-  Full duration: 71.4614388943
-
-
-At the end of the module test, a message is displayed to provide a global
-summary::
-
-  2016-02-04 12:50:18,382 - run_rally - INFO - Test scenario: "requests" OK.
-
-
-Controllers
------------
 
-OpenDaylight
-^^^^^^^^^^^^
-
-The results of ODL tests can be seen in the console::
-
- ==============================================================================
- Basic
- ==============================================================================
- Basic.010 Restconf OK :: Test suite to verify Restconf is OK
- ==============================================================================
- Get Controller Modules :: Get the controller modules via Restconf     | PASS |
- ------------------------------------------------------------------------------
- Basic.010 Restconf OK :: Test suite to verify Restconf is OK          | PASS |
- 1 critical test, 1 passed, 0 failed
- 1 test total, 1 passed, 0 failed
- ==============================================================================
- Basic                                                                 | PASS |
- 1 critical test, 1 passed, 0 failed
- 1 test total, 1 passed, 0 failed
- ==============================================================================
- Output:  /home/opnfv/repos/functest/output.xml
- Log:     /home/opnfv/repos/functest/log.html
- Report:  /home/opnfv/repos/functest/report.html
-
- ..............................................................................
-
- Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | PASS |
- 2 critical tests, 2 passed, 0 failed
- 2 tests total, 2 passed, 0 failed
- ==============================================================================
- Neutron :: Test suite for Neutron Plugin                              | PASS |
- 18 critical tests, 18 passed, 0 failed
- 18 tests total, 18 passed, 0 failed
- ==============================================================================
- Output:  /home/opnfv/repos/functest/output.xml
- Log:     /home/opnfv/repos/functest/log.html
- Report:  /home/opnfv/repos/functest/report.html
-
-3 result files are generated:
- * output.xml
- * log.html
- * report.html
-
-**ODL result page**
-
-.. figure:: ../images/functestODL.png
-   :width: 170mm
-   :align: center
-   :alt: ODL suite result page
-
-
-ONOS
+vIMS
 ^^^^
+The IP Multimedia Subsystem or IP Multimedia Core Network Subsystem (IMS) is an
+architectural framework for delivering IP multimedia services.
 
-The ONOS test logs can be found in OnosSystemTest/, and TestON/, and logs/
-(ONOSCI_PATH to be added), and can also be seen in the console::
-
- ******************************
- Result summary for Testcase4
- ******************************
-
- 2016-01-14 05:25:40,529 - FUNCvirNetNBL3 - INFO - ONOS Router Delete test Start
-
- [2016-01-14 05:25:40.529644] [FUNCvirNetNBL3] [CASE]  Virtual Network NBI Test - Router
- 2016-01-14 05:25:40,530 - FUNCvirNetNBL3 - INFO - Generate Post Data
-
- [2016-01-14 05:25:40.530825] [FUNCvirNetNBL3] [STEP]  4.1: Post Network Data via HTTP(Post Router need post network)
- 2016-01-14 05:25:40,531 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/networks/ using POST method.
- 2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
- 2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Post Network Success
- 2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Assertion Passed
-
- [2016-01-14 05:25:40.539687] [FUNCvirNetNBL3] [STEP]  4.2: Post Router Data via HTTP
- 2016-01-14 05:25:40,540 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/ using POST method.
- 2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
- 2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Post Router Success
- 2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Assertion Passed
-
- [2016-01-14 05:25:40.543489] [FUNCvirNetNBL3] [STEP]  4.3: Delete Router Data via HTTP
- 2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/e44bd655-e22c-4aeb-b1e9-ea1606875178 using DELETE method.
- 2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
- 2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Delete Router Success
- 2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Assertion Passed
-
- [2016-01-14 05:25:40.546774] [FUNCvirNetNBL3] [STEP]  4.4: Get Router Data is NULL
- 2016-01-14 05:25:40,547 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/e44bd655-e22c-4aeb-b1e9-ea1606875178 using GET method.
- 2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
- 2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Get Router Success
- 2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Assertion Passed
-
-
- *****************************
-  Result: Pass
- *****************************
-
- .......................................................................................
-
- ******************************
-  Result summary for Testcase9
- ******************************
- .......................................................................................
-
-
- [2016-01-14 05:26:42.543489] [FUNCvirNetNBL3] [STEP]  9.6: FloatingIp Clean Data via HTTP
- 2016-01-14 05:26:42,543 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/floatingips/e44bd655-e22c-4aeb-b1e9-ea1606875178 using DELETE method.
- 2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
- 2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - ERROR - Delete Floatingip failed
+vIMS has been integrated in Functest to demonstrate the capability to deploy a
+relatively complex NFV scenario on the OPNFV platform. The deployment of a complete
+functional VNF allows the test of most of the
+essential functions needed for a NFV platform.
 
- .......................................................................................
+The goal of this test suite consists of:
 
- *****************************
-  Result: Failed
- *****************************
+ * deploy a VNF orchestrator (Cloudify)
+ * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this
+   orchestrator based on a TOSCA blueprint defined in `[5]`_
+ * run suite of signaling tests on top of this VNF
 
-There is a result summary for each testcase, and a global summary for the whole test.
-If any problem occurs during the test, a ERROR message will be provided in the test and the the global summary::
+The Clearwater architecture is described as follows:
 
- *************************************
-         Test Execution Summary
- *************************************
+.. figure:: ../images/clearwater-architecture.png
+   :align: center
+   :alt: vIMS architecture
 
-  Test Start           : 14 Jan 2016 05:25:37
-  Test End             : 14 Jan 2016 05:25:41
-  Execution Time       : 0:00:03.349087
-  Total tests planned  : 11
-  Total tests RUN      : 11
-  Total Pass           : 8
-  Total Fail           : 3
-  Total No Result      : 0
-  Success Percentage   : 72%
-  Execution Result     : 100%
 
+parser
+^^^^^^
 
-OpenContrail
-^^^^^^^^^^^^
+See parser user guide for details: `[12]`_
 
-TODO OVNO
 
+.. include:: ./runfunctest.rst
 
-Feature
--------
 
-vIMS
-^^^^
-
-The results in the console can be described as follows::
-
-    FUNCTEST.info: Running vIMS test...
-    2016-02-04 13:46:25,025 - vIMS - INFO - Prepare OpenStack plateform (create tenant and user)
-    2016-02-04 13:46:25,312 - vIMS - INFO - Update OpenStack creds informations
-    2016-02-04 13:46:25,312 - vIMS - INFO - Upload some OS images if it doesn't exist
-    2016-02-04 13:46:25,566 - vIMS - INFO - centos_7 image doesn't exist on glance repository.
-                                Try downloading this image and upload on glance !
-    2016-02-04 13:47:06,167 - vIMS - INFO - ubuntu_14.04 image doesn't exist on glance repository.
-                                Try downloading this image and upload on glance !
-    2016-02-04 13:47:26,987 - vIMS - INFO - Update security group quota for this tenant
-    2016-02-04 13:47:27,193 - vIMS - INFO - Update cinder quota for this tenant
-    2016-02-04 13:47:27,746 - vIMS - INFO - Collect flavor id for cloudify manager server
-    2016-02-04 13:47:28,326 - vIMS - INFO - Prepare virtualenv for cloudify-cli
-    2016-02-04 13:48:00,657 - vIMS - INFO - Downloading the cloudify manager server blueprint
-    2016-02-04 13:48:03,391 - vIMS - INFO - Cloudify deployment Start Time:'2016-02-04 13:48:03'
-    2016-02-04 13:48:03,391 - vIMS - INFO - Writing the inputs file
-    2016-02-04 13:48:03,395 - vIMS - INFO - Launching the cloudify-manager deployment
-    2016-02-04 13:56:03,501 - vIMS - INFO - Cloudify-manager server is UP !
-    2016-02-04 13:56:03,502 - vIMS - INFO - Cloudify deployment duration:'480.1'
-    2016-02-04 13:56:03,502 - vIMS - INFO - Collect flavor id for all clearwater vm
-    2016-02-04 13:56:04,093 - vIMS - INFO - vIMS VNF deployment Start Time:'2016-02-04 13:56:04'
-    2016-02-04 13:56:04,093 - vIMS - INFO - Downloading the openstack-blueprint.yaml blueprint
-    2016-02-04 13:56:06,265 - vIMS - INFO - Writing the inputs file
-    2016-02-04 13:56:06,268 - vIMS - INFO - Launching the clearwater deployment
-    2016-02-04 14:11:27,101 - vIMS - INFO - The deployment of clearwater-opnfv is ended
-    2016-02-04 14:11:27,103 - vIMS - INFO - vIMS VNF deployment duration:'923.0'
-    2016-02-04 14:14:31,976 - vIMS - INFO - vIMS functional test Start Time:'2016-02-04 14:14:31'
-    2016-02-04 14:15:45,880 - vIMS - INFO - vIMS functional test duration:'73.9'
-    2016-02-04 14:15:46,113 - vIMS - INFO - Launching the clearwater-opnfv undeployment
-    2016-02-04 14:18:12,604 - vIMS - INFO - Launching the cloudify-manager undeployment
-    2016-02-04 14:18:51,808 - vIMS - INFO - Cloudify-manager server has been successfully removed!
-    2016-02-04 14:18:51,870 - vIMS - INFO - Removing vIMS tenant ..
-    2016-02-04 14:18:52,131 - vIMS - INFO - Removing vIMS user ..
-
-Please note that vIMS traces can bee summarized in several steps:
-
- * INFO: environment prepared successfully => environment OK
- * INFO - Cloudify-manager server is UP ! => orchestrator deployed
- * INFO - The deployment of clearwater-opnfv is ended => VNF deployed
- * Multiple Identities (UDP) - (6505550771, 6505550675) Passed => tests run
-
-
-Promise
-^^^^^^^
+Test results
+============
 
-The results can be observed in the console::
-
-    Running test case: promise
-    ----------------------------------------------
-    FUNCTEST.info: Running PROMISE test case...
-    2016-02-04 07:10:37,735 - Promise- INFO - Creating tenant 'promise'...
-    2016-02-04 07:10:37,893 - Promise- INFO - Adding role '59828986a9a94dfaa852548599fde628' to tenant 'promise'...
-    2016-02-04 07:10:38,005 - Promise- INFO - Creating user 'promiser'...
-    2016-02-04 07:10:38,128 - Promise- INFO - Updating OpenStack credentials...
-    2016-02-04 07:10:38,157 - Promise- INFO - Creating image 'promise-img' from '/home/opnfv/functest/data/cirros-0.3.4-x86_64-disk.img'...
-    2016-02-04 07:10:42,016 - Promise- INFO - Creating flavor 'promise-flavor'...
-    2016-02-04 07:10:42,836 - Promise- INFO - Exporting environment variables...
-    2016-02-04 07:10:42,836 - Promise- INFO - Running command: DEBUG=1 npm run -s test -- --reporter json
-    2016-02-04 07:10:51,505 - Promise- INFO - The test succeeded.
-    ....
-    **********************************
-        Promise test summary
-    **********************************
-    Test start: Thu Feb 04 07:10:42 UTC 2016
-    Test end: Thu Feb 04 07:10:51 UTC 2016
-    Execution time: 8.7
-    Total tests executed: 33
-    Total tests failed: 0
-    **********************************
+Manual testing
+--------------
+
+In manual mode test results are displayed in the console and result files
+are put in /home/opnfv/functest/results.
+
+Automated testing
+--------------
+
+In automated mode, test results are displayed in jenkins logs, a summary is provided
+at the end of the job and can be described as follow::
+
+ +==================================================================================================================================================+
+ |                                                                FUNCTEST REPORT                                                                   |
+ +==================================================================================================================================================+
+ |                                                                                                                                                  |
+ |  Deployment description:                                                                                                                         |
+ |    INSTALLER: fuel                                                                                                                               |
+ |    SCENARIO:  os-odl_l2-nofeature-ha                                                                                                             |
+ |    BUILD TAG: jenkins-functest-fuel-baremetal-daily-master-324                                                                                   |
+ |    CI LOOP:   daily                                                                                                                              |
+ |                                                                                                                                                  |
+ +=========================+===============+============+===============+===========================================================================+
+ | TEST CASE               | TIER          | DURATION   | RESULT        | URL                                                                       |
+ +=========================+===============+============+===============+===========================================================================+
+ | healthcheck             | healthcheck   | 03:07      | PASS          |                                                                           |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+ | vping_ssh               | smoke         | 00:56      | PASS          | http://testresults.opnfv.org/test/api/v1/results/57ac13d79377c54b278bd4c1 |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+ | vping_userdata          | smoke         | 00:41      | PASS          | http://testresults.opnfv.org/test/api/v1/results/57ac14019377c54b278bd4c2 |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+ | tempest_smoke_serial    | smoke         | 16:05      | FAIL          | http://testresults.opnfv.org/test/api/v1/results/57ac17ca9377c54b278bd4c3 |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+ | rally_sanity            | smoke         | 12:19      | PASS          | http://testresults.opnfv.org/test/api/v1/results/57ac1aad9377c54b278bd4cd |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+ | odl                     | sdn_suites    | 00:24      | PASS          | http://testresults.opnfv.org/test/api/v1/results/57ac1ad09377c54b278bd4ce |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+ | promise                 | features      | 00:41      | PASS          | http://testresults.opnfv.org/test/api/v1/results/57ac1ae59377c54b278bd4cf |
+ +-------------------------+---------------+------------+---------------+---------------------------------------------------------------------------+
+
+Results are automatically pushed to the test results database, some additional
+result files are pushed to OPNFV artifact web sites.
+
+Based on the results stored in the result database, a `Functest reporting`_
+portal is also automatically updated. This portal provides information on:
+
+ * The overall status per scenario and per installer
+ * Tempest: Tempest test case including reported errors per scenario and installer
+ * vIMS: vIMS details per scenario and installer
+
+.. figure:: ../images/functest-reporting-status.png
+   :align: center
+   :alt: Functest reporting portal Fuel status page
 
 
 Test Dashboard
 ==============
 
 Based on results collected in CI, a test dashboard is dynamically generated.
-The URL of this dashboard is TODO LF
-
-
-Troubleshooting
-===============
-
-VIM
----
-
-vPing
-^^^^^
-
-vPing should work on all the scenarios. In case of timeout, check your network
-connectivity. The test case creates its own security group to allow SSH access,
-check your network settings and your security rules.
-
-
-vPing_userdata
-^^^^^^^^^^^^^^
 
-Cloud-init in not supported on scenario dealing with ONOS.
 
-Tempest
-^^^^^^^
-
-In the upstream OpenStack CI all the Tempest test cases are supposed to pass.
-If some test cases fail in an OPNFV deployment, the reason is very probably one
-of the following::
-
- +-----------------------------+------------------------------------------------+
- | Error                       | Details                                        |
- +=============================+================================================+
- | Resources required for test | Such resources could be e.g. an external       |
- | case execution are missing  | network and access to the management subnet    |
- |                             | (adminURL) from the Functest docker container. |
- +-----------------------------+------------------------------------------------+
- | OpenStack components or     | Check running services in the controller and   |
- | services are missing or not | compute nodes (e.g. with "systemctl" or        |
- | configured properly         | "service" commands). Configuration parameters  |
- |                             | can be verified from related .conf files       |
- |                             | located under /etc/<component> directories.    |
- +-----------------------------+------------------------------------------------+
- | Some resources required for | The tempest.conf file, automatically generated |
- | execution test cases are    | by Rally in Functest, does not contain all the |
- | missing                     | needed parameters or some parameters are not   |
- |                             | set properly.                                  |
- |                             | The tempest.conf file is located in /home/opnfv|
- |                             | /.rally/tempest/for-deployment-<UUID> in       |
- |                             | Functest container                             |
- |                             | Use "rally deployment list" command in order to|
- |                             | check UUID of current deployment.              |
- +-----------------------------+------------------------------------------------+
-
-
-When some Tempest test case fails, captured traceback and possibly also related
-REST API requests/responses are output to the console.
-More detailed debug information can be found from tempest.log file stored into
-related Rally deployment folder.
-
-
-Rally
-^^^^^
-
-Same error causes than for Tempest mentioned above may lead to error in Rally.
-
-Controllers
------------
-
-ODL
-^^^
-2 versions are supported in Brahmaputra depending on the scenario:
- * Lithium
- * Berylium
-
-The upstream test suites have not been adapted, so you may get 18 or 15 tests
-passed on 18 depending on your configuration. The 3 testcases are partly failed
-due to wrong return code.
-
-ONOS
-^^^^
-
-TODO
-
-OpenContrail
-^^^^^^^^^^^^
-
-
-Feature
--------
-
-vIMS
-^^^^
-vIMS deployment may fail for several reasons, the most frequent ones are
-described in the following table:
-
-+===================================+====================================+
-| Error                             |  Comments                          |
-+-----------------------------------+------------------------------------+
-| Keystone admin API  not reachable | Impossible to create vIMS user and |
-|                                   | tenant                             |
-+-----------------------------------+------------------------------------+
-| Impossible to retrieve admin role | Impossible to create vIMS user and |
-| id                                | tenant                             |
-+-----------------------------------+------------------------------------+
-| Error when uploading image from   | impossible to deploy VNF           |
-| OpenStack to glance               |                                    |
-+-----------------------------------+------------------------------------+
-| Cinder quota cannot be updated    | Default quotas not sufficient, they|
-|                                   | are adapted in the script          |
-+-----------------------------------+------------------------------------+
-| Impossible to create a volume     | VNF cannot be deployed             |
-+-----------------------------------+------------------------------------+
-| SSH connection issue between the  | if vPing test fails, vIMS test will|
-| Test container and the VM         | fail...                            |
-+-----------------------------------+------------------------------------+
-| No Internet access from a VM      | the VMs of the VNF must have an    |
-|                                   | external access to Internet        |
-+-----------------------------------+------------------------------------+
-
-
-Promise
-^^^^^^^
+.. include:: ./troubleshooting.rst
 
-TODO
 
 References
 ==========
 
-.. _`[1]`: Functest configuration guide URL
+.. _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/#
 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
-.. _`[6]`: https://wiki.opnfv.org/opnfv_test_dashboard
-.. _`[7]`: http://testresults.opnfv.org/testapi/test_projects/functest/cases
-.. _`[8]`: https://wiki.openstack.org/wiki/Governance/DefCoreCommittee
+.. _`[6]`: https://scap.nist.gov/
+.. _`[7]`: https://github.com/OpenSCAP/openscap
 .. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml
-.. _`[10]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/rally_cert/task.yaml
 .. _`[11]`: http://robotframework.org/
+.. _`[12]`: http://artifacts.opnfv.org/parser/docs/userguide/index.html
 
 OPNFV main site: opnfvmain_.
 
@@ -869,3 +504,4 @@ IRC support chan: #opnfv-testperf
 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml
+.. _`Functest reporting`: http://testresults.opnfv.org/reporting/functest/release/master/index-status-fuel.html