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 documents is to describe the Functest test cases as well as
  15 provide a procedure about how to execute (or launch) them.
  16
  17 A presentation has been created for the first OPNFV Summit: `[4]`
  18
  19 It is assumed that Functest container has been properly installed `[1]`_.
  20
  21
  22 =============================
  23 Description of the test cases
  24 =============================
  25
  26 Functest is an OPNFV project dedicated to functional testing.
  27 In the continuous integration, it is launched after an OPNFV fresh installation.
  28 The Functest target is to verify the basic functions of the infrastructure.
  29
  30 Functest includes different test suites which several test cases within.
  31 Test cases are developed in Functest and in feature projects.
  32
  33 The current list of test suites can be distributed in 3 main domains:
  34
  35 +----------------+----------------+--------------------------------------------+
  36 | Method         | Test suite     | Comments                                   |
  37 +================+================+============================================+
  38 |                | vPing          | NFV "Hello World"                          |
  39 |                +----------------+--------------------------------------------+
  40 |    VIM         | vPing_userdata | Ping using userdata and cloud-init         |
  41 |                |                | mechanism                                  |
  42 |                +----------------+--------------------------------------------+
  43 |(Virtualised    | Tempest        | OpenStack reference test suite `[2]`_      |
  44 | Infrastructure +----------------+--------------------------------------------+
  45 | Manager)       | Rally scenario | OpenStack testing tool testing OpenStack   |
  46 |                |                | modules `[3]`_                             |
  47 +----------------+----------------+--------------------------------------------+
  48 |                | OpenDaylight   | Opendaylight Test suite                    |
  49 |                +----------------+--------------------------------------------+
  50 | Controllers    | ONOS           | Test suite of ONOS L2 and L3 functions     |
  51 |                +----------------+--------------------------------------------+
  52 |                | OpenContrail   |                                            |
  53 +----------------+----------------+--------------------------------------------+
  54 | Features       | vIMS           | Show the capability to deploy a real NFV   |
  55 |                |                | test cases.                                |
  56 |                |                | The IP Multimedia Subsytem is a typical    |
  57 |                |                | Telco test case, referenced by ETSI.       |
  58 |                |                | It provides a fully functional VoIP System.|
  59 |                +----------------+--------------------------------------------+
  60 |                | Promise        | Resource reservation and management project|
  61 |                |                | to identify NFV related requirements and   |
  62 |                |                | realize resource reservation for future    |
  63 |                |                | usage by capacity management of resource   |
  64 |                |                | pools regarding compute, network and       |
  65 |                |                | storage.                                   |
  66 |                +----------------+--------------------------------------------+
  67 |                | SDNVPN         |                                            |
  68 +----------------+----------------+--------------------------------------------+
  69
  70
  71 Most of the test suites are developed upstream.
  72 For example, Tempest `[2]`_ is the OpenStack integration test suite.
  73 Functest is in charge of the integration of different functional test suites.
  74
  75 The Tempest suite has been customized but no new test cases have been created.
  76 Some OPNFV feature projects (.e.g. SDNVPN) have created Tempest tests cases and
  77 pushed to upstream.
  78
  79 The tests run from CI are pushed into a database.
  80 The goal is to populate the database with results and to show them on a Test
  81 Dashboard.
  82
  83 There is no real notion of Test domain or Test coverage yet.
  84 Basic components (VIM, controllers) are tested through their own suites.
  85 Feature projects also provide their own test suites.
  86
  87 vIMS test case was integrated to demonstrate the capability to deploy a
  88 relatively complex NFV scenario on top of the OPNFV infrastructure.
  89
  90 Functest considers OPNFV as a black box.
  91 OPNFV, since Brahmaputra, offers lots of possible combinations:
  92
  93   * 3 controllers (OpenDayligh, ONOS, OpenContrail)
  94   * 4 installers (Apex, Compass, Fuel, Joid)
  95
  96 However most of the tests shall be runnable on any configuration.
  97
  98 The different scenarios are described in the section hereafter.
  99
 100 VIM
 101 ===
 102
 103 vPing
 104 -----
 105
 106 The goal of this test can be described as follows::
 107
 108  vPing test case
 109  +-------------+                   +-------------+
 110  |             |                   |             |
 111  |             |     Boot VM1      |             |
 112  |             +------------------>|             |
 113  |             |                   |             |
 114  |             |     Get IP VM1    |             |
 115  |             +------------------>|             |
 116  |   Tester    |                   |   System    |
 117  |             |     Boot VM2      |    Under    |
 118  |             +------------------>|     Test    |
 119  |             |                   |             |
 120  |             |   Create (VM2)    |             |
 121  |             |   floating IP     |             |
 122  |             +------------------>|             |
 123  |             |                   |             |
 124  |             | SCP vPing script  |             |
 125  |             |      to VM2       |             |
 126  |             +------------------>|             |
 127  |             |                   |             |
 128  |             |   SSH to VM2      |             |
 129  |             +------------------>|             |
 130  |             |                   |             |
 131  |             |    Ping VM1       |             |
 132  |             |    private IP     |             |
 133  |             +------------------>|             |
 134  |             |                   |             |
 135  |             |    If ping:       |             |
 136  |             |      exit OK      |             |
 137  |             |    else (timeout) |             |
 138  |             |      exit KO      |             |
 139  |             |                   |             |
 140  +-------------+                   +-------------+
 141
 142
 143 vPing_userdata
 144 --------------
 145
 146 The goal of this test can be described as follow::
 147
 148  vPing_userdata test case
 149  +-------------+                   +-------------+
 150  |             |                   |             |
 151  |             |     Boot VM1      |             |
 152  |             +------------------>|             |
 153  |             |                   |             |
 154  |             |     Get IP VM1    |             |
 155  |             +------------------>|             |
 156  |   Tester    |                   |   System    |
 157  |             |     Boot VM2      |    Under    |
 158  |             +------------------>|     Test    |
 159  |             | VM2 pings VM1     |             |
 160  |             |   (cloud-init)    |             |
 161  |             | Check console log |             |
 162  |             |    If ping:       |             |
 163  |             |      exit OK      |             |
 164  |             |    else (timeout) |             |
 165  |             |      exit KO      |             |
 166  |             |                   |             |
 167  +-------------+                   +-------------+
 168
 169
 170 This example can be considered as an "Hello World" example.
 171 It is the first basic example, it must work on any configuration.
 172
 173 Tempest
 174 -------
 175
 176 Tempest `[2]`_ is the reference OpenStack Integration test suite.
 177 It is a set of integration tests to be run against a live OpenStack cluster.
 178 Tempest has batteries of tests for:
 179
 180   * OpenStack API validation
 181   * Scenarios
 182   * other specific tests useful in validating an OpenStack deployment
 183
 184 We use Rally `[3]`_ to run Tempest suite.
 185 Rally generates automatically tempest.conf configuration file.
 186 Before running actual test cases Functest creates needed resources.
 187 Needed parameters are updated in the configuration file.
 188 When the Tempest suite is run, each test duration is measured.
 189 The full console output is stored in the tempest.log file.
 190
 191 As an addition of Arno, Brahmaputra runs a customized set of Tempest test cases.
 192 The list is specificed through --tests-file when running Rally.
 193 This option has been introduced in Rally in version 0.1.2.
 194
 195 The customized test list is available in the Functest repo `[4]`_
 196 This list contains more than 200 Tempest test cases.
 197 The list can be divied into two main parts:
 198
 199   1) Set of tempest smoke test cases
 200   2) Set of test cases from DefCore list `[8]`_
 201
 202 The goal of Tempest test suite is to check the basic functionalities of
 203 different OpenStack components on an OPNFV fresh installation using
 204 corresponding REST API interfaces.
 205
 206
 207 Rally bench test suites
 208 -----------------------
 209
 210 Rally `[3]`_ is a benchmarking tool that answers the question::
 211
 212  “How does OpenStack work at scale?”.
 213
 214 The goal of this test suite is to test the different modules of OpenStack and
 215 get significant figures that could help us to define telco Cloud KPI.
 216
 217 The OPNFV scenarios are based on the collection of the existing Rally scenarios:
 218
 219  * authenticate
 220  * cinder
 221  * glance
 222  * heat
 223  * keystone
 224  * neutron
 225  * nova
 226  * quotas
 227  * requests
 228  * vm
 229
 230 Basic SLA (stop test on errors) have been implemented.
 231
 232
 233 SDN Controllers
 234 ===============
 235
 236 Brahmaputra introduces new SDN controllers.
 237 There are currently 3 possible controllers:
 238
 239  * OpenDaylight (ODL)
 240  * ONOS
 241  * OpenContrail (OCL)
 242
 243 OpenDaylight
 244 ------------
 245
 246 The OpenDaylight (ODL) test suite consists of a set of basic tests inherited
 247 from ODL project.
 248 The suite verifies creation and deletion of networks, subnets and ports with
 249 OpenDaylight and Neutron.
 250
 251 The list of tests can be described as follow:
 252
 253  * Restconf.basic: Get the controller modules via Restconf
 254  * Neutron.Networks
 255
 256    * Check OpenStack Networks :: Checking OpenStack Neutron for known networks
 257    * Check OpenDaylight Networks :: Checking OpenDaylight Neutron API
 258    * Create Network :: Create new network in OpenStack
 259    * Check Network :: Check Network created in OpenDaylight
 260    * Neutron.Networks :: Checking Network created in OpenStack are pushed
 261
 262  * Neutron.Subnets
 263
 264    * Check OpenStack Subnets :: Checking OpenStack Neutron for known Subnets
 265    * Check OpenDaylight subnets :: Checking OpenDaylight Neutron API
 266    * Create New subnet :: Create new subnet in OpenStack
 267    * Check New subnet :: Check new subnet created in OpenDaylight
 268    * Neutron.Subnets :: Checking Subnets created in OpenStack are pushed
 269
 270  * Neutron.Ports
 271
 272    * Check OpenStack ports :: Checking OpenStack Neutron for known ports
 273    * Check OpenDaylight ports :: Checking OpenDaylight Neutron API
 274    * Create New Port :: Create new port in OpenStack
 275    * Check New Port :: Check new subnet created in OpenDaylight
 276    * Neutron.Ports :: Checking Port created in OpenStack are pushed
 277
 278  * Delete Ports
 279
 280    * Delete previously created subnet in OpenStack
 281    * Check subnet deleted in OpenDaylight
 282    * Check subnet deleted in OpenStack
 283
 284  * Delete network
 285
 286    * Delete previously created network in OpenStack
 287    * Check network deleted in OpenDaylight
 288    * Check network deleted in OpenStack
 289
 290
 291 ONOS
 292 ----
 293
 294 TestON Framework is used to test ONOS function.
 295 The test cases deal with L2 and L3 functions.
 296 ONOS is configured through OPNFV scenario.
 297 The ONOS test suite can be run on any ONOS compliant scenario.
 298
 299 The test cases may be described as follow:
 300
 301  * onosfunctest: The mainly executable file contains the initialization of the
 302  docker environment and functions called by FUNCvirNetNB and FUNCvirNetNBL3
 303  * FUNCvirNetNB
 304
 305    * Create Network :: Post Network data and check it in ONOS
 306    * Update Network :: Update the Network and compare it in ONOS
 307    * Delete Network :: Delete the Network and check if it's NULL in ONOS or not
 308    * Create Subnet :: Post Subnet data and check it in ONOS
 309    * Update Subnet :: Update the Subnet and compare it in ONOS
 310    * Delete Subnet :: Delete the Subnet and check if it's NULL in ONOS or not
 311    * Create Port :: Post Port data and check it in ONOS
 312    * Update Port :: Update the Port and compare it in ONOS
 313    * Delete Port :: Delete the Port and check if it's NULL in ONOS or not
 314
 315  * FUNCvirNetNBL3
 316
 317    * Create Router :: Post dataes for create Router and check it in ONOS
 318    * Update Router :: Update the Router and compare it in ONOS
 319    * Delete Router :: Delete the Router dataes and check it in ONOS
 320    * Create RouterInterface :: Post RouterInterface data to an exist Router and
 321    check it in ONOS
 322    * Delete RouterInterface :: Delete the RouterInterface and check the Router
 323    * Create FloatingIp :: Post dataes for create FloatingIp and check it in ONOS
 324    * Update FloatingIp :: Update the FloatingIp and compare it in ONOS
 325    * Delete FloatingIp :: Delete the FloatingIp and check if it's NULL in ONOS
 326    or not
 327    * Create External Gateway :: Post dataes for create External Gateway to an
 328    exit Router and check it
 329    * Update External Gateway :: Update the External Gateway and compare it
 330    * Delete External Gateway :: Delete the External Gateway and check if it's
 331    NULL in ONOS or not
 332
 333
 334 OpenContrail
 335 ------------
 336 TODO OVNO
 337
 338
 339
 340 Features
 341 ========
 342
 343 vIMS
 344 ----
 345 The goal of this test suite consists of:
 346  * deploying a VNF orchestrator (cloudify)
 347  * deploy a Clearwater vIMS (IP Multimedia Subsystem) VNF from this orchestrator
 348  based on a TOSCA blueprint defined in `[5]`_
 349  * run suite of signaling tests on top of this VNF
 350
 351 The Clearwater architecture is described as follows:
 352
 353 .. figure:: ../images/clearwater-architecture.png
 354    :align: center
 355    :alt: vIMS architecture
 356
 357 Two types of information are stored in the Test Database:
 358
 359  * the duration of each step (orchestion deployment, VNF deployment and test)
 360  * the test results
 361
 362 The deployment of a complete functional VNF allows the test of most of the
 363 essential functions needed for a NFV system.
 364
 365 Promise
 366 -------
 367
 368 TODO promise
 369
 370
 371 ==============
 372 Manual testing
 373 ==============
 374
 375 Once the Functest docker container is running and Functest environment ready
 376 (through /home/opnfv/repos/functest/docker/prepare_env.sh script), the system is
 377 ready to run the tests.
 378
 379 The script run_tests.sh is located in $repos_dir/functest/docker and it has
 380 several options::
 381
 382     ./run_tests.sh -h
 383     Script to trigger the tests automatically.
 384
 385     usage:
 386         bash run_tests.sh [--offline] [-h|--help] [-t <test_name>]
 387
 388     where:
 389         -h|--help         show this help text
 390         -r|--report       push results to database (false by default)
 391         -n|--no-clean     do not clean up OpenStack resources after test run
 392         -t|--test         run specific set of tests
 393           <test_name>     one or more of the following: vping,vping_userdata,odl,rally,tempest,vims,onos,promise. Separated by comma.
 394
 395     examples:
 396         run_tests.sh
 397         run_tests.sh --test vping,odl
 398         run_tests.sh -t tempest,rally --no-clean
 399
 400 The -r option is used by the Continuous Integration in order to push the test
 401 results into a test collection database, see in next section for details.
 402 In manual mode, you must not use it, your try will be anyway probably rejected
 403 as your POD must be declared in the database to collect the data.
 404
 405 The -n option is used for preserving all the existing OpenStack resources after
 406 execution test cases.
 407
 408 The -t option can be used to specify the list of test you want to launch, by
 409 default Functest will try to launch all its test suites in the following order
 410 vPing, odl, Tempest, vIMS, Rally.
 411 You may launch only one single test by using -t <the test you want to launch>
 412
 413 Within Tempest test suite you can define which test cases you want to execute in
 414 your environment by editing test_list.txt file before executing run_tests.sh
 415 script.
 416
 417 Please note that Functest includes cleaning mechanism in order to remove
 418 everything except what was present after a fresh install.
 419 If you create your own VMs, tenants, networks etc. and then launch Functest,
 420 they all will be deleted after executing the tests. Use --no-clean option with
 421 run_test.sh in order to preserve all the existing resources.
 422 However, be aware that Tempest and Rally create of lot of resources (users,
 423 tenants, networks, volumes etc.) that are not always properly cleaned, so this
 424 cleaning function has been set to keep the system as clean as possible after a
 425 full Functest run.
 426
 427 You may also add you own test by adding a section into the function run_test()
 428
 429
 430 =================
 431 Automated testing
 432 =================
 433
 434 As mentioned in `[1]`, the prepare-env.sh and run_test.sh can be executed within
 435 the container from jenkins.
 436 2 jobs have been created, one to run all the test and one that allows testing
 437 test suite by test suite.
 438 You thus just have to launch the acurate jenkins job on the target lab, all the
 439 tests shall be automatically run.
 440
 441 When the tests are automatically started from CI, a basic algorithm has been
 442 created in order to detect whether the test is runnable or not on the given
 443 scenario.
 444 In fact, one of the most challenging task in Brahmaputra consists in dealing
 445 with lots of scenario and installers.
 446 Functest test suites cannot be systematically run (e.g. run the ODL suite on an
 447 ONOS scenario).
 448
 449 CI provides several information:
 450
 451  * The installer (apex|compass|fuel|joid)
 452  * The scenario [controller]-[feature]-[mode] with
 453
 454    * controller = (odl|onos|ocl|nosdn)
 455    * feature = (ovs(dpdk)|kvm)
 456    * mode = (ha|noha)
 457
 458 Constraints per test case are defined in the Functest configuration file
 459 /home/opnfv/functest/config/config_functest.yaml::
 460
 461  test-dependencies:
 462     functest:
 463         vims:
 464             scenario: '(ocl)|(odl)|(nosdn)'
 465         vping:
 466         vping_userdata:
 467             scenario: '(ocl)|(odl)|(nosdn)'
 468         tempest:
 469         rally:
 470         odl:
 471             scenario: 'odl'
 472         onos:
 473             scenario: 'onos'
 474         ....
 475
 476 At the end of the Functest environment creation (prepare_env.sh see `[1]`_), a
 477 file (/home/opnfv/functest/conf/testcase-list.txt) is created with the list of
 478 all the runnable tests.
 479 We consider the static constraints as regex and compare them with the scenario.
 480 For instance, odl can be run only on scenario including odl in its name.
 481
 482 The order of execution is also described in the Functest configuration file::
 483
 484  test_exec_priority:
 485
 486     1: vping
 487     2: vping_userdata
 488     3: tempest
 489     4: odl
 490     5: onos
 491     6: ovno
 492     #7: doctor
 493     8: promise
 494     9: odl-vpnservice
 495     10: bgpvpn
 496     #11: openstack-neutron-bgpvpn-api-extension-tests
 497     12: vims
 498     13: rally
 499
 500 The tests are executed as follow:
 501
 502  * Basic scenario (vPing, vPing_userdata, Tempest)
 503  * Controller suites: ODL or ONOS or OpenContrail
 504  * Feature projects
 505  * vIMS
 506  * Rally (benchmark scenario)
 507
 508 At the end of an automated execution, everything is cleaned.
 509 We keep only the users/networks that have been statically declared in '[9]'_
 510
 511
 512 ============
 513 Test results
 514 ============
 515
 516 VIM
 517 ===
 518
 519 vPing
 520 -----
 521
 522 vPing results are displayed in the console::
 523
 524   FUNCTEST.info: Running vPing test...
 525   2016-01-23 03:18:20,153 - vPing- INFO - Creating neutron network vping-net...
 526   2016-01-23 03:18:35,476 - vPing- INFO - Flavor found 'm1.small'
 527   2016-01-23 03:18:36,350 - vPing- INFO - vPing Start Time:'2016-01-23 03:18:36'
 528   2016-01-23 03:18:38,571 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
 529   2016-01-23 03:18:53,716 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
 530   2016-01-23 03:18:55,239 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
 531   2016-01-23 03:19:15,593 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
 532   2016-01-23 03:19:15,593 - vPing- INFO - Creating floating IP for the second VM...
 533   2016-01-23 03:19:18,017 - vPing- INFO - Floating IP created: '10.2.65.6'
 534   2016-01-23 03:19:18,017 - vPing- INFO - Associating floating ip: '10.2.65.6' to VM2
 535   2016-01-23 03:19:37,839 - vPing- INFO - SCP ping script to VM2...
 536   2016-01-23 03:19:37,839 - vPing- INFO - Waiting for ping...
 537   2016-01-23 03:19:40,130 - vPing- INFO - vPing detected!
 538   2016-01-23 03:19:40,130 - vPing- INFO - vPing duration:'63.8'
 539   2016-01-23 03:19:40,130 - vPing- INFO - Cleaning up...
 540   2016-01-23 03:20:06,574 - vPing- INFO - Deleting network 'vping-net'...
 541   2016-01-23 03:20:13,587 - vPing- INFO - vPing OK
 542
 543
 544
 545
 546 vPing_userdata
 547 --------------
 548
 549 vPing_userdata results are displayed in the console::
 550
 551     2016-01-06 16:06:20,550 - vPing- INFO - Creating neutron network vping-net...
 552     2016-01-06 16:06:23,867 - vPing- INFO - Flavor found 'm1.small'
 553     2016-01-06 16:06:24,457 - vPing- INFO - vPing Start Time:'2016-01-06 16:06:24'
 554     2016-01-06 16:06:24,626 - vPing- INFO - Creating instance 'opnfv-vping-1' with IP 192.168.130.30...
 555     2016-01-06 16:06:39,351 - vPing- INFO - Instance 'opnfv-vping-1' is ACTIVE.
 556     2016-01-06 16:06:39,650 - vPing- INFO - Creating instance 'opnfv-vping-2' with IP 192.168.130.40...
 557     2016-01-06 16:06:53,330 - vPing- INFO - Instance 'opnfv-vping-2' is ACTIVE.
 558     2016-01-06 16:06:53,330 - vPing- INFO - Waiting for ping...
 559     2016-01-06 16:06:58,669 - vPing- INFO - vPing detected!
 560     2016-01-06 16:06:58,669 - vPing- INFO - vPing duration:'34.2'
 561     2016-01-06 16:06:58,670 - vPing- INFO - Cleaning up...
 562     2016-01-06 16:07:12,661 - vPing- INFO - Deleting network 'vping-net'...
 563     2016-01-06 16:07:14,748 - vPing- INFO - vPing OK
 564
 565 A json file is produced and pushed into the test result database.
 566
 567
 568 Tempest
 569 -------
 570
 571 The Tempest results are displayed in the console::
 572
 573   FUNCTEST.info: Running Tempest tests...
 574   2016-01-28 07:56:55,380 - run_tempest - INFO - Creating tenant and user for Tempest suite
 575   2016-01-28 07:56:56.127 23795 INFO rally.verification.tempest.tempest [-] Starting: Creating configuration file for Tempest.
 576   2016-01-28 07:56:59.512 23795 INFO rally.verification.tempest.tempest [-] Completed: Creating configuration file for Tempest.
 577   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'.
 578   Total results of verification:
 579
 580   +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 581   | UUID                                 | Deployment UUID                      | Set name | Tests | Failures | Created at                 | Status   |
 582   +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 583   | e0bf7770-2c0f-4c63-913c-cd51a6edd96d | 16582e1e-7b01-4d5d-9c13-a26db8567b7b |          | 144   | 30       | 2016-01-28 07:57:01.044856 | finished |
 584   +--------------------------------------+--------------------------------------+----------+-------+----------+----------------------------+----------+
 585
 586   Tests:
 587
 588   +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
 589   | name                                                                                                                                     | time      | status  |
 590   +------------------------------------------------------------------------------------------------------------------------------------------+-----------+---------+
 591   | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_get_flavor                                                               | 0.29804   | success |
 592   | tempest.api.compute.flavors.test_flavors.FlavorsV2TestJSON.test_list_flavors                                                             | 0.06289   | success |
 593   | tempest.api.compute.images.test_images.ImagesTestJSON.test_delete_saving_image                                                           | 9.21756   | success |
 594   | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_delete_image                                        | 8.65376   | success |
 595   | tempest.api.compute.images.test_images_oneserver.ImagesOneServerTestJSON.test_create_image_specify_multibyte_character_image_name        | 9.10993   | success |
 596   | tempest.api.compute.images.test_list_image_filters.ListImageFiltersTestJSON.test_list_images_filter_by_changes_since                     | 0.19585   | success |
 597   ...........................................
 598   2016-01-28 08:19:32,132 - run_tempest - INFO - Results: {'timestart': '2016-01-2807:57:01.044856', 'duration': 1350, 'tests': 144, 'failures': 30}
 599   2016-01-28 08:19:32,133 - run_tempest - INFO - Pushing results to DB: 'http://testresults.opnfv.org/testapi/results'.
 600   2016-01-28 08:19:32,278 - run_tempest - INFO - Deleting tenant and user for Tempest suite)
 601
 602 In order to check all the available test case related debug information, please
 603 inspect tempest.log file stored into related Rally deployment folder.
 604
 605 The Tempest results are pushed to the Test Database.
 606
 607 Rally
 608 -----
 609
 610 The Rally results are displayed in the console, each module is run one after the
 611 other. Tables are displayed::
 612
 613   +-------------------------------------------------------------------------------------------+
 614   |                                   Response Times (sec)                                    |
 615   +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 616   | action               | min   | median | 90%ile | 95%ile | max   | avg   | success | count |
 617   +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 618   | keystone.create_role | 0.358 | 0.572  | 0.772  | 0.811  | 1.106 | 0.603 | 100.0%  | 20    |
 619   | keystone.add_role    | 0.32  | 0.436  | 0.846  | 0.903  | 1.018 | 0.51  | 100.0%  | 20    |
 620   | keystone.list_roles  | 0.102 | 0.185  | 0.253  | 0.275  | 0.347 | 0.188 | 100.0%  | 20    |
 621   | total                | 0.845 | 1.223  | 1.821  | 1.822  | 1.823 | 1.302 | 100.0%  | 20    |
 622   +----------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 623   Load duration: 7.13633608818
 624   Full duration: 36.7863121033
 625   ..............
 626   +------------------------------------------------------------------------------------------+
 627   |                                   Response Times (sec)                                   |
 628   +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 629   | action              | min   | median | 90%ile | 95%ile | max   | avg   | success | count |
 630   +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 631   | nova.create_keypair | 1.005 | 1.784  | 3.025  | 3.636  | 4.373 | 2.004 | 100.0%  | 20    |
 632   | nova.delete_keypair | 0.199 | 0.699  | 1.007  | 1.244  | 3.014 | 0.79  | 100.0%  | 20    |
 633   | total               | 1.249 | 2.625  | 4.259  | 4.845  | 5.131 | 2.794 | 100.0%  | 20    |
 634   +---------------------+-------+--------+--------+--------+-------+-------+---------+-------+
 635   Load duration: 14.9231169224
 636   Full duration: 71.4614388943
 637
 638
 639 At the end of the module test, a message is displayed to provide a global
 640 summary (Test OK or test failed). The raw results are pushed into the Test
 641 Database.
 642
 643
 644 Controllers
 645 ===========
 646
 647 OpenDaylight
 648 ------------
 649
 650 The results of ODL tests can be seen in the console::
 651
 652  ==============================================================================
 653  Basic
 654  ==============================================================================
 655  Basic.010 Restconf OK :: Test suite to verify Restconf is OK
 656  ==============================================================================
 657  Get Controller Modules :: Get the controller modules via Restconf     | PASS |
 658  ------------------------------------------------------------------------------
 659  Basic.010 Restconf OK :: Test suite to verify Restconf is OK          | PASS |
 660  1 critical test, 1 passed, 0 failed
 661  1 test total, 1 passed, 0 failed
 662  ==============================================================================
 663  Basic                                                                 | PASS |
 664  1 critical test, 1 passed, 0 failed
 665  1 test total, 1 passed, 0 failed
 666  ==============================================================================
 667  Output:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
 668  Log:     /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
 669  Report:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
 670
 671  ..............................................................................
 672
 673  Neutron.Delete Networks :: Checking Network deleted in OpenStack a... | PASS |
 674  2 critical tests, 2 passed, 0 failed
 675  2 tests total, 2 passed, 0 failed
 676  ==============================================================================
 677  Neutron :: Test suite for Neutron Plugin                              | PASS |
 678  18 critical tests, 18 passed, 0 failed
 679  18 tests total, 18 passed, 0 failed
 680  ==============================================================================
 681  Output:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/output.xml
 682  Log:     /home/jenkins-ci/workspace/functest-opnfv-jump-2/log.html
 683  Report:  /home/jenkins-ci/workspace/functest-opnfv-jump-2/report.html
 684
 685 3 result files are generated:
 686  * output.xml
 687  * log.html
 688  * report.html
 689
 690  ODL result page
 691
 692 .. figure:: ./images/functestODL.png
 693    :width: 170mm
 694    :align: center
 695    :alt: ODL suite result page
 696
 697
 698 ONOS
 699 ----
 700
 701 The ONOS test logs can be found in OnosSystemTest/TestON/logs
 702 (ONOSCI_PATH to be added),and also can be seen in the console::
 703
 704  ******************************
 705  Result summary for Testcase4
 706  ******************************
 707
 708  2016-01-14 05:25:40,529 - FUNCvirNetNBL3 - INFO - ONOS Router Delete test Start
 709
 710  [2016-01-14 05:25:40.529644] [FUNCvirNetNBL3] [CASE]  Virtual Network NBI Test - Router
 711  2016-01-14 05:25:40,530 - FUNCvirNetNBL3 - INFO - Generate Post Data
 712
 713  [2016-01-14 05:25:40.530825] [FUNCvirNetNBL3] [STEP]  4.1: Post Network Data via HTTP(Post Router need post network)
 714  2016-01-14 05:25:40,531 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/networks/ using POST method.
 715  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 716  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Post Network Success
 717  2016-01-14 05:25:40,539 - FUNCvirNetNBL3 - INFO - Assertion Passed
 718
 719  [2016-01-14 05:25:40.539687] [FUNCvirNetNBL3] [STEP]  4.2: Post Router Data via HTTP
 720  2016-01-14 05:25:40,540 - FUNCvirNetNBL3 - INFO - Sending request http://192.168.122.56:8181/onos/vtn/routers/ using POST method.
 721  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 722  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Post Router Success
 723  2016-01-14 05:25:40,543 - FUNCvirNetNBL3 - INFO - Assertion Passed
 724
 725  [2016-01-14 05:25:40.543489] [FUNCvirNetNBL3] [STEP]  4.3: Delete Router Data via HTTP
 726  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.
 727  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 728  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Delete Router Success
 729  2016-01-14 05:25:40,546 - FUNCvirNetNBL3 - INFO - Assertion Passed
 730
 731  [2016-01-14 05:25:40.546774] [FUNCvirNetNBL3] [STEP]  4.4: Get Router Data is NULL
 732  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.
 733  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 734  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Get Router Success
 735  2016-01-14 05:25:40,550 - FUNCvirNetNBL3 - INFO - Assertion Passed
 736
 737
 738  *****************************
 739   Result: Pass
 740  *****************************
 741
 742  .......................................................................................
 743
 744  ******************************
 745   Result summary for Testcase9
 746  ******************************
 747  .......................................................................................
 748
 749
 750  [2016-01-14 05:26:42.543489] [FUNCvirNetNBL3] [STEP]  9.6: FloatingIp Clean Data via HTTP
 751  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.
 752  2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - INFO - Verifying the Expected is equal to the actual or not using assert_equal
 753  2016-01-14 05:26:42,546 - FUNCvirNetNBL3 - ERROR - Delete Floatingip failed
 754
 755  .......................................................................................
 756
 757  *****************************
 758   Result: Failed
 759  *****************************
 760
 761 There is a result summary for each testcase, and a global summary for the whole test.
 762 If any problem occurs during the test, a ERROR message will be provided in the test and the the global summary::
 763
 764  *************************************
 765          Test Execution Summary
 766  *************************************
 767
 768   Test Start           : 14 Jan 2016 05:25:37
 769   Test End             : 14 Jan 2016 05:25:41
 770   Execution Time       : 0:00:03.349087
 771   Total tests planned  : 11
 772   Total tests RUN      : 11
 773   Total Pass           : 8
 774   Total Fail           : 3
 775   Total No Result      : 0
 776   Success Percentage   : 72%
 777   Execution Result     : 100%
 778
 779
 780 OpenContrail
 781 ------------
 782
 783 TODO OVNO
 784
 785
 786 Feature
 787 =======
 788
 789 vIMS
 790 ----
 791
 792 The results in the console are very verbose::
 793
 794     FUNCTEST.info: Running vIMS test...
 795     2016-01-07 12:30:24,107 - vIMS - INFO - Prepare OpenStack plateform (create tenant and user)
 796     2016-01-07 12:30:24,484 - vIMS - INFO - Update OpenStack creds informations
 797     2016-01-07 12:30:24,484 - vIMS - INFO - Upload some OS images if it doesn't exist
 798     2016-01-07 12:30:24,917 - vIMS - INFO - centos_7 image doesn't exist on glance repository.
 799                                 Try downloading this image and upload on glance !
 800     2016-01-07 12:31:01,268 - vIMS - INFO - ubuntu_14.04 image doesn't exist on glance repository.
 801                                 Try downloading this image and upload on glance !
 802     2016-01-07 12:31:28,670 - vIMS - INFO - Update security group quota for this tenant
 803     2016-01-07 12:31:28,903 - vIMS - INFO - Update cinder quota for this tenant
 804     2016-01-07 12:31:29,355 - vIMS - INFO - Collect flavor id for cloudify manager server
 805     2016-01-07 12:31:30,453 - vIMS - INFO - Prepare virtualenv for cloudify-cli
 806     2016-01-07 12:31:30,453 - vIMS - DEBUG - Executing command : chmod +x /home/opnfv/repos/functest/testcases/vIMS/CI/create_venv.sh
 807     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/
 808     2016-01-07 12:31:30,469 - vIMS - INFO - Downloading the cloudify manager server blueprint
 809     2016-01-07 12:31:46,028 - vIMS - INFO - Cloudify deployment Start Time:'2016-01-07 12:31:46'
 810     2016-01-07 12:31:46,029 - vIMS - INFO - Writing the inputs file
 811     2016-01-07 12:31:46,032 - vIMS - INFO - Launching the cloudify-manager deployment
 812     .........................................
 813     2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: preparing fabric environment...
 814     2016-01-07 12:36:51 LOG <manager> [rabbitmq_3c04e.create] INFO: environment prepared successfully
 815     .........................................
 816     2016-01-07 12:42:51,982 - vIMS - INFO - Cloudify-manager server is UP !
 817     2016-01-07 12:42:51,983 - vIMS - INFO - Cloudify deployment duration:'666.0'
 818     2016-01-07 12:42:51,983 - vIMS - INFO - Collect flavor id for all clearwater vm
 819     2016-01-07 12:42:53,330 - vIMS - INFO - vIMS VNF deployment Start Time:'2016-01-07 12:42:53'
 820     2016-01-07 12:42:53,330 - vIMS - INFO - Downloading the openstack-blueprint.yaml blueprint
 821     2016-01-07 12:43:05,798 - vIMS - INFO - Writing the inputs file
 822     2016-01-07 12:43:05,801 - vIMS - INFO - Launching the clearwater deployment
 823     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; '
 824     2016-01-07 13:01:50,577 - vIMS - DEBUG - Validating openstack-blueprint.yaml
 825     Blueprint validated successfully
 826     Uploading blueprint openstack-blueprint.yaml to management server 172.30.10.165
 827     Uploaded blueprint, blueprint's id is: clearwater
 828     Creating new deployment from blueprint clearwater at management server 172.30.10.165
 829     Deployment created, deployment's id is: clearwater-opnfv
 830     .........................................
 831     2016-01-07 13:01:50,578 - vIMS - INFO - The deployment of clearwater-opnfv is ended
 832     2016-01-07 13:01:50,578 - vIMS - INFO - vIMS VNF deployment duration:'1137.2'
 833     2016-01-07 13:04:50,591 - vIMS - DEBUG - Trying to get clearwater nameserver IP ...
 834     2016-01-07 13:04:55,176 - vIMS - INFO - vIMS functional test Start Time:'2016-01-07 13:04:55'
 835     2016-01-07 13:14:20,694 - vIMS - INFO - vIMS functional test duration:'565.5'
 836     .........................................
 837     Basic Call - Rejected by remote endpoint (TCP) - (6505550603, 6505550969) Passed
 838     Basic Call - Rejected by remote endpoint (UDP) - (6505550095, 6505550084) Passed
 839     Basic Call - Messages - Pager model (TCP) - (6505550000, 6505550520) Passed
 840     Basic Call - Messages - Pager model (UDP) - (6505550742, 6505550077) Passed
 841     Basic Call - Pracks (TCP) - (6505550670, 6505550304) Passed
 842     Basic Call - Pracks (UDP) - (6505550990, 6505550391) Passed
 843     Basic Registration (TCP) - (6505550744) Passed
 844     Basic Registration (UDP) - (6505550616) Passed
 845     Multiple Identities (TCP) - (6505550957, 6505550949) Passed
 846     Multiple Identities (UDP) - (6505550771, 6505550675) Passed
 847     .........................................
 848     2016-01-07 13:14:20,695 - vIMS - DEBUG - Trying to load test results
 849     2016-01-07 13:14:20,702 - vIMS - DEBUG - Push result into DB
 850     2016-01-07 13:14:20,702 - vIMS - DEBUG - Pushing results to DB....
 851     2016-01-07 13:14:21,396 - vIMS - DEBUG - <Response [200]>
 852     2016-01-07 13:14:21,396 - vIMS - INFO - Launching the clearwater-opnfv undeployment
 853
 854 Please note that vIMS traces are very verbose but can bee summarized in several
 855 steps:
 856
 857  * INFO: environment prepared successfully => environment OK
 858  * INFO - Cloudify-manager server is UP ! => orchestrator deployed
 859  * INFO The deployment of clearwater-opnfv is ended => VNF deployed
 860  * Multiple Identities (UDP) - (6505550771, 6505550675) Passed => tests run
 861  * DEBUG - Pushing results to DB.... => tests saved
 862
 863
 864 ==========================
 865 Functest in test Dashboard
 866 ==========================
 867
 868 The OPNFV testing group created a test collection database to collect the test
 869 results from CI.
 870 Any test project running on any lab integrated in CI can push the results to
 871 this database.
 872 This databse can be used afterwards to see the evolution of the tests and
 873 compare the results versus the installers, the scenario or the labs.
 874
 875 You can find more information about the dashboard from Testing Dashboard wiki
 876 page `[6]`_.
 877
 878
 879 Overall Architecture
 880 --------------------
 881
 882 The Test result management in Brahmaputra can be summarized as follow::
 883
 884   +-------------+    +-------------+    +-------------+
 885   |             |    |             |    |             |
 886   |   Test      |    |   Test      |    |   Test      |
 887   | Project #1  |    | Project #2  |    | Project #N  |
 888   |             |    |             |    |             |
 889   +-------------+    +-------------+    +-------------+
 890            |               |               |
 891            ▼               ▼               ▼
 892        +-----------------------------------------+
 893        |                                         |
 894        |         Test Rest API front end         |
 895        |  http://testresults.opnfv.org/testapi   |
 896        |                                         |
 897        +-----------------------------------------+
 898            ▲                |
 899            |                ▼
 900            |     +-------------------------+
 901            |     |                         |
 902            |     |    Test Results DB      |
 903            |     |         Mongo DB        |
 904            |     |                         |
 905            |     +-------------------------+
 906            |
 907            |
 908      +----------------------+
 909      |                      |
 910      |    test Dashboard    |
 911      |                      |
 912      +----------------------+
 913
 914 The Test dashboard URL is: TODO LF
 915 A proto Test dashboard has been realized: http://testresults.opnfv.org/proto/
 916
 917 Test API description
 918 --------------------
 919
 920 The Test API is used to declare pods, projects, test cases and test results.
 921 An additional method dashboard has been added to post-process the raw results.
 922 The data model is very basic, 4 objects are created:
 923   * Pods
 924   * Test projects
 925   * Test cases
 926   * Test results
 927
 928 Pods::
 929
 930   {
 931     "id": <ID>,
 932     "details": <URL description of the POD>,
 933     "creation_date": YYYY-MM-DD HH:MM:SS ,
 934     "name": <The POD Name>,
 935     "mode": <metal or virtual>
 936   },
 937
 938 Test project::
 939
 940   {
 941     "id": <ID>,
 942     "name": <Name of the Project>,
 943     "creation_date": "YYYY-MM-DD HH:MM:SS",
 944     "description": <Short description>
 945   },
 946
 947 Test case::
 948
 949   {
 950     "id": <ID>,
 951     "name":<Name of the test case>,
 952     "creation_date": "YYYY-MM-DD HH:MM:SS",
 953     "description": <short description>,
 954     "url":<URL for longer description>
 955   },
 956
 957 Test results::
 958
 959   {
 960     "_id": <ID,
 961     "project_name": <Reference to project>,
 962     "pod_name": <Reference to POD where the test was executed>,
 963     "version": <Scenario on which the test was executed>,
 964     "installer": <Installer Apex or Compass or Fuel or Joid>,
 965     "description": <Short description>,
 966     "creation_date": "YYYY-MM-DD HH:MM:SS",
 967     "case_name": <Reference to the test case>
 968     "details":{
 969        <- the results to be put here ->
 970     }
 971
 972
 973 For Brahmaputra, we got:
 974
 975  * 16 pods
 976  * 18 projects
 977  * 101 test cases
 978
 979 The projects and the test cases have been frozen in December.
 980 But all were not ready for Brahmaputra.
 981
 982
 983
 984 The API can described as follow::
 985
 986 **Version:**
 987
 988 +--------+--------------------------+------------------------------------------+
 989 | Method | Path                     | Description                              |
 990 +========+==========================+==========================================+
 991 | GET    | /version                 | Get API version                          |
 992 +--------+--------------------------+------------------------------------------+
 993
 994
 995 **Pods:**
 996
 997 +--------+--------------------------+------------------------------------------+
 998 | Method | Path                     | Description                              |
 999 +========+==========================+==========================================+
1000 | GET    | /pods                    | Get the list of declared Labs (PODs)     |
1001 +--------+--------------------------+------------------------------------------+
1002 | POST   | /pods                    | Declare a new POD                        |
1003 |        |                          | Content-Type: application/json           |
1004 |        |                          | {                                        |
1005 |        |                          |    "name": "pod_foo",                    |
1006 |        |                          |    "creation_date": "YYYY-MM-DD HH:MM:SS"|
1007 |        |                          | }                                        |
1008 +--------+--------------------------+------------------------------------------+
1009
1010 **Projects:**
1011
1012 +--------+--------------------------+------------------------------------------+
1013 | Method | Path                     | Description                              |
1014 +========+==========================+==========================================+
1015 | GET    | /test_projects           | Get the list of test projects            |
1016 +--------+--------------------------+------------------------------------------+
1017 | GET    |/test_projects/{project}  | Get details on {project}                 |
1018 |        |                          |                                          |
1019 +--------+--------------------------+------------------------------------------+
1020 | POST   | /test_projects           | Add a new test project                   |
1021 |        |                          | Content-Type: application/json           |
1022 |        |                          | {                                        |
1023 |        |                          |    "name": "project_foo",                |
1024 |        |                          |    "description": "whatever you want"    |
1025 |        |                          | }                                        |
1026 +--------+--------------------------+------------------------------------------+
1027 | PUT    | /test_projects/{project} | Update a test project                    |
1028 |        |                          |                                          |
1029 |        |                          | Content-Type: application/json           |
1030 |        |                          | {                                        |
1031 |        |                          |    <the field(s) you want to modify>     |
1032 |        |                          | }                                        |
1033 +--------+--------------------------+------------------------------------------+
1034 | DELETE | /test_projects/{project} | Delete a test project                    |
1035 +--------+--------------------------+------------------------------------------+
1036
1037
1038 **Test cases:**
1039
1040 +--------+--------------------------+------------------------------------------+
1041 | Method | Path                     | Description                              |
1042 +========+==========================+==========================================+
1043 | GET    | /test_projects/{project}/| Get the list of test cases of {project}  |
1044 |        | cases                    |                                          |
1045 +--------+--------------------------+------------------------------------------+
1046 | POST   | /test_projects/{project}/| Add a new test case to {project}         |
1047 |        | cases                    | Content-Type: application/json           |
1048 |        |                          | {                                        |
1049 |        |                          |    "name": "case_foo",                   |
1050 |        |                          |    "description": "whatever you want"    |
1051 |        |                          |    "creation_date": "YYYY-MM-DD HH:MM:SS"|
1052 |        |                          |    "url": "whatever you want"            |
1053 |        |                          | }                                        |
1054 +--------+--------------------------+------------------------------------------+
1055 | PUT    | /test_projects/{project}?| Modify a test case of {project}          |
1056 |        | case_name={case}          |                                         |
1057 |        |                          | Content-Type: application/json           |
1058 |        |                          | {                                        |
1059 |        |                          |    <the field(s) you want to modify>     |
1060 |        |                          | }                                        |
1061 +--------+--------------------------+------------------------------------------+
1062 | DELETE | /test_projects/{project}/| Delete a test case                       |
1063 |        | case_name={case}         |                                          |
1064 +----------------+----------------+--------------------------------------------+
1065
1066 **Test Results:**
1067
1068 +--------+--------------------------+------------------------------------------+
1069 | Method | Path                     | Description                              |
1070 +========+==========================+==========================================+
1071 | GET    |/results/project={project}| Get the test results of {project}        |
1072 +--------+--------------------------+------------------------------------------+
1073 | GET    |/results/case={case}      | Get the test results of {case}           |
1074 +--------+--------------------------+------------------------------------------+
1075 | GET    |/results?pod={pod}        | get the results on pod {pod}             |
1076 +--------+--------------------------+------------------------------------------+
1077 | GET    |/results?installer={inst} | Get the test results of installer {inst} |
1078 +--------+--------------------------+------------------------------------------+
1079 | GET    |/results?version={version}| Get the test results of scenario         |
1080 |        |                          | {version}. Initially the version param   |
1081 |        |                          | was reflecting git version, in Functest  |
1082 |        |                          | it was decided to move to scenario       |
1083 +--------+--------------------------+------------------------------------------+
1084 | GET    |/results?project={project}| Get all the results of the test case     |
1085 |        |&case={case}              | {case} of the project {project} with     |
1086 |        |&version={scenario}       | version {scenario} installed by installer|
1087 |        |&installer={installer}    | {installer} on POD {pod} stored since    |
1088 |        |&pod={pod}                | {days} days                              |
1089 |        |                          | {project_name} and {case_name} are       |
1090 |        |&period={days}            | mandatory, the other parameters are      |
1091 |        |                          | optional.                                |
1092 +--------+--------------------------+------------------------------------------+
1093 | POST   | /results                 | Add a new test results                   |
1094 |        |                          | Content-Type: application/json           |
1095 |        |                          | {                                        |
1096 |        |                          |    "project_name": "project_foo",        |
1097 |        |                          |    "case_name": "case_foo",              |
1098 |        |                          |    "pod_name": "pod_foo",                |
1099 |        |                          |    "installer": "installer_foo",         |
1100 |        |                          |    "version": "scenario_foo",            |
1101 |        |                          |    "details": <your results>             |
1102 |        |                          | }                                        |
1103 +--------+--------------------------+------------------------------------------+
1104
1105
1106 **Dashboard:**
1107
1108 +--------+--------------------------+------------------------------------------+
1109 | Method | Path                     | Description                              |
1110 +========+==========================+==========================================+
1111 | GET    |/dashboard?               | Get all the dashboard ready results of   |
1112 |        |&project={project}        | {case} of the project {project}          |
1113 |        |&case={case}              | version {scenario} installed by installer|
1114 |        |&version={scenario}       | {installer} on POD {pod} stored since    |
1115 |        |&installer={installer}    | {days} days                              |
1116 |        |&pod={pod}                |                                          |
1117 |        |&period={days}            | {project_name} and {case_name} are       |
1118 |        |                          | mandatory, the other parameters are      |
1119 |        |                          | optional.                                |
1120 +--------+--------------------------+------------------------------------------+
1121
1122
1123 The results with dashboard method are post-processed from raw results.
1124 Please note that dashboard results are not stored. Only raw results are stored.
1125
1126
1127
1128 Test Dashboard
1129 --------------
1130
1131 Based on dashboard post-porcessed results, a Test dashboard is automatically
1132 generated.
1133
1134 TODO LF
1135 or http://testresults.opnfv.org/proto/
1136
1137 ===============
1138 Troubleshooting
1139 ===============
1140
1141 VIM
1142 ===
1143
1144 vPing
1145 -----
1146
1147
1148 vPing_userdata
1149 --------------
1150
1151
1152 Tempest
1153 -------
1154
1155 In the upstream OpenStack CI all the Tempest test cases are supposed to pass.
1156 If some test cases fail in an OPNFV deployment, the reason is very probably one
1157 of the following:
1158
1159 +-----------------------------+------------------------------------------------+
1160 | Error                       | Details                                        |
1161 +=============================+================================================+
1162 | Resources required for test | Such resources could be e.g. an external       |
1163 | case execution are missing  | network and access to the management subnet    |
1164 |                             | (adminURL) from the Functest docker container. |
1165 +-----------------------------+------------------------------------------------+
1166 | OpenStack components or     | Check running services in the controller and   |
1167 | services are missing or not | compute nodes (e.g. with "systemctl" or        |
1168 | configured properly         | "service" commands). Configuration parameters  |
1169 |                             | can be verified from related .conf files       |
1170 |                             | located under /etc/<component> directories.    |
1171 +--------------------------------+---------------------------------------------+
1172 | Some resources required for | The tempest.conf file, automatically generated |
1173 | execution test cases are    | by Rally in Functest, does not contain all the |
1174 | missing                     | needed parameters or some parameters are not   |
1175 |                             | set properly.                                  |
1176 |                             | The tempest.conf file is located in /home/opnfv|
1177 |                             | /.rally/tempest/for-deployment-<UUID> in       |
1178 |                             | Functest container                             |
1179 |                             | Use "rally deployment list" command in order to|
1180 |                             | check UUID of current deployment.              |
1181 +-----------------------------+------------------------------------------------+
1182
1183
1184 When some Tempest test case fails, captured traceback and possibly also related
1185 REST API requests/responses are output to the console.
1186 More detailed debug information can be found from tempest.log file stored into
1187 related Rally deployment folder.
1188
1189
1190 Rally
1191 -----
1192
1193 Same error causes than for Tempest mentioned above may lead to error in Rally.
1194
1195 Controllers
1196 ===========
1197
1198 ODL
1199 ---
1200
1201
1202 ONOS
1203 ----
1204
1205
1206 OpenContrail
1207 ------------
1208
1209
1210 Feature
1211 =======
1212
1213 vIMS
1214 ----
1215
1216
1217 ==========
1218 References
1219 ==========
1220
1221 .. _`[1]`: Functest configuration guide URL
1222 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
1223 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
1224 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
1225 .. _`[5]`: https://github.com/Orange-OpenSource/opnfv-cloudify-clearwater/blob/master/openstack-blueprint.yaml
1226 .. _`[6]`: https://wiki.opnfv.org/opnfv_test_dashboard
1227 .. _`[7]`: http://testresults.opnfv.org/testapi/test_projects/functest/cases
1228 .. _`[8]`: https://wiki.openstack.org/wiki/Governance/DefCoreCommittee
1229 .. _`[9]`: https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/libraries/os_defaults.yaml
1230 .. _`[10]`:https://git.opnfv.org/cgit/functest/tree/testcases/VIM/OpenStack/CI/rally_cert/task.yaml
1231
1232 OPNFV main site: opnfvmain_.
1233
1234 OPNFV functional test page: opnfvfunctest_.
1235
1236 IRC support chan: #opnfv-testperf
1237
1238 .. _opnfvmain: http://www.opnfv.org
1239 .. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
1240 .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
1241 .. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
1242 .. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
1243 .. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml
1244