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 three |
86 | | | | * Immediate Notification |
87 | | | | * Consistent resource state |
88 | | | | awareness for compute host down |
89 | | | | * Valid compute host status |
90 | | | | given to VM owner |
91 | | | | See `Doctor User Guide`_ for |
93 | | +----------------+----------------------------------+
94 | | | bgpvpn | Implementation of the OpenStack |
95 | | | | bgpvpn API from the SDNVPN |
96 | | | | feature project. It allows for |
97 | | | | the creation of BGP VPNs. |
98 | | | | See `SDNVPN User Guide`_ for |
100 | | +----------------+----------------------------------+
101 | | | security_scan | Implementation of a simple |
102 | | | | security scan. (Currently |
103 | | | | available only for the Apex |
104 | | | | installer environment) |
105 | | +----------------+----------------------------------+
106 | | | onos-sfc | SFC testing for onos scenarios |
107 | | | | TODO See for details |
108 | | +----------------+----------------------------------+
109 | | | odl-sfc | SFC testing for odl scenarios |
110 | | | | TODO See for details |
111 | | +----------------+----------------------------------+
112 | | | domino | Domino provides TOSCA template |
113 | | | | distribution service for network |
114 | | | | service and VNF descriptors |
115 | | | | among MANO components e.g., |
116 | | | | NFVO, VNFM, VIM, SDN-C, etc., |
117 | | | | as well as OSS/BSS functions. |
118 | | | | See `Domino User Guide`_ for |
120 | | +----------------+----------------------------------+
121 | | | copper | Deployment policy |
122 | | | | TODO See for details |
123 | | +----------------+----------------------------------+
124 | | | multisites | Multisites |
125 | | | | TODO See for details |
126 | | +----------------+----------------------------------+
127 | | | moon | Security management system |
128 | | | | TODO See for details |
129 +-------------+---------------+----------------+----------------------------------+
130 | VNF | vnf | vims | Example of a real VNF deployment |
131 | | | | to show the NFV capabilities of |
132 | | | | the platform. The IP Multimedia |
133 | | | | Subsytem is a typical Telco test |
134 | | | | case, referenced by ETSI. |
135 | | | | It provides a fully functional |
136 | | | | VoIP System |
137 + +---------------+----------------+----------------------------------+
138 | | | parser | Service template translation |
139 | | | | TODO See for details |
140 +-------------+---------------+----------------+----------------------------------+
143 As shown in the above table, Functest is structured into different 'domains',
144 'tiers' and 'test cases'. Each 'test case' usually represents an actual
145 'Test Suite' comprised -in turn- of several test cases internally.
147 Test cases also have an implicit execution order. For example, if the early
148 'healthcheck' Tier testcase fails, or if there are any failures in the 'smoke'
149 Tier testcases, there is little point to launch a full testcase execution round.
151 An overview of the Functest Structural Concept is depicted graphically below:
153 .. figure:: ../images/concepts_mapping_final.png
155 :alt: Functest Concepts Structure
157 Some of the test cases are developed by Functest team members, whereas others
158 are integrated from upstream communities or other OPNFV projects. For example,
159 `Tempest <http://docs.openstack.org/developer/tempest/overview.html>`_ is the
160 OpenStack integration test suite and Functest is in charge of the selection,
161 integration and automation of those tests that fit suitably to OPNFV.
163 The Tempest test suite is the default OpenStack smoke test suite but no new test
164 cases have been created in OPNFV Functest.
166 The results produced by the tests run from CI are pushed and collected into a
167 NoSQL database. The goal is to populate the database with results from different
168 sources and scenarios and to show them on a `Functest Dashboard`_. A screenshot
169 of a live Functest Dashboard is shown below:
171 .. figure:: ../images/FunctestDashboard.png
173 :alt: Functest Dashboard
176 There is no real notion of Test domain or Test coverage. Basic components
177 (VIM, SDN controllers) are tested through their own suites. Feature projects
178 also provide their own test suites with different ways of running their tests.
180 vIMS test case was integrated to demonstrate the capability to deploy a
181 relatively complex NFV scenario on top of the OPNFV infrastructure.
183 Functest considers OPNFV as a black box. As of Colorado release the OPNFV
184 offers a lot of potential combinations:
186 * 3 controllers (OpenDaylight, ONOS, OpenContrail)
187 * 4 installers (Apex, Compass, Fuel, Joid)
189 Most of the tests are runnable by any combination, but some tests might have
190 restrictions imposed by the utilized installers or due to the available
191 deployed features. The system uses the environment variables (INSTALLER_IP and
192 DEPLOY_SCENARIO) to automatically determine the valid test cases; for each given
195 In the Colorado OPNFV System release a convenience Functest CLI utility is also
196 introduced to simplify setting up the Functest evironment, management of the
197 OpenStack environment (e.g. resource clean-up) and for executing tests.
198 The Functest CLI organised the testcase into logical Tiers, which contain in
199 turn one or more testcases. The CLI allow execution of a single specified
200 testcase, all test cases in a specified Tier, or the special case of execution
201 of **ALL** testcases. The Functest CLI is introduced in more detail in the
202 section `Executing the functest suites`_ of this document.
204 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
205 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
206 .. _`Doctor User Guide`: http://artifacts.opnfv.org/opnfvdocs/brahmaputra/docs/userguide/featureusage-doctor.html
207 .. _`Promise User Guide`: http://artifacts.opnfv.org/promise/brahmaputra/docs/userguide/index.html
208 .. _`ONOSFW User Guide`: http://artifacts.opnfv.org/onosfw/brahmaputra/docs/userguide/index.html
209 .. _`SDNVPN User Guide`: http://artifacts.opnfv.org/sdnvpn/brahmaputra/docs/userguide/featureusage.html
210 .. _`Domino User Guide`: http://artifacts.opnfv.org/domino/docs/userguide/index.html
211 .. _`Functest Dashboard`: http://testresults.opnfv.org/kibana_dashboards/
Code Review / functest.git / blob