Update release Note
[functest.git] / utils / functest_utils.py
index d020eba..c6141d0 100644 (file)
@@ -7,28 +7,28 @@
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 #
-
-""" global variables """
-
 from datetime import datetime as dt
 import json
 import os
-import os.path
 import re
+import requests
 import shutil
 import subprocess
 import sys
 import urllib2
-import dns.resolver
 
 import functest.ci.tier_builder as tb
+import functest.utils.functest_logger as ft_logger
+
+import dns.resolver
 from git import Repo
-import requests
 import yaml
 
 
+logger = ft_logger.Logger("functest_utils").getLogger()
+
 REPOS_DIR = os.getenv('repos_dir')
-FUNCTEST_REPO = ("%s/functest/" % REPOS_DIR)
+FUNCTEST_REPO = ("%s/functest" % REPOS_DIR)
 
 
 # ----------------------------------------------------------
@@ -77,35 +77,33 @@ def get_git_branch(repo_path):
     return branch.name
 
 
-def get_installer_type(logger=None):
+def get_installer_type():
     """
     Get installer type (fuel, apex, joid, compass)
     """
     try:
         installer = os.environ['INSTALLER_TYPE']
     except KeyError:
-        if logger:
-            logger.error("Impossible to retrieve the installer type")
+        logger.error("Impossible to retrieve the installer type")
         installer = "Unknown_installer"
 
     return installer
 
 
-def get_scenario(logger=None):
+def get_scenario():
     """
     Get scenario
     """
     try:
         scenario = os.environ['DEPLOY_SCENARIO']
     except KeyError:
-        if logger:
-            logger.error("Impossible to retrieve the scenario")
+        logger.error("Impossible to retrieve the scenario")
         scenario = "Unknown_scenario"
 
     return scenario
 
 
-def get_version(logger=None):
+def get_version():
     """
     Get version
     """
@@ -116,7 +114,7 @@ def get_version(logger=None):
     # e.g. jenkins-functest-fuel-opnfv-jump-2-daily-master-190
     # use regex to match branch info
     rule = "daily-(.+?)-[0-9]*"
-    build_tag = get_build_tag(logger)
+    build_tag = get_build_tag()
     m = re.search(rule, build_tag)
     if m:
         return m.group(1)
@@ -124,78 +122,91 @@ def get_version(logger=None):
         return "unknown"
 
 
-def get_pod_name(logger=None):
+def get_pod_name():
     """
     Get PoD Name from env variable NODE_NAME
     """
     try:
         return os.environ['NODE_NAME']
     except KeyError:
-        if logger:
-            logger.error(
-                "Unable to retrieve the POD name from environment. " +
-                "Using pod name 'unknown-pod'")
+        logger.error(
+            "Unable to retrieve the POD name from environment. " +
+            "Using pod name 'unknown-pod'")
         return "unknown-pod"
 
 
-def get_build_tag(logger=None):
+def get_build_tag():
     """
     Get build tag of jenkins jobs
     """
     try:
         build_tag = os.environ['BUILD_TAG']
     except KeyError:
-        if logger:
-            logger.error("Impossible to retrieve the build tag")
+        logger.error("Impossible to retrieve the build tag")
         build_tag = "unknown_build_tag"
 
     return build_tag
 
 
-def get_db_url(logger=None):
+def get_db_url():
     """
     Returns DB URL
     """
