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)
122 Get PoD Name from env variable NODE_NAME
125 return os.environ['NODE_NAME']
128 "Unable to retrieve the POD name from environment. " +
129 "Using pod name 'unknown-pod'")
133 def logger_test_results(project, case_name, status, details):
135 Format test case results for the logger
137 pod_name = get_pod_name()
138 scenario = get_scenario()
139 version = get_version()
140 build_tag = CONST.__getattribute__('BUILD_TAG')
141 db_url = CONST.__getattribute__("results_test_db_url")
145 "****************************************\n"
146 "\t %(p)s/%(n)s results \n\n"
147 "****************************************\n"
153 "build tag:\t%(b)s\n"
166 @decorators.can_dump_request_to_file
167 def push_results_to_db(project, case_name,
168 start_date, stop_date, result, details):
170 POST results to the Result target DB
172 # Retrieve params from CI and conf
173 url = CONST.__getattribute__("results_test_db_url")
176 installer = os.environ['INSTALLER_TYPE']
177 scenario = os.environ['DEPLOY_SCENARIO']
178 pod_name = os.environ['NODE_NAME']
179 build_tag = os.environ['BUILD_TAG']
180 except KeyError as e:
181 logger.error("Please set env var: " + str(e))
183 version = get_version()
184 test_start = dt.fromtimestamp(start_date).strftime('%Y-%m-%d %H:%M:%S')
185 test_stop = dt.fromtimestamp(stop_date).strftime('%Y-%m-%d %H:%M:%S')
187 params = {"project_name": project, "case_name": case_name,
188 "pod_name": pod_name, "installer": installer,
189 "version": version, "scenario": scenario, "criteria": result,
190 "build_tag": build_tag, "start_date": test_start,
191 "stop_date": test_stop, "details": details}
194 headers = {'Content-Type': 'application/json'}
196 r = requests.post(url, data=json.dumps(params, sort_keys=True),
200 except requests.RequestException as exc:
202 error = ("Pushing Result to DB(%s) failed: %s" %
205 error = ("Pushing Result to DB(%s) failed: %s" % (url, exc))
206 except Exception as e:
207 error = ("Error [push_results_to_db("
209 "project: '%(project)s', "
213 "scenario: '%(s)s', "
214 "criteria: '%(c)s', "
215 "build_tag: '%(t)s', "
216 "details: '%(d)s')]: "
237 def get_resolvconf_ns():
239 Get nameservers from current resolv.conf
242 rconf = open("/etc/resolv.conf", "r")
243 line = rconf.readline()
244 resolver = dns.resolver.Resolver()
246 ip = re.search(r"\b(?:[0-9]{1,3}\.){3}[0-9]{1,3}\b", line)
248 resolver.nameservers = [ip.group(0)]
250 result = resolver.query('opnfv.org')[0]
252 nameservers.append(ip.group())
253 except dns.exception.Timeout:
255 line = rconf.readline()
259 def get_ci_envvars():
261 Get the CI env variables
264 "installer": os.environ.get('INSTALLER_TYPE'),
265 "scenario": os.environ.get('DEPLOY_SCENARIO')}
269 def execute_command_raise(cmd, info=False, error_msg="",
270 verbose=True, output_file=None):
271 ret = execute_command(cmd, info, error_msg, verbose, output_file)
273 raise Exception(error_msg)
276 def execute_command(cmd, info=False, error_msg="",
277 verbose=True, output_file=None):
279 error_msg = ("The command '%s' failed." % cmd)
280 msg_exec = ("Executing command: '%s'" % cmd)
283 logger.info(msg_exec)
285 logger.debug(msg_exec)
286 p = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE,
287 stderr=subprocess.STDOUT)
289 f = open(output_file, "w")
290 for line in iter(p.stdout.readline, b''):
294 line = line.replace('\n', '')
300 returncode = p.wait()
303 logger.error(error_msg)
308 def get_dict_by_test(testname):
309 with open(pkg_resources.resource_filename(
310 'functest', 'ci/testcases.yaml')) as f:
311 testcases_yaml = yaml.safe_load(f)
313 for dic_tier in testcases_yaml.get("tiers"):
314 for dic_testcase in dic_tier['testcases']:
315 if dic_testcase['case_name'] == testname:
318 logger.error('Project %s is not defined in testcases.yaml' % testname)
322 def get_criteria_by_test(testname):
323 dict = get_dict_by_test(testname)
325 return dict['criteria']
329 # ----------------------------------------------------------
333 # -----------------------------------------------------------
334 def get_parameter_from_yaml(parameter, file):
336 Returns the value of a given parameter in file.yaml
337 parameter must be given in string format with dots
338 Example: general.openstack.image_name
340 with open(file) as f:
341 file_yaml = yaml.safe_load(f)
344 for element in parameter.split("."):
345 value = value.get(element)
347 raise ValueError("The parameter %s is not defined in"
348 " %s" % (parameter, file))
352 def get_functest_config(parameter):
353 yaml_ = constants.CONST.__getattribute__('CONFIG_FUNCTEST_YAML')
354 return get_parameter_from_yaml(parameter, yaml_)
357 def merge_dicts(dict1, dict2):
358 for k in set(dict1.keys()).union(dict2.keys()):
359 if k in dict1 and k in dict2:
360 if isinstance(dict1[k], dict) and isinstance(dict2[k], dict):
361 yield (k, dict(merge_dicts(dict1[k], dict2[k])))
370 def get_functest_yaml():
371 with open(constants.CONST.__getattribute__('CONFIG_FUNCTEST_YAML')) as f:
372 functest_yaml = yaml.safe_load(f)
377 def print_separator():
378 logger.info("==============================================")
382 """Measure the time it takes for a function to complete"""
383 @functools.wraps(func)
384 def timed(*args, **kwargs):
386 result = func(*args, **kwargs)
388 elapsed = '{0}'.format(te - ts)
389 logger.info('{f}(*{a}, **{kw}) took: {t} sec'.format(
390 f=func.__name__, a=args, kw=kwargs, t=elapsed))
391 return result, elapsed