Merge "Update Pylint score (10/10) in Release notes"
[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  * odl
36  * tempest_smoke
37  * neutron-tempest-plugin-api
38  * rally_sanity
39  * refstack_defcore
40  * patrole
41  * neutron_trunk
42  * networking-bgpvpn
43  * networking-sfc
44  * barbican
45  * tempest_full
46  * tempest_scenario
47  * rally_full
48  * cloudify
49  * cloudify_ims
50  * heat_ims
51  * vyos_vrouter
52  * juju_epc
53  * vgpu
54
55 The OPNFV projects integrated into Functest framework for automation are:
56
57  * doctor
58  * odl-sfc
59  * barometer
60  * stor4nfv_os
61
62 Kubernetes
63 ----------
64
65 The internal test cases are:
66
67  * k8s_smoke
68  * k8s_conformance
69
70 The OPNFV projects integrated into Functest framework for automation are:
71
72  * stor4nfv
73  * clover
74
75 Release Data
76 ============
77
78 +--------------------------------------+--------------------------------------+
79 | **Project**                          | functest                             |
80 +--------------------------------------+--------------------------------------+
81 | **Repository branch**                | master                               |
82 +--------------------------------------+--------------------------------------+
83
84 Deliverables
85 ============
86
87 Software
88 --------
89
90  Functest Docker images (OpenStack):
91
92  * https://hub.docker.com/r/opnfv/functest-healthcheck
93  * https://hub.docker.com/r/opnfv/functest-smoke
94  * https://hub.docker.com/r/opnfv/functest-benchmarking
95  * https://hub.docker.com/r/opnfv/functest-features
96  * https://hub.docker.com/r/opnfv/functest-vnf
97
98  Functest Docker images (Kubernetes):
99
100  * https://hub.docker.com/r/opnfv/functest-kubernetes-healthcheck
101  * https://hub.docker.com/r/opnfv/functest-kubernetes-smoke
102  * https://hub.docker.com/r/opnfv/functest-kubernetes-features
103
104 Docker tag for master: latest
105
106 Documents
107 ---------
108
109  * Functests Guides: https://functest.readthedocs.io/en/latest/
110  * API Docs: https://functest-api.readthedocs.io/en/latest/
111
112 Version change
113 ==============
114
115 Key changes
116 -----------
117
118  * update testcases and containers to `OpenStack master`_ and to
119    `Kubernetes master`_
120
121 .. _`OpenStack master`: https://github.com/openstack/requirements/blob/master/upper-constraints.txt
122 .. _`Kubernetes master`: https://github.com/kubernetes/kubernetes
123
124 Key benefits
125 ------------
126
127  * Functest master is conformed with OpenStack Gates
128  * Functest VNF testcases could be executed in Openstack Gates
129
130 Code quality
131 ------------
132
133  * pylint: 10.00/10
134  * code coverage: 71%
135
136 Useful links
137 ============
138
139  * wiki project page: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
140  * Functest git repository: https://github.com/opnfv/functest
141  * Functest CI dashboard: https://build.opnfv.org/ci/view/functest/
142  * JIRA dashboard: https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10611
143  * Functest IRC channel: #opnfv-functest
144  * Reporting page: http://testresults.opnfv.org/reporting/master/functest/functest.html