-    with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
-        functest_yaml = yaml.safe_load(f)
-    f.close()
-    db_url = functest_yaml.get("results").get("test_db_url")
-    return db_url
-
-
-def logger_test_results(logger, project, case_name, status, details):
-    pod_name = get_pod_name(logger)
-    scenario = get_scenario(logger)
-    version = get_version(logger)
-    build_tag = get_build_tag(logger)
-
-    logger.info("Pushing %(p)s/%(n)s results: TEST_DB_URL=%(db)s "
-                "pod_name=%(pod)s version=%(v)s scenario=%(s)s "
-                "criteria=%(c)s details=%(d)s" % {
-                    'p': project,
-                    'n': case_name,
-                    'db': get_db_url(),
-                    'pod': pod_name,
-                    'v': version,
-                    's': scenario,
-                    'c': status,
-                    'b': build_tag,
-                    'd': details,
-                })
-
-
-def push_results_to_db(project, case_name, logger,
+    return get_functest_config('results.test_db_url')
+
+
+def logger_test_results(project, case_name, status, details):
+    pod_name = get_pod_name()
+    scenario = get_scenario()
+    version = get_version()
+    build_tag = get_build_tag()
+
+    logger.info(
+        "\n"
+        "****************************************\n"
+        "\t %(p)s/%(n)s results \n\n"
+        "****************************************\n"
+        "DB:\t%(db)s\n"
+        "pod:\t%(pod)s\n"
+        "version:\t%(v)s\n"
+        "scenario:\t%(s)s\n"
+        "status:\t%(c)s\n"
+        "build tag:\t%(b)s\n"
+        "details:\t%(d)s\n"
+        % {'p': project,
+            'n': case_name,
+            'db': get_db_url(),
+            'pod': pod_name,
+            'v': version,
+            's': scenario,
+            'c': status,
+            'b': build_tag,
+            'd': details})
+
+
+def push_results_to_db(project, case_name,
                        start_date, stop_date, criteria, details):
     """
     POST results to the Result target DB
     """
     # Retrieve params from CI and conf
-    url = get_db_url(logger) + "/results"
-    installer = get_installer_type(logger)
-    scenario = get_scenario(logger)
-    version = get_version(logger)
-    pod_name = get_pod_name(logger)
-    build_tag = get_build_tag(logger)
+    url = get_db_url() + "/results"
+
+    try:
+        installer = os.environ['INSTALLER_TYPE']
+        scenario = os.environ['DEPLOY_SCENARIO']
+        pod_name = os.environ['NODE_NAME']
+        build_tag = os.environ['BUILD_TAG']
+    except KeyError as e:
+        logger.error("Please set env var: " + str(e))
+        return False
+    rule = "daily-(.+?)-[0-9]*"
+    m = re.search(rule, build_tag)
+    if m:
+        version = m.group(1)
+    else:
+        logger.error("Please fix BUILD_TAG env var: " + build_tag)
+        return False
     test_start = dt.fromtimestamp(start_date).strftime('%Y-%m-%d %H:%M:%S')
     test_stop = dt.fromtimestamp(stop_date).strftime('%Y-%m-%d %H:%M:%S')
 
@@ -205,18 +216,47 @@ def push_results_to_db(project, case_name, logger,
               "build_tag": build_tag, "start_date": test_start,
               "stop_date": test_stop, "details": details}
 
+    error = None
     headers = {'Content-Type': 'application/json'}
     try:
         r = requests.post(url, data=json.dumps(params), headers=headers)
-        if logger:
-            logger.debug(r)
+        logger.debug(r)
+        r.raise_for_status()
+    except requests.RequestException as exc:
+        if 'r' in locals():
+            error = ("Pushing Result to DB(%s) failed: %s" %
+                     (r.url, r.content))
+        else:
+            error = ("Pushing Result to DB(%s) failed: %s" % (url, exc))
+    except Exception as e:
+        error = ("Error [push_results_to_db("
+                 "DB: '%(db)s', "
+                 "project: '%(project)s', "
+                 "case: '%(case)s', "
+                 "pod: '%(pod)s', "
+                 "version: '%(v)s', "
+                 "scenario: '%(s)s', "
+                 "criteria: '%(c)s', "
+                 "build_tag: '%(t)s', "
+                 "details: '%(d)s')]: "
+                 "%(error)s" %
+                 {
+                     'db': url,
+                     'project': project,
+                     'case': case_name,
+                     'pod': pod_name,
+                     'v': version,
+                     's': scenario,
+                     'c': criteria,
+                     't': build_tag,
+                     'd': details,
+                     'error': e
+                 })
+    finally:
+        if error:
+            logger.error(error)
+            return False
         return True
-    except Exception, e:
-        print("Error [push_results_to_db('%s', '%s', '%s', " +
-              "'%s', '%s', '%s', '%s', '%s', '%s')]:" %
-              (url, project, case_name, pod_name, version,
-               scenario, criteria, build_tag, details)), e
-        return False
 
 
 def get_resolvconf_ns():
@@ -251,56 +291,46 @@ def get_ci_envvars():
     return ci_env_var
 
 
-def execute_command(cmd, logger=None,
-                    exit_on_error=True,
-                    info=False,
-                    error_msg="",
-                    verbose=True):
+def execute_command(cmd, exit_on_error=True, info=False, error_msg="",
+                    verbose=True, output_file=None):
     if not error_msg:
         error_msg = ("The command '%s' failed." % cmd)
     msg_exec = ("Executing command: '%s'" % cmd)
     if verbose:
-        if logger:
-            if info:
-                logger.info(msg_exec)
-            else:
-                logger.debug(msg_exec)
+        if info:
+            logger.info(msg_exec)
         else:
-            print(msg_exec)
-    p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE)
+            logger.debug(msg_exec)
+    p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,
+                         stderr=subprocess.STDOUT)
+    if output_file:
+        f = open(output_file, "w")
     for line in iter(p.stdout.readline, b''):
