Merge "Add result overview and onos-nosdn-ha scenario reults"

1 files changed, 74 insertions, 2 deletions

diff --git a/docs/results/overview.rst b/docs/results/overview.rst
index bd8493667..9a9b68d32 100644
--- a/docs/results/overview.rst
+++ b/docs/results/overview.rst
@@ -4,9 +4,81 @@
 FuncTest test result document overview
 ======================================
 
-Provide an overview of the document and functest here in regard to the results listed
+Functest project is described in `Functest user guide`_.
+The user guide details the different test cases as well as the possible errors.
+A `developer guide`_ and a `configuration guide`_ are also available.
+
+Functest is run systematically at the end of an OPNFV fresh installation.
+All the runnable tests are run sequentially. The installer and the scenario are
+considered to evaluate whether the test case can be run or not. That is why all
+the number of test cases may vary from 1 installer to another and from 1
+scenario to another.
+
+The list of scenario supported by installer can be described as follows::
+
+ +================+=========+=========+=========+=========+
+ |    Scenario    |  Apex   | Compass |  Fuel   |   Joid  |
+ +================+=========+=========+=========+=========+
+ |   odl_l2       |    X    |    X    |    X    |     X   |
+ +----------------+---------+---------+---------+---------+
+ |   odl_l3       |    X    |         |    X    |         |
+ +----------------+---------+---------+---------+---------+
+ |   onos         |    X    |    X    |    X    |     X   |
+ +----------------+---------+---------+---------+---------+
+ |   nosdn        |         |    X    |    X    |     X   |
+ +----------------+---------+---------+---------+---------+
+ |   odl_l2-sfc   |    X    |         |         |         |
+ +----------------+---------+---------+---------+---------+
+ |  odl_l2-bgpvpn |         |         |    X    |         |
+ +----------------+---------+---------+---------+---------+
+ |   ovs (dpdk)   |         |         |    X    |         |
+ +----------------+---------+---------+---------+---------+
+
+The matrix below details the Functest runnable tests versus the installer and
+the scenario::
+
+ +================+=============+=============+=============+=============+
+ |  Test cases    |    Apex     |   Compass   |    Fuel     |     Joid    |
+ +================+=============+=============+=============+=============+
+ |   vPing        |all scenario |     all     |     all     |     all     |
+ +----------------+-------------+-------------+-------------+-------------+
+ | vPing userdata | all except  | all except  | all except  | all except  |
+ |                |   ONOS      |    ONOS     |    ONOS     |    ONOS     |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   Tempest      |     all     |     all     |     all     |     all     |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   Rally        |     all     |     all     |     all     |     all     |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   ODL          |    all ODL  |  all ODL    |  all ODL    |  all ODL    |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   ONOS         |    ONOS     |    ONOS     |  ONOS       |     ONOS    |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   Promise      |     no      |     no      |    all      |   all       |
+ +----------------+-------------+-------------+-------------+-------------+
+ |     vIMS       | all except  | all except  | all except  | all except  |
+ |                |   ONOS      |    ONOS     |    ONOS     |    ONOS     |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   Doctor       |     all     |     no      |    no       |   no        |
+ +----------------+-------------+-------------+-------------+-------------+
+ |   SDNVPN       |     no      |     no      |   bgpvpn    |   no        |
+ +----------------+-------------+-------------+-------------+-------------+
+
+Functest results from continuous integration can be found in:
+ * jenkins logs: https://build.opnfv.org/ci/view/functest/
+ * artifacts http://artifacts.opnfv.org/, it includes the tempest logs and the
+ Rally html pages
 
 Additional test result assests and information
 ==============================================
 
-Provide links to dashboards and other useful information for readers and those wnating to get involved.
+The Functest deals with 2 dashboards:
+ * The `Test Dashboard`_ provides an overview of all the projects
+ * The  `Functest Dashboard`_ dedicated to Functest real-time test results
+
+    * is used to provide a quick overview of the different testcases according to installer and scenario.
+
+.. _`Test Dashboard`: https://www.opnfv.org/opnfvtestgraphs/per-test-projects/default
+.. _`Functest Dashboard`: https://testresults.opnfv.org/dashboard/
+.. _`Functest user guide`: artifacts.opnfv.org/functest/docs/userguide/index.html
+.. _`developer guide`: artifacts.opnfv.org/functest/docs/devguide/index.html
+.. _`configuration guide`: artifacts.opnfv.org/functest/docs/configguide/index.html