utils/test/reporting/functest/reporting-status.py

   1 #!/usr/bin/python
   2 #
   3 # This program and the accompanying materials
   4 # are made available under the terms of the Apache License, Version 2.0
   5 # which accompanies this distribution, and is available at
   6 #
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 import datetime
  10 import jinja2
  11 import os
  12 import sys
  13 import time
  14
  15 import testCase as tc
  16 import scenarioResult as sr
  17
  18 # manage conf
  19 import utils.reporting_utils as rp_utils
  20
  21 # Logger
  22 logger = rp_utils.getLogger("Functest-Status")
  23
  24 # Initialization
  25 testValid = []
  26 otherTestCases = []
  27 reportingDate = datetime.datetime.now().strftime("%Y-%m-%d %H:%M")
  28
  29 # init just connection_check to get the list of scenarios
  30 # as all the scenarios run connection_check
  31 healthcheck = tc.TestCase("connection_check", "functest", -1)
  32
  33 # Retrieve the Functest configuration to detect which tests are relevant
  34 # according to the installer, scenario
  35 cf = rp_utils.get_config('functest.test_conf')
  36 period = rp_utils.get_config('general.period')
  37 versions = rp_utils.get_config('general.versions')
  38 installers = rp_utils.get_config('general.installers')
  39 blacklist = rp_utils.get_config('functest.blacklist')
  40 log_level = rp_utils.get_config('general.log.log_level')
  41 exclude_noha = rp_utils.get_config('functest.exclude_noha')
  42 exclude_virtual = rp_utils.get_config('functest.exclude_virtual')
  43
  44 functest_yaml_config = rp_utils.getFunctestConfig()
  45
  46 logger.info("*******************************************")
  47 logger.info("*                                         *")
  48 logger.info("*   Generating reporting scenario status  *")
  49 logger.info("*   Data retention: %s days               *" % period)
  50 logger.info("*   Log level: %s                         *" % log_level)
  51 logger.info("*                                         *")
  52 logger.info("*   Virtual PODs exluded: %s              *" % exclude_virtual)
  53 logger.info("*   NOHA scenarios excluded: %s           *" % exclude_noha)
  54 logger.info("*                                         *")
  55 logger.info("*******************************************")
  56
  57 # Retrieve test cases of Tier 1 (smoke)
  58 config_tiers = functest_yaml_config.get("tiers")
  59
  60 # we consider Tier 0 (Healthcheck), Tier 1 (smoke),2 (features)
  61 # to validate scenarios
  62 # Tier > 2 are not used to validate scenarios but we display the results anyway
  63 # tricky thing for the API as some tests are Functest tests
  64 # other tests are declared directly in the feature projects
  65 for tier in config_tiers:
  66     if tier['order'] >= 0 and tier['order'] < 2:
  67         for case in tier['testcases']:
  68             if case['case_name'] not in blacklist:
  69                 testValid.append(tc.TestCase(case['case_name'],
  70                                              "functest",
  71                                              case['dependencies']))
  72     elif tier['order'] == 2:
  73         for case in tier['testcases']:
  74             if case['case_name'] not in blacklist:
  75                 testValid.append(tc.TestCase(case['case_name'],
  76                                              case['case_name'],
  77                                              case['dependencies']))
  78     elif tier['order'] > 2:
  79         for case in tier['testcases']:
  80             if case['case_name'] not in blacklist:
  81                 otherTestCases.append(tc.TestCase(case['case_name'],
  82                                                   "functest",
  83                                                   case['dependencies']))
  84
  85 logger.debug("Functest reporting start")
  86
  87 # For all the versions
  88 for version in versions:
  89     # For all the installers
  90     scenario_directory = "./display/" + version + "/functest/"
  91     scenario_file_name = scenario_directory + "scenario_history.txt"
  92
  93     # check that the directory exists, if not create it
  94     # (first run on new version)
  95     if not os.path.exists(scenario_directory):
  96         os.makedirs(scenario_directory)
  97
  98     # initiate scenario file if it does not exist
  99     if not os.path.isfile(scenario_file_name):
 100         with open(scenario_file_name, "a") as my_file:
 101             logger.debug("Create scenario file: %s" % scenario_file_name)
 102             my_file.write("date,scenario,installer,detail,score\n")
 103
 104     for installer in installers:
 105
 106         # get scenarios
 107         scenario_results = rp_utils.getScenarios(healthcheck,
 108                                                  installer,
 109                                                  version)
 110
 111         # get nb of supported architecture (x86, aarch64)
 112         architectures = rp_utils.getArchitectures(scenario_results)
 113         logger.info("Supported architectures: {}".format(architectures))
 114
 115         for architecture in architectures:
 116             logger.info("architecture: {}".format(architecture))
 117             # Consider only the results for the selected architecture
 118             # i.e drop x86 for aarch64 and vice versa
 119             filter_results = rp_utils.filterArchitecture(scenario_results,
 120                                                          architecture)
 121             scenario_stats = rp_utils.getScenarioStats(filter_results)
 122             items = {}
 123             scenario_result_criteria = {}
 124
 125             # in case of more than 1 architecture supported
 126             # precise the architecture
 127             installer_display = installer
 128             if (len(architectures) > 1):
 129                 installer_display = installer + "@" + architecture
 130
 131             # For all the scenarios get results
 132             for s, s_result in filter_results.items():
 133                 logger.info("---------------------------------")
 134                 logger.info("installer %s, version %s, scenario %s:" %
 135                             (installer, version, s))
 136                 logger.debug("Scenario results: %s" % s_result)
 137
 138                 # Green or Red light for a given scenario
 139                 nb_test_runnable_for_this_scenario = 0
 140                 scenario_score = 0
 141                 # url of the last jenkins log corresponding to a given
 142                 # scenario
 143                 s_url = ""
 144                 if len(s_result) > 0:
 145                     build_tag = s_result[len(s_result)-1]['build_tag']
 146                     logger.debug("Build tag: %s" % build_tag)
 147                     s_url = rp_utils.getJenkinsUrl(build_tag)
 148                     if s_url is None:
 149                         s_url = "http://testresultS.opnfv.org/reporting"
 150                     logger.info("last jenkins url: %s" % s_url)
 151                 testCases2BeDisplayed = []
 152                 # Check if test case is runnable / installer, scenario
 153                 # for the test case used for Scenario validation
 154                 try:
 155                     # 1) Manage the test cases for the scenario validation
 156                     # concretely Tiers 0-3
 157                     for test_case in testValid:
 158                         test_case.checkRunnable(installer, s,
 159                                                 test_case.getConstraints())
 160                         logger.debug("testcase %s (%s) is %s" %
 161                                      (test_case.getDisplayName(),
 162                                       test_case.getName(),
 163                                       test_case.isRunnable))
 164                         time.sleep(1)
 165                         if test_case.isRunnable:
 166                             name = test_case.getName()
 167                             displayName = test_case.getDisplayName()
 168                             project = test_case.getProject()
 169                             nb_test_runnable_for_this_scenario += 1
 170                             logger.info(" Searching results for case %s " %
 171                                         (displayName))
 172                             result = rp_utils.getResult(name, installer,
 173                                                         s, version)
 174                             # if no result set the value to 0
 175                             if result < 0:
 176                                 result = 0
 177                             logger.info(" >>>> Test score = " + str(result))
 178                             test_case.setCriteria(result)
 179                             test_case.setIsRunnable(True)
 180                             testCases2BeDisplayed.append(tc.TestCase(name,
 181                                                                      project,
 182                                                                      "",
 183                                                                      result,
 184                                                                      True,
 185                                                                      1))
 186                             scenario_score = scenario_score + result
 187
 188                     # 2) Manage the test cases for the scenario qualification
 189                     # concretely Tiers > 3
 190                     for test_case in otherTestCases:
 191                         test_case.checkRunnable(installer, s,
 192                                                 test_case.getConstraints())
 193                         logger.debug("testcase %s (%s) is %s" %
 194                                      (test_case.getDisplayName(),
 195                                       test_case.getName(),
 196                                       test_case.isRunnable))
 197                         time.sleep(1)
 198                         if test_case.isRunnable:
 199                             name = test_case.getName()
 200                             displayName = test_case.getDisplayName()
 201                             project = test_case.getProject()
 202                             logger.info(" Searching results for case %s " %
 203                                         (displayName))
 204                             result = rp_utils.getResult(name, installer,
 205                                                         s, version)
 206                             # at least 1 result for the test
 207                             if result > -1:
 208                                 test_case.setCriteria(result)
 209                                 test_case.setIsRunnable(True)
 210                                 testCases2BeDisplayed.append(tc.TestCase(
 211                                     name,
 212                                     project,
 213                                     "",
 214                                     result,
 215                                     True,
 216                                     4))
 217                             else:
 218                                 logger.debug("No results found")
 219
 220                         items[s] = testCases2BeDisplayed
 221                 except:
 222                     logger.error("Error: installer %s, version %s, scenario %s"
 223                                  % (installer, version, s))
 224                     logger.error("No data available: %s" % (sys.exc_info()[0]))
 225
 226                 # **********************************************
 227                 # Evaluate the results for scenario validation
 228                 # **********************************************
 229                 # the validation criteria = nb runnable tests x 3
 230                 # because each test case = 0,1,2 or 3
 231                 scenario_criteria = nb_test_runnable_for_this_scenario * 3
 232                 # if 0 runnable tests set criteria at a high value
 233                 if scenario_criteria < 1:
 234                     scenario_criteria = 50  # conf.MAX_SCENARIO_CRITERIA
 235
 236                 s_score = str(scenario_score) + "/" + str(scenario_criteria)
 237                 s_score_percent = rp_utils.getScenarioPercent(
 238                     scenario_score,
 239                     scenario_criteria)
 240
 241                 s_status = "KO"
 242                 if scenario_score < scenario_criteria:
 243                     logger.info(">>>> scenario not OK, score = %s/%s" %
 244                                 (scenario_score, scenario_criteria))
 245                     s_status = "KO"
 246                 else:
 247                     logger.info(">>>>> scenario OK, save the information")
 248                     s_status = "OK"
 249                     path_validation_file = ("./display/" + version +
 250                                             "/functest/" +
 251                                             "validated_scenario_history.txt")
 252                     with open(path_validation_file, "a") as f:
 253                         time_format = "%Y-%m-%d %H:%M"
 254                         info = (datetime.datetime.now().strftime(time_format) +
 255                                 ";" + installer_display + ";" + s + "\n")
 256                         f.write(info)
 257
 258                 # Save daily results in a file
 259                 with open(scenario_file_name, "a") as f:
 260                     info = (reportingDate + "," + s + "," + installer_display +
 261                             "," + s_score + "," +
 262                             str(round(s_score_percent)) + "\n")
 263                     f.write(info)
 264
 265                 scenario_result_criteria[s] = sr.ScenarioResult(
 266                     s_status,
 267                     s_score,
 268                     s_score_percent,
 269                     s_url)
 270                 logger.info("--------------------------")
 271
 272             templateLoader = jinja2.FileSystemLoader(".")
 273             templateEnv = jinja2.Environment(
 274                 loader=templateLoader, autoescape=True)
 275
 276             TEMPLATE_FILE = "./functest/template/index-status-tmpl.html"
 277             template = templateEnv.get_template(TEMPLATE_FILE)
 278
 279             outputText = template.render(
 280                             scenario_stats=scenario_stats,
 281                             scenario_results=scenario_result_criteria,
 282                             items=items,
 283                             installer=installer_display,
 284                             period=period,
 285                             version=version,
 286                             date=reportingDate)
 287
 288             with open("./display/" + version +
 289                       "/functest/status-" +
 290                       installer_display + ".html", "wb") as fh:
 291                 fh.write(outputText)
 292
 293             logger.info("Manage export CSV & PDF")
 294             rp_utils.export_csv(scenario_file_name, installer_display, version)
 295             logger.error("CSV generated...")
 296
 297             # Generate outputs for export
 298             # pdf
 299             # TODO Change once web site updated...use the current one
 300             # to test pdf production
 301             url_pdf = rp_utils.get_config('general.url')
 302             pdf_path = ("./display/" + version +
 303                         "/functest/status-" + installer_display + ".html")
 304             pdf_doc_name = ("./display/" + version +
 305                             "/functest/status-" + installer_display + ".pdf")
 306             rp_utils.export_pdf(pdf_path, pdf_doc_name)
 307             logger.info("PDF generated...")