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
|
import os
from pathlib import Path
from subprocess import CalledProcessError
from unittest.mock import ANY
import pytest
from briefcase.console import LogLevel
from .conftest import CREATE_NEW_PROCESS_GROUP, CREATE_NO_WINDOW
@pytest.mark.parametrize("platform", ["Linux", "Darwin", "Windows"])
def test_call(mock_sub, capsys, platform, sub_kw):
"""A simple call will be invoked."""
mock_sub.tools.sys.platform = platform
mock_sub.run(["hello", "world"], stream_output=False)
mock_sub._subprocess.run.assert_called_with(["hello", "world"], **sub_kw)
assert capsys.readouterr().out == ""
def test_call_with_arg(mock_sub, capsys, sub_kw):
"""Any extra keyword arguments are passed through as-is."""
mock_sub.run(["hello", "world"], extra_kw="extra", stream_output=False)
mock_sub._subprocess.run.assert_called_with(
["hello", "world"],
extra_kw="extra",
**sub_kw,
)
assert capsys.readouterr().out == ""
def test_call_with_path_arg(mock_sub, capsys, tmp_path, sub_kw):
"""Path-based arguments are converted to strings and passed in as-is."""
mock_sub.run(
["hello", tmp_path / "location"],
cwd=tmp_path / "cwd",
stream_output=False,
)
mock_sub._subprocess.run.assert_called_with(
["hello", os.fsdecode(tmp_path / "location")],
cwd=os.fsdecode(tmp_path / "cwd"),
**sub_kw,
)
assert capsys.readouterr().out == ""
@pytest.mark.parametrize(
("platform", "start_new_session", "run_kwargs"),
[
("Linux", None, {}),
("Linux", True, {}),
("Linux", False, {}),
("Darwin", None, {}),
("Darwin", True, {}),
("Darwin", False, {}),
("Windows", None, {}),
(
"Windows",
True,
{"creationflags": CREATE_NEW_PROCESS_GROUP | CREATE_NO_WINDOW},
),
("Windows", False, {}),
],
)
def test_call_with_start_new_session(
mock_sub,
capsys,
platform,
start_new_session,
run_kwargs,
sub_kw,
):
"""start_new_session is passed thru on Linux and macOS but converted for Windows."""
mock_sub.tools.host_os = platform
mock_sub.run(
["hello", "world"],
start_new_session=start_new_session,
stream_output=False,
)
final_kwargs = {**run_kwargs, **sub_kw}
if platform == "Windows":
mock_sub._subprocess.run.assert_called_with(["hello", "world"], **final_kwargs)
assert capsys.readouterr().out == ""
else:
mock_sub._subprocess.run.assert_called_with(
["hello", "world"],
start_new_session=start_new_session,
**final_kwargs,
)
assert capsys.readouterr().out == ""
@pytest.mark.parametrize(
("creationflags", "final_creationflags"),
[
(0x1, CREATE_NEW_PROCESS_GROUP | CREATE_NO_WINDOW | 1),
(CREATE_NEW_PROCESS_GROUP, CREATE_NEW_PROCESS_GROUP | CREATE_NO_WINDOW),
(0, CREATE_NEW_PROCESS_GROUP | CREATE_NO_WINDOW),
],
)
def test_call_windows_with_start_new_session_and_creationflags(
mock_sub,
capsys,
creationflags,
final_creationflags,
):
"""Creationflags used to simulate start_new_session=True should be merged with any
existing flags."""
mock_sub.tools.host_os = "Windows"
# use commented test below when merging creationflags is allowed
with pytest.raises(
AssertionError, match="Subprocess called with creationflags set"
):
mock_sub.run(
["hello", "world"],
start_new_session=True,
creationflags=creationflags,
stream_output=False,
)
def test_debug_call(mock_sub, capsys, sub_kw):
"""If verbosity is turned up, there is output."""
mock_sub.tools.console.verbosity = LogLevel.DEBUG
mock_sub.run(["hello", "world"], stream_output=False)
mock_sub._subprocess.run.assert_called_with(["hello", "world"], **sub_kw)
# fmt: off
expected_output = (
"\n"
">>> Running Command:\n"
">>> hello world\n"
">>> Working Directory:\n"
f">>> {Path.cwd()}\n"
">>> Return code: 0\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
def test_debug_call_with_env(mock_sub, capsys, tmp_path, sub_kw):
"""If verbosity is turned up, injected env vars are included output."""
mock_sub.tools.console.verbosity = LogLevel.DEBUG
env = {"NewVar": "NewVarValue"}
mock_sub.run(["hello", "world"], env=env, cwd=tmp_path / "cwd", stream_output=False)
merged_env = mock_sub.tools.os.environ.copy()
merged_env.update(env)
mock_sub._subprocess.run.assert_called_with(
["hello", "world"],
env=merged_env,
cwd=os.fsdecode(tmp_path / "cwd"),
**sub_kw,
)
expected_output = (
"\n"
">>> Running Command:\n"
">>> hello world\n"
">>> Working Directory:\n"
f">>> {tmp_path / 'cwd'}\n"
">>> Environment Overrides:\n"
">>> NewVar=NewVarValue\n"
">>> Return code: 0\n"
"\n"
)
assert capsys.readouterr().out == expected_output
def test_calledprocesserror_exception_logging(mock_sub, capsys):
mock_sub.tools.console.verbosity = LogLevel.DEBUG
mock_sub._subprocess.run.side_effect = CalledProcessError(
returncode=-1,
cmd="hello world",
output="output line 1\noutput line 2",
stderr="error line 1\nerror line 2",
)
with pytest.raises(CalledProcessError):
mock_sub.run(["hello", "world"], stream_output=False)
# fmt: off
expected_output = (
"\n"
">>> Running Command:\n"
">>> hello world\n"
">>> Working Directory:\n"
f">>> {Path.cwd()}\n"
">>> Return code: -1\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
@pytest.mark.parametrize(
"in_kwargs, kwargs",
[
({}, {"text": True, "encoding": ANY, "errors": "backslashreplace"}),
({"text": True}, {"text": True, "encoding": ANY, "errors": "backslashreplace"}),
({"text": False}, {"text": False}),
({"universal_newlines": False}, {"text": False}),
(
{"universal_newlines": True},
{"text": True, "encoding": ANY, "errors": "backslashreplace"},
),
],
)
def test_text_eq_true_default_overriding(mock_sub, in_kwargs, kwargs):
"""If text or universal_newlines is explicitly provided, those should override
text=true default and universal_newlines should be converted to text."""
mock_sub.run(["hello", "world"], stream_output=False, **in_kwargs)
mock_sub._subprocess.run.assert_called_with(["hello", "world"], **kwargs)
def test_call_with_filter_func(mock_sub, capsys, sub_kw):
"""Providing a filter function when not streaming raises an exception."""
with pytest.raises(
ValueError,
match=r"Cannot apply a filter to non-streamed output",
):
mock_sub.run(
["hello", "world"],
filter_func=lambda line: line,
stream_output=False,
)
|
