aboutsummaryrefslogtreecommitdiffstats
path: root/xtesting/tests/unit/ci/test_run_tests.py
blob: 423bf486a8e2bde8371898eab2c4f748ab9d26bb (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
#!/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

# pylint: disable=missing-docstring

import logging
import unittest
import os

import mock

from xtesting.ci import run_tests
from xtesting.core.testcase import TestCase


class FakeModule(TestCase):

    def run(self, **kwargs):
        self.start_time = 0
        self.stop_time = 1
        self.criteria = 100
        self.result = 100
        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()

    @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test')
    def test_get_run_dict(self, *args):
        retval = {'run': mock.Mock()}
        args[0].return_value = retval
        self.assertEqual(self.runner.get_run_dict('test_name'), retval['run'])
        args[0].assert_called_once_with('test_name')

    @mock.patch('xtesting.ci.run_tests.LOGGER.error')
    @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test',
                return_value=None)
    def test_get_run_dict_config_ko(self, *args):
        testname = 'test_name'
        self.assertEqual(self.runner.get_run_dict(testname), None)
        args[0].return_value = {}
        self.assertEqual(self.runner.get_run_dict(testname), None)
        calls = [mock.call(testname), mock.call(testname)]
        args[0].assert_has_calls(calls)
        calls = [mock.call("Cannot get %s's config options", testname),
                 mock.call("Cannot get %s's config options", testname)]
        args[1].assert_has_calls(calls)

    @mock.patch('xtesting.ci.run_tests.LOGGER.exception')
    @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test',
                side_effect=Exception)
    def test_get_run_dict_exception(self, *args):
        testname = 'test_name'
        self.assertEqual(self.runner.get_run_dict(testname), None)
        args[1].assert_called_once_with(
            "Cannot get %s's config options", testname)

    def _test_source_envfile(self, msg, key='OS_TENANT_NAME', value='admin'):
        try:
            del os.environ[key]
        except Exception:  # pylint: disable=broad-except
            pass
        envfile = 'rc_file'
        with mock.patch('six.moves.builtins.open',
                        mock.mock_open(read_data=msg)) as mock_method,\
                mock.patch('os.path.isfile', return_value=True):
            mock_method.return_value.__iter__ = lambda self: iter(
                self.readline, '')
            self.runner.source_envfile(envfile)
            mock_method.assert_called_once_with(envfile, 'r')
            self.assertEqual(os.environ[key], value)

    def test_source_envfile(self):
        self._test_source_envfile('OS_TENANT_NAME=admin')
        self._test_source_envfile('OS_TENANT_NAME= admin')
        self._test_source_envfile('OS_TENANT_NAME = admin')
        self._test_source_envfile('OS_TENANT_NAME = "admin"')
        self._test_source_envfile('export OS_TENANT_NAME=admin')
        self._test_source_envfile('export OS_TENANT_NAME =admin')
        self._test_source_envfile('export OS_TENANT_NAME = admin')
        self._test_source_envfile('export OS_TENANT_NAME = "admin"')
        # This test will fail as soon as rc_file is fixed
        self._test_source_envfile(
            'export "\'OS_TENANT_NAME\'" = "\'admin\'"')

    def test_get_dict_by_test(self):
        with mock.patch('six.moves.builtins.open', mock.mock_open()), \
                mock.patch('yaml.safe_load') as mock_yaml:
            mock_obj = mock.Mock()
            testcase_dict = {'case_name': 'testname',
                             'criteria': 50}
            attrs = {'get.return_value': [{'testcases': [testcase_dict]}]}
            mock_obj.configure_mock(**attrs)
            mock_yaml.return_value = mock_obj
            self.assertDictEqual(
                run_tests.Runner.get_dict_by_test('testname'),
                testcase_dict)

    @mock.patch('xtesting.ci.run_tests.Runner.get_run_dict',
                return_value=None)
    def test_run_tests_import_exception(self, *args):
        mock_test = mock.Mock()
        kwargs = {'get_name.return_value': 'test_name',
                  'is_skipped.return_value': False,
                  'is_enabled.return_value': True,
                  'needs_clean.return_value': False}
        mock_test.configure_mock(**kwargs)
        with self.assertRaises(Exception) as context:
            self.runner.run_test(mock_test)
        args[0].assert_called_with('test_name')
        msg = "Cannot import the class for the test case."
        self.assertTrue(msg in str(context.exception))

    @mock.patch('stevedore.driver.DriverManager',
                return_value=mock.Mock(driver=FakeModule()))
    @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test')
    def test_run_tests_default(self, *args):
        mock_test = mock.Mock()
        kwargs = {'get_name.return_value': 'test_name',
                  'is_skipped.return_value': False,
                  'is_enabled.return_value': True,
                  'needs_clean.return_value': True}
        mock_test.configure_mock(**kwargs)
        test_run_dict = {'name': 'test_module'}
        with mock.patch('xtesting.ci.run_tests.Runner.get_run_dict',
                        return_value=test_run_dict):
            self.runner.clean_flag = True
            self.assertEqual(self.runner.run_test(mock_test), TestCase.EX_OK)
        args[0].assert_called_with('test_name')
        args[1].assert_called_with(
            invoke_kwds=mock.ANY, invoke_on_load=True, name='test_module',
            namespace='xtesting.testcase')
        self.assertEqual(self.runner.overall_result,
                         run_tests.Result.EX_OK)

    @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test')
    def test_run_tests_disabled(self, *args):
        mock_test = mock.Mock()
        kwargs = {'get_name.return_value': 'test_name',
                  'is_skipped.return_value': False,
                  'is_enabled.return_value': False,
                  'needs_clean.return_value': True}
        mock_test.configure_mock(**kwargs)
        test_run_dict = {'name': 'test_name'}
        with mock.patch('xtesting.ci.run_tests.Runner.get_run_dict',
                        return_value=test_run_dict):
            self.runner.clean_flag = True
            self.runner.run_test(mock_test)
        args[0].assert_not_called()
        self.assertEqual(self.runner.overall_result,
                         run_tests.Result.EX_OK)

    @mock.patch('xtesting.ci.run_tests.Runner.get_dict_by_test')
    def test_run_tests_skipped(self, *args):
        mock_test = mock.Mock()
        kwargs = {'get_name.return_value': 'test_name',
                  'is_skipped.return_value': True,
                  'is_enabled.return_value': True,
                  'needs_clean.return_value': True}
        mock_test.configure_mock(**kwargs)
        test_run_dict = {'module': 'test_module',
                         'class': 'test_class'}
        with mock.patch('xtesting.ci.run_tests.Runner.get_run_dict',
                        return_value=test_run_dict):
            self.runner.clean_flag = True
            self.runner.run_test(mock_test)
        args[0].assert_not_called()
        self.assertEqual(self.runner.overall_result,
                         run_tests.Result.EX_OK)

    @mock.patch('xtesting.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('xtesting.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('xtesting.ci.run_tests.LOGGER.info')
    @mock.patch('xtesting.ci.run_tests.Runner.run_tier')
    @mock.patch('xtesting.ci.run_tests.Runner.summary')
    def test_run_all_default(self, *mock_methods):
        os.environ['CI_LOOP'] = 'test_ci_loop'
        self.runner.run_all()
        self.assertTrue(mock_methods[2].called)

    @mock.patch('xtesting.ci.run_tests.Runner.source_envfile',
                side_effect=Exception)
    @mock.patch('xtesting.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('xtesting.ci.run_tests.Runner.source_envfile')
    @mock.patch('xtesting.ci.run_tests.Runner.run_test',
                return_value=TestCase.EX_OK)
    @mock.patch('xtesting.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('xtesting.ci.run_tests.Runner.source_envfile')
    @mock.patch('xtesting.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()
        mock_methods[1].return_value = self.creds
        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('xtesting.ci.run_tests.Runner.source_envfile')
    @mock.patch('xtesting.ci.run_tests.Runner.run_all')
    @mock.patch('xtesting.ci.run_tests.Runner.summary')
    def test_main_all_tier(self, *args):
        kwargs = {'get_tier.return_value': None,
                  'get_test.return_value': None}
        self.runner.tiers = mock.Mock()
        self.runner.tiers.configure_mock(**kwargs)
        self.assertEqual(
            self.runner.main(test='all', noclean=True, report=True),
            run_tests.Result.EX_OK)
        args[0].assert_called_once_with(None)
        args[1].assert_called_once_with()
        args[2].assert_called_once_with()

    @mock.patch('xtesting.ci.run_tests.Runner.source_envfile')
    def test_main_any_tier_test_ko(self, *args):
        kwargs = {'get_tier.return_value': None,
                  'get_test.return_value': None}
        self.runner.tiers = mock.Mock()
        self.runner.tiers.configure_mock(**kwargs)
        self.assertEqual(
            self.runner.main(test='any', noclean=True, report=True),
            run_tests.Result.EX_ERROR)
        args[0].assert_called_once_with()


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