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  * tempest_smoke
  36  * tempest_horizon
  37  * odl
  38  * tempest_neutron
  39  * tempest_cinder
  40  * tempest_keystone
  41  * tempest_heat
  42  * tempest_telemetry
  43  * rally_sanity
  44  * refstack_compute
  45  * refstack_object
  46  * refstack_platform
  47  * tempest_full
  48  * tempest_scenario
  49  * tempest_slow
  50  * patrole_admin
  51  * patrole_user
  52  * patrole_reader
  53  * tempest_barbican
  54  * tempest_octavia
  55  * tempest_cyborg
  56  * rally_full
  57  * rally_jobs
  58  * vmtp
  59  * shaker
  60  * cloudify
  61  * cloudify_ims
  62  * heat_ims
  63  * vyos_vrouter
  64  * juju_epc
  65
  66 Kubernetes
  67 ----------
  68
  69 The internal test cases are:
  70
  71  * k8s_quick
  72  * k8s_smoke
  73  * k8s_conformance
  74  * xrally_kubernetes
  75  * kube_hunter
  76  * kube_bench_master
  77  * kube_bench_node
  78  * xrally_kubernetes_full
  79  * k8s_vims
  80  * helm_vims
  81  * cnf_conformance
  82
  83 Release Data
  84 ============
  85
  86 +--------------------------------------+--------------------------------------+
  87 | **Project**                          | functest                             |
  88 +--------------------------------------+--------------------------------------+
  89 | **Repository branch**                | master                               |
  90 +--------------------------------------+--------------------------------------+
  91
  92 Deliverables
  93 ============
  94
  95 Software
  96 --------
  97
  98  Functest Docker images (OpenStack):
  99
 100  * https://hub.docker.com/r/opnfv/functest-healthcheck
 101  * https://hub.docker.com/r/opnfv/functest-smoke
 102  * https://hub.docker.com/r/opnfv/functest-benchmarking
 103  * https://hub.docker.com/r/opnfv/functest-vnf
 104  * https://hub.docker.com/r/opnfv/functest-smoke-cntt
 105  * https://hub.docker.com/r/opnfv/functest-benchmarking-cntt
 106
 107  Functest Docker images (Kubernetes):
 108
 109  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
 110  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
 111  * https://hub.docker.com/r/opnfv/functest-kubernetes-security
 112  * https://hub.docker.com/r/opnfv/functest-kubernetes-benchmarking
 113  * https://hub.docker.com/r/opnfv/functest-kubernetes-cnf
 114
 115 Docker tag for master: latest
 116
 117 Documents
 118 ---------
 119
 120  * Functest Guides: https://functest.readthedocs.io/en/latest/
 121  * API Docs: https://functest-api.readthedocs.io/en/latest/
 122
 123 Version change
 124 ==============
 125
 126 Key changes
 127 -----------
 128
 129  * update testcases and containers to `OpenStack master`_ and to
 130    `Kubernetes master`_
 131
 132 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
 133 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
 134
 135 Key benefits
 136 ------------
 137
 138  * the enduser can easily deploy its own `Functest toolchains`_ in few commands
 139  * everyone can pick stable Functest rolling releases (latest included)
 140  * Functest can verify VIM in production even on `Raspberry PI`_
 141  * all testcases can run in parallel (tested with 4 executors in our gates)
 142  * no remaining resources detected in our gates after multiple runs
 143
 144 .. _`Functest toolchains`: https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004
 145 .. _`Raspberry PI`: https://wiki.opnfv.org/display/functest/Run+Functest+containers+on+Raspberry+PI
 146
 147 Code quality
 148 ------------
 149
 150  * pylint: 10.00/10
 151  * code coverage: 70%
 152
 153 Useful links
 154 ============
 155
 156  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
 157  * Functest git repository: https://github.com/opnfv/functest
 158  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
 159  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
 160  * Functest IRC channel: #opnfv-functest
 161  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html