docs/release-notes/functest-release.rst

   1 ==============================================
   2 OPNFV Brahmaputra3.0 release note for Functest
   3 ==============================================
   4
   5 Abstract
   6 ========
   7
   8 This document describes the release note of Functest project.
   9
  10 License
  11 =======
  12
  13 OPNFV Colorado release note for Functest Docs
  14 (c) by Morgan Richomme (Orange)
  15
  16 OPNFV Colorado release note for Functest Docs
  17 are licensed under a Creative Commons Attribution 4.0 International License.
  18 You should have received a copy of the license along with this.
  19 If not, see <http://creativecommons.org/licenses/by/4.0/>.
  20
  21 Version history
  22 ===============
  23
  24 +------------+----------+------------------+------------------------+
  25 | **Date**   | **Ver.** | **Author**       | **Comment**            |
  26 |            |          |                  |                        |
  27 +------------+----------+------------------+------------------------+
  28 | 2016-08-17 | 1.0.0    | Morgan Richomme  | Functest for C release |
  29 |            |          | (Orange)         |                        |
  30 +------------+----------+------------------+------------------------+
  31
  32 OPNFV Colorado Release
  33 =========================
  34
  35 Functest deals with functional testing of the OPNFV solution.
  36 It includes test cases developed within the project and test cases developed in
  37 other OPNFV projects and other upstream communities.
  38
  39 The internal test cases are:
  40
  41  * healthcheck
  42  * vPing ssh
  43  * vPing userdata
  44  * Tempest Smoke Serial
  45  * Rally Sanity
  46  * ODL
  47  * Tempest full parallel
  48  * Rally full
  49  * vIMS
  50
  51 The OPNFV projects integrated into Functest framework for automation are:
  52
  53  * bgpvpn
  54  * Copper
  55  * Doctor
  56  * Domino
  57  * Moon
  58  * Multisite
  59  * ONOSFW
  60  * ONOS-sfc
  61  * ODL-sfc
  62  * Parser
  63  * Promise
  64  * Security scan
  65
  66 The validation of a scenario requires a subset of these tests depending
  67 on the installer and the scenario.
  68
  69 The 3 last internal test cases (tempest full parallel, Rally full and
  70 vIMS) are not considered for scenario validation.
  71
  72 Release Data
  73 ============
  74
  75 +--------------------------------------+--------------------------------------+
  76 | **Project**                          | functest                             |
  77 |                                      |                                      |
  78 +--------------------------------------+--------------------------------------+
  79 | **Repo/tag**                         | colorado.1.0                         |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82 | **Release designation**              | Colorado base release                |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85 | **Release date**                     | September 22 2016                    |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | **Purpose of the delivery**          | Colorado base release                |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91
  92 Deliverables
  93 ============
  94
  95 Software
  96 --------
  97
  98  - The Functest Docker image: * TODO link *
  99
 100  - The testapi Docker image: * TODO link *
 101
 102
 103 Documents
 104 ---------
 105
 106  - Installation/configuration guide: * TODO link *
 107
 108  - User Guide: * TODO link *
 109
 110  - Developer Guide: * TODO link *
 111
 112
 113 Version change
 114 ==============
 115
 116 Feature evolution
 117 -----------------
 118
 119  - refactoring of ODL functional tests (with upstream modifications)
 120
 121  - refactoring of testapi (update, swagger documentation, dockerization)
 122
 123  - jenkins logs improvement
 124
 125  - update integration of Doctor, Promise and SDNVPN  projects
 126
 127  - split Tempest and rally into 2 different tests: smoke and full
 128
 129  - vIMS test suite integration
 130
 131  - adoption of Kibana for dashboarding
 132
 133
 134 New features
 135 ------------
 136
 137  - Functest CLI to prepare and run the tests
 138
 139  - creation of the healthcheck test case
 140
 141  - support new scenarios (ocl, odl_l2-sfc, onos-sfc, lxd, moon, multisite)
 142
 143  - integration of new OPNFV feature projects (copper, domino, multisite,
 144  moon, parser, onos-sfc, odl-sfc, security scan)
 145
 146  - introduction of test tiers in functest framework
 147
 148  - automatic reporting
 149
 150  - introduction of a jenkins summary table
 151
 152  - support of ARM architecture
 153
 154
 155 Scenario Matrix
 156 ===============
 157
 158 For Colorado 1.0, Functest was tested on the following scenarios (if not
 159 precised, the scenario is a na scenario):
 160
 161 +---------------------+---------+---------+---------+---------+
 162 |    Scenario         |  Apex   | Compass |  Fuel   |   Joid  |
 163 +=====================+=========+=========+=========+=========+
 164 |   nosdn             |    X    |    X    |    X    |    X    |
 165 +---------------------+---------+---------+---------+---------+
 166 |   odl_l2            |    X    |    X    |    X    |    X    |
 167 +---------------------+---------+---------+---------+---------+
 168 |   odl_l3            |    X    |    X    |    X    |         |
 169 +---------------------+---------+---------+---------+---------+
 170 |   onos              |    X    |    X    |    X    |    X    |
 171 +---------------------+---------+---------+---------+---------+
 172 |   ocl               |         |    X    |         |         |
 173 +---------------------+---------+---------+---------+---------+
 174 |   ovs-noha (dpdk)   |         |         |    X    |         |
 175 +---------------------+---------+---------+---------+---------+
 176 |   kvm-noha          |         |         |    X    |         |
 177 +---------------------+---------+---------+---------+---------+
 178 |   odl_l2-bgpvpn     |    X    |         |    X    |         |
 179 +---------------------+---------+---------+---------+---------+
 180 |   odl_l2-sfc        |         |         |    X    |         |
 181 +---------------------+---------+---------+---------+---------+
 182 |   onos-sfc          |    X    |    X    |    X    |    X    |
 183 +---------------------+---------+---------+---------+---------+
 184 |   odl_l2-moon       |         |    X    |         |         |
 185 +---------------------+---------+---------+---------+---------+
 186 |   multisite         |         |         |         |         |
 187 +---------------------+---------+---------+---------+---------+
 188 |   lxd               |         |         |         |    X    |
 189 +---------------------+---------+---------+---------+---------+
 190
 191 Functest defines a scenario scoring based on the sum of the unitary test
 192 cases run in CI.
 193 The scoring method is described in https://wiki.opnfv.org/pages/viewpage.action?pageId=6828617
 194
 195 In Colorado, the functional tests have been sliced in different
 196 categories:
 197
 198 +----------------+-----------------------------------------------+
 199 | Category       |  Description                                  |
 200 +================+===============================================+
 201 | healthcheck    | Basic OpenStack commands                      |
 202 +----------------+-----------------------------------------------+
 203 | smoke          | vPings, Tempest and rally smoke tests         |
 204 +----------------+-----------------------------------------------+
 205 | sdn_suites     | Specific SDN feature tests                    |
 206 +----------------+-----------------------------------------------+
 207 | features       | OPNFV feature project functional test suites  |
 208 +----------------+-----------------------------------------------+
 209 | openstack      | Advanced, long duration OpenStack tests       |
 210 |                | (Tempest and Rally full suite). Each test may |
 211 |                | last several hours                            |
 212 +----------------+-----------------------------------------------+
 213 | vnf            | Complex scenarios dealing with orchestration, |
 214 |                | VNF deployment and tests (e.g. vIMS)          |
 215 +----------------+-----------------------------------------------+
 216
 217 For the scenario validation, we consider only the categories healthcheck,
 218 smoke, sdn_suites and features. These tests are run systematically in
 219 the CI daily loops.
 220
 221 Success criteria have been defined for these test cases, they can be
 222 PASS/FAIl or a success rate may be declared (100%, > 90%)
 223 All the criteria, as well as the test dependencies are declared in the
 224 ci/testcases.yaml file.
 225
 226 * TODO scoring table *
 227
 228 The reporting pages can be found at:
 229
 230  * apex: * TODO / check branch *
 231  * compass: * TODO / check branch *
 232  * fuel: * TODO / check branch *
 233  * joid: * TODO / check branch *
 234
 235 Colorado limitations
 236 -----------------------
 237
 238 - vPing userdata and Tempest cases related to metada service excluded
 239 from onos scenarios https://gerrit.opnfv.org/gerrit/#/c/18729/
 240
 241 - Tempest cases related to storage for joid scenarios
 242 https://gerrit.opnfv.org/gerrit/#/c/17871/
 243
 244 - vPing_ssh and vIMS excluded from bgpvpn and kvm scenario
 245
 246
 247 See known issues section for details
 248
 249
 250 Test and installer/scenario dependencies
 251 ========================================
 252
 253 It is not always possible to run all the test cases on all the scenarios.
 254 The following table details the dependencies of the test cases per
 255 scenario. The scenario dependencies (installer or scenario) are detailed
 256 in https://git.opnfv.org/cgit/functest/tree/ci/testcases.yaml
 257
 258 Test results
 259 ============
 260
 261 Test results are available in:
 262
 263  - test results document: http://artifacts.opnfv.org/functest
 264
 265  - jenkins logs on CI: https://build.opnfv.org/ci/view/functest/
 266
 267
 268 Known issues
 269 ------------
 270
 271
 272 Open JIRA tickets
 273 =================
 274
 275 +------------------+-----------------------------------------------+
 276 |   JIRA           |         Description                           |
 277 +==================+===============================================+
 278 +------------------+-----------------------------------------------+
 279 +------------------+-----------------------------------------------+
 280 +------------------+-----------------------------------------------+
 281 +------------------+-----------------------------------------------+
 282 +------------------+-----------------------------------------------+
 283
 284 Useful links
 285 ============
 286
 287  - wiki project page: https://wiki.opnfv.org/opnfv_functional_testing
 288
 289  - wiki Functest Colorado page: https://wiki.opnfv.org/display/functest/Functest+Colorado
 290
 291  - Functest repo: https://git.opnfv.org/cgit/functest
 292
 293  - Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
 294
 295  - JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
 296
 297  - Functest IRC chan: #opnfv-functest
 298
 299  - Functest reporting: http://testresults.opnfv.org/reporting
 300
 301  - Functest test configuration: https://git.opnfv.org/cgit/functest/tree/ci/testcases.yaml
 302
 303  - Functest Colorado user guide: * TODO *
 304
 305  - Functest installation/configuration guide: * TODO *
 306
 307  - Functest developer guide: * TODO *
 308
 309