Merge "Improve the pylint score of functest-core"
[functest.git] / 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 import logging
9 import unittest
10
11 import mock
12
13 from functest.ci import run_tests
14 from functest.utils.constants import CONST
15 from functest.core.testcase import TestCase
16
17
18 class FakeModule(TestCase):
19
20     def run(self):
21         return TestCase.EX_OK
22
23     def push_to_db(self):
24         return TestCase.EX_OK
25
26     def is_successful(self):
27         return TestCase.EX_OK
28
29
30 class RunTestsTesting(unittest.TestCase):
31
32     def setUp(self):
33         self.runner = run_tests.Runner()
34         mock_test_case = mock.Mock()
35         mock_test_case.is_successful.return_value = TestCase.EX_OK
36         self.runner.executed_test_cases['test1'] = mock_test_case
37         self.runner.executed_test_cases['test2'] = mock_test_case
38         self.sep = 'test_sep'
39         self.creds = {'OS_AUTH_URL': 'http://test_ip:test_port/v2.0',
40                       'OS_USERNAME': 'test_os_username',
41                       'OS_TENANT_NAME': 'test_tenant',
42                       'OS_PASSWORD': 'test_password'}
43         self.test = {'test_name': 'test_name'}
44         self.tier = mock.Mock()
45         test1 = mock.Mock()
46         test1.get_name.return_value = 'test1'
47         test2 = mock.Mock()
48         test2.get_name.return_value = 'test2'
49         attrs = {'get_name.return_value': 'test_tier',
50                  'get_tests.return_value': [test1, test2],
51                  'get_ci_loop.return_value': 'test_ci_loop',
52                  'get_test_names.return_value': ['test1', 'test2']}
53         self.tier.configure_mock(**attrs)
54
55         self.tiers = mock.Mock()
56         attrs = {'get_tiers.return_value': [self.tier]}
57         self.tiers.configure_mock(**attrs)
58
59         self.run_tests_parser = run_tests.RunTestsParser()
60
61     @mock.patch('functest.ci.run_tests.LOGGER.error')
62     def test_source_rc_file_missing_file(self, mock_logger_error):
63         with mock.patch('functest.ci.run_tests.os.path.isfile',
64                         return_value=False), \
65                 self.assertRaises(Exception):
66             self.runner.source_rc_file()
67
68     @mock.patch('functest.ci.run_tests.LOGGER.debug')
69     @mock.patch('functest.ci.run_tests.os.path.isfile',
70                 return_value=True)
71     def test_source_rc_file_default(self, *args):
72         with mock.patch('functest.ci.run_tests.os_utils.source_credentials',
73                         return_value=self.creds):
74             self.runner.source_rc_file()
75
76     def test_get_run_dict_if_defined_default(self):
77         mock_obj = mock.Mock()
78         with mock.patch('functest.ci.run_tests.'
79                         'ft_utils.get_dict_by_test',
80                         return_value={'run': mock_obj}):
81             self.assertEqual(self.runner.get_run_dict('test_name'),
82                              mock_obj)
83
84     @mock.patch('functest.ci.run_tests.LOGGER.error')
85     def test_get_run_dict_if_defined_missing_config_option(self,
86                                                            mock_logger_error):
87         with mock.patch('functest.ci.run_tests.'
88                         'ft_utils.get_dict_by_test',
89                         return_value=None):
90             testname = 'test_name'
91             self.assertEqual(self.runner.get_run_dict(testname),
92                              None)
93             mock_logger_error.assert_called_once_with(
94                 "Cannot get %s's config options", testname)
95
96         with mock.patch('functest.ci.run_tests.'
97                         'ft_utils.get_dict_by_test',
98                         return_value={}):
99             testname = 'test_name'
100             self.assertEqual(self.runner.get_run_dict(testname),
101                              None)
102
103     @mock.patch('functest.ci.run_tests.LOGGER.exception')
104     def test_get_run_dict_if_defined_exception(self,
105                                                mock_logger_except):
106         with mock.patch('functest.ci.run_tests.'
107                         'ft_utils.get_dict_by_test',
108                         side_effect=Exception):
109             testname = 'test_name'
110             self.assertEqual(self.runner.get_run_dict(testname),
111                              None)
112             mock_logger_except.assert_called_once_with(
113                 "Cannot get %s's config options", testname)
114
115     def test_run_tests_import_test_class_exception(self):
116         mock_test = mock.Mock()
117         args = {'get_name.return_value': 'test_name',
118                 'needs_clean.return_value': False}
119         mock_test.configure_mock(**args)
120         with mock.patch('functest.ci.run_tests.Runner.source_rc_file'), \
121             mock.patch('functest.ci.run_tests.Runner.get_run_dict',
122                        return_value=None), \
123                 self.assertRaises(Exception) as context:
124             self.runner(mock_test, 'tier_name')
125             msg = "Cannot import the class for the test case."
126             self.assertTrue(msg in context)
127
128     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
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         self.assertEqual(self.runner.overall_result,
145                          run_tests.Result.EX_OK)
146
147     @mock.patch('functest.ci.run_tests.Runner.run_test',
148                 return_value=TestCase.EX_OK)
149     def test_run_tier_default(self, *mock_methods):
150         self.assertEqual(self.runner.run_tier(self.tier),
151                          run_tests.Result.EX_OK)
152         mock_methods[0].assert_called_with(mock.ANY)
153
154     @mock.patch('functest.ci.run_tests.LOGGER.info')
155     def test_run_tier_missing_test(self, mock_logger_info):
156         self.tier.get_tests.return_value = None
157         self.assertEqual(self.runner.run_tier(self.tier),
158                          run_tests.Result.EX_ERROR)
159         self.assertTrue(mock_logger_info.called)
160
161     @mock.patch('functest.ci.run_tests.LOGGER.info')
162     @mock.patch('functest.ci.run_tests.Runner.run_tier')
163     @mock.patch('functest.ci.run_tests.Runner.summary')
164     def test_run_all_default(self, *mock_methods):
165         CONST.__setattr__('CI_LOOP', 'test_ci_loop')
166         self.runner.run_all()
167         mock_methods[1].assert_not_called()
168         self.assertTrue(mock_methods[2].called)
169
170     @mock.patch('functest.ci.run_tests.LOGGER.info')
171     @mock.patch('functest.ci.run_tests.Runner.summary')
172     def test_run_all_missing_tier(self, *mock_methods):
173         CONST.__setattr__('CI_LOOP', 'loop_re_not_available')
174         self.runner.run_all()
175         self.assertTrue(mock_methods[1].called)
176
177     @mock.patch('functest.ci.run_tests.Runner.source_rc_file',
178                 side_effect=Exception)
179     @mock.patch('functest.ci.run_tests.Runner.summary')
180     def test_main_failed(self, *mock_methods):
181         kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
182         args = {'get_tier.return_value': False,
183                 'get_test.return_value': False}
184         self.runner._tiers = mock.Mock()
185         self.runner._tiers.configure_mock(**args)
186         self.assertEqual(self.runner.main(**kwargs),
187                          run_tests.Result.EX_ERROR)
188         mock_methods[1].assert_called_once_with()
189
190     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
191     @mock.patch('functest.ci.run_tests.Runner.run_test',
192                 return_value=TestCase.EX_OK)
193     @mock.patch('functest.ci.run_tests.Runner.summary')
194     def test_main_tier(self, *mock_methods):
195         mock_tier = mock.Mock()
196         test_mock = mock.Mock()
197         test_mock.get_name.return_value = 'test1'
198         args = {'get_name.return_value': 'tier_name',
199                 'get_tests.return_value': [test_mock]}
200         mock_tier.configure_mock(**args)
201         kwargs = {'test': 'tier_name', 'noclean': True, 'report': True}
202         args = {'get_tier.return_value': mock_tier,
203                 'get_test.return_value': None}
204         self.runner._tiers = mock.Mock()
205         self.runner._tiers.configure_mock(**args)
206         self.assertEqual(self.runner.main(**kwargs),
207                          run_tests.Result.EX_OK)
208         mock_methods[1].assert_called()
209
210     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
211     @mock.patch('functest.ci.run_tests.Runner.run_test',
212                 return_value=TestCase.EX_OK)
213     def test_main_test(self, *mock_methods):
214         kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
215         args = {'get_tier.return_value': None,
216                 'get_test.return_value': 'test_name'}
217         self.runner._tiers = mock.Mock()
218         self.runner._tiers.configure_mock(**args)
219         self.assertEqual(self.runner.main(**kwargs),
220                          run_tests.Result.EX_OK)
221         mock_methods[0].assert_called_once_with('test_name')
222
223     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
224     @mock.patch('functest.ci.run_tests.Runner.run_all')
225     @mock.patch('functest.ci.run_tests.Runner.summary')
226     def test_main_all_tier(self, *mock_methods):
227         kwargs = {'test': 'all', 'noclean': True, 'report': True}
228         args = {'get_tier.return_value': None,
229                 'get_test.return_value': None}
230         self.runner._tiers = mock.Mock()
231         self.runner._tiers.configure_mock(**args)
232         self.assertEqual(self.runner.main(**kwargs),
233                          run_tests.Result.EX_OK)
234         mock_methods[1].assert_called_once_with()
235
236     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
237     @mock.patch('functest.ci.run_tests.Runner.summary')
238     def test_main_any_tier_test_ko(self, *mock_methods):
239         kwargs = {'test': 'any', 'noclean': True, 'report': True}
240         args = {'get_tier.return_value': None,
241                 'get_test.return_value': None}
242         self.runner._tiers = mock.Mock()
243         self.runner._tiers.configure_mock(**args)
244         self.assertEqual(self.runner.main(**kwargs),
245                          run_tests.Result.EX_ERROR)
246
247
248 if __name__ == "__main__":
249     logging.disable(logging.CRITICAL)
250     unittest.main(verbosity=2)