Remove Functest gating
[functest.git] / 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  * Functests Guides: https://functest.readthedocs.io/en/latest/
116  * API Docs: https://functest-api.readthedocs.io/en/latest/
117
118 Version change
119 ==============
120
121 New test cases
122 --------------
123
124  * tenantnetwork1
125  * tenantnetwork2
126  * vmready1
127  * vmready2
128  * singlevm1
129  * singlevm2
130  * cinder_test
131  * neutron-tempest-plugin-api
132  * rally_jobs
133  * networking-bgpvpn
134  * networking-sfc
135  * barbican
136  * vmtp
137  * shaker
138  * tempest_scenario
139  * cloudify
140  * heat_ims
141  * vgpu
142
143 Key changes
144 -----------
145
146  * update test cases and containers to `OpenStack master`_ and to
147    `Kubernetes master`_
148  * define new scenarios to ease writing testcases vs OpenStack
149  * isolate all resources created in different tenants
150  * fully remove all OPNFV logics
151  * publish new Jenkins jobs
152  * support VIO (VMware Integrated OpenStack) and arm64 for Kubernetes
153  * reduce Functest Kubernetes image sizes
154  * add tempest_full and tempest_scenario in all daily jobs
155  * include benchmarking tools such as Vmtp ans Shaker
156  * increase functional scope by adding bgpvpn and sfc tempest plugins
157
158 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
159 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
160
161 Key benefits
162 ------------
163
164  * the enduser can easily build its own toolchains by loading our Jenkins jobs
165  * all developpers can easily verify their changes before merge
166  * our testcases may be run vs VIM in production
167  * all testcases can run in parallel to decrease the overall duration
168  * Functest includes most of the OpenStack gate jobs
169
170 Code quality
171 ------------
172
173  * pylint: ~9.5/10
174  * code coverage: ~70%
175
176 Useful links
177 ============
178
179  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
180  * Functest git repository: https://git.opnfv.org/cgit/functest
181  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
182  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
183  * Functest IRC channel: #opnfv-functest
184  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html