Renaming the description text to include in composite docs.
[functest.git] / docs / results / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 FuncTest test result document overview
5 ======================================
6
7 Functest project is described in `Functest user guide`_.
8 The user guide details the different test cases as well as the possible errors.
9 A `developer guide`_ and a `configuration guide`_ are also available.
10
11 Functest is run systematically at the end of an OPNFV fresh installation.
12 All the runnable tests are run sequentially. The installer and the scenario are
13 considered to evaluate whether the test case can be run or not. That is why all
14 the number of test cases may vary from 1 installer to another and from 1
15 scenario to another.
16
17 The list of scenario supported by installer can be described as follows::
18
19  +================+=========+=========+=========+=========+
20  |    Scenario    |  Apex   | Compass |  Fuel   |   Joid  |
21  +================+=========+=========+=========+=========+
22  |   odl_l2       |    X    |    X    |    X    |     X   |
23  +----------------+---------+---------+---------+---------+
24  |   odl_l3       |    X    |         |    X    |         |
25  +----------------+---------+---------+---------+---------+
26  |   onos         |    X    |    X    |    X    |     X   |
27  +----------------+---------+---------+---------+---------+
28  |   nosdn        |         |    X    |    X    |     X   |
29  +----------------+---------+---------+---------+---------+
30  |   odl_l2-sfc   |    X    |         |         |         |
31  +----------------+---------+---------+---------+---------+
32  |  odl_l2-bgpvpn |         |         |    X    |         |
33  +----------------+---------+---------+---------+---------+
34  |   ovs (dpdk)   |         |         |    X    |         |
35  +----------------+---------+---------+---------+---------+
36
37 The matrix below details the Functest runnable tests versus the installer and
38 the scenario::
39
40  +================+=============+=============+=============+=============+
41  |  Test cases    |    Apex     |   Compass   |    Fuel     |     Joid    |
42  +================+=============+=============+=============+=============+
43  |   vPing        |all scenario |     all     |     all     |     all     |
44  +----------------+-------------+-------------+-------------+-------------+
45  | vPing userdata | all except  | all except  | all except  | all except  |
46  |                |   ONOS      |    ONOS     |    ONOS     |    ONOS     |
47  +----------------+-------------+-------------+-------------+-------------+
48  |   Tempest      |     all     |     all     |     all     |     all     |
49  +----------------+-------------+-------------+-------------+-------------+
50  |   Rally        |     all     |     all     |     all     |     all     |
51  +----------------+-------------+-------------+-------------+-------------+
52  |   ODL          |    all ODL  |  all ODL    |  all ODL    |  all ODL    |
53  +----------------+-------------+-------------+-------------+-------------+
54  |   ONOS         |    ONOS     |    ONOS     |  ONOS       |     ONOS    |
55  +----------------+-------------+-------------+-------------+-------------+
56  |   Promise      |     no      |     no      |    all      |   all       |
57  +----------------+-------------+-------------+-------------+-------------+
58  |     vIMS       | all except  | all except  | all except  | all except  |
59  |                |   ONOS      |    ONOS     |    ONOS     |    ONOS     |
60  +----------------+-------------+-------------+-------------+-------------+
61  |   Doctor       |     all     |     no      |    no       |   no        |
62  +----------------+-------------+-------------+-------------+-------------+
63  |   SDNVPN       |     no      |     no      |   bgpvpn    |   no        |
64  +----------------+-------------+-------------+-------------+-------------+
65
66 Functest results from continuous integration can be found in:
67  * jenkins logs: https://build.opnfv.org/ci/view/functest/
68  * artifacts http://artifacts.opnfv.org/, it includes the tempest logs and the
69  Rally html pages
70
71 Additional test result assests and information
72 ==============================================
73
74 The Functest deals with 2 dashboards:
75  * The `Test Dashboard`_ provides an overview of all the projects
76  * The  `Functest Dashboard`_ dedicated to Functest real-time test results
77
78     * is used to provide a quick overview of the different testcases according to installer and scenario.
79
80 .. _`Test Dashboard`: https://www.opnfv.org/opnfvtestgraphs/per-test-projects/default
81 .. _`Functest Dashboard`: https://testresults.opnfv.org/dashboard/
82 .. _`Functest user guide`: artifacts.opnfv.org/functest/docs/userguide/index.html
83 .. _`developer guide`: artifacts.opnfv.org/functest/docs/devguide/index.html
84 .. _`configuration guide`: artifacts.opnfv.org/functest/docs/configguide/index.html