1 .. SPDX-License-Identifier: CC-BY-4.0
3 The different test cases are described in the remaining sections of this
6 VIM (Virtualized Infrastructure Manager)
7 ----------------------------------------
11 Since Danube, healthcheck tests have been refactored and rely on SNAPS, an
12 OPNFV middleware project.
14 SNAPS stands for "SDN/NFV Application development Platform and Stack".
15 SNAPS is an object-oriented OpenStack library packaged with tests that exercise
17 More information on SNAPS can be found in `[13]`_
19 Three tests are declared as healthcheck tests and can be used for gating by the
20 installer, they cover functionally the tests previously done by healthcheck
28 * *snaps_health_check*
30 Connection_check consists in 9 test cases (test duration < 5s) checking the
31 connectivity with Glance, Keystone, Neutron, Nova and the external network.
33 Api_check verifies the retrieval of OpenStack clients: Keystone, Glance,
34 Neutron and Nova and may perform some simple queries. When the config value of
35 snaps.use_keystone is True, functest must have access to the cloud's private
36 network. This suite consists in 49 tests (test duration < 2 minutes).
38 Snaps_health_check creates a VM with a single port with an IPv4 address that
39 is assigned by DHCP and then validates the expected IP with the actual.
41 Self-obviously, successful completion of the 'healthcheck' testcase is a
42 necessary pre-requisite for the execution of all other test Tiers.
48 Given the script **ping.sh**::
51 ping -c 1 $1 2>&1 >/dev/null
53 if [ "Z$RES" = "Z0" ] ; then
60 The goal of this test is to establish an SSH connection using a floating IP
61 on the Public/External network and verify that 2 instances can talk over a
62 Private Tenant network::
65 +-------------+ +-------------+
67 | | Boot VM1 with IP1 | |
68 | +------------------->| |
70 | | Boot VM2 | Under |
71 | +------------------->| Test |
73 | | Create floating IP | |
74 | +------------------->| |
76 | | Assign floating IP | |
78 | +------------------->| |
81 | | connection to VM2 | |
82 | | through floating IP| |
83 | +------------------->| |
85 | | SCP ping.sh to VM2 | |
86 | +------------------->| |
89 | | ping.sh to VM1 | |
90 | +------------------->| |
94 | | else (timeout): | |
97 +-------------+ +-------------+
99 This test can be considered as an "Hello World" example.
100 It is the first basic use case which **must** work on any deployment.
105 This test case is similar to vPing_ssh but without the use of Floating IPs
106 and the Public/External network to transfer the ping script.
107 Instead, it uses Nova metadata service to pass it to the instance at booting
109 As vPing_ssh, it checks that 2 instances can talk to
110 each other on a Private Tenant network::
112 vPing_userdata test case
113 +-------------+ +-------------+
115 | | Boot VM1 with IP1 | |
116 | +-------------------->| |
118 | | Boot VM2 with | |
119 | | ping.sh as userdata | |
120 | | with IP1 as $1. | |
121 | +-------------------->| |
122 | Tester | | System |
123 | | VM2 executes ping.sh| Under |
124 | | (ping IP1) | Test |
125 | +-------------------->| |
128 | | console-log VM 2 | |
131 | | else (timeout) | |
134 +-------------+ +-------------+
136 When the second VM boots it will execute the script passed as userdata
137 automatically. The ping will be detected by periodically capturing the output
138 in the console-log of the second VM.
144 Tempest `[2]`_ is the reference OpenStack Integration test suite.
145 It is a set of integration tests to be run against a live OpenStack cluster.
146 Tempest has suites of tests for:
148 * OpenStack API validation
150 * Other specific tests useful in validating an OpenStack deployment
152 Functest uses Rally `[3]`_ to run the Tempest suite.
153 Rally generates automatically the Tempest configuration file **tempest.conf**.
154 Before running the actual test cases,
155 Functest creates the needed resources (user, tenant) and
156 updates the appropriate parameters into the configuration file.
158 When the Tempest suite is executed, each test duration is measured and the full
159 console output is stored to a *log* file for further analysis.
161 The Tempest testcases are distributed across three
164 * Smoke Tier - Test Case 'tempest_smoke_serial'
165 * Components Tier - Test case 'tempest_full_parallel'
166 * Neutron Trunk Port - Test case 'neutron_trunk'
167 * OpenStack interop testcases - Test case 'refstack_defcore'
168 * Testing and verifying RBAC policy enforcement - Test case 'patrole'
170 NOTE: Test case 'tempest_smoke_serial' executes a defined set of tempest smoke
171 tests with a single thread (i.e. serial mode). Test case
172 'tempest_full_parallel' executes all defined Tempest tests using several
173 concurrent threads (i.e. parallel mode). The number of threads activated
174 corresponds to the number of available logical CPUs.
176 NOTE: The 'neutron_trunk' test set allows to connect a VM to multiple VLAN
177 separated networks using a single NIC. The feature neutron trunk ports have
178 been supported by Apex, Fuel and Compass, so the tempest testcases have been
181 NOTE: Rally is also used to run Openstack Interop testcases `[9]`_, which focus
182 on testing interoperability between OpenStack clouds.
184 NOTE: Patrole is a tempest plugin for testing and verifying RBAC policy
185 enforcement. It runs Tempest-based API tests using specified RBAC roles, thus
186 allowing deployments to verify that only intended roles have access to those
187 APIs. Patrole currently offers testing for the following OpenStack services:
188 Nova, Neutron, Glance, Cinder and Keystone. Currently in functest, only neutron
189 and glance are tested.
191 The goal of the Tempest test suite is to check the basic functionalities of the
192 different OpenStack components on an OPNFV fresh installation, using the
193 corresponding REST API interfaces.
196 Rally bench test suites
197 ^^^^^^^^^^^^^^^^^^^^^^^
199 Rally `[3]`_ is a benchmarking tool that answers the question:
201 *How does OpenStack work at scale?*
203 The goal of this test suite is to benchmark all the different OpenStack modules
204 and get significant figures that could help to define Telco Cloud KPIs.
206 The OPNFV Rally scenarios are based on the collection of the actual Rally
218 A basic SLA (stop test on errors) has been implemented.
220 The Rally testcases are distributed across two Tiers:
222 * Smoke Tier - Test Case 'rally_sanity'
223 * Components Tier - Test case 'rally_full'
225 NOTE: Test case 'rally_sanity' executes a limited number of Rally smoke test
226 cases. Test case 'rally_full' executes the full defined set of Rally tests.
232 This test case contains tests that setup and destroy environments with VMs with
233 and without Floating IPs with a newly created user and project. Set the config
234 value snaps.use_floating_ips (True|False) to toggle this functionality.
235 Please note that When the configuration value of snaps.use_keystone is True,
236 Functest must have access the cloud's private network.
237 This suite consists in 120 tests (test duration ~= 50 minutes)
246 The OpenDaylight (ODL) test suite consists of a set of basic tests inherited
247 from the ODL project using the Robot `[11]`_ framework.
248 The suite verifies creation and deletion of networks, subnets and ports with
249 OpenDaylight and Neutron.
251 The list of tests can be described as follows:
253 * Basic Restconf test cases
255 * Connect to Restconf URL
256 * Check the HTTP code status
258 * Neutron Reachability test cases
260 * Get the complete list of neutron resources (networks, subnets, ports)
262 * Neutron Network test cases
264 * Check OpenStack networks
265 * Check OpenDaylight networks
266 * Create a new network via OpenStack and check the HTTP status code returned
268 * Check that the network has also been successfully created in OpenDaylight
270 * Neutron Subnet test cases
272 * Check OpenStack subnets
273 * Check OpenDaylight subnets
274 * Create a new subnet via OpenStack and check the HTTP status code returned
276 * Check that the subnet has also been successfully created in OpenDaylight
278 * Neutron Port test cases
280 * Check OpenStack Neutron for known ports
281 * Check OpenDaylight ports
282 * Create a new port via OpenStack and check the HTTP status code returned by
284 * Check that the new port has also been successfully created in OpenDaylight
288 * Delete the port previously created via OpenStack
289 * Check that the port has been also successfully deleted in OpenDaylight
290 * Delete previously subnet created via OpenStack
291 * Check that the subnet has also been successfully deleted in OpenDaylight
292 * Delete the network created via OpenStack
293 * Check that the network has also been successfully deleted in OpenDaylight
295 Note: the checks in OpenDaylight are based on the returned HTTP status
296 code returned by OpenDaylight.
302 Functest has been supporting several feature projects since Brahmaputra:
305 +-----------------+---------+----------+--------+-----------+-----------+
306 | Test | Brahma | Colorado | Danube | Euphrates | Fraser |
307 +=================+=========+==========+========+===========+===========+
308 | barometer | | | X | X | X |
309 +-----------------+---------+----------+--------+-----------+-----------+
310 | bgpvpn | | X | X | X | X |
311 +-----------------+---------+----------+--------+-----------+-----------+
312 | copper | | X | | | |
313 +-----------------+---------+----------+--------+-----------+-----------+
314 | doctor | X | X | X | X | X |
315 +-----------------+---------+----------+--------+-----------+-----------+
316 | domino | | X | X | X | |
317 +-----------------+---------+----------+--------+-----------+-----------+
318 | fds | | | X | X | X |
319 +-----------------+---------+----------+--------+-----------+-----------+
321 +-----------------+---------+----------+--------+-----------+-----------+
322 | multisite | | X | X | | |
323 +-----------------+---------+----------+--------+-----------+-----------+
324 | netready | | | X | | |
325 +-----------------+---------+----------+--------+-----------+-----------+
326 | odl_sfc | | X | X | X | X |
327 +-----------------+---------+----------+--------+-----------+-----------+
328 | opera | | | X | | |
329 +-----------------+---------+----------+--------+-----------+-----------+
330 | orchestra | | | X | X | X |
331 +-----------------+---------+----------+--------+-----------+-----------+
332 | parser | | | X | X | X |
333 +-----------------+---------+----------+--------+-----------+-----------+
334 | promise | X | X | X | X | X |
335 +-----------------+---------+----------+--------+-----------+-----------+
336 | security_scan | | X | X | | |
337 +-----------------+---------+----------+--------+-----------+-----------+
338 | clover | | | | | X |
339 +-----------------+---------+----------+--------+-----------+-----------+
340 | stor4nfv | | | | | X |
341 +-----------------+---------+----------+--------+-----------+-----------+
343 Please refer to the dedicated feature user guides for details.
352 The IP Multimedia Subsystem or IP Multimedia Core Network Subsystem (IMS) is an
353 architectural framework for delivering IP multimedia services.
355 vIMS has been integrated in Functest to demonstrate the capability to deploy a
356 relatively complex NFV scenario on the OPNFV platform. The deployment of a
357 complete functional VNF allows the test of most of the essential functions
358 needed for a NFV platform.
360 The goal of this test suite consists of:
362 * deploy a VNF orchestrator (Cloudify)
363 * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this
364 orchestrator based on a TOSCA blueprint defined in `[5]`_
365 * run suite of signaling tests on top of this VNF
367 The Clearwater architecture is described as follows:
369 .. figure:: ../../../images/clearwater-architecture-v2.png
371 :alt: vIMS architecture
376 This test case deals with the deployment and the test of vyos vrouter with
377 Cloudify orchestrator. The test case can do testing for interchangeability of
378 BGP Protocol using vyos.
380 The Workflow is as follows:
382 Deploy VNF Testing topology by Cloudify using blueprint.
384 Setting configuration to Target VNF and reference VNF using ssh
386 Execution of test command for test item written YAML format file.
387 Check VNF status and behavior.
389 Output of report based on result using JSON format.
391 The vyos-vrouter architecture is described in `[14]`_
395 The Evolved Packet Core (EPC) is the main component of the System Architecture
396 Evolution (SAE) which forms the core of the 3GPP LTE specification.
398 vEPC has been integrated in Functest to demonstrate the capability to deploy a
399 complex mobility-specific NFV scenario on the OPNFV platform. The OAI EPC
400 supports most of the essential functions defined by the 3GPP Technical Specs;
401 hence the successful execution of functional tests on the OAI EPC provides a
402 good endorsement of the underlying NFV platform.
404 This integration also includes ABot, a Test Orchestration system that enables
405 test scenarios to be defined in high-level DSL. ABot is also deployed as a
406 VM on the OPNFV platform; and this provides an example of the automation
407 driver and the Test VNF being both deployed as separate VNFs on the underlying
410 The Workflow is as follows:
411 * Deploy Orchestrator
412 Deploy Juju controller using Bootstrap command.
414 Deploy ABot orchestrator and OAI EPC as Juju charms.
415 Configuration of ABot and OAI EPC components is handled through
416 built-in Juju relations.
418 Execution of ABot feature files triggered by Juju actions.
419 This executes a suite of LTE signalling tests on the OAI EPC.
421 ABot test results are parsed accordingly and pushed to Functest Db.
423 Details of the ABot test orchestration tool may be found in `[15]`_
428 Kubernetes testing relies on sets of tests, which are part of the Kubernetes
429 source tree, such as the Kubernetes End-to-End (e2e) tests `[16]`_.
431 The kubernetes testcases are distributed across various Tiers:
435 * k8s_smoke Test Case: Creates a Guestbook application that contains redis
436 server, 2 instances of redis slave, frontend application, frontend service
437 and redis master service and redis slave service. Using frontend service,
438 the test will write an entry into the guestbook application which will
439 store the entry into the backend redis database. Application flow MUST
440 work as expected and the data written MUST be available to read.
444 * k8s_conformance Test Case: Runs a series of k8s e2e tests expected to
445 pass on any Kubernetes cluster. It is a subset of tests necessary to
446 demonstrate conformance grows with each release. Conformance is thus
447 considered versioned, with backwards compatibility guarantees and are
448 designed to be run with no cloud provider configured.
451 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
452 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
453 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
454 .. _`[8]`: https://github.com/openstack/refstack-client
455 .. _`[9]`: https://github.com/openstack/defcore
456 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
457 .. _`[11]`: http://robotframework.org/
458 .. _`[12]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
459 .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO
460 .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter
461 .. _`[15]`: https://www.rebaca.com/abot-test-orchestration-tool/
462 .. _`[16]`: https://github.com/kubernetes/community/blob/master/contributors/devel/e2e-tests.md