File: test_config_file.py

package info (click to toggle)
python-stestr 4.1.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 852 kB
  • sloc: python: 6,303; makefile: 32; sh: 12
file content (202 lines) | stat: -rw-r--r-- 7,856 bytes parent folder | download
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
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import os
import random
from unittest import mock

import ddt
import fixtures

from stestr import config_file
from stestr.tests import base


@ddt.ddt
class TestTestrConf(base.TestCase):
    @mock.patch.object(config_file.configparser, "ConfigParser")
    def setUp(self, mock_ConfigParser):
        super().setUp()
        self._testr_conf = config_file.TestrConf(mock.sentinel.config_file)

    @mock.patch.object(config_file.util, "get_repo_open")
    @mock.patch.object(config_file.test_processor, "TestProcessorFixture")
    @mock.patch.object(config_file, "sys")
    @mock.patch("os.path.exists", new=lambda x: True)
    def _check_get_run_command(
        self,
        mock_sys,
        mock_TestProcessorFixture,
        mock_get_repo_open,
        platform="win32",
        group_regex=".*",
        parallel_class=False,
        sys_executable="/usr/bin/python",
        expected_python="/usr/bin/python",
        expected_group_callback=mock.ANY,
        environment=None,
    ):
        mock_sys.platform = platform
        mock_sys.executable = sys_executable
        if environment is None:
            environment = {"PYTHON": ""}

        with mock.patch.dict("os.environ", environment):
            fixture = self._testr_conf.get_run_command(
                test_path="fake_test_path",
                top_dir="fake_top_dir",
                group_regex=group_regex,
                parallel_class=parallel_class,
            )

        self.assertEqual(mock_TestProcessorFixture.return_value, fixture)
        mock_get_repo_open.assert_called_once_with(repo_url=None)
        command = (
            '"%s" -m stestr.subunit_runner.run discover -t "%s" "%s" '
            "$LISTOPT $IDOPTION" % (expected_python, "fake_top_dir", "fake_test_path")
        )
        # Ensure TestProcessorFixture is created with defaults except for where
        # we specfied and with the correct python.
        mock_TestProcessorFixture.assert_called_once_with(
            None,
            command,
            "--list",
            "--load-list $IDFILE",
            mock_get_repo_open.return_value,
            exclude_regex=None,
            exclude_list=None,
            concurrency=0,
            group_callback=expected_group_callback,
            test_filters=None,
            randomize=False,
            serial=False,
            include_list=None,
            worker_path=None,
        )

    @mock.patch.object(config_file, "sys")
    def _check_get_run_command_exception(
        self,
        mock_sys,
        platform="win32",
        sys_executable="/usr/bin/python",
        environment=None,
    ):
        mock_sys.platform = platform
        mock_sys.executable = sys_executable
        if environment is None:
            environment = {"PYTHON": ""}

        with mock.patch.dict("os.environ", environment):
            self.assertRaises(
                RuntimeError,
                self._testr_conf.get_run_command,
                test_path="fake_test_path",
                top_dir="fake_top_dir",
            )

    def test_get_run_command_linux(self):
        self._check_get_run_command(
            platform="linux2", expected_python="/usr/bin/python"
        )

    def test_get_run_command_emptysysexecutable_noenv(self):
        self._check_get_run_command_exception(platform="linux2", sys_executable=None)

    def test_get_run_command_emptysysexecutable_win32(self):
        self._check_get_run_command_exception(
            platform="win32", sys_executable=None, environment={"PYTHON": "python3"}
        )

    def test_get_run_command_emptysysexecutable_withenv(self):
        self._check_get_run_command(
            platform="linux2",
            sys_executable=None,
            expected_python="${PYTHON}",
            environment={"PYTHON": "/usr/bin/python3"},
        )

    def test_get_run_command_win32(self):
        self._check_get_run_command()

    def test_get_run_command_parallel_class(self):
        self._check_get_run_command(parallel_class=True)

    def test_get_run_command_nogroup_regex_noparallel_class(self):
        self._testr_conf.parallel_class = False
        self._testr_conf.group_regex = ""
        self._check_get_run_command(group_regex="", expected_group_callback=None)

    @ddt.data((".\\", ".\\\\"), ("a\\b\\", "a\\b\\\\"), ("a\\b", "a\\b"))
    @ddt.unpack
    @mock.patch("os.sep", new="\\")
    def test_sanitize_dir_win32(self, path, expected):
        sanitized = self._testr_conf._sanitize_path(path)
        self.assertEqual(expected, sanitized)

    @mock.patch("os.path.isfile")
    @mock.patch("stestr.config_file.TestrConf.__init__")
    def test_load_from_file_user_specified(self, initializer, isfile):
        # Test that user-specified config files are "one-and-done"
        initializer.return_value = None
        isfile.return_value = True
        config_file.TestrConf.load_from_file("user.conf")
        initializer.assert_called_once_with("user.conf")

    @mock.patch("os.path.isfile")
    @mock.patch("stestr.config_file.TestrConf.__init__")
    def test_load_from_file_user_specified_fails(self, initializer, isfile):
        # Test that user-specified config files that do not exist gives up
        # immediately
        initializer.return_value = None
        initializer.side_effect = FileNotFoundError
        isfile.return_value = False
        self.assertRaises(
            FileNotFoundError, config_file.TestrConf.load_from_file, "user.conf"
        )
        isfile.assert_called_once_with("user.conf")
        initializer.assert_called_once_with("user.conf")

    @mock.patch("os.path.isfile")
    @mock.patch("stestr.config_file.TestrConf.__init__")
    def test_load_from_file_toml_has_precedence(self, initializer, isfile):
        # Test that tox.ini is ignored if a pyproject.toml config exists
        initializer.return_value = None
        isfile.return_value = False
        config_file.TestrConf.load_from_file(".stestr.conf")
        isfile.assert_called_once_with(".stestr.conf")
        initializer.assert_called_once_with("pyproject.toml")

    @mock.patch("os.path.isfile")
    @mock.patch("stestr.config_file.TestrConf.__init__")
    def test_load_from_file_ini_fallback(self, initializer, isfile):
        initializer.return_value = None
        # The only difference between "no config file" and "nothing defined
        # in the config file" is the type of exception thrown; we'll make
        # sure that, in aggregate, we test for both conditions
        exc = random.choice([FileNotFoundError, KeyError])
        initializer.side_effect = (exc, None)
        isfile.return_value = False
        config_file.TestrConf.load_from_file(".stestr.conf")
        isfile.assert_called_once_with(".stestr.conf")
        initializer.assert_has_calls(
            [mock.call("pyproject.toml"), mock.call("tox.ini", section="stestr")]
        )

    @mock.patch.object(config_file.tomlkit, "load")
    def test_toml_load(self, mock_toml):
        tmpdir = self.useFixture(fixtures.TempDir()).path
        file_path = os.path.join(tmpdir, "myfile.toml")
        with open(file_path, "w"):
            pass
        self._testr_conf = config_file.TestrConf(file_path)
        self._check_get_run_command()
        mock_toml.return_value.__getitem__.assert_called_once_with("tool")