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
10 """Define the classes required to fully cover odl."""
16 from keystoneauth1.exceptions import auth_plugins
18 from robot.errors import RobotError
20 from six.moves import urllib
22 from functest.core import testcase
23 from functest.opnfv_tests.sdn.odl import odl
25 __author__ = "Cedric Ollivier <cedric.ollivier@orange.com>"
28 class ODLTesting(unittest.TestCase):
30 """The super class which testing classes could inherit."""
31 # pylint: disable=missing-docstring
33 logging.disable(logging.CRITICAL)
35 _keystone_ip = "127.0.0.1"
36 _neutron_url = "http://127.0.0.2:9696"
37 _sdn_controller_ip = "127.0.0.3"
38 _os_auth_url = "http://{}:5000/v3".format(_keystone_ip)
39 _os_projectname = "admin"
40 _os_username = "admin"
41 _os_password = "admin"
43 _odl_restconfport = "8181"
44 _odl_username = "admin"
45 _odl_password = "admin"
46 _os_userdomainname = 'Default'
47 _os_projectdomainname = 'Default'
50 for var in ("INSTALLER_TYPE", "SDN_CONTROLLER", "SDN_CONTROLLER_IP"):
53 os.environ["OS_AUTH_URL"] = self._os_auth_url
54 os.environ["OS_USERNAME"] = self._os_username
55 os.environ["OS_USER_DOMAIN_NAME"] = self._os_userdomainname
56 os.environ["OS_PASSWORD"] = self._os_password
57 os.environ["OS_PROJECT_NAME"] = self._os_projectname
58 os.environ["OS_PROJECT_DOMAIN_NAME"] = self._os_projectdomainname
59 os.environ["OS_PASSWORD"] = self._os_password
60 self.test = odl.ODLTests(case_name='odl', project_name='functest')
61 self.defaultargs = {'odlusername': self._odl_username,
62 'odlpassword': self._odl_password,
63 'neutronurl': "http://{}:9696".format(
65 'osauthurl': self._os_auth_url,
66 'osusername': self._os_username,
67 'osuserdomainname': self._os_userdomainname,
68 'osprojectname': self._os_projectname,
69 'osprojectdomainname': self._os_projectdomainname,
70 'ospassword': self._os_password,
71 'odlip': self._keystone_ip,
72 'odlwebport': self._odl_webport,
73 'odlrestconfport': self._odl_restconfport,
77 class ODLRobotTesting(ODLTesting):
79 """The class testing ODLTests.set_robotframework_vars()."""
80 # pylint: disable=missing-docstring
82 @mock.patch('fileinput.input', side_effect=Exception())
83 def test_set_vars_ko(self, mock_method):
84 self.assertFalse(self.test.set_robotframework_vars())
85 mock_method.assert_called_once_with(
86 os.path.join(odl.ODLTests.odl_test_repo,
87 'csit/variables/Variables.robot'), inplace=True)
89 @mock.patch('fileinput.input', return_value=[])
90 def test_set_vars_empty(self, mock_method):
91 self.assertTrue(self.test.set_robotframework_vars())
92 mock_method.assert_called_once_with(
93 os.path.join(odl.ODLTests.odl_test_repo,
94 'csit/variables/Variables.robot'), inplace=True)
96 @mock.patch('sys.stdout', new_callable=six.StringIO)
97 def _test_set_vars(self, msg1, msg2, *args):
98 line = mock.MagicMock()
99 line.__iter__.return_value = [msg1]
100 with mock.patch('fileinput.input', return_value=line) as mock_method:
101 self.assertTrue(self.test.set_robotframework_vars())
102 mock_method.assert_called_once_with(
103 os.path.join(odl.ODLTests.odl_test_repo,
104 'csit/variables/Variables.robot'), inplace=True)
105 self.assertEqual(args[0].getvalue(), "{}\n".format(msg2))
107 def test_set_vars_auth_default(self):
110 "@{AUTH} admin admin")
112 def test_set_vars_auth1(self):
117 @mock.patch('sys.stdout', new_callable=six.StringIO)
118 def test_set_vars_auth_foo(self, *args):
119 line = mock.MagicMock()
120 line.__iter__.return_value = ["@{AUTH} "]
121 with mock.patch('fileinput.input', return_value=line) as mock_method:
122 self.assertTrue(self.test.set_robotframework_vars('foo', 'bar'))
123 mock_method.assert_called_once_with(
124 os.path.join(odl.ODLTests.odl_test_repo,
125 'csit/variables/Variables.robot'), inplace=True)
131 class ODLMainTesting(ODLTesting):
133 """The class testing ODLTests.run_suites()."""
134 # pylint: disable=missing-docstring
136 def _get_run_suites_kwargs(self, key=None):
137 kwargs = {'odlusername': self._odl_username,
138 'odlpassword': self._odl_password,
139 'neutronurl': self._neutron_url,
140 'osauthurl': self._os_auth_url,
141 'osusername': self._os_username,
142 'osuserdomainname': self._os_userdomainname,
143 'osprojectname': self._os_projectname,
144 'osprojectdomainname': self._os_projectdomainname,
145 'ospassword': self._os_password,
146 'odlip': self._sdn_controller_ip,
147 'odlwebport': self._odl_webport,
148 'odlrestconfport': self._odl_restconfport}
153 def _test_run_suites(self, status, *args):
154 kwargs = self._get_run_suites_kwargs()
155 self.assertEqual(self.test.run_suites(**kwargs), status)
157 args[0].assert_called_once_with(self.test.res_dir)
160 'KEYSTONEURL:{}://{}'.format(
161 urllib.parse.urlparse(self._os_auth_url).scheme,
162 urllib.parse.urlparse(self._os_auth_url).netloc),
163 'NEUTRONURL:{}'.format(self._neutron_url),
164 'OS_AUTH_URL:"{}"'.format(self._os_auth_url),
165 'OSUSERNAME:"{}"'.format(self._os_username),
166 'OSUSERDOMAINNAME:"{}"'.format(self._os_userdomainname),
167 'OSTENANTNAME:"{}"'.format(self._os_projectname),
168 'OSPROJECTDOMAINNAME:"{}"'.format(self._os_projectdomainname),
169 'OSPASSWORD:"{}"'.format(self._os_password),
170 'ODL_SYSTEM_IP:{}'.format(self._sdn_controller_ip),
171 'PORT:{}'.format(self._odl_webport),
172 'RESTCONFPORT:{}'.format(self._odl_restconfport)]
173 args[1].assert_called_once_with(
174 odl.ODLTests.basic_suite_dir,
175 odl.ODLTests.neutron_suite_dir,
177 output=os.path.join(self.test.res_dir, 'output.xml'),
182 args[2].assert_called_with(
183 os.path.join(self.test.res_dir, 'stdout.txt'))
185 def _test_no_keyword(self, key):
186 kwargs = self._get_run_suites_kwargs(key)
187 self.assertEqual(self.test.run_suites(**kwargs),
188 testcase.TestCase.EX_RUN_ERROR)
190 def test_no_odlusername(self):
191 self._test_no_keyword('odlusername')
193 def test_no_odlpassword(self):
194 self._test_no_keyword('odlpassword')
196 def test_no_neutronurl(self):
197 self._test_no_keyword('neutronurl')
199 def test_no_osauthurl(self):
200 self._test_no_keyword('osauthurl')
202 def test_no_osusername(self):
203 self._test_no_keyword('osusername')
205 def test_no_osprojectname(self):
206 self._test_no_keyword('osprojectname')
208 def test_no_ospassword(self):
209 self._test_no_keyword('ospassword')
211 def test_no_odlip(self):
212 self._test_no_keyword('odlip')
214 def test_no_odlwebport(self):
215 self._test_no_keyword('odlwebport')
217 def test_no_odlrestconfport(self):
218 self._test_no_keyword('odlrestconfport')
220 def test_set_vars_ko(self):
221 with mock.patch.object(self.test, 'set_robotframework_vars',
222 return_value=False) as mock_object:
223 self._test_run_suites(testcase.TestCase.EX_RUN_ERROR)
224 mock_object.assert_called_once_with(
225 self._odl_username, self._odl_password)
227 @mock.patch('robot.run', side_effect=RobotError)
228 @mock.patch('os.makedirs')
229 def test_run_ko(self, *args):
230 with mock.patch.object(self.test, 'set_robotframework_vars',
231 return_value=True), \
232 self.assertRaises(RobotError):
233 self._test_run_suites(testcase.TestCase.EX_RUN_ERROR, *args)
235 @mock.patch('robot.run')
236 @mock.patch('os.makedirs')
237 def test_parse_results_ko(self, *args):
238 with mock.patch.object(self.test, 'set_robotframework_vars',
239 return_value=True), \
240 mock.patch.object(self.test, 'parse_results',
241 side_effect=RobotError):
242 self._test_run_suites(testcase.TestCase.EX_RUN_ERROR, *args)
244 @mock.patch('robot.run')
245 @mock.patch('os.makedirs')
246 def test_ok(self, *args):
247 with mock.patch.object(self.test, 'set_robotframework_vars',
248 return_value=True), \
249 mock.patch.object(self.test, 'parse_results'):
250 self._test_run_suites(testcase.TestCase.EX_OK, *args)
252 @mock.patch('robot.run', return_value=1)
253 @mock.patch('os.makedirs')
254 def test_testcases_in_failure(self, *args):
255 with mock.patch.object(self.test, 'set_robotframework_vars',
256 return_value=True), \
257 mock.patch.object(self.test, 'parse_results'):
258 self._test_run_suites(testcase.TestCase.EX_OK, *args)
261 class ODLRunTesting(ODLTesting):
263 """The class testing ODLTests.run()."""
264 # pylint: disable=missing-docstring
266 def _test_no_env_var(self, var):
267 with mock.patch('functest.utils.openstack_utils.get_endpoint',
268 return_value=ODLTesting._neutron_url):
270 self.assertEqual(self.test.run(),
271 testcase.TestCase.EX_RUN_ERROR)
273 def _test_run(self, status=testcase.TestCase.EX_OK,
274 exception=None, **kwargs):
275 odlip = kwargs['odlip'] if 'odlip' in kwargs else '127.0.0.3'
276 odlwebport = kwargs['odlwebport'] if 'odlwebport' in kwargs else '8080'
277 odlrestconfport = (kwargs['odlrestconfport']
278 if 'odlrestconfport' in kwargs else '8181')
280 with mock.patch('functest.utils.openstack_utils.get_endpoint',
281 return_value=ODLTesting._neutron_url):
283 self.test.run_suites = mock.Mock(side_effect=exception)
285 self.test.run_suites = mock.Mock(return_value=status)
286 self.assertEqual(self.test.run(), status)
287 self.test.run_suites.assert_called_once_with(
288 odl.ODLTests.default_suites,
289 neutronurl=self._neutron_url,
290 odlip=odlip, odlpassword=self._odl_password,
291 odlrestconfport=odlrestconfport,
292 odlusername=self._odl_username, odlwebport=odlwebport,
293 osauthurl=self._os_auth_url,
294 ospassword=self._os_password,
295 osprojectname=self._os_projectname,
296 osusername=self._os_username,
297 osprojectdomainname=self._os_projectdomainname,
298 osuserdomainname=self._os_userdomainname)
300 def _test_multiple_suites(self, suites,
301 status=testcase.TestCase.EX_OK, **kwargs):
302 odlip = kwargs['odlip'] if 'odlip' in kwargs else '127.0.0.3'
303 odlwebport = kwargs['odlwebport'] if 'odlwebport' in kwargs else '8080'
304 odlrestconfport = (kwargs['odlrestconfport']
305 if 'odlrestconfport' in kwargs else '8181')
306 with mock.patch('functest.utils.openstack_utils.get_endpoint',
307 return_value=ODLTesting._neutron_url):
308 self.test.run_suites = mock.Mock(return_value=status)
309 self.assertEqual(self.test.run(suites=suites), status)
310 self.test.run_suites.assert_called_once_with(
312 neutronurl=self._neutron_url,
313 odlip=odlip, odlpassword=self._odl_password,
314 odlrestconfport=odlrestconfport,
315 odlusername=self._odl_username, odlwebport=odlwebport,
316 osauthurl=self._os_auth_url,
317 ospassword=self._os_password,
318 osprojectname=self._os_projectname,
319 osusername=self._os_username,
320 osprojectdomainname=self._os_projectdomainname,
321 osuserdomainname=self._os_userdomainname)
324 with mock.patch('functest.utils.openstack_utils.get_endpoint',
325 side_effect=auth_plugins.MissingAuthPlugin()):
326 self.assertEqual(self.test.run(),
327 testcase.TestCase.EX_RUN_ERROR)
329 def test_no_os_auth_url(self):
330 self._test_no_env_var("OS_AUTH_URL")
332 def test_no_os_username(self):
333 self._test_no_env_var("OS_USERNAME")
335 def test_no_os_password(self):
336 self._test_no_env_var("OS_PASSWORD")
338 def test_no_os__name(self):
339 self._test_no_env_var("OS_PROJECT_NAME")
341 def test_run_suites_false(self):
342 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
343 self._test_run(testcase.TestCase.EX_RUN_ERROR,
344 odlip=self._sdn_controller_ip,
345 odlwebport=self._odl_webport)
347 def test_run_suites_exc(self):
348 with self.assertRaises(Exception):
349 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
350 self._test_run(status=testcase.TestCase.EX_RUN_ERROR,
351 exception=Exception(),
352 odlip=self._sdn_controller_ip,
353 odlwebport=self._odl_webport)
355 def test_no_sdn_controller_ip(self):
356 with mock.patch('functest.utils.openstack_utils.get_endpoint',
357 return_value=ODLTesting._neutron_url):
358 self.assertEqual(self.test.run(),
359 testcase.TestCase.EX_RUN_ERROR)
361 def test_without_installer_type(self):
362 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
363 self._test_run(testcase.TestCase.EX_OK,
364 odlip=self._sdn_controller_ip,
365 odlwebport=self._odl_webport)
367 def test_suites(self):
368 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
369 self._test_multiple_suites(
370 [odl.ODLTests.basic_suite_dir],
371 testcase.TestCase.EX_OK,
372 odlip=self._sdn_controller_ip,
373 odlwebport=self._odl_webport)
376 os.environ["INSTALLER_TYPE"] = "fuel"
377 self._test_run(testcase.TestCase.EX_OK,
378 odlip=urllib.parse.urlparse(self._neutron_url).hostname,
380 odlrestconfport='8282')
382 def test_apex_no_controller_ip(self):
383 with mock.patch('functest.utils.openstack_utils.get_endpoint',
384 return_value=ODLTesting._neutron_url):
385 os.environ["INSTALLER_TYPE"] = "apex"
386 self.assertEqual(self.test.run(),
387 testcase.TestCase.EX_RUN_ERROR)
390 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
391 os.environ["INSTALLER_TYPE"] = "apex"
392 self._test_run(testcase.TestCase.EX_OK,
393 odlip=self._sdn_controller_ip, odlwebport='8081',
394 odlrestconfport='8081')
396 def test_netvirt_no_controller_ip(self):
397 with mock.patch('functest.utils.openstack_utils.get_endpoint',
398 return_value=ODLTesting._neutron_url):
399 os.environ["INSTALLER_TYPE"] = "netvirt"
400 self.assertEqual(self.test.run(),
401 testcase.TestCase.EX_RUN_ERROR)
403 def test_netvirt(self):
404 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
405 os.environ["INSTALLER_TYPE"] = "netvirt"
406 self._test_run(testcase.TestCase.EX_OK,
407 odlip=self._sdn_controller_ip, odlwebport='8081',
408 odlrestconfport='8081')
410 def test_joid_no_controller_ip(self):
411 with mock.patch('functest.utils.openstack_utils.get_endpoint',
412 return_value=ODLTesting._neutron_url):
413 os.environ["INSTALLER_TYPE"] = "joid"
414 self.assertEqual(self.test.run(),
415 testcase.TestCase.EX_RUN_ERROR)
418 os.environ["SDN_CONTROLLER"] = self._sdn_controller_ip
419 os.environ["INSTALLER_TYPE"] = "joid"
420 self._test_run(testcase.TestCase.EX_OK,
421 odlip=self._sdn_controller_ip, odlwebport='8080')
423 def test_compass(self):
424 os.environ["INSTALLER_TYPE"] = "compass"
425 self._test_run(testcase.TestCase.EX_OK,
426 odlip=urllib.parse.urlparse(self._neutron_url).hostname,
427 odlrestconfport='8080')
429 def test_daisy_no_controller_ip(self):
430 with mock.patch('functest.utils.openstack_utils.get_endpoint',
431 return_value=ODLTesting._neutron_url):
432 os.environ["INSTALLER_TYPE"] = "daisy"
433 self.assertEqual(self.test.run(),
434 testcase.TestCase.EX_RUN_ERROR)
436 def test_daisy(self):
437 os.environ["SDN_CONTROLLER_IP"] = self._sdn_controller_ip
438 os.environ["INSTALLER_TYPE"] = "daisy"
439 self._test_run(testcase.TestCase.EX_OK,
440 odlip=self._sdn_controller_ip, odlwebport='8181',
441 odlrestconfport='8087')
444 class ODLArgParserTesting(ODLTesting):
446 """The class testing ODLParser."""
447 # pylint: disable=missing-docstring
450 self.parser = odl.ODLParser()
451 super(ODLArgParserTesting, self).setUp()
453 def test_default(self):
454 self.assertEqual(self.parser.parse_args(), self.defaultargs)
456 def test_basic(self):
457 self.defaultargs['neutronurl'] = self._neutron_url
458 self.defaultargs['odlip'] = self._sdn_controller_ip
460 self.parser.parse_args(
461 ["--neutronurl={}".format(self._neutron_url),
462 "--odlip={}".format(self._sdn_controller_ip)]),
465 @mock.patch('sys.stderr', new_callable=six.StringIO)
466 def test_fail(self, mock_method):
467 self.defaultargs['foo'] = 'bar'
468 with self.assertRaises(SystemExit):
469 self.parser.parse_args(["--foo=bar"])
470 self.assertTrue(mock_method.getvalue().startswith("usage:"))
472 def _test_arg(self, arg, value):
473 self.defaultargs[arg] = value
475 self.parser.parse_args(["--{}={}".format(arg, value)]),
478 def test_odlusername(self):
479 self._test_arg('odlusername', 'foo')
481 def test_odlpassword(self):
482 self._test_arg('odlpassword', 'foo')
484 def test_osauthurl(self):
485 self._test_arg('osauthurl', 'http://127.0.0.4:5000/v2')
487 def test_neutronurl(self):
488 self._test_arg('neutronurl', 'http://127.0.0.4:9696')
490 def test_osusername(self):
491 self._test_arg('osusername', 'foo')
493 def test_osuserdomainname(self):
494 self._test_arg('osuserdomainname', 'domain')
496 def test_osprojectname(self):
497 self._test_arg('osprojectname', 'foo')
499 def test_osprojectdomainname(self):
500 self._test_arg('osprojectdomainname', 'domain')
502 def test_ospassword(self):
503 self._test_arg('ospassword', 'foo')
505 def test_odlip(self):
506 self._test_arg('odlip', '127.0.0.4')
508 def test_odlwebport(self):
509 self._test_arg('odlwebport', '80')
511 def test_odlrestconfport(self):
512 self._test_arg('odlrestconfport', '80')
514 def test_pushtodb(self):
515 self.defaultargs['pushtodb'] = True
516 self.assertEqual(self.parser.parse_args(["--{}".format('pushtodb')]),
519 def test_multiple_args(self):
520 self.defaultargs['neutronurl'] = self._neutron_url
521 self.defaultargs['odlip'] = self._sdn_controller_ip
523 self.parser.parse_args(
524 ["--neutronurl={}".format(self._neutron_url),
525 "--odlip={}".format(self._sdn_controller_ip)]),
529 if __name__ == "__main__":
530 logging.disable(logging.CRITICAL)
531 unittest.main(verbosity=2)