summaryrefslogtreecommitdiffstats
path: root/docs/release-notes/functest-release.rst
blob: 6c7f8b54c386e48c9e3be2b84d98a6cf1bfbac97 (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
==============================================
OPNFV Brahmaputra3.0 release note for Functest
==============================================

Abstract
========

This document describes the release note of Functest project.

License
=======

OPNFV Colorado release note for Functest Docs
(c) by Morgan Richomme (Orange)

OPNFV Colorado release note for Functest Docs
are licensed under a Creative Commons Attribution 4.0 International License.
You should have received a copy of the license along with this.
If not, see <http://creativecommons.org/licenses/by/4.0/>.

Version history
===============

+------------+----------+------------------+------------------------+
| **Date**   | **Ver.** | **Author**       | **Comment**            |
|            |          |                  |                        |
+------------+----------+------------------+------------------------+
| 2016-08-17 | 1.0.0    | Morgan Richomme  | Functest for C release |
|            |          | (Orange)         |                        |
+------------+----------+------------------+------------------------+

OPNFV Colorado Release
=========================

Functest deals with functional testing of the OPNFV solution.
It includes test cases developed within the project and test cases developed in
other OPNFV projects and other upstream communities.

The internal test cases are:

 * healthcheck
 * vPing ssh
 * vPing userdata
 * Tempest Smoke Serial
 * Rally Sanity
 * ODL
 * Tempest full parallel
 * Rally full
 * vIMS

The OPNFV projects integrated into Functest framework for automation are:

 * bgpvpn
 * Copper
 * Doctor
 * Domino
 * Moon
 * Multisite
 * ONOSFW
 * ONOS-sfc
 * ODL-sfc
 * Parser
 * Promise
 * Security scan

The validation of a scenario requires a subset of these tests depending
on the installer and the scenario.

The 3 last internal test cases (tempest full parallel, Rally full and
vIMS) are not considered for scenario validation.

Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | functest                             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | colorado.1.0                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Colorado base release                |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | September 22 2016                    |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Colorado base release                |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Deliverables
============

Software
--------

 - The Functest Docker image: * TODO link *

 - The testapi Docker image: * TODO link *


Documents
---------

 - Installation/configuration guide: * TODO link *

 - User Guide: * TODO link *

 - Developer Guide: * TODO link *


Version change
==============

Feature evolution
-----------------

 - refactoring of ODL functional tests (with upstream modifications)

 - refactoring of testapi (update, swagger documentation, dockerization)

 - jenkins logs improvement

 - update integration of Doctor, Promise and SDNVPN  projects

 - split Tempest and rally into 2 different tests: smoke and full

 - vIMS test suite integration

 - adoption of Kibana for dashboarding


New features
------------

 - Functest CLI to prepare and run the tests

 - creation of the healthcheck test case

 - support new scenarios (ocl, odl_l2-sfc, onos-sfc, lxd, moon, multisite)

 - integration of new OPNFV feature projects (copper, domino, multisite,
 moon, parser, onos-sfc, odl-sfc, security scan)

 - introduction of test tiers in functest framework

 - automatic reporting

 - introduction of a jenkins summary table

 - support of ARM architecture


Scenario Matrix
===============

For Colorado 1.0, Functest was tested on the following scenarios (if not
precised, the scenario is a na scenario):

+---------------------+---------+---------+---------+---------+
|    Scenario         |  Apex   | Compass |  Fuel   |   Joid  |
+=====================+=========+=========+=========+=========+
|   nosdn             |    X    |    X    |    X    |    X    |
+---------------------+---------+---------+---------+---------+
|   odl_l2            |    X    |    X    |    X    |    X    |
+---------------------+---------+---------+---------+---------+
|   odl_l3            |    X    |    X    |    X    |         |
+---------------------+---------+---------+---------+---------+
|   onos              |    X    |    X    |    X    |    X    |
+---------------------+---------+---------+---------+---------+
|   ocl               |         |    X    |         |         |
+---------------------+---------+---------+---------+---------+
|   ovs-noha (dpdk)   |         |         |    X    |         |
+---------------------+---------+---------+---------+---------+
|   kvm-noha          |         |         |    X    |         |
+---------------------+---------+---------+---------+---------+
|   odl_l2-bgpvpn     |    X    |         |    X    |         |
+---------------------+---------+---------+---------+---------+
|   odl_l2-sfc        |         |         |    X    |         |
+---------------------+---------+---------+---------+---------+
|   onos-sfc          |    X    |    X    |    X    |    X    |
+---------------------+---------+---------+---------+---------+
|   odl_l2-moon       |         |    X    |         |         |
+---------------------+---------+---------+---------+---------+
|   multisite         |         |         |         |         |
+---------------------+---------+---------+---------+---------+
|   lxd               |         |         |         |    X    |
+---------------------+---------+---------+---------+---------+

Functest defines a scenario scoring based on the sum of the unitary test
cases run in CI.
The scoring method is described in https://wiki.opnfv.org/pages/viewpage.action?pageId=6828617

In Colorado, the functional tests have been sliced in different
categories:

+----------------+-----------------------------------------------+
| Category       |  Description                                  |
+================+===============================================+
| healthcheck    | Basic OpenStack commands                      |
+----------------+-----------------------------------------------+
| smoke          | vPings, Tempest and rally smoke tests         |
+----------------+-----------------------------------------------+
| sdn_suites     | Specific SDN feature tests                    |
+----------------+-----------------------------------------------+
| features       | OPNFV feature project functional test suites  |
+----------------+-----------------------------------------------+
| openstack      | Advanced, long duration OpenStack tests       |
|                | (Tempest and Rally full suite). Each test may |
|                | last several hours                            |
+----------------+-----------------------------------------------+
| vnf            | Complex scenarios dealing with orchestration, |
|                | VNF deployment and tests (e.g. vIMS)          |
+----------------+-----------------------------------------------+

For the scenario validation, we consider only the categories healthcheck,
smoke, sdn_suites and features. These tests are run systematically in
the CI daily loops.

Success criteria have been defined for these test cases, they can be
PASS/FAIl or a success rate may be declared (100%, > 90%)
All the criteria, as well as the test dependencies are declared in the
ci/testcases.yaml file.

* TODO scoring table *

The reporting pages can be found at:

 * apex: http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-apex.html
 * compass: http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-compass.html
 * fuel: http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-fuel.html
 * joid: http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-joid.html

Colorado known restrictions/issues
==================================

+-----------+-----------+----------------------------------------------+
| Installer | Scenario  |  Issue                                       |
+===========+===========+==============================================+
| any       | onos-*    | vPing userdata and Tempest cases related to  |
|           |           | metadata service excluded from onos scenarios|
|           |           | https://gerrit.opnfv.org/gerrit/#/c/18729/   |
+-----------+-----------+----------------------------------------------+
| any       | odl_l3-*  | Tempest cases related to using floating IP   |
|           |           | addresses fail because of a known ODL bug.   |
|           |           | vPing_ssh test case is excluded for the same |
|           |           | reason.                                      |
|           |           | https://jira.opnfv.org/browse/APEX-112       |
|           |           | https://jira.opnfv.org/browse/FUNCTEST-445   |
+-----------+-----------+----------------------------------------------+
| apex/fuel | *-bgpvpn  | vPing_ssh (floating ips not supported) and   |
|           |           | vIMS excluded. Some Tempest cases related to |
|           |           | floating ips also excluded.                  |
+-----------+-----------+----------------------------------------------+
| compass   | moon      | First ODL test FAILS because ODL/Openstack   |
|           |           | federation done in moon is partial. Only     |
|           |           | MD-SAL is federated (not AD-SAL)             |
+-----------+-----------+----------------------------------------------+
| fuel      | any       | TestServerBasicOps test case skipped         |
|           |           | https://gerrit.opnfv.org/gerrit/#/c/19635/   |
+-----------+-----------+----------------------------------------------+
| fuel      | kvm       | vPing_ssh and vIMS excluded (metadata related|
|           |           | scenarios)                                   |
+-----------+-----------+----------------------------------------------+
| fuel      | multisite | random errors running multisite. A known bug |
|           |           | in keystone mitaka, due to which memcache    |
|           |           | raises exception and keystone becomes        |
|           |           | unresponsive                                 |
|           |           | bugs.launchpad.net/keystone/+bug/1600394     |
|           |           | workaround consists in restarting memcache on|
|           |           | server                                       |
+-----------+-----------+----------------------------------------------+
| joid      | any       | Tempest cases related to object storage      |
|           |           | excluded                                     |
|           |           | https://gerrit.opnfv.org/gerrit/#/c/17871/   |
+-----------+-----------+----------------------------------------------+
| joid      | domino    | Domino tests are skipped in CI. However the  |
|           |           | test case can be run by manually setting     |
|           |           | IS_IPandKEY_CONFIGURED=true after manually   |
|           |           | setting properly the IP addresses of the 3   |
|           |           | Controller nodes in the configuration file   |
|           |           | /repos/domino/tests/run_multinode.sh         |
+-----------+-----------+----------------------------------------------+


Test and installer/scenario dependencies
========================================

It is not always possible to run all the test cases on all the scenarios.
The following table details the dependencies of the test cases per
scenario. The scenario dependencies (installer or scenario) are detailed
in https://git.opnfv.org/cgit/functest/tree/ci/testcases.yaml

Test results
============

Test results are available in:

 - test results document: http://artifacts.opnfv.org/functest

 - jenkins logs on CI: https://build.opnfv.org/ci/view/functest/

 - jenkins logs on ARM CI: https://build.opnfv.org/ci/view/armband/



Open JIRA tickets
=================

+------------------+-----------------------------------------------+
|   JIRA           |         Description                           |
+==================+===============================================+
+------------------+-----------------------------------------------+
+------------------+-----------------------------------------------+
+------------------+-----------------------------------------------+
+------------------+-----------------------------------------------+
+------------------+-----------------------------------------------+

Useful links
============

 - wiki project page: https://wiki.opnfv.org/opnfv_functional_testing

 - wiki Functest Colorado page: https://wiki.opnfv.org/display/functest/Functest+Colorado

 - Functest repo: https://git.opnfv.org/cgit/functest

 - Functest CI dashboard: https://build.opnfv.org/ci/view/functest/

 - JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611

 - Functest IRC chan: #opnfv-functest

 - Functest reporting: http://testresults.opnfv.org/reporting

 - Functest test configuration: https://git.opnfv.org/cgit/functest/tree/ci/testcases.yaml

 - Functest Colorado user guide: * TODO *

 - Functest installation/configuration guide: * TODO *

 - Functest developer guide: * TODO *