summaryrefslogtreecommitdiffstats
path: root/utils/test/reporting/functest/reporting-status.py
blob: 95f9e66e8def0e993ff99c79d74fc2b1df96c18f (plain)
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
#!/usr/bin/python
#
# This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
import datetime
import jinja2
import os
import requests
import sys
import time
import yaml

import testCase as tc
import scenarioResult as sr

# manage conf
import utils.reporting_utils as rp_utils

# Logger
logger = rp_utils.getLogger("Functest-Status")

# Initialization
testValid = []
otherTestCases = []
reportingDate = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")

# init just connection_check to get the list of scenarios
# as all the scenarios run connection_check
healthcheck = tc.TestCase("connection_check", "functest", -1)

# Retrieve the Functest configuration to detect which tests are relevant
# according to the installer, scenario
cf = rp_utils.get_config('functest.test_conf')
period = rp_utils.get_config('general.period')
versions = rp_utils.get_config('general.versions')
installers = rp_utils.get_config('general.installers')
blacklist = rp_utils.get_config('functest.blacklist')
log_level = rp_utils.get_config('general.log.log_level')
exclude_noha = rp_utils.get_config('functest.exclude_noha')
exclude_virtual = rp_utils.get_config('functest.exclude_virtual')

response = requests.get(cf)

functest_yaml_config = yaml.safe_load(response.text)

logger.info("*******************************************")
logger.info("*                                         *")
logger.info("*   Generating reporting scenario status  *")
logger.info("*   Data retention: %s days               *" % period)
logger.info("*   Log level: %s                         *" % log_level)
logger.info("*                                         *")
logger.info("*   Virtual PODs exluded: %s              *" % exclude_virtual)
logger.info("*   NOHA scenarios excluded: %s           *" % exclude_noha)
logger.info("*                                         *")
logger.info("*******************************************")

# Retrieve test cases of Tier 1 (smoke)
config_tiers = functest_yaml_config.get("tiers")

# we consider Tier 0 (Healthcheck), Tier 1 (smoke),2 (features)
# to validate scenarios
# Tier > 2 are not used to validate scenarios but we display the results anyway
# tricky thing for the API as some tests are Functest tests
# other tests are declared directly in the feature projects
for tier in config_tiers:
    if tier['order'] >= 0 and tier['order'] < 2:
        for case in tier['testcases']:
            if case['name'] not in blacklist:
                testValid.append(tc.TestCase(case['name'],
                                             "functest",
                                             case['dependencies']))
    elif tier['order'] == 2:
        for case in tier['testcases']:
            if case['name'] not in blacklist:
                testValid.append(tc.TestCase(case['name'],
                                             case['name'],
                                             case['dependencies']))
    elif tier['order'] > 2:
        for case in tier['testcases']:
            if case['name'] not in blacklist:
                otherTestCases.append(tc.TestCase(case['name'],
                                                  "functest",
                                                  case['dependencies']))