-        line = line.replace('\n', '')
-        if logger:
-            if info:
-                logger.info(line)
-            else:
-                logger.debug(line)
+        if output_file:
+            f.write(line)
         else:
+            line = line.replace('\n', '')
             print line
+            sys.stdout.flush()
+    if output_file:
+        f.close()
     p.stdout.close()
     returncode = p.wait()
     if returncode != 0:
         if verbose:
-            if logger:
-                logger.error(error_msg)
-            else:
-                print(error_msg)
+            logger.error(error_msg)
         if exit_on_error:
             sys.exit(1)
 
     return returncode
 
 
-def get_deployment_dir(logger=None):
+def get_deployment_dir():
     """
     Returns current Rally deployment directory
     """
-    with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
-        functest_yaml = yaml.safe_load(f)
-    f.close()
-    deployment_name = functest_yaml.get("rally").get("deployment_name")
-    rally_dir = functest_yaml.get("general").get("directories").get(
-        "dir_rally_inst")
+    deployment_name = get_functest_config('rally.deployment_name')
+    rally_dir = get_functest_config('general.directories.dir_rally_inst')
     cmd = ("rally deployment list | awk '/" + deployment_name +
            "/ {print $2}'")
     p = subprocess.Popen(cmd, shell=True,
@@ -308,8 +338,7 @@ def get_deployment_dir(logger=None):
                          stderr=subprocess.STDOUT)
     deployment_uuid = p.stdout.readline().rstrip()
     if deployment_uuid == "":
-        if logger:
-            logger.error("Rally deployment not found.")
+        logger.error("Rally deployment not found.")
         exit(-1)
     deployment_dir = (rally_dir + "/tempest/for-deployment-" +
                       deployment_uuid)
@@ -318,7 +347,7 @@ def get_deployment_dir(logger=None):
 
 def get_criteria_by_test(testname):
     criteria = ""
-    file = FUNCTEST_REPO + "/ci/testcases.yaml"
+    file = get_testcases_file()
     tiers = tb.TierBuilder("", "", file)
     for tier in tiers.get_tiers():
         for test in tier.get_tests():
@@ -333,18 +362,16 @@ def get_criteria_by_test(testname):
 #               YAML UTILS
 #
 # -----------------------------------------------------------
-def get_parameter_from_yaml(parameter, file=None):
+def get_parameter_from_yaml(parameter, file):
     """
-    Returns the value of a given parameter in config_functest.yaml
+    Returns the value of a given parameter in file.yaml
     parameter must be given in string format with dots
     Example: general.openstack.image_name
     """
-    if file is None:
-        file = os.environ["CONFIG_FUNCTEST_YAML"]
     with open(file) as f:
-        functest_yaml = yaml.safe_load(f)
+        file_yaml = yaml.safe_load(f)
     f.close()
-    value = functest_yaml
+    value = file_yaml
     for element in parameter.split("."):
         value = value.get(element)
         if value is None:
@@ -353,6 +380,11 @@ def get_parameter_from_yaml(parameter, file=None):
     return value
 
 
+def get_functest_config(parameter):
+    yaml_ = os.environ["CONFIG_FUNCTEST_YAML"]
+    return get_parameter_from_yaml(parameter, yaml_)
+
+
 def check_success_rate(case_name, success_rate):
     success_rate = float(success_rate)
     criteria = get_criteria_by_test(case_name)
@@ -400,3 +432,14 @@ def check_test_result(test_name, ret, start_time, stop_time):
     }
 
     return status, details
+
+
+def get_testcases_file():
+    return FUNCTEST_REPO + "/ci/testcases.yaml"
+
+
+def get_functest_yaml():
+    with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
+        functest_yaml = yaml.safe_load(f)
+    f.close()
+    return functest_yaml