1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
4 Overview of the Functest suites
5 ===============================
7 Functest is the OPNFV project primarily targeting function testing.
8 In the Continuous Integration pipeline, it is launched after an OPNFV fresh
9 installation to validate and verify the basic functions of the
12 The current list of test suites can be distributed over 4 main domains: VIM
13 (Virtualised Infrastructure Manager), Controllers (i.e. SDN Controllers),
14 Features and VNF (Virtual Network Functions).
16 +-------------+---------------+----------------+----------------------------------+
17 | Domain | Tier | Test case | Comments |
18 +=============+===============+================+==================================+
19 | VIM | healthcheck | healthcheck | Verify basic operation in VIM |
20 | +---------------+----------------+----------------------------------+
21 | | smoke | vPing_SSH | NFV "Hello World" using an SSH |
22 | | | | connection to a destination VM |
23 | | | | over a created floating IP |
24 | | | | address on the SUT Public / |
25 | | | | External network. Using the SSH |
26 | | | | connection a test script is then |
27 | | | | copied to the destination |
28 | | | | VM and then executed via SSH. |
29 | | | | The script will ping another |
30 | | | | VM on a specified IP address over|
31 | | | | the SUT Private Tenant network. |
32 | | +----------------+----------------------------------+
33 | | | vPing_userdata | Uses Ping with given userdata |
34 | | | | to test intra-VM connectivity |
35 | | | | over the SUT Private Tenant |
36 | | | | network. The correct operation |
37 | | | | of the NOVA Metadata service is |
38 | | | | also verified in this test. |
39 | | +----------------+----------------------------------+
40 | | | tempest_smoke | Generate and run a relevant |
41 | | | \_serial | Tempest Test Suite in smoke mode.|
42 | | | | The generated test set is |
43 | | | | dependent on the OpenStack |
44 | | | | deployment environment. |
45 | | +----------------+----------------------------------+
46 | | | rally_sanity | Run a subset of the OpenStack |
47 | | | | Rally Test Suite in smoke mode |
48 | +---------------+----------------+----------------------------------+
49 | | openstack | tempest_full | Generate and run a full set of |
50 | | | \_parallel | the OpenStack Tempest Test Suite.|
51 | | | | See the OpenStack reference test |
52 | | | | suite `[2]`_. The generated |
53 | | | | test set is dependent on the |
54 | | | | OpenStack deployment environment.|
55 | | +----------------+----------------------------------+
56 | | | rally_full | Run the OpenStack testing tool |
57 | | | | benchmarking OpenStack modules |
58 | | | | See the Rally documents `[3]`_. |
59 +-------------+---------------+----------------+----------------------------------+
60 | Controllers | sdn_suites | odl | Opendaylight Test suite |
61 | | | | Limited test suite to check the |
62 | | | | basic neutron (Layer 2) |
63 | | | | operations mainly based on |
64 | | | | upstream testcases. See below |
66 | | +----------------+----------------------------------+
67 | | | onos | Test suite of ONOS L2 and L3 |
69 | | | | See `ONOSFW User Guide`_ for |
71 +-------------+---------------+----------------+----------------------------------+
72 | Features | features | Promise | Resource reservation and |
73 | | | | management project to identify |
74 | | | | NFV related requirements and |
75 | | | | realize resource reservation for |
76 | | | | future usage by capacity |
77 | | | | management of resource pools |
78 | | | | regarding compute, network and |
80 | | | | See `Promise User Guide`_ for |
82 | | +----------------+----------------------------------+
83 | | | Doctor | Doctor platform, as of Colorado |
84 | | | | release, provides the two |
86 | | | | * Immediate Notification |
87 | | | | * Consistent resource state |
88 | | | | awareness (compute) |
89 | | | | * Get Valid Server state |
90 | | | | See `Doctor User Guide`_ for |
92 | | +----------------+----------------------------------+
93 | | | bgpvpn | Implementation of the OpenStack |
94 | | | | bgpvpn API from the SDNVPN |
95 | | | | feature project. It allows for |
96 | | | | the creation of BGP VPNs. |
97 | | | | See `SDNVPN User Guide`_ for |
99 | | +----------------+----------------------------------+
100 | | | security_scan | Implementation of a simple |
101 | | | | security scan. (Currently |
102 | | | | available only for the Apex |
103 | | | | installer environment) |
104 | | +----------------+----------------------------------+
105 | | | onos-sfc | SFC testing for onos scenarios |
106 | | | | TODO See for details |
107 | | +----------------+----------------------------------+
108 | | | odl-sfc | SFC testing for odl scenarios |
109 | | | | TODO See for details |
110 | | +----------------+----------------------------------+
111 | | | domino | Domino provides TOSCA template |
112 | | | | distribution service for network |
113 | | | | service and VNF descriptors |
114 | | | | among MANO components e.g., |
115 | | | | NFVO, VNFM, VIM, SDN-C, etc., |
116 | | | | as well as OSS/BSS functions. |
117 | | | | See `Domino User Guide`_ for |
119 | | +----------------+----------------------------------+
120 | | | copper | Deployment policy |
121 | | | | TODO See for details |
122 | | +----------------+----------------------------------+
123 | | | multisites | Multisites |
124 | | | | TODO See for details |
125 | | +----------------+----------------------------------+
126 | | | moon | Security management system |
127 | | | | TODO See for details |
128 +-------------+---------------+----------------+----------------------------------+
129 | VNF | vnf | vims | Example of a real VNF deployment |
130 | | | | to show the NFV capabilities of |
131 | | | | the platform. The IP Multimedia |
132 | | | | Subsytem is a typical Telco test |
133 | | | | case, referenced by ETSI. |
134 | | | | It provides a fully functional |
135 | | | | VoIP System |
136 + +---------------+----------------+----------------------------------+
137 | | | parser | Service template translation |
138 | | | | TODO See for details |
139 +-------------+---------------+----------------+----------------------------------+
142 As shown in the above table, Functest is structured into different 'domains',
143 'tiers' and 'test cases'. Each 'test case' usually represents an actual
144 'Test Suite' comprised -in turn- of several test cases internally.
146 Test cases also have an implicit execution order. For example, if the early
147 'healthcheck' Tier testcase fails, or if there are any failures in the 'smoke'
148 Tier testcases, there is little point to launch a full testcase execution round.
150 An overview of the Functest Structural Concept is depicted graphically below:
152 .. figure:: ../images/concepts_mapping_final.png
154 :alt: Functest Concepts Structure
156 Some of the test cases are developed by Functest team members, whereas others
157 are integrated from upstream communities or other OPNFV projects. For example,
158 `Tempest <http://docs.openstack.org/developer/tempest/overview.html>`_ is the
159 OpenStack integration test suite and Functest is in charge of the selection,
160 integration and automation of those tests that fit suitably to OPNFV.
162 The Tempest test suite is the default OpenStack smoke test suite but no new test
163 cases have been created in OPNFV Functest.
165 The results produced by the tests run from CI are pushed and collected into a
166 NoSQL database. The goal is to populate the database with results from different
167 sources and scenarios and to show them on a `Functest Dashboard`_. A screenshot
168 of a live Functest Dashboard is shown below:
170 .. figure:: ../images/FunctestDashboard.png
172 :alt: Functest Dashboard
175 There is no real notion of Test domain or Test coverage. Basic components
176 (VIM, SDN controllers) are tested through their own suites. Feature projects
177 also provide their own test suites with different ways of running their tests.
179 vIMS test case was integrated to demonstrate the capability to deploy a
180 relatively complex NFV scenario on top of the OPNFV infrastructure.
182 Functest considers OPNFV as a black box. As of Colorado release the OPNFV
183 offers a lot of potential combinations:
185 * 3 controllers (OpenDaylight, ONOS, OpenContrail)
186 * 4 installers (Apex, Compass, Fuel, Joid)
188 Most of the tests are runnable by any combination, but some tests might have
189 restrictions imposed by the utilized installers or due to the available
190 deployed features. The system uses the environment variables (INSTALLER_IP and
191 DEPLOY_SCENARIO) to automatically determine the valid test cases; for each given
194 In the Colorado OPNFV System release a convenience Functest CLI utility is also
195 introduced to simplify setting up the Functest evironment, management of the
196 OpenStack environment (e.g. resource clean-up) and for executing tests.
197 The Functest CLI organised the testcase into logical Tiers, which contain in
198 turn one or more testcases. The CLI allow execution of a single specified
199 testcase, all test cases in a specified Tier, or the special case of execution
200 of **ALL** testcases. The Functest CLI is introduced in more detail in the
201 section `Executing the functest suites`_ of this document.
203 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
204 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
205 .. _`Doctor User Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/featureusage-doctor.html
206 .. _`Promise User Guide`: http://artifacts.opnfv.org/promise/brahmaputra/docs/userguide/index.html
207 .. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html
208 .. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/brahmaputra/docs/userguide/featureusage.html
209 .. _`Domino User Guide`: http://artifacts.opnfv.org/domino/docs/userguide/index.html
210 .. _`Functest Dashboard`: http://testresults.opnfv.org/kibana_dashboards/
Code Review / functest.git / blob