1 *************************
2 OPNFV FUNCTEST user guide
3 *************************
14 The goal of this document consists in describing the Functest test cases for Brahmaputra.
15 A presentation has been created for the first OPNFV Summit: `[4]`
17 This guide will detail how to launch the different tests assuming that Functest container has been properly installed `[1]`_.
20 =============================
21 Description of the test cases
22 =============================
24 Functest is an OPNFV project dedicated to functional testing.
25 In the continuous integration, it is launched after a fresh installation of an OPNFV solution to verify the basic functions.
27 Functest includes several test suites that usually include several test cases.
28 Some are developped within the Functest project, some in dedicated feature projects.
30 The current list of test suites can be distributed in 3 main domains:
32 +--------------+----------------+---------------------------------------------------------+
33 | Component | Testcase | Comments |
34 +--------------+----------------+---------------------------------------------------------+
35 | | vPing | NFV Hello World |
36 | +----------------+---------------------------------------------------------+
37 | VIM | Tempest | OpenStack reference test suite `[2]`_ |
38 | +----------------+---------------------------------------------------------+
39 | | Rally scenario | OpenStack testing tool testing OpenStack modules `[3]`_ |
40 +--------------+----------------+---------------------------------------------------------+
42 | +----------------+---------------------------------------------------------+
43 | Controllers | onos | |
44 | +----------------+---------------------------------------------------------+
46 +--------------+----------------+---------------------------------------------------------+
47 | Features | vIMS | Show the capability to deploy a real NFV testcase |
48 | +----------------+---------------------------------------------------------+
50 +--------------+----------------+---------------------------------------------------------+
53 Most of the test suites are developped upstream, Functest is in charge of the integration in OPNFV.
54 Tempest `[2]`_, for example, is the OpenStack reference test suite.
56 In Functest we customized the list of tests within Tempest but do not created our own test cases.
57 Some OPNFV feature projects (.e.g. SDNVPN) may create tempest scenario upstream that are integrated in our Tempest through our configuration.
59 The test results are pushed into a test result database (when possible) in order to build a test dashboard.
61 There is no real notion of Test domain or Test coverage yet, we tried to cover basic components such as VIM and controllers and integrate the tests of the feature projects.
63 The vIMS test case was also integrated to demonstrate the capability to deploy a relatively complex NFV scenario on top of the OPNFV infrastructure.
65 Functest considers OPNFV as a black box. OPNFV, since Brahmaputra, offers lots of possible combination (3 controllers, 4 installers).
67 However most of the tests (except obviously those dedicated to a specific controller) shall be runnable on any configuration.
69 The different scenarios are described in the section hereafter.
77 The goal of this test can be described as follow::
80 +-------------+ +-------------+
84 | +------------------>| |
87 | +------------------>| |
89 | | Boot VM2 | Under |
90 | +------------------>| Test |
93 | | Check console log | |
96 | | else (timeout) | |
100 +-------------+ +-------------+
103 This example, using OpenStack Python clients can be considered as an "Hello World" example and may be modified for future use.
104 It is the first basic example, it must work on any configuration.
109 Tempest `[2]`_ is the reference OpenStack Integration test suite. It is a set of integration tests to be run against a live OpenStack cluster.
110 Tempest has batteries of tests for OpenStack API validation, Scenarios, and other specific tests useful in validating an OpenStack deployment.
112 We use Rally `[3]`_ to run Tempest suite.
113 The tempest.conf configuration file is automatically generated by Rally then the Tempest suite is run, each test duration is measured.
115 We considered the smoke test suite for Arno. For Brahmaputra, we decided to customize the list of test cases using the --tests-file option introduced in Rally in version 0.1.2.
117 The custom list is available on the Functest repo `[4]`_ and contains more than 200 test cases.
118 This list contains tempest test cases chosen for Functest deployment.
119 It consists of two main parts:
121 1) Set of tempest smoke test cases
122 2) Set of test cases from DefCore list (https://wiki.openstack.org/wiki/Governance/DefCoreCommittee)
124 The goal of this test is to check the basic OpenStack functionalities on an OPNFV fresh installation.
127 Rally bench test suites
128 -----------------------
130 Rally `[3]`_ is a benchmarking tool that answers the question: “How does OpenStack work at scale?”.
132 The goal of this test suite is to test the different modules of OpenStack and get significant figures that could help us to define telco Cloud KPI.
134 The OPNFV scenarios are based on the collection of the existing Rally scenarios:
146 For Brahmaputra, we integrated the rally certification feature introduced in Rally 0.1.1.
154 Brahmaputra introduces new SDN controllers in addition of odl already integrated in Arno.
155 There are currently 3 possible controllers:
164 The ODL suite consists in a set of basic tests inherited from ODL project.
165 The suite tests the creation and deletion of network, subnet, port though OpenDaylight and Neutron.
167 The list of tests can be described as follow::
169 * Restconf.basic: Get the controller modules via Restconf
172 * Check OpenStack Networks :: Checking OpenStack Neutron for known networks
173 * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API
174 * Create Network :: Create new network in OpenStack
175 * Check Network :: Check Network created in OpenDaylight
176 * Neutron.Networks :: Checking Network created in OpenStack are pushed
180 * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets
181 * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API
182 * Create New subnet :: Create new subnet in OpenStack
183 * Check New subnet :: Check new subnet created in OpenDaylight
184 * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed
188 * Check OpenStack ports :: Checking OpenStack Neutron for known ports
189 * Check OpenDaylight ports :: Checking OpenDaylight Neutron API
190 * Create New Port :: Create new port in OpenStack
191 * Check New Port :: Check new subnet created in OpenDaylight
192 * Neutron.Ports :: Checking Port created in OpenStack are pushed
196 * Delete previously created subnet in OpenStack
197 * Check subnet deleted in OpenDaylight
198 * Check subnet deleted in OpenStack
202 * Delete previously created network in OpenStack
203 * Check network deleted in OpenDaylight
204 * Check network deleted in OpenStack
222 The goal of this test suite consists in:
223 * deploying a VNF orchestrator (cloudify)
224 * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this orchestrator based on a TOSCA blueprint defined in `[5]`_
225 * run suite of signaling tests on top of this VNF
227 The Clearwater architecture may be described as follow:
229 .. figure:: ../images/clearwater-architecture.png
231 :alt: vIMS architecture
233 The duration of each step (orchestion deployment, VNF deployment and test), as well as test results, are stored and, in CI, pushed into the test collection database.
245 Once you have installed Functest docker file `[1]`_, and configured the system (though /home/opnfv/repos/functest/docker/prepare_env.sh script), you are ready to run the tests.
247 The script run_tests.sh has several options::
250 Script to trigger the tests automatically.
253 bash run_tests.sh [--offline] [-h|--help] [-t <test_name>]
256 -o|--offline optional offline mode (experimental)
257 -h|--help show this help text
258 -r|--report push results to database (false by default)
259 -t|--test run specific set of tests
260 <test_name> one or more of the following: vping,odl,rally,tempest,vims. Separated by comma.
264 run_tests.sh --test vping,odl
265 run_tests.sh --offline -t tempest,rally
267 The -o option can be used to run the container offline (in case you are in a summit where there is no Internet connection...). It is an experimental option.
269 The -r option is used by the Continuous Integration in order to push the test results into a test collection database, see in next section for details. In manual mode, you must not use it, your try will be anyway probably rejected as your POD must be declared in the database to collect the data.
271 The -t option can be used to specify the list of test you want to launch, by default Functest will try to launch all its test suites in the following order vPing, odl, Tempest, vIMS, Rally. You may launch only one single test by using -t <the test you want to launch>
273 Please note that Functest includes cleaning mechanism to remove everything except what was present after a fresh install. If you create VM, tenants, networks then launch Functest, there is a risk to remove elements. Be carefull or comment the cleaning phase in run_test.sh (comment call to clean_openstack.py). However, be aware that Tempest and rally triggers the creation of lots of components that are not always properly cleaned, this function has been set to keep the system as clean as possible after a full Functest run.
275 You may also add you own test by adding a section into the function run_test()
282 As mentioned in `[1]`, the prepare-env.sh and run_test.sh can be executed within the container from jenkins. 2 jobs have been created, one to run all the test and one that allows testing test suite by test suite. You thus just have to launch the acurate jenkins job on the target lab, all the tests shall be automatically run.
295 vPing result is displayed in the console::
297 2016-01-06 16:06:20,550 - vPing- INFO - Creating neutron network vping-net...
298 2016-01-06 16:06:23,867 - vPing- INFO - Flavor found 'm1.small'
299 2016-01-06 16:06:24,457 - vPing- INFO - vPing Start Time:'2016-01-06 16:06:24'
300 2016-01-06 16:06:24,626 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
301 2016-01-06 16:06:39,351 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
302 2016-01-06 16:06:39,650 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
303 2016-01-06 16:06:53,330 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
304 2016-01-06 16:06:53,330 - vPing- INFO - Waiting for ping...
305 2016-01-06 16:06:58,669 - vPing- INFO - vPing detected!
306 2016-01-06 16:06:58,669 - vPing- INFO - vPing duration:'34.2'
307 2016-01-06 16:06:58,670 - vPing- INFO - Cleaning up...
308 2016-01-06 16:07:12,661 - vPing- INFO - Deleting network 'vping-net'...
309 2016-01-06 16:07:14,748 - vPing- INFO - vPing OK
311 A json file is produced and pushed into the test result database.
317 The Tempest results are displayed in the console::
319 FUNCTEST.info: Running Tempest tests...
320 2016-01-06 16:07:32,271 - run_tempest - INFO - Creating tenant and user for Tempest suite
321 2016-01-06 16:07:38,864 - run_tempest - INFO - Starting Tempest test suite: '--tests-file /home/opnfv/repos/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt'.
323 {23} tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor [0.131741s] ... ok
324 {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_get_image [0.367465s] ... ok
325 {23} tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors [0.089323s] ... ok
326 {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_list_images [0.245090s] ... ok
327 {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_list_images_with_detail [0.434553s] ... ok
328 {7} setUpClass (tempest.api.identity.admin.v3.test_services.ServicesTestJSON) [0.000000s] ... FAILED
329 {5} setUpClass (tempest.api.identity.admin.v3.test_groups.GroupsV3TestJSON) [0.000000s] ... FAILED
330 {4} setUpClass (tempest.api.network.test_floating_ips.FloatingIPTestJSON) [0.000000s] ... FAILED
331 {10} setUpClass (tempest.api.identity.admin.v3.test_policies.PoliciesTestJSON) [0.000000s] ... FAILED
332 {3} tempest.api.compute.servers.test_servers.ServersTestJSON.test_create_server_with_admin_password [3.107954s] ... ok
333 {9} tempest.api.compute.security_groups.test_security_groups.SecurityGroupsTestJSON.test_security_groups_create_list_delete [2.933169s] ... ok
335 {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_network [1.002445s] ... ok
336 {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_port [1.553398s] ... ok
337 {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_subnet [3.082247s] ... ok
338 {3} tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops [48.295630s] ... ok
339 {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_rebuild_server [78.782038s] ... ok
340 {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_resize_server_confirm [15.597440s] ... ok
341 {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_resize_server_revert [19.248253s] ... ok
342 {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_stop_start_server [7.078850s] ... ok
343 {6} tempest.api.compute.volumes.test_attach_volume.AttachVolumeTestJSON.test_attach_detach_volume [40.311720s] ... ok
344 {6} tempest.api.volume.test_volumes_actions.VolumesV1ActionsTest.test_attach_detach_volume_to_instance [1.159194s] ... ok
349 Ran: 199 tests in 241.0000 sec.
353 - Unexpected Success: 0
355 Sum of execute time for each test: 481.0934 sec.
368 The results of ODL tests can be seen in the console::
370 ==============================================================================
372 ==============================================================================
373 Basic.010 Restconf OK :: Test suite to verify Restconf is OK
374 ==============================================================================
375 Get Controller Modules :: Get the controller modules via Restconf | PASS |
376 ------------------------------------------------------------------------------
377 Basic.010 Restconf OK :: Test suite to verify Restconf is OK | PASS |
378 1 critical test, 1 passed, 0 failed
379 1 test total, 1 passed, 0 failed
380 ==============================================================================
382 1 critical test, 1 passed, 0 failed
383 1 test total, 1 passed, 0 failed
384 ==============================================================================
385 Output: /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
386 Log: /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
387 Report: /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
389 ..............................................................................
391 Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | FAIL |
392 2 critical tests, 1 passed, 1 failed
393 2 tests total, 1 passed, 1 failed
394 ==============================================================================
395 Neutron :: Test suite for Neutron Plugin | FAIL |
396 18 critical tests, 15 passed, 3 failed
397 18 tests total, 15 passed, 3 failed
398 ==============================================================================
399 Output: /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
400 Log: /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
401 Report: /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
403 3 result files are generated:
410 .. figure:: ./images/functestODL.png
413 :alt: ODL suite result page
419 Tests are expected to fail now:
420 * Check port deleted in OpenDaylight
421 * Check subnet deleted in OpenDaylight
422 * Check Network deleted in OpenDaylight
424 These failures to delete objects in OpenDaylight (when removed via OpenStack Neutron) are due to the following bug: https://bugs.opendaylight.org/show_bug.cgi?id=3052.
443 The results in the console are very verbose::
445 FUNCTEST.info: Running vIMS test...
446 2016-01-07 12:30:24,107 - vIMS - INFO - Prepare OpenStack plateform (create tenant and user)
447 2016-01-07 12:30:24,484 - vIMS - INFO - Update OpenStack creds informations
448 2016-01-07 12:30:24,484 - vIMS - INFO - Upload some OS images if it doesn't exist
449 2016-01-07 12:30:24,917 - vIMS - INFO - centos_7 image doesn't exist on glance repository.
450 Try downloading this image and upload on glance !
451 2016-01-07 12:31:01,268 - vIMS - INFO - ubuntu_14.04 image doesn't exist on glance repository.
452 Try downloading this image and upload on glance !
453 2016-01-07 12:31:28,670 - vIMS - INFO - Update security group quota for this tenant
454 2016-01-07 12:31:28,903 - vIMS - INFO - Update cinder quota for this tenant
455 2016-01-07 12:31:29,355 - vIMS - INFO - Collect flavor id for cloudify manager server
456 2016-01-07 12:31:30,453 - vIMS - INFO - Prepare virtualenv for cloudify-cli
457 2016-01-07 12:31:30,453 - vIMS - DEBUG - Executing command : chmod +x /home/opnfv/repos/functest/testcases/vIMS/CI/create_venv.sh
458 2016-01-07 12:31:30,460 - vIMS - DEBUG - Executing command : /home/opnfv/repos/functest/testcases/vIMS/CI/create_venv.sh /home/opnfv/functest/data/vIMS/
459 2016-01-07 12:31:30,469 - vIMS - INFO - Downloading the cloudify manager server blueprint
460 2016-01-07 12:31:46,028 - vIMS - INFO - Cloudify deployment Start Time:'2016-01-07 12:31:46'
461 2016-01-07 12:31:46,029 - vIMS - INFO - Writing the inputs file
462 2016-01-07 12:31:46,032 - vIMS - INFO - Launching the cloudify-manager deployment
463 .........................................
464 2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: preparing fabric environment...
465 2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: environment prepared successfully
466 .........................................
467 2016-01-07 12:42:51,982 - vIMS - INFO - Cloudify-manager server is UP !
468 2016-01-07 12:42:51,983 - vIMS - INFO - Cloudify deployment duration:'666.0'
469 2016-01-07 12:42:51,983 - vIMS - INFO - Collect flavor id for all clearwater vm
470 2016-01-07 12:42:53,330 - vIMS - INFO - vIMS VNF deployment Start Time:'2016-01-07 12:42:53'
471 2016-01-07 12:42:53,330 - vIMS - INFO - Downloading the openstack-blueprint.yaml blueprint
472 2016-01-07 12:43:05,798 - vIMS - INFO - Writing the inputs file
473 2016-01-07 12:43:05,801 - vIMS - INFO - Launching the clearwater deployment
474 2016-01-07 12:43:05,801 - vIMS - DEBUG - Executing command : /bin/bash -c 'source /home/opnfv/functest/data/vIMS/venv_cloudify/bin/activate; cd /home/opnfv/functest/data/vIMS/opnfv-cloudify-clearwater; cfy blueprints upload -b clearwater -p openstack-blueprint.yaml; cfy deployments create -b clearwater -d clearwater-opnfv --inputs inputs.yaml; cfy executions start -w install -d clearwater-opnfv --timeout 1800; '
475 2016-01-07 13:01:50,577 - vIMS - DEBUG - Validating openstack-blueprint.yaml
476 Blueprint validated successfully
477 Uploading blueprint openstack-blueprint.yaml to management server 172.30.10.165
478 Uploaded blueprint, blueprint's id is: clearwater
479 Creating new deployment from blueprint clearwater at management server 172.30.10.165
480 Deployment created, deployment's id is: clearwater-opnfv
481 .........................................
482 2016-01-07 13:01:50,578 - vIMS - INFO - The deployment of clearwater-opnfv is ended
483 2016-01-07 13:01:50,578 - vIMS - INFO - vIMS VNF deployment duration:'1137.2'
484 2016-01-07 13:04:50,591 - vIMS - DEBUG - Trying to get clearwater nameserver IP ...
485 2016-01-07 13:04:55,176 - vIMS - INFO - vIMS functional test Start Time:'2016-01-07 13:04:55'
486 2016-01-07 13:14:20,694 - vIMS - INFO - vIMS functional test duration:'565.5'
487 .........................................
488 Basic Call - Rejected by remote endpoint (TCP) - (6505550603, 6505550969) Passed
489 Basic Call - Rejected by remote endpoint (UDP) - (6505550095, 6505550084) Passed
490 Basic Call - Messages - Pager model (TCP) - (6505550000, 6505550520) Passed
491 Basic Call - Messages - Pager model (UDP) - (6505550742, 6505550077) Passed
492 Basic Call - Pracks (TCP) - (6505550670, 6505550304) Passed
493 Basic Call - Pracks (UDP) - (6505550990, 6505550391) Passed
494 Basic Registration (TCP) - (6505550744) Passed
495 Basic Registration (UDP) - (6505550616) Passed
496 Multiple Identities (TCP) - (6505550957, 6505550949) Passed
497 Multiple Identities (UDP) - (6505550771, 6505550675) Passed
498 .........................................
499 2016-01-07 13:14:20,695 - vIMS - DEBUG - Trying to load test results
500 2016-01-07 13:14:20,702 - vIMS - DEBUG - Push result into DB
501 2016-01-07 13:14:20,702 - vIMS - DEBUG - Pushing results to DB....
502 2016-01-07 13:14:21,396 - vIMS - DEBUG - <Response [200]>
503 2016-01-07 13:14:21,396 - vIMS - INFO - Launching the clearwater-opnfv undeployment
506 ==========================
507 Functest in test Dashboard
508 ==========================
510 The OPNFV testing group created a test collection database to collect the test results from CI.
511 Any lab integrated in CI can push the results to this database.
513 The idea is to centralize the resultes and created a dashboard to give a high level overview of the test activities.
521 .. _`[1]`: Functest configuration guide URL
522 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
523 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
524 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
525 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
528 OPNFV main site: opnfvmain_.
530 OPNFV functional test page: opnfvfunctest_.
532 IRC support chan: #opnfv-testperf
534 .. _opnfvmain: http://www.opnfv.org
535 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
536 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
537 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
538 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
539 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml