aboutsummaryrefslogtreecommitdiffstats
path: root/docs/devguide/index.rst
blob: 7f3233c4cd0998e61917cc97406dcb7aa9fbcf88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
******************************
OPNFV FUNCTEST developer guide
******************************

.. toctree::
   :numbered:
   :maxdepth: 2


============
Introduction
============

This document describes how feature projects aiming to run functional tests can
be integrated into FuncTest framework.


================================
Functest High level architecture
================================

Functest is project delivering a test container dedicated to OPNFV.
It includes the tools, the scripts and the test scenarios.

Functest can be described as follow::

 +----------------------+
 |                      |
 |   +--------------+   |                  +-------------------+
 |   |              |   |    Public        |                   |
 |   | Tools        |   +------------------+      OPNFV        |
 |   | Scripts      |   |                  | System Under Test |
 |   | Scenarios    |   +------------------+                   |
 |   |              |   |    Management    |                   |
 |   +--------------+   |                  +-------------------+
 |                      |
 |    Functest Docker   |
 |                      |
 +----------------------+

Functest deals with internal and external test cases.
The Internal test cases in Brahmaputra are:

 * vPing_SSH
 * vPing_userdata
 * ODL
 * Tempest
 * vIMS
 * Rally

The external tescases are:

 * Promise
 * Doctor
 * Onos
 * BGPVPN

see `[2]`_ for details.

Functest can also be considered as a framework that may include external OPNFV
projects.
This framework will ease the integration of the feature test suite to the CI.

==================
How Functest works
==================

The installation and the launch of the Functest docker image is described in
`[1]`_.

The Functest docker directories are::

 home
    |
    `-- opnfv
        |-- functest
        |   |-- conf
        |   |-- data
        |   `-- results
        `-- repos
            |-- bgpvpn
            |-- doctor
            |-- functest
            |-- odl_integration
            |-- onos
            |-- ovno
            |-- promise
            |-- rally
            |-- releng
            `-- vims-test

::

 +-----------+-------------------+---------------------------------------------+
 | Directory | Subdirectory      | Comments                                    |
 +-----------+-------------------+---------------------------------------------+
 |           | <project>/conf    | All the useful configuration file(s) for    |
 |           |                   | <project> the openstack creds are put there |
 |           |                   | for CI                                      |
 |           |                   | It is recommended to push it there when     |
 |           |                   | passing the credentials to container through|
 |           |                   | the -v option                               |
 |           +-------------------+---------------------------------------------+
 |    opnfv  | <project>/data    | Usefull data, images for <projects>         |
 |           |                   | By default we put a cirros image:           |
 |           |                   | cirros-0.3.4-x86_64-disk.img                |
 |           |                   | This image can be used by any projects      |
 |           +-------------------+---------------------------------------------+
 |           | <project>/results | Local result directory of project <project> |
 +-----------+-------------------+---------------------------------------------+
 |           | bgpvpn            |                                             |
 |           +-------------------+                                             +
 | repos     | doctor            |                                             |
 |           +-------------------+                                             +
 |           | functest          |                                             |
 |           +-------------------+                                             +
 |           | odl_integration   |                                             |
 |           +-------------------+    Clone of the useful repositories         +
 |           | onos              |     These repositories may include:         |
 |           +-------------------+                - tooling                    +
 |           | promise           |                - scenario                   |
 |           +-------------------+                - scripts                    +
 |           | rally             |                                             |
 |           +-------------------+                                             +
 |           | releng            |                                             |
 |           +-------------------+                                             +
 |           | vims-test         |                                             |
 |           +-------------------+                                             +
 |           | <your project>    |                                             |
 +-----------+-------------------+---------------------------------------------+

Before running the test suite, you must prepare the environement by running::

 $ /home/opnfv/repos/functest/docker/prepare_env.sh

By running prepare_env.sh, you build the test environement required by the tests
including the retrieval and sourcing of OpenStack credentials.
This is an example of the env variables we have in the docker container:

 * HOSTNAME=373f77816eb0
 * INSTALLER_TYPE=fuel
 * repos_dir=/home/opnfv/repos
 * INSTALLER_IP=10.20.0.2
 * PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 * PWD=/home/opnfv
 * SHLVL=1
 * HOME=/home/opnfv
 * NODE_NAME=opnfv-jump-2
 * creds=/home/opnfv/functest/conf/openstack.creds
 * _=/usr/bin/env

The prepare_env.sh will source the credentials, so once run you should have
access to the following env variables::

 root@373f77816eb0:~# env|grep OS_
 OS_REGION_NAME=RegionOne
 OS_PROJECT_NAME=admin
 OS_PASSWORD=admin
 OS_AUTH_STRATEGY=keystone
 OS_AUTH_URL=http://172.30.10.70:5000/v2.0
 OS_USERNAME=admin
 OS_TENANT_NAME=admin
 OS_ENDPOINT_TYPE=internalURL
 OS_NO_CACHE=true


Then you may run the test suite by running::

 $ /home/opnfv/repos/functest/docker/run_tests.sh -t <your project>

see `[2]`_ for details.



=========================
How to integrate Functest
=========================

The files of the Functest repository you must modify to integrate Functest are:

 * functest/docker/Dockerfile
 * functest/docker/common.sh
 * functest/docker/requirements.pip
 * functest/docker/run_tests.sh
 * functest/docker/prepare_env.sh
 * functest/config_funtest.yaml


Dockerfile
==========

This file lists the repositories to be cloned in the Functest container.
The repositories can be internal or external::

 RUN git clone https://gerrit.opnfv.org/gerrit/<your porject> ${repos_dir}/<your project>


Common.sh
==========

This file can be used to declare the branch and commit  variables of your
projects::

 <YOUR_PROJECT>_BRANCH=$(cat $config_file | grep -w <your project>_branch | awk 'END {print $NF}')
 <YOUR_PROJECT>_COMMIT=$(cat $config_file | grep -w <your project>_commit | awk 'END {print $NF}')

 echo "<YOUR_PROJECT>_BRANCH=${<YOUR_PROJECT>_BRANCH}"
 echo "<YOUR_PROJECT>_COMMIT=${<YOUR_PROJECT>_COMMIT}"


requirements.pip
================

This file can be used to preloaded all the needed Python libraries (and avoid
that each project does it)
The current libraries used in Functest container are::

 # cat requirements.pip
 pyyaml==3.10
 gitpython==1.0.1
 python-neutronclient==2.6.0
 python-novaclient==2.28.1
 python-glanceclient==1.1.0
 python-cinderclient==1.4.0
 python-ceilometerclient==1.5.1
 python-keystoneclient==1.6.0
 virtualenv==1.11.4
 pexpect==4.0
 requests==2.8.0
 robotframework==2.9.1
 robotframework-requests==0.3.8
 robotframework-sshlibrary==2.1.1
 configObj==5.0.6
 Flask==0.10.1
 xmltodict==0.9.2
 scp==0.10.2
 paramiko==1.16.0


prepare_env.sh
==============

This script can be adapted if you need to set up a specific environment before
running the tests.

run_tests.sh
============

This script is used to run the tests. You must thus complete the cases with your
own project::

 ;;
    "promise")
        info "Running PROMISE test case..."
        # TODO
    ;;
    "doctor")
        info "Running Doctor test..."
        python ${FUNCTEST_REPO_DIR}/testcases/features/doctor.py
    ;;
    "<your project>")
        info "Running <your project> test..."
        # your script that launchs your tests...
    ;;

And do not forget to update also the help line::

 -t|--test         run specific set of tests
      <test_name>     one or more of the following separated by comma:
                         vping_ssh,vping_userdata,odl,rally,tempest,vims,onos,promise,ovno


config_funtest.yaml
===================

This file is the main configuration file of Functest. You must add the
references to your project::

 general:
    directories:
        dir_repo_<your project>:      /home/opnfv/repos/<your project>
     repositories:
        # branch and commit ID to which the repos will be reset (HEAD)
        <your project>_branch:   master
        <your project>_commit:   latest


====================
Test Dashboard & API
====================

The OPNFV testing group created a test collection database to collect the test
results from CI.
Any test project running on any lab integrated in CI can push the results to
this database.
This database can be used afterwards to see the evolution of the tests and
compare the results versus the installers, the scenario or the labs.

You can find more information about the dashboard from Testing Dashboard wiki
page `[3]`_.


Overall Architecture
--------------------

The Test result management in Brahmaputra can be summarized as follows::

  +-------------+    +-------------+    +-------------+
  |             |    |             |    |             |
  |   Test      |    |   Test      |    |   Test      |
  | Project #1  |    | Project #2  |    | Project #N  |
  |             |    |             |    |             |
  +-------------+    +-------------+    +-------------+
           |               |               |
           V               V               V
       +-----------------------------------------+
       |                                         |
       |         Test Rest API front end         |
       |  http://testresults.opnfv.org/testapi   |
       |                                         |
       +-----------------------------------------+
           A                |
           |                V
           |     +-------------------------+
           |     |                         |
           |     |    Test Results DB      |
           |     |         Mongo DB        |
           |     |                         |
           |     +-------------------------+
           |
           |
     +----------------------+
     |                      |
     |    test Dashboard    |
     |                      |
     +----------------------+

The Test dashboard URL is: TODO LF
A alternate Test dashboard has been realized to provide a view per installer and
per scenario for Brahmaputra release::

  http://testresults.opnfv.org/proto/brahma/

This Dashboard consumes the results retrieved thanks to the Test API.

Test API description
--------------------

The Test API is used to declare pods, projects, test cases and test results. An
additional method dashboard has been added to post-process the raw results. The
data model is very basic, 4 objects are created:

  * Pods
  * Test projects
  * Test cases
  * Test results

Pods::

  {
    "id": <ID>,
    "details": <URL description of the POD>,
    "creation_date": YYYY-MM-DD HH:MM:SS ,
    "name": <The POD Name>,
    "mode": <metal or virtual>
  },

Test project::

  {
    "id": <ID>,
    "name": <Name of the Project>,
    "creation_date": "YYYY-MM-DD HH:MM:SS",
    "description": <Short description>
  },

Test case::

  {
    "id": <ID>,
    "name":<Name of the test case>,
    "creation_date": "YYYY-MM-DD HH:MM:SS",
    "description": <short description>,
    "url":<URL for longer description>
  },

Test results::

  {
    "_id": <ID,
    "project_name": <Reference to project>,
    "pod_name": <Reference to POD where the test was executed>,
    "version": <Scenario on which the test was executed>,
    "installer": <Installer Apex or Compass or Fuel or Joid>,
    "description": <Short description>,
    "creation_date": "YYYY-MM-DD HH:MM:SS",
    "case_name": <Reference to the test case>
    "details":{
       <- the results to be put here ->
    }


For Brahmaputra, we got:

 * 16 pods
 * 18 projects
 * 101 test cases

The projects and the test cases have been frozen in December.
But all were not ready for Brahmaputra.



The API can described as follows:

Version:

 +--------+--------------------------+-----------------------------------------+
 | Method | Path                     | Description                             |
 +========+==========================+=========================================+
 | GET    | /version                 | Get API version                         |
 +--------+--------------------------+-----------------------------------------+


Pods:

 +--------+--------------------------+-----------------------------------------+
 | Method | Path                     | Description                             |
 +========+==========================+=========================================+
 | GET    | /pods                    | Get the list of declared Labs (PODs)    |
 +--------+--------------------------+-----------------------------------------+
 | POST   | /pods                    | Declare a new POD                       |
 |        |                          | Content-Type: application/json          |
 |        |                          | {                                       |
 |        |                          |   "name": "pod_foo",                    |
 |        |                          |   "creation_date": "YYYY-MM-DD HH:MM:SS"|
 |        |                          | }                                       |
 +--------+--------------------------+-----------------------------------------+

Projects:

 +--------+--------------------------+-----------------------------------------+
 | Method | Path                     | Description                             |
 +========+==========================+=========================================+
 | GET    | /test_projects           | Get the list of test projects           |
 +--------+--------------------------+-----------------------------------------+
 | GET    |/test_projects/{project}  | Get details on {project}                |
 |        |                          |                                         |
 +--------+--------------------------+-----------------------------------------+
 | POST   | /test_projects           | Add a new test project                  |
 |        |                          | Content-Type: application/json          |
 |        |                          | {                                       |
 |        |                          |    "name": "project_foo",               |
 |        |                          |    "description": "whatever you want"   |
 |        |                          | }                                       |
 +--------+--------------------------+-----------------------------------------+
 | PUT    | /test_projects/{project} | Update a test project                   |
 |        |                          |                                         |
 |        |                          | Content-Type: application/json          |
 |        |                          | {                                       |
 |        |                          |    <the field(s) you want to modify>    |
 |        |                          | }                                       |
 +--------+--------------------------+-----------------------------------------+
 | DELETE | /test_projects/{project} | Delete a test project                   |
 +--------+--------------------------+-----------------------------------------+


Test cases:

 +--------+--------------------------+-----------------------------------------+
 | Method | Path                     | Description                             |
 +========+==========================+=========================================+
 | GET    | /test_projects/{project}/| Get the list of test cases of {project} |
 |        | cases                    |                                         |
 +--------+--------------------------+-----------------------------------------+
 | POST   | /test_projects/{project}/| Add a new test case to {project}        |
 |        | cases                    | Content-Type: application/json          |
 |        |                          | {                                       |
 |        |                          |   "name": "case_foo",                   |
 |        |                          |   "description": "whatever you want"    |
 |        |                          |   "creation_date": "YYYY-MM-DD HH:MM:SS"|
 |        |                          |   "url": "whatever you want"            |
 |        |                          | }                                       |
 +--------+--------------------------+-----------------------------------------+
 | PUT    | /test_projects/{project}?| Modify a test case of {project}         |
 |        | case_name={case}         |                                         |
 |        |                          | Content-Type: application/json          |
 |        |                          | {                                       |
 |        |                          |    <the field(s) you want to modify>    |
 |        |                          | }                                       |
 +--------+--------------------------+-----------------------------------------+
 | DELETE | /test_projects/{project}/| Delete a test case                      |
 |        | case_name={case}         |                                         |
 +--------+--------------------------+-----------------------------------------+

Test Results:

 +--------+--------------------------+-----------------------------------------+
 | Method | Path                     | Description                             |
 +========+==========================+=========================================+
 | GET    |/results/project={project}| Get the test results of {project}       |
 +--------+--------------------------+-----------------------------------------+
 | GET    |/results/case={case}      | Get the test results of {case}          |
 +--------+--------------------------+-----------------------------------------+
 | GET    |/results?pod={pod}        | get the results on pod {pod}            |
 +--------+--------------------------+-----------------------------------------+
 | GET    |/results?installer={inst} | Get the test results of installer {inst}|
 +--------+--------------------------+-----------------------------------------+
 | GET    |/results?version={version}| Get the test results of scenario        |
 |        |                          | {version}. Initially the version param  |
 |        |                          | was reflecting git version, in Functest |
 |        |                          | it was decided to move to scenario      |
 +--------+--------------------------+-----------------------------------------+
 | GET    |/results?project={project}| Get all the results of the test case    |
 |        |&case={case}              | {case} of the project {project} with    |
 |        |&version={scenario}       | version {scenario} installed by         |
 |        |&installer={installer}    | {installer} on POD {pod} stored since   |
 |        |&pod={pod}                | {days} days                             |
 |        |                          | {project_name} and {case_name} are      |
 |        |&period={days}            | mandatory, the other parameters are     |
 |        |                          | optional.                               |
 +--------+--------------------------+-----------------------------------------+
 | POST   | /results                 | Add a new test results                  |
 |        |                          | Content-Type: application/json          |
 |        |                          | {                                       |
 |        |                          |    "project_name": "project_foo",       |
 |        |                          |    "case_name": "case_foo",             |
 |        |                          |    "pod_name": "pod_foo",               |
 |        |                          |    "installer": "installer_foo",        |
 |        |                          |    "version": "scenario_foo",           |
 |        |                          |    "details": <your results>            |
 |        |                          | }                                       |
 +--------+--------------------------+-----------------------------------------+


Dashboard:

 +--------+--------------------------+-----------------------------------------+
 | Method | Path                     | Description                             |
 +========+==========================+=========================================+
 | GET    |/dashboard?               | Get all the dashboard ready results of  |
 |        |&project={project}        | {case} of the project {project}         |
 |        |&case={case}              | version {scenario} installed by         |
 |        |&version={scenario}       | {installer} on POD {pod} stored since   |
 |        |&installer={installer}    | {days} days                             |
 |        |&pod={pod}                |                                         |
 |        |&period={days}            | {project_name} and {case_name} are      |
 |        |                          | mandatory, the other parameters are     |
 |        |                          | optional.                               |
 +--------+--------------------------+-----------------------------------------+


The results with dashboard method are post-processed from raw results.
Please note that dashboard results are not stored. Only raw results are stored.


===============================================
How to push your results into the Test Database
===============================================

The test database is used to collect test results. By default it is enabled only
in Continuous Integration.
The architecture and associated API is described in `[2]`_.
If you want to push your results from CI, you just have to use the API at the
end of your script.

You can also reuse a python function defined in functest_utils.py::

  def push_results_to_db(db_url, case_name, logger, pod_name,version, payload):
    """
    POST results to the Result target DB
    """
    url = db_url + "/results"
    installer = get_installer_type(logger)
    params = {"project_name": "functest", "case_name": case_name,
              "pod_name": pod_name, "installer": installer,
              "version": version, "details": payload}

    headers = {'Content-Type': 'application/json'}
    try:
        r = requests.post(url, data=json.dumps(params), headers=headers)
        if logger:
            logger.debug(r)
        return True
    except Exception, e:
        print "Error [push_results_to_db('%s', '%s', '%s', '%s', '%s')]:" \
            % (db_url, case_name, pod_name, version, payload), e
        return False

::

==========
References
==========

.. _`[1]`: http://artifacts.opnfv.org/functest/docs/configguide/index.html Functest configuration guide URL
.. _`[2]`: http://artifacts.opnfv.org/functest/docs/userguide/index.html functest user guide URL
.. _`[3]`: https://wiki.opnfv.org/opnfv_test_dashboard


OPNFV main site: opnfvmain_.

OPNFV functional test page: opnfvfunctest_.

IRC support chan: #opnfv-testperf

.. _opnfvmain: http://www.opnfv.org
.. _opnfvfunctest: https://wiki.opnfv.org/opnfv_functional_testing
.. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html
.. _`Rally installation procedure`: https://rally.readthedocs.org/en/latest/tutorial/step_0_installation.html
.. _`config_test.py` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.py
.. _`config_functest.yaml` : https://git.opnfv.org/cgit/functest/tree/testcases/config_functest.yaml