docs/userguide/index.rst

   1 *************************
   2 OPNFV FUNCTEST user guide
   3 *************************
   4
   5 .. toctree::
   6    :numbered:
   7    :maxdepth: 2
   8
   9
  10 ============
  11 Introduction
  12 ============
  13
  14 The goal of this document is describing the Functest test cases for Brahmaputra.
  15 A presentation has been created for the first OPNFV Summit: `[4]`
  16
  17 This guide will detail how to launch the different tests assuming that Functest container has been properly installed `[1]`_.
  18
  19
  20 =============================
  21 Description of the test cases
  22 =============================
  23
  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.
  26
  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.
  29
  30 The current list of test suites can be distributed in 3 main domains:
  31
  32 +----------------+----------------+---------------------------------------------------------+
  33 | Component      | Test suite     | Comments                                                |
  34 +----------------+----------------+---------------------------------------------------------+
  35 |                | vPing          | NFV "Hello World"                                       |
  36 |    VIM         +----------------+---------------------------------------------------------+
  37 |(Virtualised    | Tempest        | OpenStack reference test suite `[2]`_                   |
  38 | Infrastructure +----------------+---------------------------------------------------------+
  39 | Manager)       | Rally scenario | OpenStack testing tool testing OpenStack modules `[3]`_ |
  40 +----------------+----------------+---------------------------------------------------------+
  41 |                | odl            |                                                         |
  42 |                +----------------+---------------------------------------------------------+
  43 | Controllers    | onos           |                                                         |
  44 |                +----------------+---------------------------------------------------------+
  45 |                | opencontrail   |                                                         |
  46 +----------------+----------------+---------------------------------------------------------+
  47 | Features       | vIMS           | Show the capability to deploy a real NFV testcase       |
  48 |                +----------------+---------------------------------------------------------+
  49 |                | X              |                                                         |
  50 +----------------+----------------+---------------------------------------------------------+
  51
  52
  53 Most of the test suites are developed upstream. For example, Tempest `[2]`_ is the OpenStack integration test suite.
  54 Functest is in charge of the integration of different functional test suites in OPNFV.
  55
  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.
  58
  59 The test results are pushed into a test result database (when possible) in order to build a test dashboard.
  60
  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.
  62
  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.
  64
  65 Functest considers OPNFV as a black box. OPNFV, since Brahmaputra, offers lots of possible combination (3 controllers, 4 installers).
  66
  67 However most of the tests (except obviously those dedicated to a specific controller) shall be runnable on any configuration.
  68
  69 The different scenarios are described in the section hereafter.
  70
  71 VIM
  72 ===
  73
  74 vPing
  75 -----
  76
  77 The goal of this test can be described as follow::
  78
  79  vPing test case
  80  +-------------+                   +-------------+
  81  |             |                   |             |
  82  |             |                   |             |
  83  |             |     Boot VM1      |             |
  84  |             +------------------>|             |
  85  |             |                   |             |
  86  |             |     Get IP VM1    |             |
  87  |             +------------------>|             |
  88  |   Tester    |                   |   System    |
  89  |             |     Boot VM2      |    Under    |
  90  |             +------------------>|     Test    |
  91  |             | VM2 pings VM1     |             |
  92  |             |                   |             |
  93  |             | Check console log |             |
  94  |             |    If ping:       |             |
  95  |             |      exit OK      |             |
  96  |             |    else (timeout) |             |
  97  |             |      exit KO      |             |
  98  |             |                   |             |
  99  |             |                   |             |
 100  +-------------+                   +-------------+
 101
 102
 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.
 105
 106 Tempest
 107 -------
 108
 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.
 111
 112 We use Rally `[3]`_ to run Tempest suite.
 113 Rally generates automatically tempest.conf configuration file.
 114 Before running actual test cases Functest creates needed resources and updates needed parameters into the configuration file.
 115 When the Tempest suite is run, each test duration is measured and full console output is stored into tempest.log file.
 116
 117 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.
 118
 119 The customized test list is available on the Functest repo `[4]`_ and contains more than 200 tempest test cases chosen for Functest deployment.
 120 The list consists of two main parts:
 121
 122   1) Set of tempest smoke test cases
 123   2) Set of test cases from DefCore list (https://wiki.openstack.org/wiki/Governance/DefCoreCommittee)
 124
 125 The goal of Tempest test suite is to check the basic functionality of different OpenStack components on an OPNFV fresh installation using corresponding REST API interfaces.
 126
 127
 128 Rally bench test suites
 129 -----------------------
 130
 131 Rally `[3]`_ is a benchmarking tool that answers the question: “How does OpenStack work at scale?”.
 132
 133 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
 135 The OPNFV scenarios are based on the collection of the existing Rally scenarios:
 136  * authenticate
 137  * cinder
 138  * glance
 139  * heat
 140  * keystone
 141  * neutron
 142  * nova
 143  * quotas
 144  * requests
 145  * vm
 146
 147 For Brahmaputra, we integrated the rally certification feature introduced in Rally 0.1.1.
 148
 149 SLA
 150
 151
 152 SDN Controllers
 153 ===============
 154
 155 Brahmaputra introduces new SDN controllers in addition of odl already integrated in Arno.
 156 There are currently 3 possible controllers:
 157
 158  * odl
 159  * onos
 160  * opencontrail
 161
 162 OpenDaylight
 163 ------------
 164
 165 The ODL test suite consists of a set of basic tests inherited from ODL project.
 166 The suite verifies creation and deletion of networks, subnets and ports with OpenDaylight and Neutron.
 167
 168 The list of tests can be described as follow:
 169
 170  * Restconf.basic: Get the controller modules via Restconf
 171  * Neutron.Networks
 172
 173    * Check OpenStack Networks :: Checking OpenStack Neutron for known networks
 174    * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API
 175    * Create Network :: Create new network in OpenStack
 176    * Check Network :: Check Network created in OpenDaylight
 177    * Neutron.Networks :: Checking Network created in OpenStack are pushed
 178
 179  * Neutron.Subnets
 180
 181    * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets
 182    * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API
 183    * Create New subnet :: Create new subnet in OpenStack
 184    * Check New subnet :: Check new subnet created in OpenDaylight
 185    * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed
 186
 187  * Neutron.Ports
 188
 189    * Check OpenStack ports :: Checking OpenStack Neutron for known ports
 190    * Check OpenDaylight ports :: Checking OpenDaylight Neutron API
 191    * Create New Port :: Create new port in OpenStack
 192    * Check New Port :: Check new subnet created in OpenDaylight
 193    * Neutron.Ports :: Checking Port created in OpenStack are pushed
 194
 195  * Delete Ports
 196
 197    * Delete previously created subnet in OpenStack
 198    * Check subnet deleted in OpenDaylight
 199    * Check subnet deleted in OpenStack
 200
 201  * Delete network
 202
 203    * Delete previously created network in OpenStack
 204    * Check network deleted in OpenDaylight
 205    * Check network deleted in OpenStack
 206
 207
 208 ONOS
 209 ----
 210
 211 For ONOS function test,TestON Framework is being used.
 212 The test cases contains L2 and L3 function.We config the function by OpenStack,and then check it in ONOS.
 213 Following describe the test cases:
 214
 215  * onosfunctest: The mainly executable file,contains init the docker environment for test and function call of FUNCvirNetNB and FUNCvirNetNBL3
 216  * FUNCvirNetNB
 217
 218    * Create Network :: Post Network data and check it in ONOS
 219    * Update Network :: Update the Network and compare it in ONOS
 220    * Delete Network :: Delete the Network and check if it's NULL in ONOS or not
 221    * Create Subnet :: Post Subnet data and check it in ONOS
 222    * Update Subnet :: Update the Subnet and compare it in ONOS
 223    * Delete Subnet :: Delete the Subnet and check if it's NULL in ONOS or not
 224    * Create Port :: Post Port data and check it in ONOS
 225    * Update Port :: Update the Port and compare it in ONOS
 226    * Delete Port :: Delete the Port and check if it's NULL in ONOS or not
 227
 228  * FUNCvirNetNBL3
 229
 230    * Create Router :: Post dataes for create Router and check it in ONOS
 231    * Update Router :: Update the Router and compare it in ONOS
 232    * Delete Router :: Delete the Router dataes and check it in ONOS
 233    * Create RouterInterface :: Post RouterInterface data to an exist Router and check it in ONOS
 234    * Delete RouterInterface :: Delete the RouterInterface and check the Router
 235    * Create FloatingIp :: Post dataes for create FloatingIp and check it in ONOS
 236    * Update FloatingIp :: Update the FloatingIp and compare it in ONOS
 237    * Delete FloatingIp :: Delete the FloatingIp and check if it's NULL in ONOS or not
 238    * Create External Gateway :: Post dataes for create External Gateway to an exit Router and check it
 239    * Update External Gateway :: Update the External Gateway and compare it
 240    * Delete External Gateway :: Delete the External Gateway and check if it's NULL in ONOS or not
 241
 242
 243 OpenContrail
 244 ------------
 245 TODO
 246
 247
 248
 249 Features
 250 ========
 251
 252 vIMS
 253 ----
 254 The goal of this test suite consists in:
 255  * deploying a VNF orchestrator (cloudify)
 256  * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this orchestrator based on a TOSCA blueprint defined in `[5]`_
 257  * run suite of signaling tests on top of this VNF
 258
 259 The Clearwater architecture may be described as follow:
 260
 261 .. figure:: ../images/clearwater-architecture.png
 262    :align: center
 263    :alt: vIMS architecture
 264
 265 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.
 266
 267 X
 268 --
 269
 270 TODO
 271
 272
 273 ==============
 274 Manual testing
 275 ==============
 276
 277 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.
 278
 279 The script run_tests.sh has several options::
 280
 281     ./run_tests.sh -h
 282     Script to trigger the tests automatically.
 283
 284     usage:
 285         bash run_tests.sh [--offline] [-h|--help] [-t <test_name>]
 286
 287     where:
 288         -h|--help         show this help text
 289         -r|--report       push results to database (false by default)
 290         -n|--no-clean     do not clean up OpenStack resources after test run
 291         -t|--test         run specific set of tests
 292           <test_name>     one or more of the following: vping,odl,rally,tempest,vims. Separated by comma.
 293
 294     examples:
 295         run_tests.sh
 296         run_tests.sh --test vping,odl
 297         run_tests.sh -t tempest,rally --no-clean
 298
 299 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.
 300
 301 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.
 302
 303 The -n option is used for preserving all the existing OpenStack resources after execution test cases.
 304
 305 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>
 306
 307 Within Tempest test suite you can define which test cases you want to execute in your environment by editing test_list.txt file before executing run_tests.sh script.
 308
 309 Please note that Functest includes cleaning mechanism in order to remove everything except what was present after a fresh install. If you create your own VMs, tenants, networks etc. and then launch Functest, they all will be deleted after executing the tests. Use --no-clean option with run_test.sh in order to preserve all the existing resources. However, be aware that Tempest and Rally create of lot of resources (users, tenants, networks, volumes etc.) that are not always properly cleaned, so this cleaning function has been set to keep the system as clean as possible after a full Functest run.
 310
 311 You may also add you own test by adding a section into the function run_test()
 312
 313
 314 =================
 315 Automated testing
 316 =================
 317
 318 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.
 319
 320
 321 ============
 322 Test results
 323 ============
 324
 325 VIM
 326 ===
 327
 328 vPing
 329 -----
 330
 331 vPing result is displayed in the console::
 332
 333     2016-01-06 16:06:20,550 - vPing- INFO - Creating neutron network vping-net...
 334     2016-01-06 16:06:23,867 - vPing- INFO - Flavor found 'm1.small'
 335     2016-01-06 16:06:24,457 - vPing- INFO - vPing Start Time:'2016-01-06 16:06:24'
 336     2016-01-06 16:06:24,626 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
 337     2016-01-06 16:06:39,351 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
 338     2016-01-06 16:06:39,650 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
 339     2016-01-06 16:06:53,330 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
 340     2016-01-06 16:06:53,330 - vPing- INFO - Waiting for ping...
 341     2016-01-06 16:06:58,669 - vPing- INFO - vPing detected!
 342     2016-01-06 16:06:58,669 - vPing- INFO - vPing duration:'34.2'
 343     2016-01-06 16:06:58,670 - vPing- INFO - Cleaning up...
 344     2016-01-06 16:07:12,661 - vPing- INFO - Deleting network 'vping-net'...
 345     2016-01-06 16:07:14,748 - vPing- INFO - vPing OK
 346
 347 A json file is produced and pushed into the test result database.
 348
 349
 350 Tempest
 351 -------
 352
 353 The Tempest results are displayed in the console::
 354
 355     FUNCTEST.info: Running Tempest tests...
 356     2016-01-06 16:07:32,271 - run_tempest - INFO - Creating tenant and user for Tempest suite
 357     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'.
 358
 359     {23} tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor [0.131741s] ... ok
 360     {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_get_image [0.367465s] ... ok
 361     {23} tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors [0.089323s] ... ok
 362     {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_list_images [0.245090s] ... ok
 363     {13} tempest.api.compute.images.test_list_images.ListImagesTestJSON.test_list_images_with_detail [0.434553s] ... ok
 364     {7} setUpClass (tempest.api.identity.admin.v3.test_services.ServicesTestJSON) [0.000000s] ... FAILED
 365     {5} setUpClass (tempest.api.identity.admin.v3.test_groups.GroupsV3TestJSON) [0.000000s] ... FAILED
 366     {4} setUpClass (tempest.api.network.test_floating_ips.FloatingIPTestJSON) [0.000000s] ... FAILED
 367     {10} setUpClass (tempest.api.identity.admin.v3.test_policies.PoliciesTestJSON) [0.000000s] ... FAILED
 368     {3} tempest.api.compute.servers.test_servers.ServersTestJSON.test_create_server_with_admin_password [3.107954s] ... ok
 369     {9} tempest.api.compute.security_groups.test_security_groups.SecurityGroupsTestJSON.test_security_groups_create_list_delete [2.933169s] ... ok
 370     .......
 371     {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_network [1.002445s] ... ok
 372     {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_port [1.553398s] ... ok
 373     {1} tempest.api.network.test_networks.BulkNetworkOpsIpV6TestJSON.test_bulk_create_delete_subnet [3.082247s] ... ok
 374     {3} tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops [48.295630s] ... ok
 375     {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_rebuild_server [78.782038s] ... ok
 376     {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_resize_server_confirm [15.597440s] ... ok
 377     {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_resize_server_revert [19.248253s] ... ok
 378     {6} tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON.test_stop_start_server [7.078850s] ... ok
 379     {6} tempest.api.compute.volumes.test_attach_volume.AttachVolumeTestJSON.test_attach_detach_volume [40.311720s] ... ok
 380     {6} tempest.api.volume.test_volumes_actions.VolumesV1ActionsTest.test_attach_detach_volume_to_instance [1.159194s] ... ok
 381     .......
 382     ======
 383     Totals
 384     ======
 385     Ran: 199 tests in 241.0000 sec.
 386      - Passed: 182
 387      - Skipped: 3
 388      - Expected Fail: 0
 389      - Unexpected Success: 0
 390      - Failed: 14
 391     Sum of execute time for each test: 481.0934 sec.
 392
 393 In order to check all the available test case related debug information, please inspect tempest.log file stored into related Rally deployment folder.
 394
 395 Rally
 396 -----
 397  TODO
 398
 399 Controllers
 400 ===========
 401
 402 odl
 403 ---
 404
 405 The results of ODL tests can be seen in the console::
 406
 407  ==============================================================================
 408  Basic
 409  ==============================================================================
 410  Basic.010 Restconf OK :: Test suite to verify Restconf is OK
 411  ==============================================================================
 412  Get Controller Modules :: Get the controller modules via Restconf     | PASS |
 413  ------------------------------------------------------------------------------
 414  Basic.010 Restconf OK :: Test suite to verify Restconf is OK          | PASS |
 415  1 critical test, 1 passed, 0 failed
 416  1 test total, 1 passed, 0 failed
 417  ==============================================================================
 418  Basic                                                                 | PASS |
 419  1 critical test, 1 passed, 0 failed
 420  1 test total, 1 passed, 0 failed
 421  ==============================================================================
 422  Output:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
 423  Log:     /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
 424  Report:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
 425
 426  ..............................................................................
 427
 428  Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | FAIL |
 429  2 critical tests, 1 passed, 1 failed
 430  2 tests total, 1 passed, 1 failed
 431  ==============================================================================
 432  Neutron :: Test suite for Neutron Plugin                              | FAIL |
 433  18 critical tests, 15 passed, 3 failed
 434  18 tests total, 15 passed, 3 failed
 435  ==============================================================================
 436  Output:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
 437  Log:     /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
 438  Report:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
 439
 440 3 result files are generated:
 441  * output.xml
 442  * log.html
 443  * report.html
 444
 445  ODL result page
 446
 447 .. figure:: ./images/functestODL.png
 448    :width: 170mm
 449    :align: center
 450    :alt: ODL suite result page
 451
 452
 453 Known issues
 454 ------------
 455
 456 Tests are expected to fail now:
 457  * Check port deleted in OpenDaylight
 458  * Check subnet deleted in OpenDaylight
 459  * Check Network deleted in OpenDaylight
 460
 461 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.
 462
 463 onos
 464 ----
 465
 466 The ONOS test logs output to OnosSystemTest/TestON/logs with ONOSCI_PATH added,and also can be seen in the console::
 467
 468  ******************************
 469   Result summary for Testcase4
 470  ******************************
 471
 472  2016-01-14 05:25:40,529 - FUNCvirNetNBL3 - INFO - ONOS Router Delete test Start
 473
 474  [2016-01-14 05:25:40.529644] [FUNCvirNetNBL3] [CASE]  Virtual Network NBI Test - Router
 475  2016-01-14 05:25:40,530 - FUNCvirNetNBL3 - INFO - Generate Post Data
 476
 477  [2016-01-14 05:25:40.530825] [FUNCvirNetNBL3] [STEP]  4.1: Post Network Data via HTTP(Post Router need post network)
 478  2016-01-14 05:25:40,531 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/networks/ using POST method.
 479  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 480  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Post Network Success
 481  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Assertion Passed
 482
 483  [2016-01-14 05:25:40.539687] [FUNCvirNetNBL3] [STEP]  4.2: Post Router Data via HTTP
 484  2016-01-14 05:25:40,540 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/ using POST method.
 485  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 486  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Post Router Success
 487  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Assertion Passed
 488
 489  [2016-01-14 05:25:40.543489] [FUNCvirNetNBL3] [STEP]  4.3: Delete Router Data via HTTP
 490  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/e44bd655-e22c-4aeb-b1e9-ea1606875178 using DELETE method.
 491  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 492  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Delete Router Success
 493  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Assertion Passed
 494
 495  [2016-01-14 05:25:40.546774] [FUNCvirNetNBL3] [STEP]  4.4: Get Router Data is NULL
 496  2016-01-14 05:25:40,547 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/e44bd655-e22c-4aeb-b1e9-ea1606875178 using GET method.
 497  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 498  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Get Router Success
 499  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Assertion Passed
 500
 501
 502  *****************************
 503   Result: Pass
 504  *****************************
 505
 506  .......................................................................................
 507
 508  ******************************
 509   Result summary for Testcase9
 510  ******************************
 511  .......................................................................................
 512
 513
 514  [2016-01-14 05:26:42.543489] [FUNCvirNetNBL3] [STEP]  9.6: FloatingIp Clean Data via HTTP
 515  2016-01-14 05:26:42,543 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/floatingips/e44bd655-e22c-4aeb-b1e9-ea1606875178 using DELETE method.
 516  2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 517  2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - ERROR - Delete Floatingip failed
 518
 519  .......................................................................................
 520
 521  *****************************
 522   Result: Failed
 523  *****************************
 524
 525 There's a Result summary for each testcase,and a total summary for the whole test file,if any problem occured,ERROR can be seen in the testcase summary and total summary::
 526
 527  *************************************
 528          Test Execution Summary
 529
 530  *************************************
 531
 532   Test Start           : 14 Jan 2016 05:25:37
 533   Test End             : 14 Jan 2016 05:25:41
 534   Execution Time       : 0:00:03.349087
 535   Total tests planned  : 11
 536   Total tests RUN      : 11
 537   Total Pass           : 8
 538   Total Fail           : 3
 539   Total No Result      : 0
 540   Success Percentage   : 72%
 541   Execution Result     : 100%
 542
 543 opencontrail
 544 ------------
 545
 546 TODO
 547
 548
 549 Feature
 550 =======
 551
 552 vIMS
 553 ----
 554
 555 The results in the console are very verbose::
 556
 557     FUNCTEST.info: Running vIMS test...
 558     2016-01-07 12:30:24,107 - vIMS - INFO - Prepare OpenStack plateform (create tenant and user)
 559     2016-01-07 12:30:24,484 - vIMS - INFO - Update OpenStack creds informations
 560     2016-01-07 12:30:24,484 - vIMS - INFO - Upload some OS images if it doesn't exist
 561     2016-01-07 12:30:24,917 - vIMS - INFO - centos_7 image doesn't exist on glance repository.
 562                                 Try downloading this image and upload on glance !
 563     2016-01-07 12:31:01,268 - vIMS - INFO - ubuntu_14.04 image doesn't exist on glance repository.
 564                                 Try downloading this image and upload on glance !
 565     2016-01-07 12:31:28,670 - vIMS - INFO - Update security group quota for this tenant
 566     2016-01-07 12:31:28,903 - vIMS - INFO - Update cinder quota for this tenant
 567     2016-01-07 12:31:29,355 - vIMS - INFO - Collect flavor id for cloudify manager server
 568     2016-01-07 12:31:30,453 - vIMS - INFO - Prepare virtualenv for cloudify-cli
 569     2016-01-07 12:31:30,453 - vIMS - DEBUG - Executing command : chmod +x /home/opnfv/repos/functest/testcases/vIMS/CI/create_venv.sh
 570     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/
 571     2016-01-07 12:31:30,469 - vIMS - INFO - Downloading the cloudify manager server blueprint
 572     2016-01-07 12:31:46,028 - vIMS - INFO - Cloudify deployment Start Time:'2016-01-07 12:31:46'
 573     2016-01-07 12:31:46,029 - vIMS - INFO - Writing the inputs file
 574     2016-01-07 12:31:46,032 - vIMS - INFO - Launching the cloudify-manager deployment
 575     .........................................
 576     2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: preparing fabric environment...
 577     2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: environment prepared successfully
 578     .........................................
 579     2016-01-07 12:42:51,982 - vIMS - INFO - Cloudify-manager server is UP !
 580     2016-01-07 12:42:51,983 - vIMS - INFO - Cloudify deployment duration:'666.0'
 581     2016-01-07 12:42:51,983 - vIMS - INFO - Collect flavor id for all clearwater vm
 582     2016-01-07 12:42:53,330 - vIMS - INFO - vIMS VNF deployment Start Time:'2016-01-07 12:42:53'
 583     2016-01-07 12:42:53,330 - vIMS - INFO - Downloading the openstack-blueprint.yaml blueprint
 584     2016-01-07 12:43:05,798 - vIMS - INFO - Writing the inputs file
 585     2016-01-07 12:43:05,801 - vIMS - INFO - Launching the clearwater deployment
 586     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; '
 587     2016-01-07 13:01:50,577 - vIMS - DEBUG - Validating openstack-blueprint.yaml
 588     Blueprint validated successfully
 589     Uploading blueprint openstack-blueprint.yaml to management server 172.30.10.165
 590     Uploaded blueprint, blueprint's id is: clearwater
 591     Creating new deployment from blueprint clearwater at management server 172.30.10.165
 592     Deployment created, deployment's id is: clearwater-opnfv
 593     .........................................
 594     2016-01-07 13:01:50,578 - vIMS - INFO - The deployment of clearwater-opnfv is ended
 595     2016-01-07 13:01:50,578 - vIMS - INFO - vIMS VNF deployment duration:'1137.2'
 596     2016-01-07 13:04:50,591 - vIMS - DEBUG - Trying to get clearwater nameserver IP ...
 597     2016-01-07 13:04:55,176 - vIMS - INFO - vIMS functional test Start Time:'2016-01-07 13:04:55'
 598     2016-01-07 13:14:20,694 - vIMS - INFO - vIMS functional test duration:'565.5'
 599     .........................................
 600     Basic Call - Rejected by remote endpoint (TCP) - (6505550603, 6505550969) Passed
 601     Basic Call - Rejected by remote endpoint (UDP) - (6505550095, 6505550084) Passed
 602     Basic Call - Messages - Pager model (TCP) - (6505550000, 6505550520) Passed
 603     Basic Call - Messages - Pager model (UDP) - (6505550742, 6505550077) Passed
 604     Basic Call - Pracks (TCP) - (6505550670, 6505550304) Passed
 605     Basic Call - Pracks (UDP) - (6505550990, 6505550391) Passed
 606     Basic Registration (TCP) - (6505550744) Passed
 607     Basic Registration (UDP) - (6505550616) Passed
 608     Multiple Identities (TCP) - (6505550957, 6505550949) Passed
 609     Multiple Identities (UDP) - (6505550771, 6505550675) Passed
 610     .........................................
 611     2016-01-07 13:14:20,695 - vIMS - DEBUG - Trying to load test results
 612     2016-01-07 13:14:20,702 - vIMS - DEBUG - Push result into DB
 613     2016-01-07 13:14:20,702 - vIMS - DEBUG - Pushing results to DB....
 614     2016-01-07 13:14:21,396 - vIMS - DEBUG - <Response [200]>
 615     2016-01-07 13:14:21,396 - vIMS - INFO - Launching the clearwater-opnfv undeployment
 616
 617
 618 ==========================
 619 Functest in test Dashboard
 620 ==========================
 621
 622 The OPNFV testing group created a test collection database to collect the test results from CI.
 623 Any lab integrated in CI can push the results to this database.
 624
 625 The idea is to centralize the resultes and create a dashboard to give a high level overview of the test activities.
 626 You can find more information about the dashboard from Testing Dashboard wiki page `[6]`_.
 627
 628
 629 ===============
 630 Troubleshooting
 631 ===============
 632
 633 VIM
 634 ===
 635
 636 vPing
 637 -----
 638
 639
 640 Tempest
 641 -------
 642
 643 In the upstream OpenStack CI all the Tempest test cases are supposed to pass. If some test cases fail in an OPNFV deployment, the reason is very probably one of the following:
 644
 645  * Some resources required for execution test cases are missing. Such resources could be e.g. an external network and access to the management subnet (adminURL) from the Functest docker container.
 646  * Some OpenStack components or services are missing or not configured properly. You can check running services in the controller and compute nodes e.g. with "systemctl" or "service" commands. Configuration parameters can be verified from related .conf files located under /etc/<component> directories.
 647  * Used tempest.conf file doesn't contain all the needed parameters or some parameters are not set properly. When using Functest, tempest.conf file is generated by Rally and updated with needed parameters automatically before executing Tempest cases. You can find the used configuration file e.g. with "find / -name tempest.conf" command. Use "rally deployment list" command in order to check UUID of current deployment.
 648
 649 When some Tempest test case fails, captured traceback and possibly also related REST API requests/responses are output to the console.
 650 More detailed debug information can be found from tempest.log file stored into related Rally deployment folder.
 651
 652
 653 Rally
 654 -----
 655
 656
 657 Controllers
 658 ===========
 659
 660 odl
 661 ---
 662
 663
 664 onos
 665 ----
 666
 667
 668 opencontrail
 669 ------------
 670
 671
 672 Feature
 673 =======
 674
 675 vIMS
 676 ----
 677
 678
 679 ==========
 680 References
 681 ==========
 682
 683 .. _`[1]`: Functest configuration guide URL
 684 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 685 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
 686 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
 687 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
 688 .. _`[6]`: https://wiki.opnfv.org/opnfv_test_dashboard
 689
 690
 691 OPNFV main site: opnfvmain_.
 692
 693 OPNFV functional test page: opnfvfunctest_.
 694
 695 IRC support chan: #opnfv-testperf
 696
 697 .. _opnfvmain: http://www.opnfv.org
 698 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
 699 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 700 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 701 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
 702 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml
 703