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