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