Return Functest status to Jenkins
[functest-xtesting.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("Cannot get {}'s config "
94                                                       "options"
95                                                       .format(testname))
96
97         with mock.patch('functest.ci.run_tests.'
98                         'ft_utils.get_dict_by_test',
99                         return_value={}):
100             testname = 'test_name'
101             self.assertEqual(self.runner.get_run_dict(testname),
102                              None)
103
104     @mock.patch('functest.ci.run_tests.logger.exception')
105     def test_get_run_dict_if_defined_exception(self,
106                                                mock_logger_except):
107         with mock.patch('functest.ci.run_tests.'
108                         'ft_utils.get_dict_by_test',
109                         side_effect=Exception):
110             testname = 'test_name'
111             self.assertEqual(self.runner.get_run_dict(testname),
112                              None)
113             mock_logger_except.assert_called_once_with("Cannot get {}'s config"
114                                                        " options"
115                                                        .format(testname))
116
117     def test_run_tests_import_test_class_exception(self):
118         mock_test = mock.Mock()
119         args = {'get_name.return_value': 'test_name',
120                 'needs_clean.return_value': False}
121         mock_test.configure_mock(**args)
122         with mock.patch('functest.ci.run_tests.Runner.source_rc_file'), \
123             mock.patch('functest.ci.run_tests.Runner.get_run_dict',
124                        return_value=None), \
125                 self.assertRaises(Exception) as context:
126             self.runner(mock_test, 'tier_name')
127             msg = "Cannot import the class for the test case."
128             self.assertTrue(msg in context)
129
130     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
131     @mock.patch('importlib.import_module', name="module",
132                 return_value=mock.Mock(test_class=mock.Mock(
133                     side_effect=FakeModule)))
134     @mock.patch('functest.utils.functest_utils.get_dict_by_test')
135     def test_run_tests_default(self, *args):
136         mock_test = mock.Mock()
137         kwargs = {'get_name.return_value': 'test_name',
138                   'needs_clean.return_value': True}
139         mock_test.configure_mock(**kwargs)
140         test_run_dict = {'module': 'test_module',
141                          'class': 'test_class'}
142         with mock.patch('functest.ci.run_tests.Runner.get_run_dict',
143                         return_value=test_run_dict):
144             self.runner.clean_flag = True
145             self.runner.run_test(mock_test)
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_rc_file',
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
192     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
193     @mock.patch('functest.ci.run_tests.Runner.run_test',
194                 return_value=TestCase.EX_OK)
195     @mock.patch('functest.ci.run_tests.Runner.summary')
196     def test_main_tier(self, *mock_methods):
197         mock_tier = mock.Mock()
198         test_mock = mock.Mock()
199         test_mock.get_name.return_value = 'test1'
200         args = {'get_name.return_value': 'tier_name',
201                 'get_tests.return_value': [test_mock]}
202         mock_tier.configure_mock(**args)
203         kwargs = {'test': 'tier_name', 'noclean': True, 'report': True}
204         args = {'get_tier.return_value': mock_tier,
205                 'get_test.return_value': None}
206         self.runner._tiers = mock.Mock()
207         self.runner._tiers.configure_mock(**args)
208         self.assertEqual(self.runner.main(**kwargs),
209                          run_tests.Result.EX_OK)
210         mock_methods[1].assert_called()
211
212     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
213     @mock.patch('functest.ci.run_tests.Runner.run_test',
214                 return_value=TestCase.EX_OK)
215     def test_main_test(self, *mock_methods):
216         kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
217         args = {'get_tier.return_value': None,
218                 'get_test.return_value': 'test_name'}
219         self.runner._tiers = mock.Mock()
220         self.runner._tiers.configure_mock(**args)
221         self.assertEqual(self.runner.main(**kwargs),
222                          run_tests.Result.EX_OK)
223         mock_methods[0].assert_called_once_with('test_name')
224
225     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
226     @mock.patch('functest.ci.run_tests.Runner.run_all')
227     @mock.patch('functest.ci.run_tests.Runner.summary')
228     def test_main_all_tier(self, *mock_methods):
229         kwargs = {'test': 'all', 'noclean': True, 'report': True}
230         args = {'get_tier.return_value': None,
231                 'get_test.return_value': None}
232         self.runner._tiers = mock.Mock()
233         self.runner._tiers.configure_mock(**args)
234         self.assertEqual(self.runner.main(**kwargs),
235                          run_tests.Result.EX_OK)
236         mock_methods[1].assert_called_once_with()
237
238     @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
239     @mock.patch('functest.ci.run_tests.Runner.summary')
240     def test_main_any_tier_test_ko(self, *mock_methods):
241         kwargs = {'test': 'any', 'noclean': True, 'report': True}
242         args = {'get_tier.return_value': None,
243                 'get_test.return_value': None}
244         self.runner._tiers = mock.Mock()
245         self.runner._tiers.configure_mock(**args)
246         self.assertEqual(self.runner.main(**kwargs),
247                          run_tests.Result.EX_ERROR)
248
249
250 if __name__ == "__main__":
251     logging.disable(logging.CRITICAL)
252     unittest.main(verbosity=2)