Initiate packetization of Testing reporting

Testing reporting provides
- static reporting pages [1] (jinja2)
- landing pages including test case catalogue [2] (angular)

It consumes the Test API to build web pages providing status for
the testing projects (so far functest, yardstick, storperf and
qtip).

Dockerization has been initiated [3]. The goal is to replace the
static page hosted on testresults.opnfv.org by a docker regenerated
and redeployed when reporting code is changed

But the docker and more generally the testing reporting directory
must be refactored to
- manage dependencies properly
- leverage tox (py27, docs, pylint, pep8)

This patch
- setups tox (py27, pep8, pylint, docs)
- integrate the requirement management
- fix pep8 errors
- introduce 1 dummy unit test

This patch does not
- fix pylint errors
- create any doc

[1]: http://testresults.opnfv.org/reporting2/display/index.html
[2]: http://testresults.opnfv.org/reporting2/reporting/index.html
[3]: https://gerrit.opnfv.org/gerrit/#/c/36735/

Change-Id: I4613de7ca7036d6c6bbb8f58ade492b1d673599b
Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>

3 files changed, 0 insertions, 494 deletions

diff --git a/reporting/utils/__init__.py b/reporting/utils/__init__.py
deleted file mode 100644
index e69de29..0000000
--- a/reporting/utils/__init__.py
+++ /dev/null
diff --git a/reporting/utils/reporting_utils.py b/reporting/utils/reporting_utils.py
deleted file mode 100644
index 0a178ba..0000000
--- a/reporting/utils/reporting_utils.py
+++ /dev/null
@@ -1,461 +0,0 @@
-#!/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
-#
-from urllib2 import Request, urlopen, URLError
-import logging
-import json
-import os
-import requests
-import pdfkit
-import yaml
-
-
-# ----------------------------------------------------------
-#
-#               YAML UTILS
-#
-# -----------------------------------------------------------
-def get_parameter_from_yaml(parameter, file):
-    """
-    Returns the value of a given parameter in file.yaml
-    parameter must be given in string format with dots
-    Example: general.openstack.image_name
-    """
-    with open(file) as f:
-        file_yaml = yaml.safe_load(f)
-    f.close()
-    value = file_yaml
-    for element in parameter.split("."):
-        value = value.get(element)
-        if value is None:
-            raise ValueError("The parameter %s is not defined in"
-                             " reporting.yaml" % parameter)
-    return value
-
-
-def get_config(parameter):
-    yaml_ = os.environ["CONFIG_REPORTING_YAML"]
-    return get_parameter_from_yaml(parameter, yaml_)
-
-
-# ----------------------------------------------------------
-#
-#               LOGGER UTILS
-#
-# -----------------------------------------------------------
-def getLogger(module):
-    logFormatter = logging.Formatter("%(asctime)s [" +
-                                     module +
-                                     "] [%(levelname)-5.5s]  %(message)s")
-    logger = logging.getLogger()
-    log_file = get_config('general.log.log_file')
-    log_level = get_config('general.log.log_level')
-
-    fileHandler = logging.FileHandler("{0}/{1}".format('.', log_file))
-    fileHandler.setFormatter(logFormatter)
-    logger.addHandler(fileHandler)
-
-    consoleHandler = logging.StreamHandler()
-    consoleHandler.setFormatter(logFormatter)
-    logger.addHandler(consoleHandler)
-    logger.setLevel(log_level)
-    return logger
-
-
-# ----------------------------------------------------------
-#
-#               REPORTING UTILS
-#
-# -----------------------------------------------------------
-def getApiResults(case, installer, scenario, version):
-    results = json.dumps([])
-    # to remove proxy (to be removed at the end for local test only)
-    # proxy_handler = urllib2.ProxyHandler({})
-    # opener = urllib2.build_opener(proxy_handler)
-    # urllib2.install_opener(opener)
-    # url = "http://127.0.0.1:8000/results?case=" + case + \
-    #       "&period=30&installer=" + installer
-    period = get_config('general.period')
-    url_base = get_config('testapi.url')
-    nb_tests = get_config('general.nb_iteration_tests_success_criteria')
-
-    url = ("http://" + url_base + "?case=" + case +
-           "&period=" + str(period) + "&installer=" + installer +
-           "&scenario=" + scenario + "&version=" + version +
-           "&last=" + str(nb_tests))
-    request = Request(url)
-
-    try:
-        response = urlopen(request)
-        k = response.read()
-        results = json.loads(k)
-    except URLError as e:
-        print('No kittez. Got an error code:', e)
-
-    return results
-
-
-def getScenarios(case, installer, version):
-
-    try:
-        case = case.getName()
-    except:
-        # if case is not an object test case, try the string
-        if type(case) == str:
-            case = case
-        else:
-            raise ValueError("Case cannot be evaluated")
-
-    period = get_config('general.period')
-    url_base = get_config('testapi.url')
-
-    url = ("http://" + url_base + "?case=" + case +
-           "&period=" + str(period) + "&installer=" + installer +
-           "&version=" + version)
-
-    try:
-        request = Request(url)
-        response = urlopen(request)
-        k = response.read()
-        results = json.loads(k)
-        test_results = results['results']
-
-        page = results['pagination']['total_pages']
-        if page > 1:
-            test_results = []
-            for i in range(1, page + 1):
-                url_page = url + "&page=" + str(i)
-                request = Request(url_page)
-                response = urlopen(request)
-                k = response.read()
-                results = json.loads(k)
-                test_results += results['results']
-    except URLError as err:
-        print('Got an error code:', err)
-
-    if test_results is not None:
-        test_results.reverse()
-        scenario_results = {}
-
-        for r in test_results:
-            # Retrieve all the scenarios per installer
-            if not r['scenario'] in scenario_results.keys():
-                scenario_results[r['scenario']] = []
-            # Do we consider results from virtual pods ...
-            # Do we consider results for non HA scenarios...
-            exclude_virtual_pod = get_config('functest.exclude_virtual')
-            exclude_noha = get_config('functest.exclude_noha')
-            if ((exclude_virtual_pod and "virtual" in r['pod_name']) or
-                    (exclude_noha and "noha" in r['scenario'])):
-                print("exclude virtual pod results...")
-            else:
-                scenario_results[r['scenario']].append(r)
-
-    return scenario_results
-
-
-def getScenarioStats(scenario_results):
-    scenario_stats = {}
-    for k, v in scenario_results.iteritems():
-        scenario_stats[k] = len(v)
-
-    return scenario_stats
-
-
-def getScenarioStatus(installer, version):
-    period = get_config('general.period')
-    url_base = get_config('testapi.url')
-
-    url = ("http://" + url_base + "?case=scenario_status" +
-           "&installer=" + installer +
-           "&version=" + version + "&period=" + str(period))
-    request = Request(url)
-
-    try:
-        response = urlopen(request)
-        k = response.read()
-        response.close()
-        results = json.loads(k)
-        test_results = results['results']
-    except URLError as e:
-        print('Got an error code:', e)
-
-    scenario_results = {}
-    result_dict = {}
-    if test_results is not None:
-        for r in test_results:
-            if r['stop_date'] != 'None' and r['criteria'] is not None:
-                if not r['scenario'] in scenario_results.keys():
-                    scenario_results[r['scenario']] = []
-                scenario_results[r['scenario']].append(r)
-
-        for k, v in scenario_results.items():
-            # scenario_results[k] = v[:LASTEST_TESTS]
-            s_list = []
-            for element in v:
-                if element['criteria'] == 'SUCCESS':
-                    s_list.append(1)
-                else:
-                    s_list.append(0)
-            result_dict[k] = s_list
-
-    # return scenario_results
-    return result_dict
-
-
-def getQtipResults(version, installer):
-    period = get_config('qtip.period')
-    url_base = get_config('testapi.url')
-
-    url = ("http://" + url_base + "?project=qtip" +
-           "&installer=" + installer +
-           "&version=" + version + "&period=" + str(period))
-    request = Request(url)
-
-    try:
-        response = urlopen(request)
-        k = response.read()
-        response.close()
-        results = json.loads(k)['results']
-    except URLError as err:
-        print('Got an error code:', err)
-
-    result_dict = {}
-    if results:
-        for r in results:
-            key = '{}/{}'.format(r['pod_name'], r['scenario'])
-            if key not in result_dict.keys():
-                result_dict[key] = []
-            result_dict[key].append(r['details']['score'])
-
-    # return scenario_results
-    return result_dict
-
-
-def getNbtestOk(results):
-    nb_test_ok = 0
-    for r in results:
-        for k, v in r.iteritems():
-            try:
-                if "PASS" in v:
-                    nb_test_ok += 1
-            except:
-                print("Cannot retrieve test status")
-    return nb_test_ok
-
-
-def getResult(testCase, installer, scenario, version):
-
-    # retrieve raw results
-    results = getApiResults(testCase, installer, scenario, version)
-    # let's concentrate on test results only
-    test_results = results['results']
-
-    # if results found, analyze them
-    if test_results is not None:
-        test_results.reverse()
-
-        scenario_results = []
-
-        # print " ---------------- "
-        # print test_results
-        # print " ---------------- "
-        # print "nb of results:" + str(len(test_results))
-
-        for r in test_results:
-            # print r["start_date"]
-            # print r["criteria"]
-            scenario_results.append({r["start_date"]: r["criteria"]})
-        # sort results
-        scenario_results.sort()
-        # 4 levels for the results
-        # 3: 4+ consecutive runs passing the success criteria
-        # 2: <4 successful consecutive runs but passing the criteria
-        # 1: close to pass the success criteria
-        # 0: 0% success, not passing
-        # -1: no run available
-        test_result_indicator = 0
-        nbTestOk = getNbtestOk(scenario_results)
-
-        # print "Nb test OK (last 10 days):"+ str(nbTestOk)
-        # check that we have at least 4 runs
-        if len(scenario_results) < 1:
-            # No results available
-            test_result_indicator = -1
-        elif nbTestOk < 1:
-            test_result_indicator = 0
-        elif nbTestOk < 2:
-            test_result_indicator = 1
-        else:
-            # Test the last 4 run
-            if (len(scenario_results) > 3):
-                last4runResults = scenario_results[-4:]
-                nbTestOkLast4 = getNbtestOk(last4runResults)
-                # print "Nb test OK (last 4 run):"+ str(nbTestOkLast4)
-                if nbTestOkLast4 > 3:
-                    test_result_indicator = 3
-                else:
-                    test_result_indicator = 2
-            else:
-                test_result_indicator = 2
-    return test_result_indicator
-
-
-def getJenkinsUrl(build_tag):
-    # e.g. jenkins-functest-apex-apex-daily-colorado-daily-colorado-246
-    # id = 246
-    # jenkins-functest-compass-huawei-pod5-daily-master-136
-    # id = 136
-    # note it is linked to jenkins format
-    # if this format changes...function to be adapted....
-    url_base = get_config('functest.jenkins_url')
-    try:
-        build_id = [int(s) for s in build_tag.split("-") if s.isdigit()]
-        url_id = (build_tag[8:-(len(str(build_id[0])) + 1)] +
-                  "/" + str(build_id[0]))
-        jenkins_url = url_base + url_id + "/console"
-    except:
-        print('Impossible to get jenkins url:')
-
-    if "jenkins-" not in build_tag:
-        jenkins_url = None
-
-    return jenkins_url
-
-
-def getScenarioPercent(scenario_score, scenario_criteria):
-    score = 0.0
-    try:
-        score = float(scenario_score) / float(scenario_criteria) * 100
-    except:
-        print('Impossible to calculate the percentage score')
-    return score
-
-
-# *********
-# Functest
-# *********
-def getFunctestConfig(version=""):
-    config_file = get_config('functest.test_conf') + version
-    response = requests.get(config_file)
-    return yaml.safe_load(response.text)
-
-
-def getArchitectures(scenario_results):
-    supported_arch = ['x86']
-    if (len(scenario_results) > 0):
-        for scenario_result in scenario_results.values():
-            for value in scenario_result:
-                if ("armband" in value['build_tag']):
-                    supported_arch.append('aarch64')
-                    return supported_arch
-    return supported_arch
-
-
-def filterArchitecture(results, architecture):
-    filtered_results = {}
-    for name, results in results.items():
-        filtered_values = []
-        for value in results:
-            if (architecture is "x86"):
-                # drop aarch64 results
-                if ("armband" not in value['build_tag']):
-                    filtered_values.append(value)
-            elif(architecture is "aarch64"):
-                # drop x86 results
-                if ("armband" in value['build_tag']):
-                    filtered_values.append(value)
-        if (len(filtered_values) > 0):
-            filtered_results[name] = filtered_values
-    return filtered_results
-
-
-# *********
-# Yardstick
-# *********
-def subfind(given_list, pattern_list):
-    LASTEST_TESTS = get_config('general.nb_iteration_tests_success_criteria')
-    for i in range(len(given_list)):
-        if given_list[i] == pattern_list[0] and \
-                given_list[i:i + LASTEST_TESTS] == pattern_list:
-            return True
-    return False
-
-
-def _get_percent(status):
-
-    if status * 100 % 6:
-        return round(float(status) * 100 / 6, 1)
-    else:
-        return status * 100 / 6
-
-
-def get_percent(four_list, ten_list):
-    four_score = 0
-    ten_score = 0
-
-    for v in four_list:
-        four_score += v
-    for v in ten_list:
-        ten_score += v
-
-    LASTEST_TESTS = get_config('general.nb_iteration_tests_success_criteria')
-    if four_score == LASTEST_TESTS:
-        status = 6
-    elif subfind(ten_list, [1, 1, 1, 1]):
-        status = 5
-    elif ten_score == 0:
-        status = 0
-    else:
-        status = four_score + 1
-
-    return _get_percent(status)
-
-
-def _test():
-    status = getScenarioStatus("compass", "master")
-    print("status:++++++++++++++++++++++++")
-    print(json.dumps(status, indent=4))
-
-
-# ----------------------------------------------------------
-#
-#               Export
-#
-# -----------------------------------------------------------
-
-def export_csv(scenario_file_name, installer, version):
-    # csv
-    # generate sub files based on scenario_history.txt
-    scenario_installer_file_name = ("./display/" + version +
-                                    "/functest/scenario_history_" +
-                                    installer + ".csv")
-    scenario_installer_file = open(scenario_installer_file_name, "a")
-    with open(scenario_file_name, "r") as scenario_file:
-        scenario_installer_file.write("date,scenario,installer,detail,score\n")
-        for line in scenario_file:
-            if installer in line:
-                scenario_installer_file.write(line)
-        scenario_installer_file.close
-
-
-def generate_csv(scenario_file):
-    import shutil
-    # csv
-    # generate sub files based on scenario_history.txt
-    csv_file = scenario_file.replace('txt', 'csv')
-    shutil.copy2(scenario_file, csv_file)
-
-
-def export_pdf(pdf_path, pdf_doc_name):
-    try:
-        pdfkit.from_file(pdf_path, pdf_doc_name)
-    except IOError:
-        print("Error but pdf generated anyway...")
-    except:
-        print("impossible to generate PDF")
diff --git a/reporting/utils/scenarioResult.py b/reporting/utils/scenarioResult.py
deleted file mode 100644
index 6029d7f..0000000
--- a/reporting/utils/scenarioResult.py
+++ /dev/null
@@ -1,33 +0,0 @@
-#!/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
-#
-
-
-class ScenarioResult(object):
-    def __init__(self, status, four_days_score='', ten_days_score='',
-                 score_percent=0.0, last_url=''):
-        self.status = status
-        self.four_days_score = four_days_score
-        self.ten_days_score = ten_days_score
-        self.score_percent = score_percent
-        self.last_url = last_url
-
-    def getStatus(self):
-        return self.status
-
-    def getTenDaysScore(self):
-        return self.ten_days_score
-
-    def getFourDaysScore(self):
-        return self.four_days_score
-
-    def getScorePercent(self):
-        return self.score_percent
-
-    def getLastUrl(self):
-        return self.last_url