1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
#!/usr/bin/env python3
# Copyright 2020 Orange, Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""
Generate result page
"""
import logging
import pathlib
import json
from dataclasses import dataclass
import os
import statistics
import wget
import yaml
from packaging.version import Version
from jinja2 import ( # pylint: disable=import-error
Environment,
select_autoescape,
PackageLoader,
)
# Logger
LOG_LEVEL = "INFO"
logging.basicConfig()
LOGGER = logging.getLogger("onap-versions-status-reporting")
LOGGER.setLevel(LOG_LEVEL)
REPORTING_FILE = "/var/lib/xtesting/results/versions_reporting.html"
# REPORTING_FILE = "/tmp/versions_reporting.html"
RESULT_FILE = "/tmp/versions.json"
RECOMMENDED_VERSIONS_FILE = "/tmp/recommended_versions.yaml"
WAIVER_LIST_FILE = "/tmp/versions_xfail.txt"
@dataclass
class TestResult:
"""Test results retrieved from xtesting."""
pod_name: str
container: str
image: str
python_version: str
python_status: int
java_version: str
java_status: int
@dataclass
class SerieResult:
"""Serie of tests."""
serie_id: str
success_rate: int = 0
min: int = 0
max: int = 0
mean: float = 0.0
median: float = 0.0
nb_occurences: int = 0
class OnapVersionsReporting:
"""Build html summary page."""
def __init__(self, result_file) -> None:
"""Initialization of the report."""
version = os.getenv("ONAP_VERSION", "master")
base_url = "https://git.onap.org/integration/seccom/plain"
if pathlib.Path(WAIVER_LIST_FILE).is_file():
self._waiver_file = pathlib.Path(WAIVER_LIST_FILE)
else:
self._waiver_file = wget.download(
base_url + "/waivers/versions/versions_xfail.txt?h=" + version,
out=WAIVER_LIST_FILE,
)
if pathlib.Path(RECOMMENDED_VERSIONS_FILE).is_file():
self._recommended_versions_file = pathlib.Path(RECOMMENDED_VERSIONS_FILE)
else:
self._recommended_versions_file = wget.download(
base_url + "/recommended_versions.yaml?h=" + version,
out=RECOMMENDED_VERSIONS_FILE,
)
def get_versions_scan_results(self, result_file, waiver_list):
"""Get all the versions from the scan."""
testresult = []
# Get the recommended version list for java and python
min_java_version = self.get_recommended_version(
RECOMMENDED_VERSIONS_FILE, "java11"
)
min_python_version = self.get_recommended_version(
RECOMMENDED_VERSIONS_FILE, "python3"
)
LOGGER.info("Min Java recommended version: %s", min_java_version)
LOGGER.info("Min Python recommended version: %s", min_python_version)
with open(result_file) as json_file:
data = json.load(json_file)
LOGGER.info("Number of pods: %s", len(data))
for component in data:
if component["container"] not in waiver_list:
testresult.append(
TestResult(
pod_name=component["pod"],
container=component["container"],
image=component["extra"]["image"],
python_version=component["versions"]["python"],
java_version=component["versions"]["java"],
python_status=self.get_version_status(
component["versions"]["python"], min_python_version[0]
),
java_status=self.get_version_status(
component["versions"]["java"], min_java_version[0]
),
)
)
LOGGER.info("Nb of pods (after waiver filtering) %s", len(testresult))
return testresult
@staticmethod
def get_version_status(versions, min_version):
"""Based on the min version set the status of the component version."""
# status_code
# 0: only recommended version found
# 1: recommended version found but not alone
# 2: recommended version not found but not far
# 3: recommended version not found but not far but not alone
# 4: recommended version not found
# we assume that versions are given accordign to usual java way
# X.Y.Z
LOGGER.debug("Version = %s", versions)
LOGGER.debug("Min Version = %s", min_version)
nb_versions_found = len(versions)
status_code = -1
LOGGER.debug("Nb versions found :%s", nb_versions_found)
# if no version found retrieved -1
if nb_versions_found > 0:
for version in versions:
clean_version = Version(version.replace("_", "."))
min_version_ok = str(min_version)
if clean_version >= Version(min_version_ok):
if nb_versions_found < 2:
status_code = 0
else:
status_code = 2
elif clean_version.major >= Version(min_version_ok).major:
if nb_versions_found < 2:
status_code = 1
else:
status_code = 3
else:
status_code = 4
LOGGER.debug("Version status code = %s", status_code)
return status_code
@staticmethod
def get_recommended_version(recommended_versions_file, component):
"""Retrieve data from the json file."""
with open(recommended_versions_file) as stream:
data = yaml.safe_load(stream)
try:
recommended_version = data[component]["recommended_versions"]
except KeyError:
recommended_version = None
return recommended_version
@staticmethod
def get_waiver_list(waiver_file_path):
"""Get the waiver list."""
pods_to_be_excluded = []
with open(waiver_file_path) as waiver_list:
for line in waiver_list:
line = line.strip("\n")
line = line.strip("\t")
if not line.startswith("#"):
pods_to_be_excluded.append(line)
return pods_to_be_excluded
@staticmethod
def get_score(component_type, scan_res):
# Look at the java and python results
# 0 = recommended version
# 1 = acceptable version
nb_good_versions = 0
nb_results = 0
for res in scan_res:
if component_type == "java":
if res.java_status >= 0:
nb_results += 1
if res.java_status < 2:
nb_good_versions += 1
elif component_type == "python":
if res.python_status >= 0:
nb_results += 1
if res.python_status < 2:
nb_good_versions += 1
try:
return round(nb_good_versions * 100 / nb_results, 1)
except ZeroDivisionError:
LOGGER.error("Impossible to calculate the success rate")
return 0
def generate_reporting(self, result_file):
"""Generate HTML reporting page."""
LOGGER.info("Generate versions HTML report.")
# Get the waiver list
waiver_list = self.get_waiver_list(self._waiver_file)
LOGGER.info("Waiver list: %s", waiver_list)
# Get the Versions results
scan_res = self.get_versions_scan_results(result_file, waiver_list)
LOGGER.info("scan_res: %s", scan_res)
# Evaluate result
status_res = {"java": 0, "python": 0}
for component_type in "java", "python":
status_res[component_type] = self.get_score(component_type, scan_res)
LOGGER.info("status_res: %s", status_res)
# Calculate the average score
numbers = [status_res[key] for key in status_res]
mean_ = statistics.mean(numbers)
# Create reporting page
jinja_env = Environment(
autoescape=select_autoescape(["html"]),
loader=PackageLoader("versions"),
)
page_info = {
"title": "ONAP Integration versions reporting",
"success_rate": status_res,
"mean": mean_,
}
jinja_env.get_template("versions.html.j2").stream(
info=page_info, data=scan_res
).dump("{}".format(REPORTING_FILE))
return mean_
if __name__ == "__main__":
test = OnapVersionsReporting(
RESULT_FILE, WAIVER_LIST_FILE, RECOMMENDED_VERSIONS_FILE
)
test.generate_reporting(RESULT_FILE)
|
