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
20 from datetime import datetime as dt
24 from six.moves import urllib
27 from functest.utils import constants
28 from functest.utils import decorators
29 from functest.utils.constants import CONST
31 logger = logging.getLogger(__name__)
34 # ----------------------------------------------------------
38 # -----------------------------------------------------------
39 def check_internet_connectivity(url='http://www.opnfv.org/'):
41 Check if there is access to the internet
44 urllib.request.urlopen(url, timeout=5)
46 except urllib.error.URLError:
50 def download_url(url, dest_path):
52 Download a file to a destination path given a URL
54 name = url.rsplit('/')[-1]
55 dest = dest_path + "/" + name
57 response = urllib.request.urlopen(url)
58 except (urllib.error.HTTPError, urllib.error.URLError):
61 with open(dest, 'wb') as f:
62 shutil.copyfileobj(response, f)
66 # ----------------------------------------------------------
70 # -----------------------------------------------------------
71 def get_installer_type():
73 Get installer type (fuel, apex, joid, compass)
76 installer = os.environ['INSTALLER_TYPE']
78 logger.error("Impossible to retrieve the installer type")
79 installer = "Unknown_installer"
89 scenario = os.environ['DEPLOY_SCENARIO']
91 logger.info("Impossible to retrieve the scenario."
92 "Use default os-nosdn-nofeature-noha")
93 scenario = "os-nosdn-nofeature-noha"
102 # Use the build tag to retrieve the version
103 # By default version is unknown
104 # if launched through CI the build tag has the following format
105 # jenkins-<project>-<installer>-<pod>-<job>-<branch>-<id>
106 # e.g. jenkins-functest-fuel-opnfv-jump-2-daily-master-190
107 # jenkins-functest-fuel-baremetal-weekly-master-8
108 # use regex to match branch info
109 rule = "(dai|week)ly-(.+?)-[0-9]*"
110 build_tag = CONST.__getattribute__('BUILD_TAG')
113 m = re.search(rule, build_tag)
120 def logger_test_results(project, case_name, status, details):
122 Format test case results for the logger
124 pod_name = CONST.__getattribute__('NODE_NAME')
125 scenario = get_scenario()
126 version = get_version()
127 build_tag = CONST.__getattribute__('BUILD_TAG')
128 db_url = CONST.__getattribute__("results_test_db_url")
132 "****************************************\n"
133 "\t %(p)s/%(n)s results \n\n"
134 "****************************************\n"
140 "build tag:\t%(b)s\n"
153 @decorators.can_dump_request_to_file
154 def push_results_to_db(project, case_name,
155 start_date, stop_date, result, details):
157 POST results to the Result target DB
159 # Retrieve params from CI and conf
160 url = CONST.__getattribute__("results_test_db_url")
163 installer = os.environ['INSTALLER_TYPE']
164 scenario = os.environ['DEPLOY_SCENARIO']
165 pod_name = os.environ['NODE_NAME']
166 build_tag = os.environ['BUILD_TAG']
167 except KeyError as e:
168 logger.error("Please set env var: " + str(e))
170 version = get_version()
171 test_start = dt.fromtimestamp(start_date).strftime('%Y-%m-%d %H:%M:%S')
172 test_stop = dt.fromtimestamp(stop_date).strftime('%Y-%m-%d %H:%M:%S')
174 params = {"project_name": project, "case_name": case_name,
175 "pod_name": pod_name, "installer": installer,
176 "version": version, "scenario": scenario, "criteria": result,
177 "build_tag": build_tag, "start_date": test_start,
178 "stop_date": test_stop, "details": details}
181 headers = {'Content-Type': 'application/json'}
183 r = requests.post(url, data=json.dumps(params, sort_keys=True),
187 except requests.RequestException as exc:
189 error = ("Pushing Result to DB(%s) failed: %s" %
192 error = ("Pushing Result to DB(%s) failed: %s" % (url, exc))
193 except Exception as e:
194 error = ("Error [push_results_to_db("
196 "project: '%(project)s', "
200 "scenario: '%(s)s', "
201 "criteria: '%(c)s', "
202 "build_tag: '%(t)s', "
203 "details: '%(d)s')]: "
224 def get_resolvconf_ns():
226 Get nameservers from current resolv.conf
229 rconf = open("/etc/resolv.conf", "r")
230 line = rconf.readline()
231 resolver = dns.resolver.Resolver()
233 ip = re.search(r"\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b", line)
235 resolver.nameservers = [ip.group(0)]
237 result = resolver.query('opnfv.org')[0]
239 nameservers.append(ip.group())
240 except dns.exception.Timeout:
242 line = rconf.readline()
246 def get_ci_envvars():
248 Get the CI env variables
251 "installer": os.environ.get('INSTALLER_TYPE'),
252 "scenario": os.environ.get('DEPLOY_SCENARIO')}
256 def execute_command_raise(cmd, info=False, error_msg="",
257 verbose=True, output_file=None, env=None):
258 ret = execute_command(cmd, info, error_msg, verbose, output_file, env)
260 raise Exception(error_msg)
263 def execute_command(cmd, info=False, error_msg="",
264 verbose=True, output_file=None, env=None):
266 error_msg = ("The command '%s' failed." % cmd)
267 msg_exec = ("Executing command: '%s'" % cmd)
270 logger.info(msg_exec)
272 logger.debug(msg_exec)
273 p = subprocess.Popen(cmd, env=env, shell=True, stdout=subprocess.PIPE,
274 stderr=subprocess.STDOUT)
276 f = open(output_file, "w")
277 for line in iter(p.stdout.readline, b''):
281 line = line.replace('\n', '')
287 returncode = p.wait()
290 logger.error(error_msg)
295 def get_dict_by_test(testname):
296 with open(pkg_resources.resource_filename(
297 'functest', 'ci/testcases.yaml')) as f:
298 testcases_yaml = yaml.safe_load(f)
300 for dic_tier in testcases_yaml.get("tiers"):
301 for dic_testcase in dic_tier['testcases']:
302 if dic_testcase['case_name'] == testname:
305 logger.error('Project %s is not defined in testcases.yaml' % testname)
309 def get_criteria_by_test(testname):
310 dict = get_dict_by_test(testname)
312 return dict['criteria']
316 # ----------------------------------------------------------
320 # -----------------------------------------------------------
321 def get_parameter_from_yaml(parameter, file):
323 Returns the value of a given parameter in file.yaml
324 parameter must be given in string format with dots
325 Example: general.openstack.image_name
327 with open(file) as f:
328 file_yaml = yaml.safe_load(f)
331 for element in parameter.split("."):
332 value = value.get(element)
334 raise ValueError("The parameter %s is not defined in"
335 " %s" % (parameter, file))
339 def get_functest_config(parameter):
340 yaml_ = constants.CONST.__getattribute__('CONFIG_FUNCTEST_YAML')
341 return get_parameter_from_yaml(parameter, yaml_)
344 def merge_dicts(dict1, dict2):
345 for k in set(dict1.keys()).union(dict2.keys()):
346 if k in dict1 and k in dict2:
347 if isinstance(dict1[k], dict) and isinstance(dict2[k], dict):
348 yield (k, dict(merge_dicts(dict1[k], dict2[k])))
357 def get_functest_yaml():
358 with open(constants.CONST.__getattribute__('CONFIG_FUNCTEST_YAML')) as f:
359 functest_yaml = yaml.safe_load(f)
364 def print_separator():
365 logger.info("==============================================")
369 """Measure the time it takes for a function to complete"""
370 @functools.wraps(func)
371 def timed(*args, **kwargs):
373 result = func(*args, **kwargs)
375 elapsed = '{0}'.format(te - ts)
376 logger.info('{f}(*{a}, **{kw}) took: {t} sec'.format(
377 f=func.__name__, a=args, kw=kwargs, t=elapsed))
378 return result, elapsed