3 # Copyright (c) 2016 Orange and others.
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
16 from git.exc import NoSuchPathError
20 from functest.tests.unit import test_utils
21 from functest.utils import functest_utils
24 class FunctestUtilsTesting(unittest.TestCase):
26 logging.disable(logging.CRITICAL)
29 self.url = 'http://www.opnfv.org/'
31 self.dest_path = 'test_path'
32 self.repo_path = 'test_repo_path'
33 self.installer = 'test_installer'
34 self.scenario = 'test_scenario'
35 self.build_tag = 'jenkins-functest-fuel-opnfv-jump-2-daily-master-190'
36 self.build_tag_week = 'jenkins-functest-fuel-baremetal-weekly-master-8'
37 self.version = 'master'
38 self.node_name = 'test_node_name'
39 self.project = 'test_project'
40 self.case_name = 'test_case_name'
41 self.status = 'test_status'
42 self.details = 'test_details'
43 self.db_url = 'test_db_url'
44 self.success_rate = 2.0
45 self.criteria = 'test_criteria==2.0'
47 self.start_date = 1482624000
48 self.stop_date = 1482624000
49 self.start_time = time.time()
50 self.stop_time = time.time()
52 self.test_ip = ['10.1.23.4', '10.1.14.15', '10.1.16.15']
53 self.test_file = 'test_file'
54 self.error_msg = 'test_error_msg'
56 self.output_file = 'test_output_file'
57 self.testname = 'testname'
58 self.testcase_dict = {'case_name': 'testname',
59 'criteria': self.criteria}
60 self.parameter = 'general.openstack.image_name'
61 self.config_yaml = 'test_config_yaml-'
62 self.db_url_env = 'http://foo/testdb'
63 self.file_yaml = {'general': {'openstack': {'image_name':
66 @mock.patch('urllib2.urlopen',
67 side_effect=urllib2.URLError('no host given'))
68 def test_check_internet_connectivity_failed(self, mock_method):
69 self.assertFalse(functest_utils.check_internet_connectivity())
70 mock_method.assert_called_once_with(self.url, timeout=self.timeout)
72 @mock.patch('urllib2.urlopen')
73 def test_check_internet_connectivity_default(self, mock_method):
74 self.assertTrue(functest_utils.check_internet_connectivity())
75 mock_method.assert_called_once_with(self.url, timeout=self.timeout)
77 @mock.patch('urllib2.urlopen')
78 def test_check_internet_connectivity_debian(self, mock_method):
79 self.url = "https://www.debian.org/"
80 self.assertTrue(functest_utils.check_internet_connectivity(self.url))
81 mock_method.assert_called_once_with(self.url, timeout=self.timeout)
83 @mock.patch('urllib2.urlopen',
84 side_effect=urllib2.URLError('no host given'))
85 def test_download_url_failed(self, mock_url):
86 self.assertFalse(functest_utils.download_url(self.url, self.dest_path))
88 @mock.patch('urllib2.urlopen')
89 def test_download_url_default(self, mock_url):
90 with mock.patch("__builtin__.open", mock.mock_open()) as m, \
91 mock.patch('functest.utils.functest_utils.shutil.copyfileobj')\
93 name = self.url.rsplit('/')[-1]
94 dest = self.dest_path + "/" + name
95 self.assertTrue(functest_utils.download_url(self.url,
97 m.assert_called_once_with(dest, 'wb')
98 self.assertTrue(mock_sh.called)
100 def test_get_git_branch(self):
101 with mock.patch('functest.utils.functest_utils.Repo') as mock_repo:
102 mock_obj2 = mock.Mock()
103 attrs = {'name': 'test_branch'}
104 mock_obj2.configure_mock(**attrs)
106 mock_obj = mock.Mock()
107 attrs = {'active_branch': mock_obj2}
108 mock_obj.configure_mock(**attrs)
110 mock_repo.return_value = mock_obj
111 self.assertEqual(functest_utils.get_git_branch(self.repo_path),
114 @mock.patch('functest.utils.functest_utils.Repo',
115 side_effect=NoSuchPathError)
116 def test_get_git_branch_failed(self, mock_repo):
117 self.assertRaises(NoSuchPathError,
118 lambda: functest_utils.get_git_branch(self.repo_path
121 @mock.patch('functest.utils.functest_utils.logger.error')
122 def test_get_installer_type_failed(self, mock_logger_error):
123 with mock.patch.dict(os.environ,
126 self.assertEqual(functest_utils.get_installer_type(),
128 mock_logger_error.assert_called_once_with("Impossible to retrieve"
129 " the installer type")
131 def test_get_installer_type_default(self):
132 with mock.patch.dict(os.environ,
133 {'INSTALLER_TYPE': 'test_installer'},
135 self.assertEqual(functest_utils.get_installer_type(),
138 @mock.patch('functest.utils.functest_utils.logger.info')
139 def test_get_scenario_failed(self, mock_logger_info):
140 with mock.patch.dict(os.environ,
143 self.assertEqual(functest_utils.get_scenario(),
144 "os-nosdn-nofeature-noha")
145 mock_logger_info.assert_called_once_with("Impossible to retrieve "
148 "os-nosdn-nofeature-noha")
150 def test_get_scenario_default(self):
151 with mock.patch.dict(os.environ,
152 {'DEPLOY_SCENARIO': 'test_scenario'},
154 self.assertEqual(functest_utils.get_scenario(),
157 @mock.patch('functest.utils.functest_utils.get_build_tag')
158 def test_get_version_daily_job(self, mock_get_build_tag):
159 mock_get_build_tag.return_value = self.build_tag
160 self.assertEqual(functest_utils.get_version(), self.version)
162 @mock.patch('functest.utils.functest_utils.get_build_tag')
163 def test_get_version_weekly_job(self, mock_get_build_tag):
164 mock_get_build_tag.return_value = self.build_tag_week
165 self.assertEqual(functest_utils.get_version(), self.version)
167 @mock.patch('functest.utils.functest_utils.get_build_tag')
168 def test_get_version_with_dummy_build_tag(self, mock_get_build_tag):
169 mock_get_build_tag.return_value = 'whatever'
170 self.assertEqual(functest_utils.get_version(), 'unknown')
172 @mock.patch('functest.utils.functest_utils.get_build_tag')
173 def test_get_version_unknown(self, mock_get_build_tag):
174 mock_get_build_tag.return_value = "unknown_build_tag"
175 self.assertEqual(functest_utils.get_version(), "unknown")
177 @mock.patch('functest.utils.functest_utils.logger.info')
178 def test_get_pod_name_failed(self, mock_logger_info):
179 with mock.patch.dict(os.environ,
182 self.assertEqual(functest_utils.get_pod_name(),
184 mock_logger_info.assert_called_once_with("Unable to retrieve "
186 "environment. Using "
187 "pod name 'unknown-pod'")
189 def test_get_pod_name_default(self):
190 with mock.patch.dict(os.environ,
191 {'NODE_NAME': 'test_node_name'},
193 self.assertEqual(functest_utils.get_pod_name(),
196 @mock.patch('functest.utils.functest_utils.logger.info')
197 def test_get_build_tag_failed(self, mock_logger_info):
198 with mock.patch.dict(os.environ,
201 self.assertEqual(functest_utils.get_build_tag(),
203 mock_logger_info.assert_called_once_with("Impossible to retrieve"
206 def test_get_build_tag_default(self):
207 with mock.patch.dict(os.environ,
208 {'BUILD_TAG': self.build_tag},
210 self.assertEqual(functest_utils.get_build_tag(),
213 def test_get_db_url_env_var(self):
214 with mock.patch.dict(os.environ,
215 {'TEST_DB_URL': self.db_url_env,
216 'CONFIG_FUNCTEST_YAML':
217 "./functest/ci/config_functest.yaml"},
219 self.assertEqual(functest_utils.get_db_url(),
222 @mock.patch('functest.utils.functest_utils.get_functest_config')
223 def test_get_db_url_default(self, mock_get_functest_config):
224 mock_get_functest_config.return_value = self.db_url
225 self.assertEqual(functest_utils.get_db_url(), self.db_url)
226 mock_get_functest_config.assert_called_once_with('results.test_db_url')
228 @mock.patch('functest.utils.functest_utils.logger.info')
229 def test_logger_test_results(self, mock_logger_info):
230 with mock.patch('functest.utils.functest_utils.get_pod_name',
231 return_value=self.node_name), \
232 mock.patch('functest.utils.functest_utils.get_scenario',
233 return_value=self.scenario), \
234 mock.patch('functest.utils.functest_utils.get_version',
235 return_value=self.version), \
236 mock.patch('functest.utils.functest_utils.get_build_tag',
237 return_value=self.build_tag), \
238 mock.patch('functest.utils.functest_utils.get_db_url',
239 return_value=self.db_url):
240 functest_utils.logger_test_results(self.project, self.case_name,
241 self.status, self.details)
242 mock_logger_info.assert_called_once_with(
244 "****************************************\n"
245 "\t %(p)s/%(n)s results \n\n"
246 "****************************************\n"
252 "build tag:\t%(b)s\n"
254 % {'p': self.project,
257 'pod': self.node_name,
264 def _get_env_dict(self, var):
265 dic = {'INSTALLER_TYPE': self.installer,
266 'DEPLOY_SCENARIO': self.scenario,
267 'NODE_NAME': self.node_name,
268 'BUILD_TAG': self.build_tag}
272 def _test_push_results_to_db_missing_env(self, env_var):
273 dic = self._get_env_dict(env_var)
274 with mock.patch('functest.utils.functest_utils.get_db_url',
275 return_value=self.db_url), \
276 mock.patch.dict(os.environ,
279 mock.patch('functest.utils.functest_utils.logger.error') \
280 as mock_logger_error:
281 functest_utils.push_results_to_db(self.project, self.case_name,
282 self.start_date, self.stop_date,
283 self.result, self.details)
284 mock_logger_error.assert_called_once_with("Please set env var: " +
288 def test_push_results_to_db_missing_installer(self):
289 self._test_push_results_to_db_missing_env('INSTALLER_TYPE')
291 def test_push_results_to_db_missing_scenario(self):
292 self._test_push_results_to_db_missing_env('DEPLOY_SCENARIO')
294 def test_push_results_to_db_missing_nodename(self):
295 self._test_push_results_to_db_missing_env('NODE_NAME')
297 def test_push_results_to_db_missing_buildtag(self):
298 self._test_push_results_to_db_missing_env('BUILD_TAG')
300 def test_push_results_to_db_request_post_failed(self):
301 dic = self._get_env_dict(None)
302 with mock.patch('functest.utils.functest_utils.get_db_url',
303 return_value=self.db_url), \
304 mock.patch.dict(os.environ,
307 mock.patch('functest.utils.functest_utils.logger.error') \
308 as mock_logger_error, \
309 mock.patch('functest.utils.functest_utils.requests.post',
310 side_effect=requests.RequestException):
311 self.assertFalse(functest_utils.
312 push_results_to_db(self.project, self.case_name,
315 self.result, self.details))
316 mock_logger_error.assert_called_once_with(test_utils.
317 RegexMatch("Pushing "
323 def test_push_results_to_db_request_post_exception(self):
324 dic = self._get_env_dict(None)
325 with mock.patch('functest.utils.functest_utils.get_db_url',
326 return_value=self.db_url), \
327 mock.patch.dict(os.environ,
330 mock.patch('functest.utils.functest_utils.logger.error') \
331 as mock_logger_error, \
332 mock.patch('functest.utils.functest_utils.requests.post',
333 side_effect=Exception):
334 self.assertFalse(functest_utils.
335 push_results_to_db(self.project, self.case_name,
338 self.result, self.details))
339 self.assertTrue(mock_logger_error.called)
341 def test_push_results_to_db_default(self):
342 dic = self._get_env_dict(None)
343 with mock.patch('functest.utils.functest_utils.get_db_url',
344 return_value=self.db_url), \
345 mock.patch.dict(os.environ,
348 mock.patch('functest.utils.functest_utils.requests.post'):
349 self.assertTrue(functest_utils.
350 push_results_to_db(self.project, self.case_name,
353 self.result, self.details))
355 test_ip = ['10.1.23.4', '10.1.14.15', '10.1.16.15']
359 if FunctestUtilsTesting.readline == \
360 len(FunctestUtilsTesting.test_ip) - 1:
362 FunctestUtilsTesting.readline += 1
363 return FunctestUtilsTesting.test_ip[FunctestUtilsTesting.readline]
365 # TODO: get_resolvconf_ns
366 @mock.patch('functest.utils.functest_utils.dns.resolver.Resolver')
367 def test_get_resolvconf_ns_default(self, mock_dns_resolve):
368 attrs = {'query.return_value': ["test"]}
369 mock_dns_resolve.configure_mock(**attrs)
372 attrs = {'readline.side_effect': self.readline_side}
373 m.configure_mock(**attrs)
375 with mock.patch("__builtin__.open") as mo:
377 self.assertEqual(functest_utils.get_resolvconf_ns(),
380 def _get_environ(self, var):
381 if var == 'INSTALLER_TYPE':
382 return self.installer
383 elif var == 'DEPLOY_SCENARIO':
387 def test_get_ci_envvars_default(self):
388 with mock.patch('os.environ.get',
389 side_effect=self._get_environ):
390 dic = {"installer": self.installer,
391 "scenario": self.scenario}
392 self.assertDictEqual(functest_utils.get_ci_envvars(), dic)
394 def cmd_readline(self):
395 return 'test_value\n'
397 @mock.patch('functest.utils.functest_utils.logger.error')
398 @mock.patch('functest.utils.functest_utils.logger.info')
399 def test_execute_command_args_present_with_error(self, mock_logger_info,
401 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
402 as mock_subproc_open, \
403 mock.patch('__builtin__.open', mock.mock_open()) as mopen:
405 FunctestUtilsTesting.readline = 0
407 mock_obj = mock.Mock()
408 attrs = {'readline.side_effect': self.cmd_readline()}
409 mock_obj.configure_mock(**attrs)
411 mock_obj2 = mock.Mock()
412 attrs = {'stdout': mock_obj, 'wait.return_value': 1}
413 mock_obj2.configure_mock(**attrs)
415 mock_subproc_open.return_value = mock_obj2
417 resp = functest_utils.execute_command(self.cmd, info=True,
418 error_msg=self.error_msg,
420 output_file=self.output_file)
421 self.assertEqual(resp, 1)
422 msg_exec = ("Executing command: '%s'" % self.cmd)
423 mock_logger_info.assert_called_once_with(msg_exec)
424 mopen.assert_called_once_with(self.output_file, "w")
425 mock_logger_error.assert_called_once_with(self.error_msg)
427 @mock.patch('functest.utils.functest_utils.logger.info')
428 def test_execute_command_args_present_with_success(self, mock_logger_info,
430 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
431 as mock_subproc_open, \
432 mock.patch('__builtin__.open', mock.mock_open()) as mopen:
434 FunctestUtilsTesting.readline = 0
436 mock_obj = mock.Mock()
437 attrs = {'readline.side_effect': self.cmd_readline()}
438 mock_obj.configure_mock(**attrs)
440 mock_obj2 = mock.Mock()
441 attrs = {'stdout': mock_obj, 'wait.return_value': 0}
442 mock_obj2.configure_mock(**attrs)
444 mock_subproc_open.return_value = mock_obj2
446 resp = functest_utils.execute_command(self.cmd, info=True,
447 error_msg=self.error_msg,
449 output_file=self.output_file)
450 self.assertEqual(resp, 0)
451 msg_exec = ("Executing command: '%s'" % self.cmd)
452 mock_logger_info.assert_called_once_with(msg_exec)
453 mopen.assert_called_once_with(self.output_file, "w")
455 @mock.patch('functest.utils.functest_utils.logger.info')
456 def test_execute_command_args_missing_with_success(self, mock_logger_info,
458 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
459 as mock_subproc_open:
461 FunctestUtilsTesting.readline = 2
463 mock_obj = mock.Mock()
464 attrs = {'readline.side_effect': self.cmd_readline()}
465 mock_obj.configure_mock(**attrs)
467 mock_obj2 = mock.Mock()
468 attrs = {'stdout': mock_obj, 'wait.return_value': 0}
469 mock_obj2.configure_mock(**attrs)
471 mock_subproc_open.return_value = mock_obj2
473 resp = functest_utils.execute_command(self.cmd, info=False,
477 self.assertEqual(resp, 0)
479 @mock.patch('functest.utils.functest_utils.logger.error')
480 def test_execute_command_args_missing_with_error(self, mock_logger_error,
482 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
483 as mock_subproc_open:
485 FunctestUtilsTesting.readline = 2
486 mock_obj = mock.Mock()
487 attrs = {'readline.side_effect': self.cmd_readline()}
488 mock_obj.configure_mock(**attrs)
490 mock_obj2 = mock.Mock()
491 attrs = {'stdout': mock_obj, 'wait.return_value': 1}
492 mock_obj2.configure_mock(**attrs)
494 mock_subproc_open.return_value = mock_obj2
496 resp = functest_utils.execute_command(self.cmd, info=False,
500 self.assertEqual(resp, 1)
502 def _get_functest_config(self, var):
505 @mock.patch('functest.utils.functest_utils.logger.error')
506 def test_get_dict_by_test(self, mock_logger_error):
507 with mock.patch('__builtin__.open', mock.mock_open()), \
508 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
510 mock.patch('functest.utils.functest_utils.get_testcases_'
512 mock_obj = mock.Mock()
513 attrs = {'get.return_value': [{'testcases': [self.testcase_dict]}]}
514 mock_obj.configure_mock(**attrs)
516 mock_yaml.return_value = mock_obj
518 self.assertDictEqual(functest_utils.
519 get_dict_by_test(self.testname),
522 @mock.patch('functest.utils.functest_utils.get_dict_by_test')
523 def test_get_criteria_by_test_default(self, mock_get_dict_by_test):
524 mock_get_dict_by_test.return_value = self.testcase_dict
525 self.assertEqual(functest_utils.get_criteria_by_test(self.testname),
528 @mock.patch('functest.utils.functest_utils.get_dict_by_test')
529 def test_get_criteria_by_test_failed(self, mock_get_dict_by_test):
530 mock_get_dict_by_test.return_value = None
531 self.assertIsNone(functest_utils.get_criteria_by_test(self.testname))
533 def test_get_parameter_from_yaml_failed(self):
534 self.file_yaml['general'] = None
535 with mock.patch('__builtin__.open', mock.mock_open()), \
536 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
538 self.assertRaises(ValueError) as excep:
539 mock_yaml.return_value = self.file_yaml
540 functest_utils.get_parameter_from_yaml(self.parameter,
542 self.assertTrue(("The parameter %s is not"
543 " defined in config_functest.yaml" %
544 self.parameter) in excep.exception)
546 def test_get_parameter_from_yaml_default(self):
547 with mock.patch('__builtin__.open', mock.mock_open()), \
548 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
550 mock_yaml.return_value = self.file_yaml
551 self.assertEqual(functest_utils.
552 get_parameter_from_yaml(self.parameter,
556 @mock.patch('functest.utils.functest_utils.get_parameter_from_yaml')
557 def test_get_functest_config_default(self, mock_get_parameter_from_yaml):
558 with mock.patch.dict(os.environ,
559 {'CONFIG_FUNCTEST_YAML': self.config_yaml}):
560 functest_utils.get_functest_config(self.parameter)
561 mock_get_parameter_from_yaml. \
562 assert_called_once_with(self.parameter,
565 def test_check_success_rate_default(self):
566 with mock.patch('functest.utils.functest_utils.get_criteria_by_test') \
568 mock_criteria.return_value = self.criteria
569 resp = functest_utils.check_success_rate(self.case_name,
571 self.assertEqual(resp, 'PASS')
573 def test_check_success_rate_failed(self):
574 with mock.patch('functest.utils.functest_utils.get_criteria_by_test') \
576 mock_criteria.return_value = self.criteria
577 resp = functest_utils.check_success_rate(self.case_name,
579 self.assertEqual(resp, 'FAIL')
583 def test_get_testcases_file_dir(self):
584 resp = functest_utils.get_testcases_file_dir()
585 self.assertEqual(resp,
586 "/home/opnfv/repos/functest/"
587 "functest/ci/testcases.yaml")
589 def test_get_functest_yaml(self):
590 with mock.patch('__builtin__.open', mock.mock_open()), \
591 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
593 mock_yaml.return_value = self.file_yaml
594 resp = functest_utils.get_functest_yaml()
595 self.assertEqual(resp, self.file_yaml)
597 @mock.patch('functest.utils.functest_utils.logger.info')
598 def test_print_separator(self, mock_logger_info):
599 functest_utils.print_separator()
600 mock_logger_info.assert_called_once_with("======================="
601 "=======================")
604 if __name__ == "__main__":
605 unittest.main(verbosity=2)