3 # jose.lausuch@ericsson.com
4 # valentin.boucher@orange.com
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
19 from datetime import datetime as dt
26 from functest.utils import decorators
27 import functest.utils.functest_logger as ft_logger
29 logger = ft_logger.Logger("functest_utils").getLogger()
32 # ----------------------------------------------------------
36 # -----------------------------------------------------------
37 def check_internet_connectivity(url='http://www.opnfv.org/'):
39 Check if there is access to the internet
42 urllib2.urlopen(url, timeout=5)
44 except urllib2.URLError:
48 def download_url(url, dest_path):
50 Download a file to a destination path given a URL
52 name = url.rsplit('/')[-1]
53 dest = dest_path + "/" + name
55 response = urllib2.urlopen(url)
56 except (urllib2.HTTPError, urllib2.URLError):
59 with open(dest, 'wb') as f:
60 shutil.copyfileobj(response, f)
64 # ----------------------------------------------------------
68 # -----------------------------------------------------------
69 def get_git_branch(repo_path):
73 repo = Repo(repo_path)
74 branch = repo.active_branch
78 def get_installer_type():
80 Get installer type (fuel, apex, joid, compass)
83 installer = os.environ['INSTALLER_TYPE']
85 logger.error("Impossible to retrieve the installer type")
86 installer = "Unknown_installer"
96 scenario = os.environ['DEPLOY_SCENARIO']
98 logger.info("Impossible to retrieve the scenario."
99 "Use default os-nosdn-nofeature-noha")
100 scenario = "os-nosdn-nofeature-noha"
109 # Use the build tag to retrieve the version
110 # By default version is unknown
111 # if launched through CI the build tag has the following format
112 # jenkins-<project>-<installer>-<pod>-<job>-<branch>-<id>
113 # e.g. jenkins-functest-fuel-opnfv-jump-2-daily-master-190
114 # jenkins-functest-fuel-baremetal-weekly-master-8
115 # use regex to match branch info
116 rule = "(dai|week)ly-(.+?)-[0-9]*"
117 build_tag = get_build_tag()
118 m = re.search(rule, build_tag)
127 Get PoD Name from env variable NODE_NAME
130 return os.environ['NODE_NAME']
133 "Unable to retrieve the POD name from environment. " +
134 "Using pod name 'unknown-pod'")
140 Get build tag of jenkins jobs
143 build_tag = os.environ['BUILD_TAG']
145 logger.info("Impossible to retrieve the build tag")
155 # TODO use CONST mechanism
157 # if TEST_DB_URL declared in env variable, use it!
158 db_url = os.environ['TEST_DB_URL']
160 db_url = get_functest_config('results.test_db_url')
164 def logger_test_results(project, case_name, status, details):
165 pod_name = get_pod_name()
166 scenario = get_scenario()
167 version = get_version()
168 build_tag = get_build_tag()
172 "****************************************\n"
173 "\t %(p)s/%(n)s results \n\n"
174 "****************************************\n"
180 "build tag:\t%(b)s\n"
193 @decorators.can_dump_request_to_file
194 def push_results_to_db(project, case_name,
195 start_date, stop_date, criteria, details):
197 POST results to the Result target DB
199 # Retrieve params from CI and conf
200 url = get_db_url() + "/results"
203 installer = os.environ['INSTALLER_TYPE']
204 scenario = os.environ['DEPLOY_SCENARIO']
205 pod_name = os.environ['NODE_NAME']
206 build_tag = os.environ['BUILD_TAG']
207 except KeyError as e:
208 logger.error("Please set env var: " + str(e))
210 rule = "daily-(.+?)-[0-9]*"
211 m = re.search(rule, build_tag)
215 logger.error("Please fix BUILD_TAG env var: " + build_tag)
217 test_start = dt.fromtimestamp(start_date).strftime('%Y-%m-%d %H:%M:%S')
218 test_stop = dt.fromtimestamp(stop_date).strftime('%Y-%m-%d %H:%M:%S')
220 params = {"project_name": project, "case_name": case_name,
221 "pod_name": pod_name, "installer": installer,
222 "version": version, "scenario": scenario, "criteria": criteria,
223 "build_tag": build_tag, "start_date": test_start,
224 "stop_date": test_stop, "details": details}
227 headers = {'Content-Type': 'application/json'}
229 r = requests.post(url, data=json.dumps(params), headers=headers)
232 except requests.RequestException as exc:
234 error = ("Pushing Result to DB(%s) failed: %s" %
237 error = ("Pushing Result to DB(%s) failed: %s" % (url, exc))
238 except Exception as e:
239 error = ("Error [push_results_to_db("
241 "project: '%(project)s', "
245 "scenario: '%(s)s', "
246 "criteria: '%(c)s', "
247 "build_tag: '%(t)s', "
248 "details: '%(d)s')]: "
269 def get_resolvconf_ns():
271 Get nameservers from current resolv.conf
274 rconf = open("/etc/resolv.conf", "r")
275 line = rconf.readline()
276 resolver = dns.resolver.Resolver()
278 ip = re.search(r"\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b", line)
280 resolver.nameservers = [ip.group(0)]
282 result = resolver.query('opnfv.org')[0]
284 nameservers.append(ip.group())
285 except dns.exception.Timeout:
287 line = rconf.readline()
291 def get_ci_envvars():
293 Get the CI env variables
296 "installer": os.environ.get('INSTALLER_TYPE'),
297 "scenario": os.environ.get('DEPLOY_SCENARIO')}
301 def execute_command_raise(cmd, info=False, error_msg="",
302 verbose=True, output_file=None):
303 ret = execute_command(cmd, info, error_msg, verbose, output_file)
305 raise Exception(error_msg)
308 def execute_command(cmd, info=False, error_msg="",
309 verbose=True, output_file=None):
311 error_msg = ("The command '%s' failed." % cmd)
312 msg_exec = ("Executing command: '%s'" % cmd)
315 logger.info(msg_exec)
317 logger.debug(msg_exec)
318 p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,
319 stderr=subprocess.STDOUT)
321 f = open(output_file, "w")
322 for line in iter(p.stdout.readline, b''):
326 line = line.replace('\n', '')
332 returncode = p.wait()
335 logger.error(error_msg)
340 def get_dict_by_test(testname):
341 with open(get_testcases_file_dir()) as f:
342 testcases_yaml = yaml.safe_load(f)
344 for dic_tier in testcases_yaml.get("tiers"):
345 for dic_testcase in dic_tier['testcases']:
346 if dic_testcase['name'] == testname:
349 logger.error('Project %s is not defined in testcases.yaml' % testname)
353 def get_criteria_by_test(testname):
354 dict = get_dict_by_test(testname)
356 return dict['criteria']
360 # ----------------------------------------------------------
364 # -----------------------------------------------------------
365 def get_parameter_from_yaml(parameter, file):
367 Returns the value of a given parameter in file.yaml
368 parameter must be given in string format with dots
369 Example: general.openstack.image_name
371 with open(file) as f:
372 file_yaml = yaml.safe_load(f)
375 for element in parameter.split("."):
376 value = value.get(element)
378 raise ValueError("The parameter %s is not defined in"
379 " %s" % (parameter, file))
383 def get_functest_config(parameter):
384 yaml_ = os.environ["CONFIG_FUNCTEST_YAML"]
385 return get_parameter_from_yaml(parameter, yaml_)
388 def check_success_rate(case_name, success_rate):
389 success_rate = float(success_rate)
390 criteria = get_criteria_by_test(case_name)
392 def get_criteria_value(op):
393 return float(criteria.split(op)[1].rstrip('%'))
399 c_value = get_criteria_value(op)
400 if eval("%s %s %s" % (success_rate, op, c_value)):
407 def merge_dicts(dict1, dict2):
408 for k in set(dict1.keys()).union(dict2.keys()):
409 if k in dict1 and k in dict2:
410 if isinstance(dict1[k], dict) and isinstance(dict2[k], dict):
411 yield (k, dict(merge_dicts(dict1[k], dict2[k])))
420 def get_testcases_file_dir():
421 return get_functest_config('general.functest.testcases_yaml')
424 def get_functest_yaml():
425 with open(os.environ["CONFIG_FUNCTEST_YAML"]) as f:
426 functest_yaml = yaml.safe_load(f)
431 def print_separator():
432 logger.info("==============================================")
436 """Measure the time it takes for a function to complete"""
437 @functools.wraps(func)
438 def timed(*args, **kwargs):
440 result = func(*args, **kwargs)
442 elapsed = '{0}'.format(te - ts)
443 logger.info('{f}(*{a}, **{kw}) took: {t} sec'.format(
444 f=func.__name__, a=args, kw=kwargs, t=elapsed))
445 return result, elapsed