aboutsummaryrefslogtreecommitdiffstats
path: root/functest/tests/unit/ci/test_run_tests.py
blob: fc689452da7adfad34533041afeb78aa0c95b8a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
#!/usr/bin/env python

# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0

import logging
import unittest
import os

import mock

from functest.ci import run_tests
from functest.utils.constants import CONST
from functest.core.testcase import TestCase


class FakeModule(TestCase):

    def run(self):
        return TestCase.EX_OK

    def push_to_db(self):
        return TestCase.EX_OK

    def is_successful(self):
        return TestCase.EX_OK


class RunTestsTesting(unittest.TestCase):

    def setUp(self):
        self.runner = run_tests.Runner()
        mock_test_case = mock.Mock()
        mock_test_case.is_successful.return_value = TestCase.EX_OK
        self.runner.executed_test_cases['test1'] = mock_test_case
        self.runner.executed_test_cases['test2'] = mock_test_case
        self.sep = 'test_sep'
        self.creds = {'OS_AUTH_URL': 'http://test_ip:test_port/v2.0',
                      'OS_USERNAME': 'test_os_username',
                      'OS_TENANT_NAME': 'test_tenant',
                      'OS_PASSWORD': 'test_password'}
        self.test = {'test_name': 'test_name'}
        self.tier = mock.Mock()
        test1 = mock.Mock()
        test1.get_name.return_value = 'test1'
        test2 = mock.Mock()
        test2.get_name.return_value = 'test2'
        attrs = {'get_name.return_value': 'test_tier',
                 'get_tests.return_value': [test1, test2],
                 'get_ci_loop.return_value': 'test_ci_loop',
                 'get_test_names.return_value': ['test1', 'test2']}
        self.tier.configure_mock(**attrs)

        self.tiers = mock.Mock()
        attrs = {'get_tiers.return_value': [self.tier]}
        self.tiers.configure_mock(**attrs)

        self.run_tests_parser = run_tests.RunTestsParser()

        self.config_file_yaml = {'general': {
                                     'openstack': {
                                         'image_name': 'test_image_name'}},
                                 'results': {
                                     'test_db_url': 'url1'}}
        self.config_file_patch_yaml = {'fdio': {'general': {
                                       'openstack': {
                                           'image_name':
                                           'test_image_name_2'}}}}
        self.config_file_aarcg64_patch_yaml = {'os': {'general': {
                    'openstack': {'image_name': 'test_image_name_3'}}}}

    @mock.patch('functest.ci.run_tests.Runner.patch_file')
    @mock.patch('functest.ci.run_tests.Runner.update_db_url')
    def test_update_config_file_default(self, *mock_methods):
        self.runner.update_config_file()
        mock_methods[1].assert_called()
        mock_methods[0].assert_not_called()

    @mock.patch('functest.ci.run_tests.Runner.patch_file')
    @mock.patch('functest.ci.run_tests.Runner.update_db_url')
    @mock.patch.dict(os.environ, {'TEST_DB_URL': 'somevalue'})
    def test_update_config_file_update_db(self, *mock_methods):
        self.runner.update_config_file()
        mock_methods[1].assert_called()
        mock_methods[0].assert_called()

    def test_patch_file_missing_file(self):
        patch_file_path = "unexisting_file"
        with self.assertRaises(IOError):
            self.runner.patch_file(patch_file_path)

    @mock.patch('functest.ci.run_tests.ft_utils.merge_dicts')
    @mock.patch('functest.ci.run_tests.ft_utils.get_functest_yaml')
    def test_patch_file_default(self, *mock_methods):
        CONST.__setattr__('DEPLOY_SCENARIO', 'os-nosdn-nofeature-noha')
        with mock.patch(
               'six.moves.builtins.open', mock.mock_open()), mock.patch(
               'functest.ci.run_tests.yaml.safe_load') as yaml1, mock.patch(
               'functest.ci.run_tests.ft_utils.get_functest_yaml') as yaml2:
            yaml1.return_value = self.config_file_patch_yaml
            yaml2.return_value = self.config_file_yaml
            self.runner.patch_file(yaml1)
            mock_methods[1].assert_not_called()
            mock_methods[0].assert_not_called()

    @mock.patch('functest.ci.run_tests.ft_utils.merge_dicts')
    @mock.patch('functest.ci.run_tests.os.remove')
    def test_patch_file_match_scenario(self, *mock_methods):
        CONST.__setattr__('DEPLOY_SCENARIO', 'os-nosdn-fdio-noha')
        with mock.patch(
               'six.moves.builtins.open', mock.mock_open()), mock.patch(
               'functest.ci.run_tests.yaml.safe_load') as yaml1, mock.patch(
               'functest.ci.run_tests.ft_utils.get_functest_yaml') as yaml2:
            yaml1.return_value = self.config_file_patch_yaml
            yaml2.return_value = self.config_file_yaml
            self.runner.patch_file(yaml2)
            mock_methods[1].assert_called()
            mock_methods[0].assert_called()

    def test_update_db_url_missing_file(self):
        run_tests.CONFIG_FUNCTEST_PATH = "unexisting_file"
        with self.assertRaises(IOError):
            self.runner.update_db_url()

    @mock.patch('functest.ci.run_tests.yaml.safe_load')
    @mock.patch('functest.ci.run_tests.ft_utils.get_functest_yaml')
    @mock.patch.dict(os.environ, {'TEST_DB_URL': 'url2'})
    def test_update_db_url_default(self, *mock_methods):
        with mock.patch(
               'six.moves.builtins.open', mock.mock_open()), mock.patch(
               'functest.ci.run_tests.yaml.safe_load') as yaml1:
            yaml1.return_value = self.config_file_yaml
            self.runner.update_db_url()
            self.assertEqual(
                yaml1.return_value['results']['test_db_url'], 'url2')
            mock_methods[0].assert_not_called()
            mock_methods[1].assert_not_called()

    @mock.patch('functest.ci.run_tests.logger.error')
    def test_source_rc_file_missing_file(self, mock_logger_error):
        with mock.patch('functest.ci.run_tests.os.path.isfile',
                        return_value=False), \
                self.assertRaises(Exception):
            self.runner.source_rc_file()

    @mock.patch('functest.ci.run_tests.logger.debug')
    @mock.patch('functest.ci.run_tests.os.path.isfile',
                return_value=True)
    def test_source_rc_file_default(self, *args):
        with mock.patch('functest.ci.run_tests.os_utils.source_credentials',
                        return_value=self.creds):
            self.runner.source_rc_file()

    def test_get_run_dict_if_defined_default(self):
        mock_obj = mock.Mock()
        with mock.patch('functest.ci.run_tests.'
                        'ft_utils.get_dict_by_test',
                        return_value={'run': mock_obj}):
            self.assertEqual(self.runner.get_run_dict('test_name'),
                             mock_obj)

    @mock.patch('functest.ci.run_tests.logger.error')
    def test_get_run_dict_if_defined_missing_config_option(self,
                                                           mock_logger_error):
        with mock.patch('functest.ci.run_tests.'
                        'ft_utils.get_dict_by_test',
                        return_value=None):
            testname = 'test_name'
            self.assertEqual(self.runner.get_run_dict(testname),
                             None)
            mock_logger_error.assert_called_once_with("Cannot get {}'s config "
                                                      "options"
                                                      .format(testname))

        with mock.patch('functest.ci.run_tests.'
                        'ft_utils.get_dict_by_test',
                        return_value={}):
            testname = 'test_name'
            self.assertEqual(self.runner.get_run_dict(testname),
                             None)

    @mock.patch('functest.ci.run_tests.logger.exception')
    def test_get_run_dict_if_defined_exception(self,
                                               mock_logger_except):
        with mock.patch('functest.ci.run_tests.'
                        'ft_utils.get_dict_by_test',
                        side_effect=Exception):
            testname = 'test_name'
            self.assertEqual(self.runner.get_run_dict(testname),
                             None)
            mock_logger_except.assert_called_once_with("Cannot get {}'s config"
                                                       " options"
                                                       .format(testname))

    def test_run_tests_import_test_class_exception(self):
        mock_test = mock.Mock()
        args = {'get_name.return_value': 'test_name',
                'needs_clean.return_value': False}
        mock_test.configure_mock(**args)
        with mock.patch('functest.ci.run_tests.Runner.source_rc_file'), \
            mock.patch('functest.ci.run_tests.Runner.get_run_dict',
                       return_value=None), \
                self.assertRaises(Exception) as context:
            self.runner(mock_test, 'tier_name')
            msg = "Cannot import the class for the test case."
            self.assertTrue(msg in context)

    @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
    @mock.patch('importlib.import_module', name="module",
                return_value=mock.Mock(test_class=mock.Mock(
                    side_effect=FakeModule)))
    @mock.patch('functest.utils.functest_utils.get_dict_by_test')
    def test_run_tests_default(self, *args):
        mock_test = mock.Mock()
        kwargs = {'get_name.return_value': 'test_name',
                  'needs_clean.return_value': True}
        mock_test.configure_mock(**kwargs)
        test_run_dict = {'module': 'test_module',
                         'class': 'test_class'}
        with mock.patch('functest.ci.run_tests.Runner.get_run_dict',
                        return_value=test_run_dict):
            self.runner.clean_flag = True
            self.runner.run_test(mock_test)
        self.assertEqual(self.runner.overall_result,
                         run_tests.Result.EX_OK)

    @mock.patch('functest.ci.run_tests.Runner.run_test',
                return_value=TestCase.EX_OK)
    def test_run_tier_default(self, *mock_methods):
        self.assertEqual(self.runner.run_tier(self.tier),
                         run_tests.Result.EX_OK)
        mock_methods[0].assert_called_with(mock.ANY)

    @mock.patch('functest.ci.run_tests.logger.info')
    def test_run_tier_missing_test(self, mock_logger_info):
        self.tier.get_tests.return_value = None
        self.assertEqual(self.runner.run_tier(self.tier),
                         run_tests.Result.EX_ERROR)
        self.assertTrue(mock_logger_info.called)

    @mock.patch('functest.ci.run_tests.logger.info')
    @mock.patch('functest.ci.run_tests.Runner.run_tier')
    @mock.patch('functest.ci.run_tests.Runner.summary')
    def test_run_all_default(self, *mock_methods):
        CONST.__setattr__('CI_LOOP', 'test_ci_loop')
        self.runner.run_all()
        mock_methods[1].assert_not_called()
        self.assertTrue(mock_methods[2].called)

    @mock.patch('functest.ci.run_tests.logger.info')
    @mock.patch('functest.ci.run_tests.Runner.summary')
    def test_run_all_missing_tier(self, *mock_methods):
        CONST.__setattr__('CI_LOOP', 'loop_re_not_available')
        self.runner.run_all()
        self.assertTrue(mock_methods[1].called)

    @mock.patch('functest.ci.run_tests.Runner.source_rc_file',
                side_effect=Exception)
    @mock.patch('functest.ci.run_tests.Runner.summary')
    def test_main_failed(self, *mock_methods):
        kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
        args = {'get_tier.return_value': False,
                'get_test.return_value': False}
        self.runner._tiers = mock.Mock()
        self.runner._tiers.configure_mock(**args)
        self.assertEqual(self.runner.main(**kwargs),
                         run_tests.Result.EX_ERROR)
        mock_methods[1].assert_called_once_with()

    @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
    @mock.patch('functest.ci.run_tests.Runner.run_test',
                return_value=TestCase.EX_OK)
    @mock.patch('functest.ci.run_tests.Runner.summary')
    def test_main_tier(self, *mock_methods):
        mock_tier = mock.Mock()
        test_mock = mock.Mock()
        test_mock.get_name.return_value = 'test1'
        args = {'get_name.return_value': 'tier_name',
                'get_tests.return_value': [test_mock]}
        mock_tier.configure_mock(**args)
        kwargs = {'test': 'tier_name', 'noclean': True, 'report': True}
        args = {'get_tier.return_value': mock_tier,
                'get_test.return_value': None}
        self.runner._tiers = mock.Mock()
        self.runner._tiers.configure_mock(**args)
        self.assertEqual(self.runner.main(**kwargs),
                         run_tests.Result.EX_OK)
        mock_methods[1].assert_called()

    @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
    @mock.patch('functest.ci.run_tests.Runner.run_test',
                return_value=TestCase.EX_OK)
    def test_main_test(self, *mock_methods):
        kwargs = {'test': 'test_name', 'noclean': True, 'report': True}
        args = {'get_tier.return_value': None,
                'get_test.return_value': 'test_name'}
        self.runner._tiers = mock.Mock()
        self.runner._tiers.configure_mock(**args)
        self.assertEqual(self.runner.main(**kwargs),
                         run_tests.Result.EX_OK)
        mock_methods[0].assert_called_once_with('test_name')

    @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
    @mock.patch('functest.ci.run_tests.Runner.run_all')
    @mock.patch('functest.ci.run_tests.Runner.summary')
    def test_main_all_tier(self, *mock_methods):
        kwargs = {'test': 'all', 'noclean': True, 'report': True}
        args = {'get_tier.return_value': None,
                'get_test.return_value': None}
        self.runner._tiers = mock.Mock()
        self.runner._tiers.configure_mock(**args)
        self.assertEqual(self.runner.main(**kwargs),
                         run_tests.Result.EX_OK)
        mock_methods[1].assert_called_once_with()

    @mock.patch('functest.ci.run_tests.Runner.source_rc_file')
    @mock.patch('functest.ci.run_tests.Runner.summary')
    def test_main_any_tier_test_ko(self, *mock_methods):
        kwargs = {'test': 'any', 'noclean': True, 'report': True}
        args = {'get_tier.return_value': None,
                'get_test.return_value': None}
        self.runner._tiers = mock.Mock()
        self.runner._tiers.configure_mock(**args)
        self.assertEqual(self.runner.main(**kwargs),
                         run_tests.Result.EX_ERROR)


if __name__ == "__main__":
    logging.disable(logging.CRITICAL)
    unittest.main(verbosity=2)