1 .. SPDX-License-Identifier: CC-BY-4.0
3 Overview of the Functest suites
4 ===============================
6 Functest is the OPNFV project primarily targeting functional testing.
7 In the Continuous Integration pipeline, it is launched after an OPNFV fresh
8 installation to validate and verify the basic functions of the
11 The current list of test suites can be distributed over 4 main domains:
12 * VIM (Virtualised Infrastructure Manager)
13 * Controllers (i.e. SDN Controllers)
15 * VNF (Virtual Network Functions)
17 Functest test suites are also distributed in the OPNFV testing categories:
18 healthcheck, smoke, features, components, performance, VNF, Stress tests.
20 All the Healthcheck and smoke tests of a given scenario must be succesful to
21 validate the scenario for the release.
23 +-------------+---------------+------------+----------------------------------+
24 | Domain | Tier | Test case | Comments |
25 +=============+===============+============+==================================+
26 | VIM | healthcheck | connection | Check OpenStack connectivity |
27 | | | \_check | through SNAPS framework |
28 | | +------------+----------------------------------+
29 | | | api_check | Check OpenStack API through |
30 | | | | SNAPS framework |
31 | | +------------+----------------------------------+
32 | | | snaps | basic instance creation, check |
33 | | | \_health | DHCP |
35 | +---------------+------------+----------------------------------+
36 | | smoke | vping_ssh | NFV "Hello World" using an SSH |
37 | | | | connection to a destination VM |
38 | | | | over a created floating IP |
39 | | | | address on the SUT Public / |
40 | | | | External network. Using the SSH |
41 | | | | connection a test script is then |
42 | | | | copied to the destination |
43 | | | | VM and then executed via SSH. |
44 | | | | The script will ping another |
45 | | | | VM on a specified IP address over|
46 | | | | the SUT Private Tenant network |
47 | | +------------+----------------------------------+
48 | | | vping | Uses Ping with given userdata |
49 | | | \_userdata | to test intra-VM connectivity |
50 | | | | over the SUT Private Tenant |
51 | | | | network. The correct operation |
52 | | | | of the NOVA Metadata service is |
53 | | | | also verified in this test |
54 | | +------------+----------------------------------+
55 | | | tempest | Generate and run a relevant |
56 | | | \_smoke | Tempest Test Suite in smoke mode.|
57 | | | \_serial | The generated test set is |
58 | | | | dependent on the OpenStack |
59 | | | | deployment environment |
60 | | +------------+----------------------------------+
61 | | | rally | Run a subset of the OpenStack |
62 | | | \_sanity | Rally Test Suite in smoke mode |
63 | | +------------+----------------------------------+
64 | | | snaps\ | Run the SNAPS-OO integration |
65 | | | \_smoke | tests |
66 | | +------------+----------------------------------+
67 | | | refstack | Reference RefStack suite |
68 | | | \_defcore | tempest selection for NFV |
69 | | +------------+----------------------------------+
70 | | | patrole | Patrole is a tempest plugin for |
71 | | | | testing and verifying RBAC policy|
72 | | | | enforcement, which offers testing|
73 | | | | for the following OpenStack |
74 | | | | services: Nova, Neutron, Glance, |
75 | | | | Cinder and Keystone |
76 | +---------------+------------+----------------------------------+
77 | | | neutron | The neutron trunk port testcases |
78 | | | \_trunk | have been introduced and they are|
79 | | | | supported by installers : |
80 | | | | Apex, Fuel and Compass. |
81 | +---------------+------------+----------------------------------+
82 | | components | tempest | Generate and run a full set of |
83 | | | \_full | the OpenStack Tempest Test Suite.|
84 | | | \_parallel | See the OpenStack reference test |
85 | | | | suite `[2]`_. The generated |
86 | | | | test set is dependent on the |
87 | | | | OpenStack deployment environment |
88 | | +------------+----------------------------------+
89 | | | rally_full | Run the OpenStack testing tool |
90 | | | | benchmarking OpenStack modules |
91 | | | | See the Rally documents `[3]`_ |
92 +-------------+---------------+------------+----------------------------------+
93 | Controllers | smoke | odl | Opendaylight Test suite |
94 | | | | Limited test suite to check the |
95 | | | | basic neutron (Layer 2) |
96 | | | | operations mainly based on |
97 | | | | upstream testcases. See below |
99 +-------------+---------------+------------+----------------------------------+
100 | Features | features | bgpvpn | Implementation of the OpenStack |
101 | | | | bgpvpn API from the SDNVPN |
102 | | | | feature project. It allows for |
103 | | | | the creation of BGP VPNs. |
104 | | | | See `SDNVPN User Guide`_ for |
106 | | +------------+----------------------------------+
107 | | | doctor | Doctor platform, as of Colorado |
108 | | | | release, provides the three |
110 | | | | * Immediate Notification |
111 | | | | * Consistent resource state |
112 | | | | awareness for compute host down |
113 | | | | * Valid compute host status |
114 | | | | given to VM owner |
115 | | | | See `Doctor User Guide`_ for |
117 | | +------------+----------------------------------+
118 | | | odl-sfc | SFC testing for odl scenarios |
119 | | | | See `SFC User Guide`_ for details|
120 | | +------------+----------------------------------+
121 | | | parser | Parser is an integration project |
122 | | | | which aims to provide |
123 | | | | placement/deployment templates |
124 | | | | translation for OPNFV platform, |
125 | | | | including TOSCA -> HOT, POLICY ->|
126 | | | | TOSCA and YANG -> TOSCA. it |
127 | | | | deals with a fake vRNC. |
128 | | | | See `Parser User Guide`_ for |
130 | | +------------+----------------------------------+
131 | | | fds | Test Suite for the OpenDaylight |
132 | | | | SDN Controller when the GBP |
133 | | | | features are installed. It |
134 | | | | integrates some test suites from |
135 | | | | upstream using Robot as the test |
137 +-------------+---------------+------------+----------------------------------+
138 | VNF | vnf | cloudify | Example of a real VNF deployment |
139 | | | \_ims | to show the NFV capabilities of |
140 | | | | the platform. The IP Multimedia |
141 | | | | Subsytem is a typical Telco test |
142 | | | | case, referenced by ETSI. |
143 | | | | It provides a fully functional |
144 | | | | VoIP System |
145 | | +------------+----------------------------------+
146 | | | vyos | vRouter testing |
148 | | +------------+----------------------------------+
149 | | | juju_epc | vEPC validation with Juju as VNF |
150 | | | | manager and ABoT as test executor|
151 | | +------------+----------------------------------+
152 | | | cloudify | Based on cloudify_ims test case |
153 | | | \_ims_perf | cloudify_ims_perf substitutes |
154 | | | | the signaling test suite by an |
155 | | | | automatic deployment of an Ixia |
156 | | | | loader and generic SIP stress |
158 | | | | This work has been initiated |
159 | | | | during the plugfest and allows |
160 | | | | realistic load tests on top of |
161 | | | | cloudify_ims. Please note that |
162 | | | | this test is available but not |
163 | | | | declared in testcases.yaml as it |
164 | | | | requires access to proprietary |
165 | | | | resources (Ixia loader) |
166 +-------------+---------------+------------+----------------------------------+
169 As shown in the above table, Functest is structured into different 'domains',
170 'tiers' and 'test cases'. Each 'test case' usually represents an actual
171 'Test Suite' comprised -in turn- of several test cases internally.
173 Test cases also have an implicit execution order. For example, if the early
174 'healthcheck' Tier testcase fails, or if there are any failures in the 'smoke'
175 Tier testcases, there is little point to launch a full testcase execution
178 In Danube, we merged smoke and sdn controller tiers in smoke tier.
180 An overview of the Functest Structural Concept is depicted graphically below:
182 .. figure:: ../../../images/concepts_mapping_final.png
184 :alt: Functest Concepts Structure
186 Some of the test cases are developed by Functest team members, whereas others
187 are integrated from upstream communities or other OPNFV projects. For example,
188 `Tempest <http://docs.openstack.org/developer/tempest/overview.html>`_ is the
189 OpenStack integration test suite and Functest is in charge of the selection,
190 integration and automation of those tests that fit suitably to OPNFV.
192 The Tempest test suite is the default OpenStack smoke test suite but no new
193 test cases have been created in OPNFV Functest.
195 The results produced by the tests run from CI are pushed and collected into a
196 NoSQL database. The goal is to populate the database with results from
197 different sources and scenarios and to show them on a `Functest Dashboard`_. A
198 screenshot of a live Functest Dashboard is shown below:
200 .. figure:: ../../../images/FunctestDashboardEuphrates.png
202 :alt: Functest Dashboard
205 Basic components (VIM, SDN controllers) are tested through their own suites.
206 Feature projects also provide their own test suites with different ways of
209 The notion of domain has been introduced in the description of the test cases
210 stored in the Database.
211 This parameters as well as possible tags can be used for the Test case catalog.
213 vIMS test case was integrated to demonstrate the capability to deploy a
214 relatively complex NFV scenario on top of the OPNFV infrastructure.
216 Functest considers OPNFV as a black box. OPNFV offers a lot of potential
217 combinations (which may change from one version to another):
219 * 3 controllers (OpenDaylight, ONOS, OpenContrail)
220 * 5 installers (Apex, Compass, Daisy, Fuel, Joid)
222 Most of the tests are runnable by any combination, but some tests might have
223 restrictions imposed by the utilized installers or due to the available
224 deployed features. The system uses the environment variables (INSTALLER_TYPE
225 and DEPLOY_SCENARIO) to automatically determine the valid test cases, for each
228 A convenience Functest CLI utility is also available to simplify setting up the
229 Functest evironment, management of the OpenStack environment (e.g. resource
230 clean-up) and for executing tests.
231 The Functest CLI organised the testcase into logical Tiers, which contain in
232 turn one or more testcases. The CLI allows execution of a single specified
233 testcase, all test cases in a specified Tier, or the special case of execution
234 of **ALL** testcases. The Functest CLI is introduced in more details in next
237 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
238 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
239 .. _`Doctor User Guide`: http://artifacts.opnfv.org/doctor/colorado/userguide/index.html
240 .. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html
241 .. _`Parser User Guide`: http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html
242 .. _`Functest Dashboard`: http://testresults.opnfv.org/kibana_dashboards/
243 .. _`SFC User Guide`: http://artifacts.opnfv.org/sfc/colorado/userguide/index.html
Code Review / functest.git / blob