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
18 from six.moves import urllib
20 from functest.tests.unit import test_utils
21 from functest.utils import functest_utils
22 from functest.utils.constants import CONST
25 class FunctestUtilsTesting(unittest.TestCase):
28 self.url = 'http://www.opnfv.org/'
30 self.dest_path = 'test_path'
31 self.repo_path = 'test_repo_path'
32 self.installer = 'test_installer'
33 self.scenario = 'test_scenario'
34 self.build_tag = 'jenkins-functest-fuel-opnfv-jump-2-daily-master-190'
35 self.build_tag_week = 'jenkins-functest-fuel-baremetal-weekly-master-8'
36 self.version = 'master'
37 self.node_name = 'test_node_name'
38 self.project = 'test_project'
39 self.case_name = 'test_case_name'
40 self.status = 'test_status'
41 self.details = 'test_details'
42 self.db_url = 'test_db_url'
45 self.start_date = 1482624000
46 self.stop_date = 1482624000
47 self.start_time = time.time()
48 self.stop_time = time.time()
50 self.test_ip = ['10.1.23.4', '10.1.14.15', '10.1.16.15']
51 self.test_file = 'test_file'
52 self.error_msg = 'test_error_msg'
54 self.output_file = 'test_output_file'
55 self.testname = 'testname'
56 self.testcase_dict = {'case_name': 'testname',
57 'criteria': self.criteria}
58 self.parameter = 'general.openstack.image_name'
59 self.config_yaml = pkg_resources.resource_filename(
60 'functest', 'ci/config_functest.yaml')
61 self.db_url_env = 'http://foo/testdb'
62 self.testcases_yaml = "test_testcases_yaml"
63 self.file_yaml = {'general': {'openstack': {'image_name':
66 @mock.patch('six.moves.urllib.request.urlopen',
67 side_effect=urllib.error.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('six.moves.urllib.request.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('six.moves.urllib.request.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('six.moves.urllib.request.urlopen',
84 side_effect=urllib.error.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('six.moves.urllib.request.urlopen')
89 def test_download_url_default(self, mock_url):
90 with mock.patch("six.moves.builtins.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_version_daily_job(self):
101 CONST.__setattr__('BUILD_TAG', self.build_tag)
102 self.assertEqual(functest_utils.get_version(), self.version)
104 def test_get_version_weekly_job(self):
105 CONST.__setattr__('BUILD_TAG', self.build_tag_week)
106 self.assertEqual(functest_utils.get_version(), self.version)
108 def test_get_version_with_dummy_build_tag(self):
109 CONST.__setattr__('BUILD_TAG', 'whatever')
110 self.assertEqual(functest_utils.get_version(), 'unknown')
112 def test_get_version_unknown(self):
113 CONST.__setattr__('BUILD_TAG', 'unknown_build_tag')
114 self.assertEqual(functest_utils.get_version(), "unknown")
116 @mock.patch('functest.utils.functest_utils.logger.info')
117 def test_logger_test_results(self, mock_logger_info):
118 CONST.__setattr__('results_test_db_url', self.db_url)
119 CONST.__setattr__('BUILD_TAG', self.build_tag)
120 CONST.__setattr__('NODE_NAME', self.node_name)
121 CONST.__setattr__('DEPLOY_SCENARIO', self.scenario)
122 with mock.patch('functest.utils.functest_utils.get_version',
123 return_value=self.version):
124 functest_utils.logger_test_results(self.project, self.case_name,
125 self.status, self.details)
126 mock_logger_info.assert_called_once_with(
128 "****************************************\n"
129 "\t %(p)s/%(n)s results \n\n"
130 "****************************************\n"
136 "build tag:\t%(b)s\n"
138 % {'p': self.project,
140 'db': CONST.__getattribute__('results_test_db_url'),
141 'pod': self.node_name,
148 def _get_env_dict(self, var):
149 dic = {'INSTALLER_TYPE': self.installer,
150 'DEPLOY_SCENARIO': self.scenario,
151 'NODE_NAME': self.node_name,
152 'BUILD_TAG': self.build_tag}
156 def _test_push_results_to_db_missing_env(self, env_var):
157 dic = self._get_env_dict(env_var)
158 CONST.__setattr__('results_test_db_url', self.db_url)
159 with mock.patch.dict(os.environ,
162 mock.patch('functest.utils.functest_utils.logger.error') \
163 as mock_logger_error:
164 functest_utils.push_results_to_db(self.project, self.case_name,
165 self.start_date, self.stop_date,
166 self.result, self.details)
167 mock_logger_error.assert_called_once_with("Please set env var: " +
171 def test_push_results_to_db_missing_installer(self):
172 self._test_push_results_to_db_missing_env('INSTALLER_TYPE')
174 def test_push_results_to_db_missing_scenario(self):
175 self._test_push_results_to_db_missing_env('DEPLOY_SCENARIO')
177 def test_push_results_to_db_missing_nodename(self):
178 self._test_push_results_to_db_missing_env('NODE_NAME')
180 def test_push_results_to_db_missing_buildtag(self):
181 self._test_push_results_to_db_missing_env('BUILD_TAG')
183 def test_push_results_to_db_request_post_failed(self):
184 dic = self._get_env_dict(None)
185 CONST.__setattr__('results_test_db_url', self.db_url)
186 with mock.patch.dict(os.environ,
189 mock.patch('functest.utils.functest_utils.logger.error') \
190 as mock_logger_error, \
191 mock.patch('functest.utils.functest_utils.requests.post',
192 side_effect=requests.RequestException):
193 self.assertFalse(functest_utils.
194 push_results_to_db(self.project, self.case_name,
197 self.result, self.details))
198 mock_logger_error.assert_called_once_with(test_utils.
199 RegexMatch("Pushing "
205 def test_push_results_to_db_request_post_exception(self):
206 dic = self._get_env_dict(None)
207 CONST.__setattr__('results_test_db_url', self.db_url)
208 with mock.patch.dict(os.environ,
211 mock.patch('functest.utils.functest_utils.logger.error') \
212 as mock_logger_error, \
213 mock.patch('functest.utils.functest_utils.requests.post',
214 side_effect=Exception):
215 self.assertFalse(functest_utils.
216 push_results_to_db(self.project, self.case_name,
219 self.result, self.details))
220 self.assertTrue(mock_logger_error.called)
222 def test_push_results_to_db_default(self):
223 dic = self._get_env_dict(None)
224 CONST.__setattr__('results_test_db_url', self.db_url)
225 with mock.patch.dict(os.environ,
228 mock.patch('functest.utils.functest_utils.requests.post'):
229 self.assertTrue(functest_utils.
230 push_results_to_db(self.project, self.case_name,
233 self.result, self.details))
235 test_ip = ['10.1.23.4', '10.1.14.15', '10.1.16.15']
239 if FunctestUtilsTesting.readline == \
240 len(FunctestUtilsTesting.test_ip) - 1:
242 FunctestUtilsTesting.readline += 1
243 return FunctestUtilsTesting.test_ip[FunctestUtilsTesting.readline]
245 # TODO: get_resolvconf_ns
246 @mock.patch('functest.utils.functest_utils.dns.resolver.Resolver')
247 def test_get_resolvconf_ns_default(self, mock_dns_resolve):
248 attrs = {'query.return_value': ["test"]}
249 mock_dns_resolve.configure_mock(**attrs)
252 attrs = {'readline.side_effect': self.readline_side}
253 m.configure_mock(**attrs)
255 with mock.patch("six.moves.builtins.open") as mo:
257 self.assertEqual(functest_utils.get_resolvconf_ns(),
260 def _get_environ(self, var):
261 if var == 'INSTALLER_TYPE':
262 return self.installer
263 elif var == 'DEPLOY_SCENARIO':
267 def test_get_ci_envvars_default(self):
268 with mock.patch('os.environ.get',
269 side_effect=self._get_environ):
270 dic = {"installer": self.installer,
271 "scenario": self.scenario}
272 self.assertDictEqual(functest_utils.get_ci_envvars(), dic)
274 def cmd_readline(self):
275 return 'test_value\n'
277 @mock.patch('functest.utils.functest_utils.logger.error')
278 @mock.patch('functest.utils.functest_utils.logger.info')
279 def test_execute_command_args_present_with_error(self, mock_logger_info,
281 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
282 as mock_subproc_open, \
283 mock.patch('six.moves.builtins.open',
284 mock.mock_open()) as mopen:
286 FunctestUtilsTesting.readline = 0
288 mock_obj = mock.Mock()
289 attrs = {'readline.side_effect': self.cmd_readline()}
290 mock_obj.configure_mock(**attrs)
292 mock_obj2 = mock.Mock()
293 attrs = {'stdout': mock_obj, 'wait.return_value': 1}
294 mock_obj2.configure_mock(**attrs)
296 mock_subproc_open.return_value = mock_obj2
298 resp = functest_utils.execute_command(self.cmd, info=True,
299 error_msg=self.error_msg,
301 output_file=self.output_file)
302 self.assertEqual(resp, 1)
303 msg_exec = ("Executing command: '%s'" % self.cmd)
304 mock_logger_info.assert_called_once_with(msg_exec)
305 mopen.assert_called_once_with(self.output_file, "w")
306 mock_logger_error.assert_called_once_with(self.error_msg)
308 @mock.patch('functest.utils.functest_utils.logger.info')
309 def test_execute_command_args_present_with_success(self, mock_logger_info,
311 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
312 as mock_subproc_open, \
313 mock.patch('six.moves.builtins.open',
314 mock.mock_open()) as mopen:
316 FunctestUtilsTesting.readline = 0
318 mock_obj = mock.Mock()
319 attrs = {'readline.side_effect': self.cmd_readline()}
320 mock_obj.configure_mock(**attrs)
322 mock_obj2 = mock.Mock()
323 attrs = {'stdout': mock_obj, 'wait.return_value': 0}
324 mock_obj2.configure_mock(**attrs)
326 mock_subproc_open.return_value = mock_obj2
328 resp = functest_utils.execute_command(self.cmd, info=True,
329 error_msg=self.error_msg,
331 output_file=self.output_file)
332 self.assertEqual(resp, 0)
333 msg_exec = ("Executing command: '%s'" % self.cmd)
334 mock_logger_info.assert_called_once_with(msg_exec)
335 mopen.assert_called_once_with(self.output_file, "w")
337 @mock.patch('sys.stdout')
338 def test_execute_command_args_missing_with_success(self, stdout=None):
339 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
340 as mock_subproc_open:
342 FunctestUtilsTesting.readline = 2
344 mock_obj = mock.Mock()
345 attrs = {'readline.side_effect': self.cmd_readline()}
346 mock_obj.configure_mock(**attrs)
348 mock_obj2 = mock.Mock()
349 attrs = {'stdout': mock_obj, 'wait.return_value': 0}
350 mock_obj2.configure_mock(**attrs)
352 mock_subproc_open.return_value = mock_obj2
354 resp = functest_utils.execute_command(self.cmd, info=False,
358 self.assertEqual(resp, 0)
360 @mock.patch('sys.stdout')
361 def test_execute_command_args_missing_with_error(self, stdout=None):
362 with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
363 as mock_subproc_open:
365 FunctestUtilsTesting.readline = 2
366 mock_obj = mock.Mock()
367 attrs = {'readline.side_effect': self.cmd_readline()}
368 mock_obj.configure_mock(**attrs)
370 mock_obj2 = mock.Mock()
371 attrs = {'stdout': mock_obj, 'wait.return_value': 1}
372 mock_obj2.configure_mock(**attrs)
374 mock_subproc_open.return_value = mock_obj2
376 resp = functest_utils.execute_command(self.cmd, info=False,
380 self.assertEqual(resp, 1)
382 def _get_functest_config(self, var):
385 @mock.patch('functest.utils.functest_utils.logger.error')
386 def test_get_dict_by_test(self, mock_logger_error):
387 with mock.patch('six.moves.builtins.open', mock.mock_open()), \
388 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
390 mock_obj = mock.Mock()
391 attrs = {'get.return_value': [{'testcases': [self.testcase_dict]}]}
392 mock_obj.configure_mock(**attrs)
394 mock_yaml.return_value = mock_obj
396 self.assertDictEqual(functest_utils.
397 get_dict_by_test(self.testname),
400 @mock.patch('functest.utils.functest_utils.get_dict_by_test')
401 def test_get_criteria_by_test_default(self, mock_get_dict_by_test):
402 mock_get_dict_by_test.return_value = self.testcase_dict
403 self.assertEqual(functest_utils.get_criteria_by_test(self.testname),
406 @mock.patch('functest.utils.functest_utils.get_dict_by_test')
407 def test_get_criteria_by_test_failed(self, mock_get_dict_by_test):
408 mock_get_dict_by_test.return_value = None
409 self.assertIsNone(functest_utils.get_criteria_by_test(self.testname))
411 def test_get_parameter_from_yaml_failed(self):
412 self.file_yaml['general'] = None
413 with mock.patch('six.moves.builtins.open', mock.mock_open()), \
414 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
416 self.assertRaises(ValueError) as excep:
417 mock_yaml.return_value = self.file_yaml
418 functest_utils.get_parameter_from_yaml(self.parameter,
420 self.assertTrue(("The parameter %s is not"
421 " defined in config_functest.yaml" %
422 self.parameter) in excep.exception)
424 def test_get_parameter_from_yaml_default(self):
425 with mock.patch('six.moves.builtins.open', mock.mock_open()), \
426 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
428 mock_yaml.return_value = self.file_yaml
429 self.assertEqual(functest_utils.
430 get_parameter_from_yaml(self.parameter,
434 @mock.patch('functest.utils.functest_utils.get_parameter_from_yaml')
435 def test_get_functest_config_default(self, mock_get_parameter_from_yaml):
436 with mock.patch.dict(os.environ,
437 {'CONFIG_FUNCTEST_YAML': self.config_yaml}):
438 functest_utils.get_functest_config(self.parameter)
439 mock_get_parameter_from_yaml. \
440 assert_called_once_with(self.parameter,
443 def test_get_functest_yaml(self):
444 with mock.patch('six.moves.builtins.open', mock.mock_open()), \
445 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
447 mock_yaml.return_value = self.file_yaml
448 resp = functest_utils.get_functest_yaml()
449 self.assertEqual(resp, self.file_yaml)
451 @mock.patch('functest.utils.functest_utils.logger.info')
452 def test_print_separator(self, mock_logger_info):
453 functest_utils.print_separator()
454 mock_logger_info.assert_called_once_with("======================="
455 "=======================")
458 if __name__ == "__main__":
459 logging.disable(logging.CRITICAL)
460 unittest.main(verbosity=2)