1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
5 The different test cases are described in the remaining sections of this document.
7 VIM (Virtualized Infrastructure Manager)
8 ----------------------------------------
12 Since Danube, healthcheck tests have been refactored and rely on SNAPS, an
13 OPNFV middleware project.
15 SNAPS stands for "SDN/NFV Application development Platform and Stack".
16 SNAPS is an object-oriented OpenStack library packaged with tests that exercise
18 More information on SNAPS can be found in `[13]`_
20 Three tests are declared as healthcheck tests and can be used for gating by the
21 installer, they cover functionally the tests previously done by healthcheck
29 * *snaps_health_check*
31 Connection_check consists in 9 test cases (test duration < 5s) checking the
32 connectivity with Glance, Keystone, Neutron, Nova and the external network.
34 Api_check verifies the retrieval of OpenStack clients: Keystone, Glance,
35 Neutron and Nova and may perform some simple queries. When the config value of
36 snaps.use_keystone is True, functest must have access to the cloud's private
37 network. This suite consists in 49 tests (test duration < 2 minutes).
39 Snaps_health_check creates a VM with a single port with an IPv4 address that
40 is assigned by DHCP and then validates the expected IP with the actual.
42 Self-obviously, successful completion of the 'healthcheck' testcase is a
43 necessary pre-requisite for the execution of all other test Tiers.
49 Given the script **ping.sh**::
52 ping -c 1 $1 2>&1 >/dev/null
54 if [ "Z$RES" = "Z0" ] ; then
61 The goal of this test is to establish an SSH connection using a floating IP
62 on the Public/External network and verify that 2 instances can talk over a Private
66 +-------------+ +-------------+
68 | | Boot VM1 with IP1 | |
69 | +------------------->| |
71 | | Boot VM2 | Under |
72 | +------------------->| Test |
74 | | Create floating IP | |
75 | +------------------->| |
77 | | Assign floating IP | |
79 | +------------------->| |
82 | | connection to VM2 | |
83 | | through floating IP| |
84 | +------------------->| |
86 | | SCP ping.sh to VM2 | |
87 | +------------------->| |
90 | | ping.sh to VM1 | |
91 | +------------------->| |
95 | | else (timeout): | |
98 +-------------+ +-------------+
100 This test can be considered as an "Hello World" example.
101 It is the first basic use case which **must** work on any deployment.
106 This test case is similar to vPing_ssh but without the use of Floating IPs
107 and the Public/External network to transfer the ping script.
108 Instead, it uses Nova metadata service to pass it to the instance at booting time.
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'
168 NOTE: Test case 'tempest_smoke_serial' executes a defined set of tempest smoke
169 tests with a single thread (i.e. serial mode). Test case 'tempest_full_parallel'
170 executes all defined Tempest tests using several concurrent threads
171 (i.e. parallel mode). The number of threads activated corresponds to the number
172 of available logical CPUs.
174 NOTE: The 'neutron_trunk' test set allows to connect a VM to multiple VLAN separated
175 networks using a single NIC. The feature neutron trunk ports have been supported
176 by Apex, Fuel and Compass, so the tempest testcases have been integrated normally.
178 The goal of the Tempest test suite is to check the basic functionalities of the
179 different OpenStack components on an OPNFV fresh installation, using the
180 corresponding REST API interfaces.
183 Rally bench test suites
184 ^^^^^^^^^^^^^^^^^^^^^^^
186 Rally `[3]`_ is a benchmarking tool that answers the question:
188 *How does OpenStack work at scale?*
190 The goal of this test suite is to benchmark all the different OpenStack modules and
191 get significant figures that could help to define Telco Cloud KPIs.
193 The OPNFV Rally scenarios are based on the collection of the actual Rally scenarios:
205 A basic SLA (stop test on errors) has been implemented.
207 The Rally testcases are distributed across two Tiers:
209 * Smoke Tier - Test Case 'rally_sanity'
210 * Components Tier - Test case 'rally_full'
212 NOTE: Test case 'rally_sanity' executes a limited number of Rally smoke test
213 cases. Test case 'rally_full' executes the full defined set of Rally tests.
216 Refstack-client to run OpenStack interop testcases
217 --------------------------------------------------
219 Refstack-client `[8]`_ is a command line utility that allows you to
220 execute Tempest test runs based on configurations you specify.
221 It is the official tool to run Openstack Interop (previously known as Defcore)
222 testcases `[9]`_, which focus on testing interoperability between OpenStack
225 Refstack-client is integrated in Functest, consumed by Dovetail, which
226 intends to define and provide a set of OPNFV related validation criteria
227 that will provide input for the evaluation of the use of OPNFV trademarks.
228 This progress is under the guideline of Compliance Verification Program(CVP).
233 Two running methods are provided after refstack-client integrated into
234 Functest, Functest command line and manually, respectively.
236 By default, for Defcore test cases run by Functest command line,
237 are run followed with automatically generated
238 configuration file, i.e., refstack_tempest.conf. In some circumstances,
239 the automatic configuration file may not quite satisfied with the SUT,
240 Functest also inherits the refstack-client command line and provides a way
241 for users to set its configuration file according to its own SUT manually.
245 Inside the Functest container, first to prepare Functest environment:
251 then to run default defcore testcases by using refstack-client:
255 functest testcase run refstack_defcore
257 In OPNFV Continuous Integration(CI) system, the command line method is used.
261 Prepare the tempest configuration file and the testcases want to run with the SUT,
262 run the testcases with:
266 ./refstack-client test -c <Path of the tempest configuration file to use> -v --test-list <Path or URL of test list>
268 using help for more information:
272 ./refstack-client --help
273 ./refstack-client test --help
275 Reference tempest configuration
276 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
278 *command line method*
280 When command line method is used, the default tempest configuration file
281 is generated by Rally.
285 When running manually is used, recommended way to generate tempest configuration
290 cd /usr/lib/python2.7/site-packages/functest/opnfv_tests/openstack/refstack_client
291 python tempest_conf.py
293 a file called tempest.conf is stored in the current path by default, users can do
294 some adjustment according to the SUT:
298 vim refstack_tempest.conf
300 a reference article can be used `[15]`_.
306 This test case contains tests that setup and destroy environments with VMs with
307 and without Floating IPs with a newly created user and project. Set the config
308 value snaps.use_floating_ips (True|False) to toggle this functionality.
309 Please note that When the configuration value of snaps.use_keystone is True, Functest must have access
310 the cloud's private network.
311 This suite consists in 38 tests (test duration < 10 minutes)
320 The OpenDaylight (ODL) test suite consists of a set of basic tests inherited
321 from the ODL project using the Robot `[11]`_ framework.
322 The suite verifies creation and deletion of networks, subnets and ports with
323 OpenDaylight and Neutron.
325 The list of tests can be described as follows:
327 * Basic Restconf test cases
328 * Connect to Restconf URL
329 * Check the HTTP code status
331 * Neutron Reachability test cases
332 * Get the complete list of neutron resources (networks, subnets, ports)
334 * Neutron Network test cases
335 * Check OpenStack networks
336 * Check OpenDaylight networks
337 * Create a new network via OpenStack and check the HTTP status code returned by Neutron
338 * Check that the network has also been successfully created in OpenDaylight
340 * Neutron Subnet test cases
341 * Check OpenStack subnets
342 * Check OpenDaylight subnets
343 * Create a new subnet via OpenStack and check the HTTP status code returned by Neutron
344 * Check that the subnet has also been successfully created in OpenDaylight
346 * Neutron Port test cases
347 * Check OpenStack Neutron for known ports
348 * Check OpenDaylight ports
349 * Create a new port via OpenStack and check the HTTP status code returned by Neutron
350 * Check that the new port has also been successfully created in OpenDaylight
353 * Delete the port previously created via OpenStack
354 * Check that the port has been also successfully deleted in OpenDaylight
355 * Delete previously subnet created via OpenStack
356 * Check that the subnet has also been successfully deleted in OpenDaylight
357 * Delete the network created via OpenStack
358 * Check that the network has also been successfully deleted in OpenDaylight
360 Note: the checks in OpenDaylight are based on the returned HTTP status
361 code returned by OpenDaylight.
367 Functest has been supporting several feature projects since Brahpamutra:
370 +-----------------+---------+----------+--------+-----------+
371 | Test | Brahma | Colorado | Danube | Euphrates |
372 +=================+=========+==========+========+===========+
373 | barometer | | | X | X |
374 +-----------------+---------+----------+--------+-----------+
375 | bgpvpn | | X | X | X |
376 +-----------------+---------+----------+--------+-----------+
378 +-----------------+---------+----------+--------+-----------+
379 | doctor | X | X | X | X |
380 +-----------------+---------+----------+--------+-----------+
381 | domino | | X | X | X |
382 +-----------------+---------+----------+--------+-----------+
384 +-----------------+---------+----------+--------+-----------+
386 +-----------------+---------+----------+--------+-----------+
387 | multisite | | X | X | |
388 +-----------------+---------+----------+--------+-----------+
389 | netready | | | X | |
390 +-----------------+---------+----------+--------+-----------+
391 | odl_sfc | | X | X | X |
392 +-----------------+---------+----------+--------+-----------+
394 +-----------------+---------+----------+--------+-----------+
395 | orchestra | | | X | X |
396 +-----------------+---------+----------+--------+-----------+
397 | parser | | | X | X |
398 +-----------------+---------+----------+--------+-----------+
399 | promise | X | X | X | X |
400 +-----------------+---------+----------+--------+-----------+
401 | security_scan | | X | X | |
402 +-----------------+---------+----------+--------+-----------+
404 Please refer to the dedicated feature user guides for details.
413 The IP Multimedia Subsystem or IP Multimedia Core Network Subsystem (IMS) is an
414 architectural framework for delivering IP multimedia services.
416 vIMS has been integrated in Functest to demonstrate the capability to deploy a
417 relatively complex NFV scenario on the OPNFV platform. The deployment of a complete
418 functional VNF allows the test of most of the essential functions needed for a
421 The goal of this test suite consists of:
423 * deploy a VNF orchestrator (Cloudify)
424 * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this
425 orchestrator based on a TOSCA blueprint defined in `[5]`_
426 * run suite of signaling tests on top of this VNF
428 The Clearwater architecture is described as follows:
430 .. figure:: ../../../images/clearwater-architecture.png
432 :alt: vIMS architecture
437 This testcase extends the cloudify_ims test case.
438 The first part is similar but the testing part is different.
439 The testing part consists in automating a realistic signaling load on the vIMS
440 using an Ixia loader (proprietary tools)
441 - You need to have access to an Ixia licence server defined in the configuration
442 file and have ixia image locally.
444 This test case is available but not declared in testcases.yaml. The declaration
445 of the testcase is simple, connect to your functest-vnf docker, add the following
446 section in /usr/lib/python2.7/site-packacges/functest/ci/testcases.yaml::
449 case_name: cloudify_ims_perf
450 project_name: functest
454 Stress tests based on Cloudify. Ixia loader images and access to Ixia
458 scenario: 'os-nosdn-nofeature-ha'
460 module: 'functest.opnfv_tests.vnf.ims.cloudify_ims_perf'
461 class: 'CloudifyImsPerf'
465 Orchestra test case deals with the deployment of OpenIMS with OpenBaton
468 orchestra_clearwaterims
469 ^^^^^^^^^^^^^^^^^^^^^^^
470 Orchestra test case deals with the deployment of Clearwater vIMS with OpenBaton
475 This test case deals with the deployment and the test of vyos vrouter with
476 Cloudify orchestrator. The test case can do testing for interchangeability of
477 BGP Protocol using vyos.
479 The Workflow is as follows:
481 Deploy VNF Testing topology by Cloudify using blueprint.
483 Setting configuration to Target VNF and reference VNF using ssh
485 Execution of test command for test item written YAML format file.
486 Check VNF status and behavior.
488 Output of report based on result using JSON format.
490 The vyos-vrouter architecture is described in `[14]`_
493 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
494 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
495 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
496 .. _`[8]`: https://github.com/openstack/refstack-client
497 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
498 .. _`[11]`: http://robotframework.org/
499 .. _`[12]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
500 .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO
501 .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter
502 .. _`[15]`: https://aptira.com/testing-openstack-tempest-part-1/