docs/userguide/index.rst

   1 =========================
   2 OPNFV FUNCTEST user guide
   3 =========================
   4
   5 .. toctree::
   6    :numbered:
   7    :maxdepth: 2
   8
   9
  10 Introduction
  11 ============
  12
  13 The goal of this documents is to describe the Functest test cases as well as
  14 provide a procedure about how to execute (or launch) them.
  15
  16 A presentation has been created for the first OPNFV Summit `[4]`_.
  17
  18 It is assumed that Functest container has been properly installed `[1]`_.
  19
  20 .. include:: ./description.rst
  21
  22 The different scenarios are described in the section hereafter.
  23
  24 VIM
  25 ---
  26
  27 vPing
  28 ^^^^^
  29
  30 The goal of this test can be described as follows::
  31
  32  vPing test case
  33  +-------------+                   +-------------+
  34  |             |                   |             |
  35  |             |     Boot VM1      |             |
  36  |             +------------------>|             |
  37  |             |                   |             |
  38  |             |     Get IP VM1    |             |
  39  |             +------------------>|             |
  40  |   Tester    |                   |   System    |
  41  |             |     Boot VM2      |    Under    |
  42  |             +------------------>|     Test    |
  43  |             |                   |             |
  44  |             |   Create (VM2)    |             |
  45  |             |   floating IP     |             |
  46  |             +------------------>|             |
  47  |             |                   |             |
  48  |             | SCP vPing script  |             |
  49  |             |      to VM2       |             |
  50  |             +------------------>|             |
  51  |             |                   |             |
  52  |             |   SSH to VM2      |             |
  53  |             +------------------>|             |
  54  |             |                   |             |
  55  |             |    Ping VM1       |             |
  56  |             |    private IP     |             |
  57  |             +------------------>|             |
  58  |             |                   |             |
  59  |             |    If ping:       |             |
  60  |             |      exit OK      |             |
  61  |             |    else (timeout) |             |
  62  |             |      exit KO      |             |
  63  |             |                   |             |
  64  +-------------+                   +-------------+
  65
  66 This example can be considered as an "Hello World" example.
  67 It is the first basic example, it must work on any configuration.
  68
  69 vPing_userdata
  70 ^^^^^^^^^^^^^^
  71
  72 The goal of this test can be described as follow::
  73
  74  vPing_userdata test case
  75  +-------------+                   +-------------+
  76  |             |                   |             |
  77  |             |     Boot VM1      |             |
  78  |             +------------------>|             |
  79  |             |                   |             |
  80  |             |     Get IP VM1    |             |
  81  |             +------------------>|             |
  82  |   Tester    |                   |   System    |
  83  |             |     Boot VM2      |    Under    |
  84  |             +------------------>|     Test    |
  85  |             | VM2 pings VM1     |             |
  86  |             |   (cloud-init)    |             |
  87  |             | Check console log |             |
  88  |             |    If ping:       |             |
  89  |             |      exit OK      |             |
  90  |             |    else (timeout) |             |
  91  |             |      exit KO      |             |
  92  |             |                   |             |
  93  +-------------+                   +-------------+
  94
  95 This scenario is similar to the previous one but it uses cloud-init (nova
  96 metadata service) instead of floating IPs and SSH.
  97
  98
  99 Tempest
 100 ^^^^^^^
 101
 102 Tempest `[2]`_ is the reference OpenStack Integration test suite.
 103 It is a set of integration tests to be run against a live OpenStack cluster.
 104 Tempest has batteries of tests for:
 105
 106   * OpenStack API validation
 107   * Scenarios
 108   * Other specific tests useful in validating an OpenStack deployment
 109
 110 We use Rally `[3]`_ to run Tempest suite.
 111 Rally generates automatically tempest.conf configuration file.
 112 Before running actual test cases Functest creates needed resources.
 113 Needed parameters are updated in the configuration file.
 114 When the Tempest suite is run, each test duration is measured.
 115 The full console output is stored in the tempest.log file.
 116
 117 As an addition of Arno, Brahmaputra runs a customized set of Tempest test cases.
 118 The list is specificed through *--tests-file* when running Rally.
 119 This option has been introduced in Rally in version 0.1.2.
 120
 121 The customized test list is available in the Functest repo `[4]`_.
 122 This list contains more than 200 Tempest test cases.
 123 The list can be divied into two main parts:
 124
 125   1) Set of tempest smoke test cases
 126   2) Set of test cases from DefCore list `[8]`_
 127
 128 The goal of Tempest test suite is to check the basic functionalities of
 129 different OpenStack components on an OPNFV fresh installation using
 130 corresponding REST API interfaces.
 131
 132
 133 Rally bench test suites
 134 ^^^^^^^^^^^^^^^^^^^^^^^
 135
 136 Rally `[3]`_ is a benchmarking tool that answers the question::
 137
 138  “How does OpenStack work at scale?”.
 139
 140 The goal of this test suite is to test the different modules of OpenStack and
 141 get significant figures that could help us to define telco Cloud KPI.
 142
 143 The OPNFV scenarios are based on the collection of the existing Rally scenarios:
 144
 145  * authenticate
 146  * cinder
 147  * glance
 148  * heat
 149  * keystone
 150  * neutron
 151  * nova
 152  * quotas
 153  * requests
 154
 155 Basic SLA (stop test on errors) have been implemented.
 156
 157
 158 SDN Controllers
 159 ---------------
 160
 161 Brahmaputra introduces new SDN controllers.
 162 There are currently 3 possible controllers:
 163
 164  * OpenDaylight (ODL)
 165  * ONOS
 166  * OpenContrail (OCL)
 167
 168 OpenDaylight
 169 ^^^^^^^^^^^^
 170
 171 The OpenDaylight (ODL) test suite consists of a set of basic tests inherited
 172 from ODL project.
 173 The suite verifies creation and deletion of networks, subnets and ports with
 174 OpenDaylight and Neutron.
 175
 176 The list of tests can be described as follow:
 177
 178  * Restconf.basic: Get the controller modules via Restconf
 179  * Neutron.Networks
 180
 181    * Check OpenStack Networks :: Checking OpenStack Neutron for known networks
 182    * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API
 183    * Create Network :: Create new network in OpenStack
 184    * Check Network :: Check Network created in OpenDaylight
 185    * Neutron.Networks :: Checking Network created in OpenStack are pushed
 186
 187  * Neutron.Subnets
 188
 189    * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets
 190    * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API
 191    * Create New subnet :: Create new subnet in OpenStack
 192    * Check New subnet :: Check new subnet created in OpenDaylight
 193    * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed
 194
 195  * Neutron.Ports
 196
 197    * Check OpenStack ports :: Checking OpenStack Neutron for known ports
 198    * Check OpenDaylight ports :: Checking OpenDaylight Neutron API
 199    * Create New Port :: Create new port in OpenStack
 200    * Check New Port :: Check new subnet created in OpenDaylight
 201    * Neutron.Ports :: Checking Port created in OpenStack are pushed
 202
 203  * Delete Ports
 204
 205    * Delete previously created subnet in OpenStack
 206    * Check subnet deleted in OpenDaylight
 207    * Check subnet deleted in OpenStack
 208
 209  * Delete network
 210
 211    * Delete previously created network in OpenStack
 212    * Check network deleted in OpenDaylight
 213    * Check network deleted in OpenStack
 214
 215
 216 ONOS
 217 ^^^^
 218
 219 TestON Framework is used to test ONOS function.
 220 The test cases deal with L2 and L3 functions.
 221 ONOS is configured through OPNFV scenario.
 222 The ONOS test suite can be run on any ONOS compliant scenario.
 223
 224 The test cases may be described as follow:
 225
 226  * onosfunctest: The mainly executable file contains the initialization of
 227    the docker environment and functions called by FUNCvirNetNB and
 228    FUNCvirNetNBL3
 229
 230  * FUNCvirNetNB
 231
 232    * Create Network: Post Network data and check it in ONOS
 233    * Update Network: Update the Network and compare it in ONOS
 234    * Delete Network: Delete the Network and check if it's NULL in ONOS or
 235      not
 236    * Create Subnet: Post Subnet data and check it in ONOS
 237    * Update Subnet: Update the Subnet and compare it in ONOS
 238    * Delete Subnet: Delete the Subnet and check if it's NULL in ONOS or not
 239    * Create Port: Post Port data and check it in ONOS
 240    * Update Port: Update the Port and compare it in ONOS
 241    * Delete Port: Delete the Port and check if it's NULL in ONOS or not
 242
 243  * FUNCvirNetNBL3
 244
 245    * Create Router: Post dataes for create Router and check it in ONOS
 246    * Update Router: Update the Router and compare it in ONOS
 247    * Delete Router: Delete the Router dataes and check it in ONOS
 248    * Create RouterInterface: Post RouterInterface data to an exist Router
 249      and check it in ONOS
 250    * Delete RouterInterface: Delete the RouterInterface and check the Router
 251    * Create FloatingIp: Post dataes for create FloatingIp and check it in
 252      ONOS
 253    * Update FloatingIp: Update the FloatingIp and compare it in ONOS
 254    * Delete FloatingIp: Delete the FloatingIp and check if it's NULL in
 255      ONOS  or not
 256    * Create External Gateway: Post dataes for create External Gateway to an
 257      exit Router and check it
 258    * Update External Gateway: Update the External Gateway and compare it
 259    * Delete External Gateway: Delete the External Gateway and check if it's
 260      NULL in ONOS or not
 261
 262
 263 OpenContrail
 264 ^^^^^^^^^^^^
 265 TODO OVNO
 266
 267
 268
 269 Features
 270 --------
 271
 272 vIMS
 273 ^^^^
 274 The goal of this test suite consists of:
 275
 276  * deploying a VNF orchestrator (cloudify)
 277  * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this
 278    orchestrator based on a TOSCA blueprint defined in `[5]`_
 279  * run suite of signaling tests on top of this VNF
 280
 281 The Clearwater architecture is described as follows:
 282
 283 .. figure:: ../images/clearwater-architecture.png
 284    :align: center
 285    :alt: vIMS architecture
 286
 287 Two types of information are stored in the Test Database:
 288
 289  * the duration of each step (orchestion deployment, VNF deployment and test)
 290  * the test results
 291
 292 The deployment of a complete functional VNF allows the test of most of the
 293 essential functions needed for a NFV system.
 294
 295 Promise
 296 ^^^^^^^
 297
 298 Promise provides a basic set of test cases as part of Brahmaputra.
 299
 300 The available 33 test cases can be grouped into 7 test suites:
 301
 302     #. Add a new OpenStack provider into resource pool: Registers
 303        OpenStack into a new resource pool and adds more capacity associated
 304        with this pool.
 305
 306     #. Allocation without reservation: Creates a new server in OpenStack
 307        and adds a new allocation record in Promise shim-layer.
 308
 309     #. Allocation using reservation for immediate use: Creates a resource
 310        reservation record with no start/end time and immediately creates a new
 311        server in OpenStack and add a new allocation record in Promise
 312        shim-layer.
 313
 314     #. Reservation for future use: Creates a resource reservation record
 315        for a future start time, queries, modifies and cancels the newly created
 316        reservation.
 317
 318     #. Capacity planning: Decreases and increases the available capacity
 319        from a provider in the future and queries the available collections and
 320        utilizations.
 321
 322     #. Reservation with conflict: Tries to create reservations for
 323        immediate and future use with conflict.
 324
 325     #. Cleanup test allocations: Destroys all allocations in OpenStack.
 326
 327
 328 The specific parameters for Promise can be found in config_functest.yaml and
 329 include::
 330
 331    promise:
 332      general:
 333          tenant_name: Name of the OpenStack tenant/project (e.g. promise)
 334          tenant_description: Description of the OpenStack tenant (e.g. promise Functionality Testing)
 335          user_name: Name of the user tenant (e.g. promiser)
 336          user_pwd: Password of the user tenant (e.g. test)
 337          image_name: Name of the software image (e.g. promise-img)
 338          flavor_name: Name of the flavor (e.g. promise-flavor with 1 vCPU and 512 MB RAM)
 339          flavor_vcpus: 1
 340          flavor_ram: 512
 341          flavor_disk: 0
 342
 343 .. include:: ./runfunctest.rst
 344
 345 Test results
 346 ============
 347
 348 VIM
 349 ---
 350
 351 vPing
 352 ^^^^^
 353
 354 vPing results are displayed in the console::
 355
 356   FUNCTEST.info: Running vPing test...
 357   2016-01-23 03:18:20,153 - vPing- INFO - Creating neutron network vping-net...
 358   2016-01-23 03:18:35,476 - vPing- INFO - Flavor found 'm1.small'
 359   2016-01-23 03:18:36,350 - vPing- INFO - vPing Start Time:'2016-01-23 03:18:36'
 360   2016-01-23 03:18:38,571 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
 361   2016-01-23 03:18:53,716 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
 362   2016-01-23 03:18:55,239 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
 363   2016-01-23 03:19:15,593 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
 364   2016-01-23 03:19:15,593 - vPing- INFO - Creating floating IP for the second VM...
 365   2016-01-23 03:19:18,017 - vPing- INFO - Floating IP created: '10.2.65.6'
 366   2016-01-23 03:19:18,017 - vPing- INFO - Associating floating ip: '10.2.65.6' to VM2
 367   2016-01-23 03:19:37,839 - vPing- INFO - SCP ping script to VM2...
 368   2016-01-23 03:19:37,839 - vPing- INFO - Waiting for ping...
 369   2016-01-23 03:19:40,130 - vPing- INFO - vPing detected!
 370   2016-01-23 03:19:40,130 - vPing- INFO - vPing duration:'63.8'
 371   2016-01-23 03:19:40,130 - vPing- INFO - Cleaning up...
 372   2016-01-23 03:20:06,574 - vPing- INFO - Deleting network 'vping-net'...
 373   2016-01-23 03:20:13,587 - vPing- INFO - vPing OK
 374
 375
 376
 377
 378 vPing_userdata
 379 ^^^^^^^^^^^^^^
 380
 381 vPing_userdata results are displayed in the console::
 382
 383     2016-01-06 16:06:20,550 - vPing- INFO - Creating neutron network vping-net...
 384     2016-01-06 16:06:23,867 - vPing- INFO - Flavor found 'm1.small'
 385     2016-01-06 16:06:24,457 - vPing- INFO - vPing Start Time:'2016-01-06 16:06:24'
 386     2016-01-06 16:06:24,626 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
 387     2016-01-06 16:06:39,351 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
 388     2016-01-06 16:06:39,650 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
 389     2016-01-06 16:06:53,330 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
 390     2016-01-06 16:06:53,330 - vPing- INFO - Waiting for ping...
 391     2016-01-06 16:06:58,669 - vPing- INFO - vPing detected!
 392     2016-01-06 16:06:58,669 - vPing- INFO - vPing duration:'34.2'
 393     2016-01-06 16:06:58,670 - vPing- INFO - Cleaning up...
 394     2016-01-06 16:07:12,661 - vPing- INFO - Deleting network 'vping-net'...
 395     2016-01-06 16:07:14,748 - vPing- INFO - vPing OK
 396
 397 Tempest
 398 ^^^^^^^
 399
 400 The Tempest results are displayed in the console::
 401
 402   FUNCTEST.info: Running Tempest tests...
 403   2016-01-28 07:56:55,380 - run_tempest - INFO - Creating tenant and user for Tempest suite
 404   2016-01-28 07:56:56.127 23795 INFO rally.verification.tempest.tempest [-] Starting: Creating configuration file for Tempest.
 405   2016-01-28 07:56:59.512 23795 INFO rally.verification.tempest.tempest [-] Completed: Creating configuration file for Tempest.
 406   16-01-28 07:57:00,597 - run_tempest - INFO - Starting Tempest test suite: '--tests-file /home/opnfv/repos/functest/testcases/VIM/OpenStack/CI/custom_tests/test_list.txt'.
 407   Total results of verification:
 408   .
 409   +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 410   | UUID                                 | Deployment UUID                      | Set name | Tests | Failures | Created at                 | Status   |
 411   +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 412   | e0bf7770-2c0f-4c63-913c-cd51a6edd96d | 16582e1e-7b01-4d5d-9c13-a26db8567b7b |          | 144   | 30       | 2016-01-28 07:57:01.044856 | finished |
 413   +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 414   .
 415   Tests:
 416   .
 417   +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
 418   | name                                                                                                                                     | time      | status  |
 419   +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
 420   | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor                                                               | 0.29804   | success |
 421   | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors                                                             | 0.06289   | success |
 422   | tempest.api.compute.images.test_images.ImagesTestJSON.test_delete_saving_image                                                           | 9.21756   | success |
 423   | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_delete_image                                        | 8.65376   | success |
 424   | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_image_specify_multibyte_character_image_name        | 9.10993   | success |
 425   | tempest.api.compute.images.test_list_image_filters.ListImageFiltersTestJSON.test_list_images_filter_by_changes_since                     | 0.19585   | success |
 426   ...........................................
 427   2016-01-28 08:19:32,132 - run_tempest - INFO - Results: {'timestart': '2016-01-2807:57:01.044856', 'duration': 1350, 'tests': 144, 'failures': 30}
 428   2016-01-28 08:19:32,133 - run_tempest - INFO - Pushing results to DB: 'http://testresults.opnfv.org/testapi/results'.
 429   2016-01-28 08:19:32,278 - run_tempest - INFO - Deleting tenant and user for Tempest suite)
 430
 431 In order to check all the available test cases related debug information, please
 432 inspect tempest.log file stored into related Rally deployment folder.
 433
 434
 435 Rally
 436 ^^^^^
 437
 438 The Rally results are displayed in the console, each module is run one after the
 439 other. Tables are displayed::
 440
 441   +-------------------------------------------------------------------------------------------+
 442   |                                   Response Times (sec)                                    |
 443   +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 444   | action               | min   | median | 90%ile | 95%ile | max   | avg   | success | count |
 445   +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 446   | keystone.create_role | 0.358 | 0.572  | 0.772  | 0.811  | 1.106 | 0.603 | 100.0%  | 20    |
 447   | keystone.add_role    | 0.32  | 0.436  | 0.846  | 0.903  | 1.018 | 0.51  | 100.0%  | 20    |
 448   | keystone.list_roles  | 0.102 | 0.185  | 0.253  | 0.275  | 0.347 | 0.188 | 100.0%  | 20    |
 449   | total                | 0.845 | 1.223  | 1.821  | 1.822  | 1.823 | 1.302 | 100.0%  | 20    |
 450   +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 451   Load duration: 7.13633608818
 452   Full duration: 36.7863121033
 453   ..............
 454   +------------------------------------------------------------------------------------------+
 455   |                                   Response Times (sec)                                   |
 456   +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 457   | action              | min   | median | 90%ile | 95%ile | max   | avg   | success | count |
 458   +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 459   | nova.create_keypair | 1.005 | 1.784  | 3.025  | 3.636  | 4.373 | 2.004 | 100.0%  | 20    |
 460   | nova.delete_keypair | 0.199 | 0.699  | 1.007  | 1.244  | 3.014 | 0.79  | 100.0%  | 20    |
 461   | total               | 1.249 | 2.625  | 4.259  | 4.845  | 5.131 | 2.794 | 100.0%  | 20    |
 462   +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 463   Load duration: 14.9231169224
 464   Full duration: 71.4614388943
 465
 466
 467 At the end of the module test, a message is displayed to provide a global
 468 summary::
 469
 470   2016-02-04 12:50:18,382 - run_rally - INFO - Test scenario: "requests" OK.
 471
 472
 473 Controllers
 474 -----------
 475
 476 OpenDaylight
 477 ^^^^^^^^^^^^
 478
 479 The results of ODL tests can be seen in the console::
 480
 481  ==============================================================================
 482  Basic
 483  ==============================================================================
 484  Basic.010 Restconf OK :: Test suite to verify Restconf is OK
 485  ==============================================================================
 486  Get Controller Modules :: Get the controller modules via Restconf     | PASS |
 487  ------------------------------------------------------------------------------
 488  Basic.010 Restconf OK :: Test suite to verify Restconf is OK          | PASS |
 489  1 critical test, 1 passed, 0 failed
 490  1 test total, 1 passed, 0 failed
 491  ==============================================================================
 492  Basic                                                                 | PASS |
 493  1 critical test, 1 passed, 0 failed
 494  1 test total, 1 passed, 0 failed
 495  ==============================================================================
 496  Output:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
 497  Log:     /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
 498  Report:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
 499
 500  ..............................................................................
 501
 502  Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | PASS |
 503  2 critical tests, 2 passed, 0 failed
 504  2 tests total, 2 passed, 0 failed
 505  ==============================================================================
 506  Neutron :: Test suite for Neutron Plugin                              | PASS |
 507  18 critical tests, 18 passed, 0 failed
 508  18 tests total, 18 passed, 0 failed
 509  ==============================================================================
 510  Output:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
 511  Log:     /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
 512  Report:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
 513
 514 3 result files are generated:
 515  * output.xml
 516  * log.html
 517  * report.html
 518
 519 **ODL result page**
 520
 521 .. figure:: ../images/functestODL.png
 522    :width: 170mm
 523    :align: center
 524    :alt: ODL suite result page
 525
 526
 527 ONOS
 528 ^^^^
 529
 530 The ONOS test logs can be found in OnosSystemTest/, and TestON/, and logs/
 531 (ONOSCI_PATH to be added), and can also be seen in the console::
 532
 533  ******************************
 534  Result summary for Testcase4
 535  ******************************
 536
 537  2016-01-14 05:25:40,529 - FUNCvirNetNBL3 - INFO - ONOS Router Delete test Start
 538
 539  [2016-01-14 05:25:40.529644] [FUNCvirNetNBL3] [CASE]  Virtual Network NBI Test - Router
 540  2016-01-14 05:25:40,530 - FUNCvirNetNBL3 - INFO - Generate Post Data
 541
 542  [2016-01-14 05:25:40.530825] [FUNCvirNetNBL3] [STEP]  4.1: Post Network Data via HTTP(Post Router need post network)
 543  2016-01-14 05:25:40,531 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/networks/ using POST method.
 544  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 545  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Post Network Success
 546  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Assertion Passed
 547
 548  [2016-01-14 05:25:40.539687] [FUNCvirNetNBL3] [STEP]  4.2: Post Router Data via HTTP
 549  2016-01-14 05:25:40,540 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/ using POST method.
 550  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 551  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Post Router Success
 552  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Assertion Passed
 553
 554  [2016-01-14 05:25:40.543489] [FUNCvirNetNBL3] [STEP]  4.3: Delete Router Data via HTTP
 555  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.
 556  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 557  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Delete Router Success
 558  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Assertion Passed
 559
 560  [2016-01-14 05:25:40.546774] [FUNCvirNetNBL3] [STEP]  4.4: Get Router Data is NULL
 561  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.
 562  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 563  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Get Router Success
 564  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Assertion Passed
 565
 566
 567  *****************************
 568   Result: Pass
 569  *****************************
 570
 571  .......................................................................................
 572
 573  ******************************
 574   Result summary for Testcase9
 575  ******************************
 576  .......................................................................................
 577
 578
 579  [2016-01-14 05:26:42.543489] [FUNCvirNetNBL3] [STEP]  9.6: FloatingIp Clean Data via HTTP
 580  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.
 581  2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 582  2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - ERROR - Delete Floatingip failed
 583
 584  .......................................................................................
 585
 586  *****************************
 587   Result: Failed
 588  *****************************
 589
 590 There is a result summary for each testcase, and a global summary for the whole test.
 591 If any problem occurs during the test, a ERROR message will be provided in the test and the the global summary::
 592
 593  *************************************
 594          Test Execution Summary
 595  *************************************
 596
 597   Test Start           : 14 Jan 2016 05:25:37
 598   Test End             : 14 Jan 2016 05:25:41
 599   Execution Time       : 0:00:03.349087
 600   Total tests planned  : 11
 601   Total tests RUN      : 11
 602   Total Pass           : 8
 603   Total Fail           : 3
 604   Total No Result      : 0
 605   Success Percentage   : 72%
 606   Execution Result     : 100%
 607
 608
 609 OpenContrail
 610 ^^^^^^^^^^^^
 611
 612 TODO OVNO
 613
 614
 615 Feature
 616 -------
 617
 618 vIMS
 619 ^^^^
 620
 621 The results in the console can be described as follows::
 622
 623     FUNCTEST.info: Running vIMS test...
 624     2016-02-04 13:46:25,025 - vIMS - INFO - Prepare OpenStack plateform (create tenant and user)
 625     2016-02-04 13:46:25,312 - vIMS - INFO - Update OpenStack creds informations
 626     2016-02-04 13:46:25,312 - vIMS - INFO - Upload some OS images if it doesn't exist
 627     2016-02-04 13:46:25,566 - vIMS - INFO - centos_7 image doesn't exist on glance repository.
 628                                 Try downloading this image and upload on glance !
 629     2016-02-04 13:47:06,167 - vIMS - INFO - ubuntu_14.04 image doesn't exist on glance repository.
 630                                 Try downloading this image and upload on glance !
 631     2016-02-04 13:47:26,987 - vIMS - INFO - Update security group quota for this tenant
 632     2016-02-04 13:47:27,193 - vIMS - INFO - Update cinder quota for this tenant
 633     2016-02-04 13:47:27,746 - vIMS - INFO - Collect flavor id for cloudify manager server
 634     2016-02-04 13:47:28,326 - vIMS - INFO - Prepare virtualenv for cloudify-cli
 635     2016-02-04 13:48:00,657 - vIMS - INFO - Downloading the cloudify manager server blueprint
 636     2016-02-04 13:48:03,391 - vIMS - INFO - Cloudify deployment Start Time:'2016-02-04 13:48:03'
 637     2016-02-04 13:48:03,391 - vIMS - INFO - Writing the inputs file
 638     2016-02-04 13:48:03,395 - vIMS - INFO - Launching the cloudify-manager deployment
 639     2016-02-04 13:56:03,501 - vIMS - INFO - Cloudify-manager server is UP !
 640     2016-02-04 13:56:03,502 - vIMS - INFO - Cloudify deployment duration:'480.1'
 641     2016-02-04 13:56:03,502 - vIMS - INFO - Collect flavor id for all clearwater vm
 642     2016-02-04 13:56:04,093 - vIMS - INFO - vIMS VNF deployment Start Time:'2016-02-04 13:56:04'
 643     2016-02-04 13:56:04,093 - vIMS - INFO - Downloading the openstack-blueprint.yaml blueprint
 644     2016-02-04 13:56:06,265 - vIMS - INFO - Writing the inputs file
 645     2016-02-04 13:56:06,268 - vIMS - INFO - Launching the clearwater deployment
 646     2016-02-04 14:11:27,101 - vIMS - INFO - The deployment of clearwater-opnfv is ended
 647     2016-02-04 14:11:27,103 - vIMS - INFO - vIMS VNF deployment duration:'923.0'
 648     2016-02-04 14:14:31,976 - vIMS - INFO - vIMS functional test Start Time:'2016-02-04 14:14:31'
 649     2016-02-04 14:15:45,880 - vIMS - INFO - vIMS functional test duration:'73.9'
 650     2016-02-04 14:15:46,113 - vIMS - INFO - Launching the clearwater-opnfv undeployment
 651     2016-02-04 14:18:12,604 - vIMS - INFO - Launching the cloudify-manager undeployment
 652     2016-02-04 14:18:51,808 - vIMS - INFO - Cloudify-manager server has been successfully removed!
 653     2016-02-04 14:18:51,870 - vIMS - INFO - Removing vIMS tenant ..
 654     2016-02-04 14:18:52,131 - vIMS - INFO - Removing vIMS user ..
 655
 656 Please note that vIMS traces can bee summarized in several steps:
 657
 658  * INFO: environment prepared successfully => environment OK
 659  * INFO - Cloudify-manager server is UP ! => orchestrator deployed
 660  * INFO - The deployment of clearwater-opnfv is ended => VNF deployed
 661  * Multiple Identities (UDP) - (6505550771, 6505550675) Passed => tests run
 662  * DEBUG - Pushing results to DB.... => tests saved
 663
 664
 665 Promise
 666 ^^^^^^^
 667
 668 The results can be observed in the console::
 669
 670     Running test case: promise
 671     ----------------------------------------------
 672     FUNCTEST.info: Running PROMISE test case...
 673     2016-02-04 07:10:37,735 - Promise- INFO - Creating tenant 'promise'...
 674     2016-02-04 07:10:37,893 - Promise- INFO - Adding role '59828986a9a94dfaa852548599fde628' to tenant 'promise'...
 675     2016-02-04 07:10:38,005 - Promise- INFO - Creating user 'promiser'...
 676     2016-02-04 07:10:38,128 - Promise- INFO - Updating OpenStack credentials...
 677     2016-02-04 07:10:38,157 - Promise- INFO - Creating image 'promise-img' from '/home/opnfv/functest/data/cirros-0.3.4-x86_64-disk.img'...
 678     2016-02-04 07:10:42,016 - Promise- INFO - Creating flavor 'promise-flavor'...
 679     2016-02-04 07:10:42,836 - Promise- INFO - Exporting environment variables...
 680     2016-02-04 07:10:42,836 - Promise- INFO - Running command: DEBUG=1 npm run -s test -- --reporter json
 681     2016-02-04 07:10:51,505 - Promise- INFO - The test succeeded.
 682     ....
 683     **********************************
 684         Promise test summary
 685     **********************************
 686     Test start: Thu Feb 04 07:10:42 UTC 2016
 687     Test end: Thu Feb 04 07:10:51 UTC 2016
 688     Execution time: 8.7
 689     Total tests executed: 33
 690     Total tests failed: 0
 691     **********************************
 692
 693
 694 Test Dashboard
 695 ==============
 696
 697 Based on results collected in CI, a test dashboard is dynamically generated.
 698 The URL of this dashboard is TODO LF
 699
 700
 701 Troubleshooting
 702 ===============
 703
 704 VIM
 705 ---
 706
 707 vPing
 708 ^^^^^
 709
 710 vPing should work on all the scenarios. In case of timeout, check your network
 711 connectivity. The test case creates its own security group to allow SSH access,
 712 check your network settings and your security rules.
 713
 714
 715 vPing_userdata
 716 ^^^^^^^^^^^^^^
 717
 718 Cloud-init in not supported on scenario dealing with ONOS.
 719
 720 Tempest
 721 ^^^^^^^
 722
 723 In the upstream OpenStack CI all the Tempest test cases are supposed to pass.
 724 If some test cases fail in an OPNFV deployment, the reason is very probably one
 725 of the following::
 726
 727  +-----------------------------+------------------------------------------------+
 728  | Error                       | Details                                        |
 729  +=============================+================================================+
 730  | Resources required for test | Such resources could be e.g. an external       |
 731  | case execution are missing  | network and access to the management subnet    |
 732  |                             | (adminURL) from the Functest docker container. |
 733  +-----------------------------+------------------------------------------------+
 734  | OpenStack components or     | Check running services in the controller and   |
 735  | services are missing or not | compute nodes (e.g. with "systemctl" or        |
 736  | configured properly         | "service" commands). Configuration parameters  |
 737  |                             | can be verified from related .conf files       |
 738  |                             | located under /etc/<component> directories.    |
 739  +-----------------------------+------------------------------------------------+
 740  | Some resources required for | The tempest.conf file, automatically generated |
 741  | execution test cases are    | by Rally in Functest, does not contain all the |
 742  | missing                     | needed parameters or some parameters are not   |
 743  |                             | set properly.                                  |
 744  |                             | The tempest.conf file is located in /home/opnfv|
 745  |                             | /.rally/tempest/for-deployment-<UUID> in       |
 746  |                             | Functest container                             |
 747  |                             | Use "rally deployment list" command in order to|
 748  |                             | check UUID of current deployment.              |
 749  +-----------------------------+------------------------------------------------+
 750
 751
 752 When some Tempest test case fails, captured traceback and possibly also related
 753 REST API requests/responses are output to the console.
 754 More detailed debug information can be found from tempest.log file stored into
 755 related Rally deployment folder.
 756
 757
 758 Rally
 759 ^^^^^
 760
 761 Same error causes than for Tempest mentioned above may lead to error in Rally.
 762
 763 Controllers
 764 -----------
 765
 766 ODL
 767 ^^^
 768 2 versions are supported in Brahmaputra depending on the scenario:
 769  * Lithium
 770  * Berylium
 771
 772 The upstream test suites have not been adapted, so you may get 18 or 15 tests
 773 passed on 18 depending on your configuration. The 3 testcases are partly failed
 774 due to wrong return code.
 775
 776 ONOS
 777 ^^^^
 778
 779 TODO
 780
 781 OpenContrail
 782 ^^^^^^^^^^^^
 783
 784
 785 Feature
 786 -------
 787
 788 vIMS
 789 ^^^^
 790 vIMS deployment may fail for several reasons, the most frequent ones are
 791 described in the following table:
 792
 793 +===================================+====================================+
 794 | Error                             |  Comments                          |
 795 +-----------------------------------+------------------------------------+
 796 | Keystone admin API  not reachable | Impossible to create vIMS user and |
 797 |                                   | tenant                             |
 798 +-----------------------------------+------------------------------------+
 799 | Impossible to retrieve admin role | Impossible to create vIMS user and |
 800 | id                                | tenant                             |
 801 +-----------------------------------+------------------------------------+
 802 | Error when uploading image from   | impossible to deploy VNF           |
 803 | OpenStack to glance               |                                    |
 804 +-----------------------------------+------------------------------------+
 805 | Cinder quota cannot be updated    | Default quotas not sufficient, they|
 806 |                                   | are adapted in the script          |
 807 +-----------------------------------+------------------------------------+
 808 | Impossible to create a volume     | VNF cannot be deployed             |
 809 +-----------------------------------+------------------------------------+
 810 | SSH connection issue between the  | if vPing test fails, vIMS test will|
 811 | Test container and the VM         | fail...                            |
 812 +-----------------------------------+------------------------------------+
 813 | No Internet access from a VM      | the VMs of the VNF must have an    |
 814 |                                   | external access to Internet        |
 815 +-----------------------------------+------------------------------------+
 816
 817
 818 Promise
 819 ^^^^^^^
 820
 821 TODO
 822
 823 References
 824 ==========
 825
 826 .. _`[1]`: Functest configuration guide URL
 827 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 828 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
 829 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
 830 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
 831 .. _`[6]`: https://wiki.opnfv.org/opnfv_test_dashboard
 832 .. _`[7]`: http://testresults.opnfv.org/testapi/test_projects/functest/cases
 833 .. _`[8]`: https://wiki.openstack.org/wiki/Governance/DefCoreCommittee
 834 .. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml
 835 .. _`[10]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/rally_cert/task.yaml
 836
 837 OPNFV main site: opnfvmain_.
 838
 839 OPNFV functional test page: opnfvfunctest_.
 840
 841 IRC support chan: #opnfv-testperf
 842
 843 .. _opnfvmain: http://www.opnfv.org
 844 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
 845 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
 846 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
 847 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
 848 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml