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
|
import os
import subprocess
from pathlib import Path
from unittest.mock import ANY
import pytest
from briefcase.console import LogLevel
def test_call(mock_sub, sub_stream_kw, sleep_zero, capsys):
"""A simple call will be invoked."""
with mock_sub.tools.console.wait_bar():
mock_sub.run(["hello", "world"])
mock_sub._subprocess.Popen.assert_called_with(["hello", "world"], **sub_stream_kw)
# fmt: off
expected_output = (
"output line 1\n"
"\n"
"output line 3\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
def test_call_with_arg(mock_sub, sub_stream_kw, sleep_zero, capsys):
"""Any extra keyword arguments are passed through as-is."""
with mock_sub.tools.console.wait_bar():
mock_sub.run(["hello", "world"], extra_kw="extra")
mock_sub._subprocess.Popen.assert_called_with(
["hello", "world"],
extra_kw="extra",
**sub_stream_kw,
)
# fmt: off
expected_output = (
"output line 1\n"
"\n"
"output line 3\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
def test_debug_call(mock_sub, sub_stream_kw, sleep_zero, capsys):
"""If verbosity is turned up, there is debug output."""
mock_sub.tools.console.verbosity = LogLevel.DEBUG
with mock_sub.tools.console.wait_bar():
mock_sub.run(["hello", "world"])
mock_sub._subprocess.Popen.assert_called_with(["hello", "world"], **sub_stream_kw)
expected_output = (
"\n"
">>> Running Command:\n"
">>> hello world\n"
">>> Working Directory:\n"
f">>> {Path.cwd()}\n"
"output line 1\n"
"\n"
"output line 3\n"
">>> Return code: -3\n"
"\n"
"\n"
)
assert capsys.readouterr().out == expected_output
def test_debug_call_with_env(mock_sub, sub_stream_kw, sleep_zero, capsys, tmp_path):
"""If verbosity is turned up, injected env vars are included in debug output."""
mock_sub.tools.console.verbosity = LogLevel.DEBUG
env = {"NewVar": "NewVarValue"}
with mock_sub.tools.console.wait_bar():
mock_sub.run(
["hello", "world"],
env=env,
cwd=tmp_path / "cwd",
)
merged_env = mock_sub.tools.os.environ.copy()
merged_env.update(env)
mock_sub._subprocess.Popen.assert_called_with(
["hello", "world"],
env=merged_env,
cwd=os.fsdecode(tmp_path / "cwd"),
**sub_stream_kw,
)
expected_output = (
"\n"
">>> Running Command:\n"
">>> hello world\n"
">>> Working Directory:\n"
f">>> {tmp_path / 'cwd'}\n"
">>> Environment Overrides:\n"
">>> NewVar=NewVarValue\n"
"output line 1\n"
"\n"
"output line 3\n"
">>> Return code: -3\n"
"\n"
"\n"
)
assert capsys.readouterr().out == expected_output
@pytest.mark.parametrize(
"in_kwargs, kwargs",
[
(
{},
{"text": True, "encoding": ANY, "bufsize": 1, "errors": "backslashreplace"},
),
(
{"text": True},
{"text": True, "encoding": ANY, "bufsize": 1, "errors": "backslashreplace"},
),
({"text": False}, {"text": False, "bufsize": 1}),
({"text": False, "bufsize": 42}, {"text": False, "bufsize": 42}),
({"universal_newlines": False}, {"text": False, "bufsize": 1}),
(
{"universal_newlines": True},
{"text": True, "encoding": ANY, "bufsize": 1, "errors": "backslashreplace"},
),
],
)
def test_text_eq_true_default_overriding(mock_sub, in_kwargs, kwargs, sleep_zero):
"""If text or universal_newlines is explicitly provided, those should override
text=true default and universal_newlines should be converted to text."""
with mock_sub.tools.console.wait_bar():
mock_sub.run(["hello", "world"], **in_kwargs)
mock_sub._subprocess.Popen.assert_called_with(
["hello", "world"],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
**kwargs,
)
def test_stderr_is_redirected(
mock_sub,
streaming_process,
sub_stream_kw,
sleep_zero,
capsys,
):
"""When stderr is redirected, it should be included in the result."""
stderr_output = "stderr output\nline 2"
streaming_process.stderr.read.return_value = stderr_output
with mock_sub.tools.console.wait_bar():
run_result = mock_sub.run(
["hello", "world"],
stderr=subprocess.PIPE,
)
sub_stream_kw.pop("stderr")
mock_sub._subprocess.Popen.assert_called_with(
["hello", "world"],
stderr=subprocess.PIPE,
**sub_stream_kw,
)
# fmt: off
expected_output = (
"output line 1\n"
"\n"
"output line 3\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
assert run_result.stderr == stderr_output
def test_stderr_dev_null(
mock_sub,
streaming_process,
sub_stream_kw,
sleep_zero,
capsys,
):
"""When stderr is discarded, it should be None in the result."""
streaming_process.stderr = None
with mock_sub.tools.console.wait_bar():
run_result = mock_sub.run(
["hello", "world"],
stderr=subprocess.DEVNULL,
)
sub_stream_kw.pop("stderr")
mock_sub._subprocess.Popen.assert_called_with(
["hello", "world"],
stderr=subprocess.DEVNULL,
**sub_stream_kw,
)
# fmt: off
expected_output = (
"output line 1\n"
"\n"
"output line 3\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
assert run_result.stderr is None
def test_calledprocesserror(mock_sub, streaming_process, sleep_zero, capsys):
"""CalledProcessError is raised with check=True and non-zero return value."""
stderr_output = "stderr output\nline 2"
streaming_process.stderr.read.return_value = stderr_output
with pytest.raises(subprocess.CalledProcessError) as exc:
with mock_sub.tools.console.wait_bar():
mock_sub.run(
["hello", "world"],
check=True,
stderr=subprocess.PIPE,
)
# fmt: off
expected_output = (
"output line 1\n"
"\n"
"output line 3\n"
"\n"
)
# fmt: on
assert capsys.readouterr().out == expected_output
assert exc.value.returncode == -3
assert exc.value.cmd == ["hello", "world"]
assert exc.value.stderr == stderr_output
def test_invalid_invocations(mock_sub):
"""Ensure run cannot be used in a Wait Bar with invalid arguments."""
with pytest.raises(AssertionError):
with mock_sub.tools.console.wait_bar():
mock_sub.run(
["hello", "world"],
stdout=subprocess.PIPE,
)
for invalid_arg in ("timeout", "input"):
with pytest.raises(AssertionError):
with mock_sub.tools.console.wait_bar():
mock_sub.run(["hello", "world"], **{invalid_arg: "value"})
|
