functest/tests/unit/utils/test_functest_utils.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 Orange and others.
   4 #
   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
   9
  10 # pylint: disable=missing-docstring
  11
  12 import logging
  13 import time
  14 import unittest
  15
  16 import mock
  17 import pkg_resources
  18 import six
  19
  20 from functest.utils import functest_utils
  21
  22
  23 class FunctestUtilsTesting(unittest.TestCase):
  24     # pylint: disable=too-many-instance-attributes,too-many-public-methods
  25
  26     readline = 0
  27     test_ip = ['10.1.23.4', '10.1.14.15', '10.1.16.15']
  28
  29     def setUp(self):
  30         self.url = 'http://www.opnfv.org/'
  31         self.timeout = 5
  32         self.dest_path = 'test_path'
  33         self.repo_path = 'test_repo_path'
  34         self.installer = 'test_installer'
  35         self.scenario = 'test_scenario'
  36         self.build_tag = 'jenkins-functest-fuel-opnfv-jump-2-daily-master-190'
  37         self.build_tag_week = 'jenkins-functest-fuel-baremetal-weekly-master-8'
  38         self.version = 'master'
  39         self.node_name = 'test_node_name'
  40         self.project = 'test_project'
  41         self.case_name = 'test_case_name'
  42         self.status = 'test_status'
  43         self.details = 'test_details'
  44         self.db_url = 'test_db_url'
  45         self.criteria = 50
  46         self.result = 75
  47         self.start_date = 1482624000
  48         self.stop_date = 1482624000
  49         self.start_time = time.time()
  50         self.stop_time = time.time()
  51         self.readline = -1
  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'
  55         self.cmd = 'test_cmd'
  56         self.output_file = 'test_output_file'
  57         self.testname = 'testname'
  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':
  64                                                     'test_image_name'}}}
  65
  66     def _get_env_dict(self, var):
  67         dic = {'INSTALLER_TYPE': self.installer,
  68                'DEPLOY_SCENARIO': self.scenario,
  69                'NODE_NAME': self.node_name,
  70                'BUILD_TAG': self.build_tag}
  71         dic.pop(var, None)
  72         return dic
  73
  74     @staticmethod
  75     def readline_side():
  76         if FunctestUtilsTesting.readline == \
  77                 len(FunctestUtilsTesting.test_ip) - 1:
  78             return False
  79         FunctestUtilsTesting.readline += 1
  80         return FunctestUtilsTesting.test_ip[FunctestUtilsTesting.readline]
  81
  82     def _get_environ(self, var, *args):  # pylint: disable=unused-argument
  83         if var == 'INSTALLER_TYPE':
  84             return self.installer
  85         if var == 'DEPLOY_SCENARIO':
  86             return self.scenario
  87         return var
  88
  89     @staticmethod
  90     def cmd_readline():
  91         return 'test_value\n'
  92
  93     @mock.patch('functest.utils.functest_utils.LOGGER.error')
  94     @mock.patch('functest.utils.functest_utils.LOGGER.info')
  95     def test_exec_cmd_args_present_ko(self, mock_logger_info,
  96                                       mock_logger_error):
  97         with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
  98                 as mock_subproc_open, \
  99                 mock.patch('six.moves.builtins.open',
 100                            mock.mock_open()) as mopen:
 101             stream = six.BytesIO()
 102             stream.write(self.cmd_readline().encode("utf-8"))
 103             mock_obj2 = mock.Mock()
 104             attrs = {'stdout': stream, 'wait.return_value': 1}
 105             mock_obj2.configure_mock(**attrs)
 106             mock_subproc_open.return_value = mock_obj2
 107             resp = functest_utils.execute_command(
 108                 self.cmd, info=True, error_msg=self.error_msg, verbose=True,
 109                 output_file=self.output_file)
 110             self.assertEqual(resp, 1)
 111             msg_exec = ("Executing command: '%s'" % self.cmd)
 112             mock_logger_info.assert_called_once_with(msg_exec)
 113             mopen.assert_called_once_with(self.output_file, "w")
 114             mock_logger_error.assert_called_once_with(self.error_msg)
 115
 116     @mock.patch('functest.utils.functest_utils.LOGGER.info')
 117     def test_exec_cmd_args_present_ok(self, mock_logger_info):
 118         with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
 119                 as mock_subproc_open, \
 120                 mock.patch('six.moves.builtins.open',
 121                            mock.mock_open()) as mopen:
 122             stream = six.BytesIO()
 123             stream.write(self.cmd_readline().encode("utf-8"))
 124             mock_obj2 = mock.Mock()
 125             attrs = {'stdout': stream, 'wait.return_value': 0}
 126             mock_obj2.configure_mock(**attrs)
 127             mock_subproc_open.return_value = mock_obj2
 128             resp = functest_utils.execute_command(
 129                 self.cmd, info=True, error_msg=self.error_msg, verbose=True,
 130                 output_file=self.output_file)
 131             self.assertEqual(resp, 0)
 132             msg_exec = ("Executing command: '%s'" % self.cmd)
 133             mock_logger_info.assert_called_once_with(msg_exec)
 134             mopen.assert_called_once_with(self.output_file, "w")
 135
 136     @mock.patch('sys.stdout')
 137     def test_exec_cmd_args_missing_ok(self, stdout=None):
 138         # pylint: disable=unused-argument
 139         with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
 140                 as mock_subproc_open:
 141             stream = six.BytesIO()
 142             stream.write(self.cmd_readline().encode("utf-8"))
 143             mock_obj2 = mock.Mock()
 144             attrs = {'stdout': stream, 'wait.return_value': 0}
 145             mock_obj2.configure_mock(**attrs)
 146             mock_subproc_open.return_value = mock_obj2
 147             resp = functest_utils.execute_command(
 148                 self.cmd, info=False, error_msg="", verbose=False,
 149                 output_file=None)
 150             self.assertEqual(resp, 0)
 151
 152     @mock.patch('sys.stdout')
 153     def test_exec_cmd_args_missing_ko(self, stdout=None):
 154         # pylint: disable=unused-argument
 155         with mock.patch('functest.utils.functest_utils.subprocess.Popen') \
 156                 as mock_subproc_open:
 157             stream = six.BytesIO()
 158             stream.write(self.cmd_readline().encode("utf-8"))
 159             mock_obj2 = mock.Mock()
 160             attrs = {'stdout': stream, 'wait.return_value': 1}
 161             mock_obj2.configure_mock(**attrs)
 162             mock_subproc_open.return_value = mock_obj2
 163             resp = functest_utils.execute_command(
 164                 self.cmd, info=False, error_msg="", verbose=False,
 165                 output_file=None)
 166             self.assertEqual(resp, 1)
 167
 168     def test_get_param_from_yaml_failed(self):
 169         self.file_yaml['general'] = None
 170         with mock.patch('six.moves.builtins.open', mock.mock_open()), \
 171                 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
 172                 as mock_yaml, \
 173                 self.assertRaises(ValueError) as excep:
 174             mock_yaml.return_value = self.file_yaml
 175             functest_utils.get_parameter_from_yaml(self.parameter,
 176                                                    self.test_file)
 177             self.assertTrue(("The parameter %s is not"
 178                              " defined in config_functest.yaml" %
 179                              self.parameter) in excep.exception)
 180
 181     def test_get_param_from_yaml_def(self):
 182         with mock.patch('six.moves.builtins.open', mock.mock_open()), \
 183                 mock.patch('functest.utils.functest_utils.yaml.safe_load') \
 184                 as mock_yaml:
 185             mock_yaml.return_value = self.file_yaml
 186             self.assertEqual(functest_utils.
 187                              get_parameter_from_yaml(self.parameter,
 188                                                      self.test_file),
 189                              'test_image_name')
 190
 191     def test_nova_version_exc1(self):
 192         # pylint: disable=protected-access
 193         cloud = mock.Mock()
 194         cloud._compute_client.request.return_value = None
 195         self.assertEqual(functest_utils.get_nova_version(cloud), None)
 196         cloud._compute_client.request.assert_called_once_with('/', 'GET')
 197
 198     def test_nova_version_exc2(self):
 199         # pylint: disable=protected-access
 200         cloud = mock.Mock()
 201         cloud._compute_client.request.return_value = {"version": None}
 202         self.assertEqual(functest_utils.get_nova_version(cloud), None)
 203         cloud._compute_client.request.assert_called_once_with('/', 'GET')
 204
 205     def test_nova_version_exc3(self):
 206         # pylint: disable=protected-access
 207         cloud = mock.Mock()
 208         cloud._compute_client.request.return_value = {
 209             "version": {"version": None}}
 210         self.assertEqual(functest_utils.get_nova_version(cloud), None)
 211         cloud._compute_client.request.assert_called_once_with('/', 'GET')
 212
 213     def test_nova_version_exc4(self):
 214         # pylint: disable=protected-access
 215         cloud = mock.Mock()
 216         cloud._compute_client.request.return_value = {
 217             "version": {"version": "a.b"}}
 218         self.assertEqual(functest_utils.get_nova_version(cloud), None)
 219         cloud._compute_client.request.assert_called_once_with('/', 'GET')
 220
 221     def test_nova_version(self):
 222         # pylint: disable=protected-access
 223         cloud = mock.Mock()
 224         cloud._compute_client.request.return_value = {
 225             "version": {"version": "2.1"}}
 226         self.assertEqual(functest_utils.get_nova_version(cloud), (2, 1))
 227         cloud._compute_client.request.assert_called_once_with('/', 'GET')
 228
 229     @mock.patch('functest.utils.functest_utils.get_nova_version',
 230                 return_value=(2, 61))
 231     def test_openstack_version1(self, *args):
 232         cloud = mock.Mock()
 233         self.assertEqual(functest_utils.get_openstack_version(
 234             cloud), "Rocky")
 235         args[0].assert_called_once_with(cloud)
 236
 237     @mock.patch('functest.utils.functest_utils.get_nova_version',
 238                 return_value=(2, 60))
 239     def test_openstack_version2(self, *args):
 240         cloud = mock.Mock()
 241         self.assertEqual(functest_utils.get_openstack_version(cloud), "Queens")
 242         args[0].assert_called_once_with(cloud)
 243
 244     @mock.patch('functest.utils.functest_utils.get_nova_version',
 245                 return_value=(2, 43))
 246     def test_openstack_version3(self, *args):
 247         cloud = mock.Mock()
 248         self.assertEqual(functest_utils.get_openstack_version(cloud), "Pike")
 249         args[0].assert_called_once_with(cloud)
 250
 251     @mock.patch('functest.utils.functest_utils.get_nova_version',
 252                 return_value=(2, 39))
 253     def test_openstack_version4(self, *args):
 254         cloud = mock.Mock()
 255         self.assertEqual(functest_utils.get_openstack_version(cloud), "Ocata")
 256         args[0].assert_called_once_with(cloud)
 257
 258     @mock.patch('functest.utils.functest_utils.get_nova_version',
 259                 return_value=(2, 26))
 260     def test_openstack_version5(self, *args):
 261         cloud = mock.Mock()
 262         self.assertEqual(functest_utils.get_openstack_version(cloud), "Newton")
 263         args[0].assert_called_once_with(cloud)
 264
 265     @mock.patch('functest.utils.functest_utils.get_nova_version',
 266                 return_value=(2, 13))
 267     def test_openstack_version6(self, *args):
 268         cloud = mock.Mock()
 269         self.assertEqual(functest_utils.get_openstack_version(cloud), "Mitaka")
 270         args[0].assert_called_once_with(cloud)
 271
 272     @mock.patch('functest.utils.functest_utils.get_nova_version',
 273                 return_value=(2, 4))
 274     def test_openstack_version7(self, *args):
 275         cloud = mock.Mock()
 276         self.assertEqual(
 277             functest_utils.get_openstack_version(cloud), "Liberty")
 278         args[0].assert_called_once_with(cloud)
 279
 280     @mock.patch('functest.utils.functest_utils.get_nova_version',
 281                 return_value=(2, 1))
 282     def test_openstack_version8(self, *args):
 283         cloud = mock.Mock()
 284         self.assertEqual(functest_utils.get_openstack_version(cloud), "Kilo")
 285         args[0].assert_called_once_with(cloud)
 286
 287     @mock.patch('functest.utils.functest_utils.get_nova_version',
 288                 return_value=(1, 9))
 289     def test_openstack_version9(self, *args):
 290         cloud = mock.Mock()
 291         self.assertEqual(
 292             functest_utils.get_openstack_version(cloud), "Unknown")
 293         args[0].assert_called_once_with(cloud)
 294
 295     @mock.patch('functest.utils.functest_utils.get_nova_version',
 296                 return_value=(3, 1))
 297     def test_openstack_version10(self, *args):
 298         cloud = mock.Mock()
 299         self.assertEqual(
 300             functest_utils.get_openstack_version(cloud), "Master")
 301         args[0].assert_called_once_with(cloud)
 302
 303     @mock.patch('functest.utils.functest_utils.get_nova_version',
 304                 return_value=(2, 66))
 305     def test_openstack_version11(self, *args):
 306         cloud = mock.Mock()
 307         self.assertEqual(functest_utils.get_openstack_version(
 308             cloud), "Stein")
 309         args[0].assert_called_once_with(cloud)
 310
 311     @mock.patch('functest.utils.functest_utils.get_nova_version',
 312                 return_value=(2, 78))
 313     def test_openstack_version12(self, *args):
 314         cloud = mock.Mock()
 315         self.assertEqual(functest_utils.get_openstack_version(
 316             cloud), "Train")
 317         args[0].assert_called_once_with(cloud)
 318
 319     @mock.patch('functest.utils.functest_utils.get_nova_version',
 320                 return_value=(2, 87))
 321     def test_openstack_version13(self, *args):
 322         cloud = mock.Mock()
 323         self.assertEqual(functest_utils.get_openstack_version(
 324             cloud), "Ussuri")
 325         args[0].assert_called_once_with(cloud)
 326
 327     @mock.patch('functest.utils.functest_utils.get_nova_version',
 328                 return_value=(2, 88))
 329     def test_openstack_version14(self, *args):
 330         cloud = mock.Mock()
 331         self.assertEqual(functest_utils.get_openstack_version(
 332             cloud), "Wallaby")
 333         args[0].assert_called_once_with(cloud)
 334
 335     @mock.patch('functest.utils.functest_utils.get_nova_version',
 336                 return_value=None)
 337     def test_openstack_version_exc(self, *args):
 338         cloud = mock.Mock()
 339         self.assertEqual(
 340             functest_utils.get_openstack_version(cloud), "Unknown")
 341         args[0].assert_called_once_with(cloud)
 342
 343     def test_convert_dict_to_ini(self):
 344         self.assertEqual(
 345             functest_utils.convert_dict_to_ini({}), "")
 346         self.assertEqual(
 347             functest_utils.convert_dict_to_ini({"a": "b"}), "a:b")
 348         value = functest_utils.convert_dict_to_ini({"a": "b", "c": "d"})
 349         self.assertTrue(value in ('a:b,c:d', 'c:d,a:b'))
 350         with self.assertRaises(AssertionError):
 351             functest_utils.convert_list_to_ini("")
 352
 353     def test_convert_list_to_ini(self):
 354         self.assertEqual(
 355             functest_utils.convert_list_to_ini([]), "")
 356         self.assertEqual(
 357             functest_utils.convert_list_to_ini(["a"]), "a")
 358         self.assertEqual(
 359             functest_utils.convert_list_to_ini(["a", "b"]), "a,b")
 360         with self.assertRaises(AssertionError):
 361             functest_utils.convert_list_to_ini("")
 362
 363     def test_convert_ini_to_dict(self):
 364         self.assertEqual(
 365             functest_utils.convert_ini_to_dict(""), {})
 366         self.assertEqual(
 367             functest_utils.convert_ini_to_dict("a:b"), {"a": "b"})
 368         self.assertEqual(
 369             functest_utils.convert_ini_to_dict(
 370                 "a:b,c:d"), {"a": "b", "c": "d"})
 371         self.assertEqual(
 372             functest_utils.convert_ini_to_dict(
 373                 "a:b:c,d:e:f"), {"a:b": "c", "d:e": "f"})
 374         with self.assertRaises(AssertionError):
 375             functest_utils.convert_list_to_ini({})
 376
 377     def test_convert_ini_to_list(self):
 378         self.assertEqual(
 379             functest_utils.convert_ini_to_list(""), [])
 380         self.assertEqual(
 381             functest_utils.convert_ini_to_list("a"), ["a"])
 382         self.assertEqual(
 383             functest_utils.convert_ini_to_list("a,b"), ["a", "b"])
 384         with self.assertRaises(AssertionError):
 385             functest_utils.convert_ini_to_list([])
 386
 387
 388 if __name__ == "__main__":
 389     logging.disable(logging.CRITICAL)
 390     unittest.main(verbosity=2)