docs/release/release-notes/functest-release.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2
   3 ======================================
   4 OPNFV master release note for Functest
   5 ======================================
   6
   7 Abstract
   8 ========
   9
  10 This document contains the release notes of the Functest project.
  11
  12 OPNFV master Release
  13 ====================
  14
  15 Functest deals with functional testing of the OPNFV solution.
  16 It includes test cases developed within the project, test cases developed in
  17 other OPNFV projects and it also integrates test cases from other upstream
  18 communities.
  19
  20 OpenStack
  21 ---------
  22
  23 The internal test cases are:
  24
  25  * connection_check
  26  * tenantnetwork1
  27  * tenantnetwork2
  28  * vmready1
  29  * vmready2
  30  * singlevm1
  31  * singlevm2
  32  * vping_ssh
  33  * vping_userdata
  34  * cinder_test
  35  * api_check
  36  * snaps_health_check
  37  * odl
  38  * tempest_smoke
  39  * neutron-tempest-plugin-api
  40  * rally_sanity
  41  * refstack_defcore
  42  * patrole
  43  * snaps_smoke
  44  * neutron_trunk
  45  * networking-bgpvpn
  46  * networking-sfc
  47  * barbican
  48  * tempest_full
  49  * tempest_scenario
  50  * rally_full
  51  * cloudify
  52  * cloudify_ims
  53  * heat_ims
  54  * vyos_vrouter
  55  * juju_epc
  56  * vgpu
  57
  58 The OPNFV projects integrated into Functest framework for automation are:
  59
  60  * doctor
  61  * bgpvpn
  62  * odl-sfc
  63  * barometer
  64  * fds
  65  * stor4nfv_os
  66
  67 Kubernetes
  68 ----------
  69
  70 The internal test cases are:
  71
  72  * k8s_smoke
  73  * k8s_conformance
  74
  75 The OPNFV projects integrated into Functest framework for automation are:
  76
  77  * stor4nfv
  78  * clover
  79
  80 Release Data
  81 ============
  82
  83 +--------------------------------------+--------------------------------------+
  84 | **Project**                          | functest                             |
  85 +--------------------------------------+--------------------------------------+
  86 | **Repository branch**                | master                               |
  87 +--------------------------------------+--------------------------------------+
  88
  89 Deliverables
  90 ============
  91
  92 Software
  93 --------
  94
  95  Functest Docker images (OpenStack):
  96
  97  * https://hub.docker.com/r/opnfv/functest-healthcheck
  98  * https://hub.docker.com/r/opnfv/functest-smoke
  99  * https://hub.docker.com/r/opnfv/functest-benchmarking
 100  * https://hub.docker.com/r/opnfv/functest-features
 101  * https://hub.docker.com/r/opnfv/functest-components
 102  * https://hub.docker.com/r/opnfv/functest-vnf
 103
 104  Functest Docker images (Kubernetes):
 105
 106  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
 107  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
 108  * https://hub.docker.com/r/opnfv/functest-kubernetes-features
 109
 110 Docker tag for master: latest
 111
 112 Documents
 113 ---------
 114
 115  * Config Guide: https://functest.readthedocs.io/projects/configguide/en/latest/
 116  * User Guide: https://functest.readthedocs.io/projects/userguide/en/latest/
 117  * Developer Guide: https://functest.readthedocs.io/projects/devguide/en/latest/
 118  * API Docs: http://functest.readthedocs.io/en/latest/
 119
 120 Version change
 121 ==============
 122
 123 New test cases
 124 --------------
 125
 126  * tenantnetwork1
 127  * tenantnetwork2
 128  * vmready1
 129  * vmready2
 130  * singlevm1
 131  * singlevm2
 132  * cinder_test
 133  * neutron-tempest-plugin-api
 134  * rally_jobs
 135  * networking-bgpvpn
 136  * networking-sfc
 137  * barbican
 138  * vmtp
 139  * shaker
 140  * tempest_scenario
 141  * cloudify
 142  * heat_ims
 143  * vgpu
 144
 145 Key changes
 146 -----------
 147
 148  * update test cases and containers to `OpenStack master`_ and to
 149    `Kubernetes master`_
 150  * define new scenarios to ease writing testcases vs OpenStack
 151  * isolate all resources created in different tenants
 152  * fully remove all OPNFV logics
 153  * publish new Jenkins jobs
 154  * support VIO (VMware Integrated OpenStack) and arm64 for Kubernetes
 155  * reduce Functest Kubernetes image sizes
 156  * add tempest_full and tempest_scenario in all daily jobs
 157  * include benchmarking tools such as Vmtp ans Shaker
 158  * increase functional scope by adding bgpvpn and sfc tempest plugins
 159
 160 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
 161 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
 162
 163 Key benefits
 164 ------------
 165
 166  * the enduser can easily build its own toolchains by loading our Jenkins jobs
 167  * all developpers can easily verify their changes before merge
 168  * our testcases may be run vs VIM in production
 169  * all testcases can run in parallel to decrease the overall duration
 170  * Functest includes most of the OpenStack gate jobs
 171
 172 Code quality
 173 ------------
 174
 175  * pylint: ~9.5/10
 176  * code coverage: ~70%
 177
 178 Useful links
 179 ============
 180
 181  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
 182  * Functest git repository: https://git.opnfv.org/cgit/functest
 183  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
 184  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
 185  * Functest IRC channel: #opnfv-functest
 186  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html