xtesting/tests/unit/ci/test_run_tests.py

   1 #!/usr/bin/env python
   2
   3 # All rights reserved. This program and the accompanying materials
   4 # are made available under the terms of the Apache License, Version 2.0
   5 # which accompanies this distribution, and is available at
   6 # http://www.apache.org/licenses/LICENSE-2.0
   7
   8 # pylint: disable=missing-docstring
   9
  10 import logging
  11 import unittest
  12 import os
  13
  14 import mock
  15
  16 from xtesting.ci import run_tests
  17 from xtesting.core.testcase import TestCase
  18
  19
  20 class FakeModule(TestCase):
  21
  22     def run(self, **kwargs):
  23         return TestCase.EX_OK
  24
  25
  26 class RunTestsTesting(unittest.TestCase):
  27
  28     def setUp(self):
  29         self.runner = run_tests.Runner()
  30         mock_test_case = mock.Mock()
  31         mock_test_case.is_successful.return_value = TestCase.EX_OK
  32         self.runner.executed_test_cases['test1'] = mock_test_case
  33         self.runner.executed_test_cases['test2'] = mock_test_case
  34         self.sep = 'test_sep'
  35         self.creds = {'OS_AUTH_URL': 'http://test_ip:test_port/v2.0',
  36                       'OS_USERNAME': 'test_os_username',
  37                       'OS_TENANT_NAME': 'test_tenant',
  38                       'OS_PASSWORD': 'test_password'}
  39         self.test = {'test_name': 'test_name'}
  40         self.tier = mock.Mock()
  41         test1 = mock.Mock()
  42         test1.get_name.return_value = 'test1'
  43         test2 = mock.Mock()
  44         test2.get_name.return_value = 'test2'
  45         attrs = {'get_name.return_value': 'test_tier',
  46                  'get_tests.return_value': [test1, test2],
  47                  'get_ci_loop.return_value': 'test_ci_loop',
  48                  'get_test_names.return_value': ['test1', 'test2']}
  49         self.tier.configure_mock(**attrs)
  50
  51         self.tiers = mock.Mock()
  52         attrs = {'get_tiers.return_value': [self.tier]}
  53         self.tiers.configure_mock(**attrs)
  54
  55         self.run_tests_parser = run_tests.RunTestsParser()
  56
  57     @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test')
  58     def test_get_run_dict(self, *args):
  59         retval = {'run': mock.Mock()}
  60         args[0].return_value = retval
  61         self.assertEqual(self.runner.get_run_dict('test_name'), retval['run'])
  62         args[0].assert_called_once_with('test_name')
  63
  64     @mock.patch('xtesting.ci.run_tests.LOGGER.error')
  65     @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test',
  66                 return_value=None)
  67     def test_get_run_dict_config_ko(self, *args):
  68         testname = 'test_name'
  69         self.assertEqual(self.runner.get_run_dict(testname), None)
  70         args[0].return_value = {}
  71         self.assertEqual(self.runner.get_run_dict(testname), None)
  72         calls = [mock.call(testname), mock.call(testname)]
  73         args[0].assert_has_calls(calls)
  74         calls = [mock.call("Cannot get %s's config options", testname),
  75                  mock.call("Cannot get %s's config options", testname)]
  76         args[1].assert_has_calls(calls)
  77
  78     @mock.patch('xtesting.ci.run_tests.LOGGER.exception')
  79     @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test',
  80                 side_effect=Exception)
  81     def test_get_run_dict_exception(self, *args):
  82         testname = 'test_name'
  83         self.assertEqual(self.runner.get_run_dict(testname), None)
  84         args[1].assert_called_once_with(
  85             "Cannot get %s's config options", testname)
  86
  87     def _test_source_envfile(self, msg, key='OS_TENANT_NAME', value='admin'):
  88         try:
  89             del os.environ[key]
  90         except Exception:  # pylint: disable=broad-except
  91             pass
  92         envfile = 'rc_file'
  93         with mock.patch('six.moves.builtins.open',
  94                         mock.mock_open(read_data=msg)) as mock_method,\
  95                 mock.patch('os.path.isfile', return_value=True):
  96             mock_method.return_value.__iter__ = lambda self: iter(
  97                 self.readline, '')
  98             self.runner.source_envfile(envfile)
  99             mock_method.assert_called_once_with(envfile, 'r')
 100             self.assertEqual(os.environ[key], value)
 101
 102     def test_source_envfile(self):
 103         self._test_source_envfile('OS_TENANT_NAME=admin')
 104         self._test_source_envfile('OS_TENANT_NAME= admin')
 105         self._test_source_envfile('OS_TENANT_NAME = admin')
 106         self._test_source_envfile('OS_TENANT_NAME = "admin"')
 107         self._test_source_envfile('export OS_TENANT_NAME=admin')
 108         self._test_source_envfile('export OS_TENANT_NAME =admin')
 109         self._test_source_envfile('export OS_TENANT_NAME = admin')
 110         self._test_source_envfile('export OS_TENANT_NAME = "admin"')
 111         # This test will fail as soon as rc_file is fixed
 112         self._test_source_envfile(
 113             'export "\'OS_TENANT_NAME\'" = "\'admin\'"')
 114
 115     def test_get_dict_by_test(self):
 116         with mock.patch('six.moves.builtins.open', mock.mock_open()), \
 117                 mock.patch('yaml.safe_load') as mock_yaml:
 118             mock_obj = mock.Mock()
 119             testcase_dict = {'case_name': 'testname',
 120                              'criteria': 50}
 121             attrs = {'get.return_value': [{'testcases': [testcase_dict]}]}
 122             mock_obj.configure_mock(**attrs)
 123             mock_yaml.return_value = mock_obj
 124             self.assertDictEqual(
 125                 run_tests.Runner.get_dict_by_test('testname'),
 126                 testcase_dict)
 127
 128     @mock.patch('xtesting.ci.run_tests.Runner.get_run_dict',
 129                 return_value=None)
 130     def test_run_tests_import_exception(self, *args):
 131         mock_test = mock.Mock()
 132         kwargs = {'get_name.return_value': 'test_name',
 133                   'needs_clean.return_value': False}
 134         mock_test.configure_mock(**kwargs)
 135         with self.assertRaises(Exception) as context:
 136             self.runner.run_test(mock_test)
 137         args[0].assert_called_with('test_name')
 138         msg = "Cannot import the class for the test case."
 139         self.assertTrue(msg in str(context.exception))
 140
 141     @mock.patch('importlib.import_module', name="module",
 142                 return_value=mock.Mock(test_class=mock.Mock(
 143                     side_effect=FakeModule)))
 144     @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test')
 145     def test_run_tests_default(self, *args):
 146         mock_test = mock.Mock()
 147         kwargs = {'get_name.return_value': 'test_name',
 148                   'needs_clean.return_value': True}
 149         mock_test.configure_mock(**kwargs)
 150         test_run_dict = {'module': 'test_module',
 151                          'class': 'test_class'}
 152         with mock.patch('xtesting.ci.run_tests.Runner.get_run_dict',
 153                         return_value=test_run_dict):
 154             self.runner.clean_flag = True
 155             self.runner.run_test(mock_test)
 156
 157         args[0].assert_called_with('test_name')
 158         args[1].assert_called_with('test_module')
 159         self.assertEqual(self.runner.overall_result,
 160                          run_tests.Result.EX_OK)
 161
 162     @mock.patch('xtesting.ci.run_tests.Runner.run_test',
 163                 return_value=TestCase.EX_OK)
 164     def test_run_tier_default(self, *mock_methods):
 165         self.assertEqual(self.runner.run_tier(self.tier),
 166                          run_tests.Result.EX_OK)
 167         mock_methods[0].assert_called_with(mock.ANY)
 168
 169     @mock.patch('xtesting.ci.run_tests.LOGGER.info')
 170     def test_run_tier_missing_test(self, mock_logger_info):
 171         self.tier.get_tests.return_value = None
 172         self.assertEqual(self.runner.run_tier(self.tier),
 173                          run_tests.Result.EX_ERROR)
 174         self.assertTrue(mock_logger_info.called)
 175
 176     @mock.patch('xtesting.ci.run_tests.LOGGER.info')
 177     @mock.patch('xtesting.ci.run_tests.Runner.run_tier')
 178     @mock.patch('xtesting.ci.run_tests.Runner.summary')
 179     def test_run_all_default(self, *mock_methods):
 180         os.environ['CI_LOOP'] = 'test_ci_loop'
 181         self.runner.run_all()
 182         self.assertTrue(mock_methods[2].called)
 183
 184     @mock.patch('xtesting.ci.run_tests.Runner.source_envfile',
 185                 side_effect=Exception)
 186     @mock.patch('xtesting.ci.run_tests.Runner.summary')
 187     def test_main_failed(self, *mock_methods):
 188         kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
 189         args = {'get_tier.return_value': False,
 190                 'get_test.return_value': False}
 191         self.runner.tiers = mock.Mock()
 192         self.runner.tiers.configure_mock(**args)
 193         self.assertEqual(self.runner.main(**kwargs),
 194                          run_tests.Result.EX_ERROR)
 195         mock_methods[1].assert_called_once_with()
 196
 197     @mock.patch('xtesting.ci.run_tests.Runner.source_envfile')
 198     @mock.patch('xtesting.ci.run_tests.Runner.run_test',
 199                 return_value=TestCase.EX_OK)
 200     @mock.patch('xtesting.ci.run_tests.Runner.summary')
 201     def test_main_tier(self, *mock_methods):
 202         mock_tier = mock.Mock()
 203         test_mock = mock.Mock()
 204         test_mock.get_name.return_value = 'test1'
 205         args = {'get_name.return_value': 'tier_name',
 206                 'get_tests.return_value': [test_mock]}
 207         mock_tier.configure_mock(**args)
 208         kwargs = {'test': 'tier_name', 'noclean': True, 'report': True}
 209         args = {'get_tier.return_value': mock_tier,
 210                 'get_test.return_value': None}
 211         self.runner.tiers = mock.Mock()
 212         self.runner.tiers.configure_mock(**args)
 213         self.assertEqual(self.runner.main(**kwargs),
 214                          run_tests.Result.EX_OK)
 215         mock_methods[1].assert_called()
 216
 217     @mock.patch('xtesting.ci.run_tests.Runner.source_envfile')
 218     @mock.patch('xtesting.ci.run_tests.Runner.run_test',
 219                 return_value=TestCase.EX_OK)
 220     def test_main_test(self, *mock_methods):
 221         kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
 222         args = {'get_tier.return_value': None,
 223                 'get_test.return_value': 'test_name'}
 224         self.runner.tiers = mock.Mock()
 225         mock_methods[1].return_value = self.creds
 226         self.runner.tiers.configure_mock(**args)
 227         self.assertEqual(self.runner.main(**kwargs),
 228                          run_tests.Result.EX_OK)
 229         mock_methods[0].assert_called_once_with('test_name')
 230
 231     @mock.patch('xtesting.ci.run_tests.Runner.source_envfile')
 232     @mock.patch('xtesting.ci.run_tests.Runner.run_all')
 233     @mock.patch('xtesting.ci.run_tests.Runner.summary')
 234     def test_main_all_tier(self, *args):
 235         kwargs = {'get_tier.return_value': None,
 236                   'get_test.return_value': None}
 237         self.runner.tiers = mock.Mock()
 238         self.runner.tiers.configure_mock(**kwargs)
 239         self.assertEqual(
 240             self.runner.main(test='all', noclean=True, report=True),
 241             run_tests.Result.EX_OK)
 242         args[0].assert_called_once_with(None)
 243         args[1].assert_called_once_with()
 244         args[2].assert_called_once_with()
 245
 246     @mock.patch('xtesting.ci.run_tests.Runner.source_envfile')
 247     def test_main_any_tier_test_ko(self, *args):
 248         kwargs = {'get_tier.return_value': None,
 249                   'get_test.return_value': None}
 250         self.runner.tiers = mock.Mock()
 251         self.runner.tiers.configure_mock(**kwargs)
 252         self.assertEqual(
 253             self.runner.main(test='any', noclean=True, report=True),
 254             run_tests.Result.EX_ERROR)
 255         args[0].assert_called_once_with()
 256
 257
 258 if __name__ == "__main__":
 259     logging.disable(logging.CRITICAL)
 260     unittest.main(verbosity=2)