logger.debug("Functest reporting start")
# For all the versions
for version in versions:
    # For all the installers
    for installer in installers:
        # get scenarios
        scenario_results = rp_utils.getScenarios(healthcheck,
                                                 installer,
                                                 version)
        scenario_stats = rp_utils.getScenarioStats(scenario_results)
        items = {}
        scenario_result_criteria = {}
        scenario_file_name = ("./display/" + version +
                              "/functest/scenario_history.txt")
        # initiate scenario file if it does not exist
        if not os.path.isfile(scenario_file_name):
            with open(scenario_file_name, "a") as my_file:
                logger.debug("Create scenario file: %s" % scenario_file_name)
                my_file.write("date,scenario,installer,detail,score\n")

        # For all the scenarios get results
        for s, s_result in scenario_results.items():
            logger.info("---------------------------------")
            logger.info("installer %s, version %s, scenario %s:" %
                        (installer, version, s))
            logger.debug("Scenario results: %s" % s_result)

            # Green or Red light for a given scenario
            nb_test_runnable_for_this_scenario = 0
            scenario_score = 0
            # url of the last jenkins log corresponding to a given
            # scenario
            s_url = ""
            if len(s_result) > 0:
                build_tag = s_result[len(s_result)-1]['build_tag']
                logger.debug("Build tag: %s" % build_tag)
                s_url = s_url = rp_utils.getJenkinsUrl(build_tag)
                logger.info("last jenkins url: %s" % s_url)
            testCases2BeDisplayed = []
            # Check if test case is runnable / installer, scenario
            # for the test case used for Scenario validation
            try:
                # 1) Manage the test cases for the scenario validation
                # concretely Tiers 0-3
                for test_case in testValid:
                    test_case.checkRunnable(installer, s,
                                            test_case.getConstraints())
                    logger.debug("testcase %s (%s) is %s" %
                                 (test_case.getDisplayName(),
                                  test_case.getName(),
                                  test_case.isRunnable))
                    time.sleep(1)
                    if test_case.isRunnable:
                        dbName = test_case.getDbName()
                        name = test_case.getName()
                        displayName = test_case.getDisplayName()
                        project = test_case.getProject()
                        nb_test_runnable_for_this_scenario += 1
                        logger.info(" Searching results for case %s " %
                                    (displayName))
                        result = rp_utils.getResult(dbName, installer,
                                                    s, version)
                        # if no result set the value to 0
                        if result < 0:
                            result = 0
                        logger.info(" >>>> Test score = " + str(result))
                        test_case.setCriteria(result)
                        test_case.setIsRunnable(True)
                        testCases2BeDisplayed.append(tc.TestCase(name,
                                                                 project,
                                                                 "",
                                                                 result,
                                                                 True,
                                                                 1))
                        scenario_score = scenario_score + result

                # 2) Manage the test cases for the scenario qualification
                # concretely Tiers > 3
                for test_case in otherTestCases:
                    test_case.checkRunnable(installer, s,
                                            test_case.getConstraints())
                    logger.debug("testcase %s (%s) is %s" %
                                 (test_case.getDisplayName(),
                                  test_case.getName(),
                                  test_case.isRunnable))
                    time.sleep(1)
                    if test_case.isRunnable:
                        dbName = test_case.getDbName()
                        name = test_case.getName()
                        displayName = test_case.getDisplayName()
                        project = test_case.getProject()
                        logger.info(" Searching results for case %s " %
                                    (displayName))
                        result = rp_utils.getResult(dbName, installer,
                                                    s, version)
                        # at least 1 result for the test
                        if result > -1:
                            test_case.setCriteria(result)
                            test_case.setIsRunnable(True)
                            testCases2BeDisplayed.append(tc.TestCase(name,
                                                                     project,
                                                                     "",
                                                                     result,
                                                                     True,
                                                                     4))
                        else:
                            logger.debug("No results found")

                    items[s] = testCases2BeDisplayed
            except:
                logger.error("Error: installer %s, version %s, scenario %s" %
                             (installer, version, s))
                logger.error("No data available: %s " % (sys.exc_info()[0]))

            # **********************************************
            # Evaluate the results for scenario validation
            # **********************************************
            # the validation criteria = nb runnable tests x 3
            # because each test case = 0,1,2 or 3
            scenario_criteria = nb_test_runnable_for_this_scenario * 3
            # if 0 runnable tests set criteria at a high value
            if scenario_criteria < 1:
                scenario_criteria = 50  # conf.MAX_SCENARIO_CRITERIA

            s_score = str(scenario_score) + "/" + str(scenario_criteria)
            s_score_percent = rp_utils.getScenarioPercent(scenario_score,
                                                          scenario_criteria)

            s_status = "KO"
            if scenario_score < scenario_criteria:
                logger.info(">>>> scenario not OK, score = %s/%s" %
                            (scenario_score, scenario_criteria))
                s_status = "KO"
            else:
                logger.info(">>>>> scenario OK, save the information")
                s_status = "OK"
                path_validation_file = ("./display/" + version +
                                        "/functest/" +
                                        "validated_scenario_history.txt")
                with open(path_validation_file, "a") as f:
                    time_format = "%Y-%m-%d %H:%M"
                    info = (datetime.datetime.now().strftime(time_format) +
                            ";" + installer + ";" + s + "\n")
                    f.write(info)

            # Save daily results in a file
            with open(scenario_file_name, "a") as f:
                info = (reportingDate + "," + s + "," + installer +
                        "," + s_score + "," +
                        str(round(s_score_percent)) + "\n")
                f.write(info)

            scenario_result_criteria[s] = sr.ScenarioResult(s_status,
                                                            s_score,
                                                            s_score_percent,
                                                            s_url)
            logger.info("--------------------------")

        templateLoader = jinja2.FileSystemLoader(".")
        templateEnv = jinja2.Environment(
            loader=templateLoader, autoescape=True)

        TEMPLATE_FILE = "./functest/template/index-status-tmpl.html"
        template = templateEnv.get_template(TEMPLATE_FILE)

        outputText = template.render(scenario_stats=scenario_stats,
                                     scenario_results=scenario_result_criteria,
                                     items=items,
                                     installer=installer,
                                     period=period,
                                     version=version,
                                     date=reportingDate)

        with open("./display/" + version +
                  "/functest/status-" + installer + ".html", "wb") as fh:
            fh.write(outputText)

        logger.info("Manage export CSV & PDF")
        rp_utils.export_csv(scenario_file_name, installer, version)
        logger.error("CSV generated...")

        # Generate outputs for export
        # pdf
        # TODO Change once web site updated...use the current one
        # to test pdf production
        url_pdf = rp_utils.get_config('general.url')
        pdf_path = ("./display/" + version +
                    "/functest/status-" + installer + ".html")
        pdf_doc_name = ("./display/" + version +
                        "/functest/status-" + installer + ".pdf")
        rp_utils.export_pdf(pdf_path, pdf_doc_name)
        logger.info("PDF generated...")