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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
from unittest.mock import MagicMock
import pytest
import briefcase.console
def test_wait_bar_done_message_interactive(console, capsys):
"""Custom done_message is printed when wait bar normally exits."""
with console.wait_bar("Wait message...", done_message="finished"):
pass
assert capsys.readouterr().out == "Wait message... finished\n\n"
def test_wait_bar_done_message_non_interactive(non_interactive_console, capsys):
"""Custom done_message is printed when wait bar normally exits."""
with non_interactive_console.wait_bar("Wait message...", done_message="finished"):
pass
assert capsys.readouterr().out == (
"Wait message... started\n" "Wait message... finished\n\n"
)
def test_wait_bar_done_message_nested_interactive(console, capsys):
"""Custom done_message is printed when wait bar normally exits."""
with console.wait_bar("Wait message 1...", done_message="finished"):
with console.wait_bar("Wait message 2...", done_message="finished"):
pass
expected = "Wait message 2... finished\n" "Wait message 1... finished\n\n"
assert capsys.readouterr().out == expected
def test_wait_bar_done_message_nested_non_interactive(non_interactive_console, capsys):
"""Custom done_message is printed when wait bar normally exits."""
with non_interactive_console.wait_bar("Wait message 1...", done_message="finished"):
with non_interactive_console.wait_bar(
"Wait message 2...", done_message="finished"
):
pass
expected = (
"Wait message 1... started\n"
"Wait message 2... started\n"
"Wait message 2... finished\n"
"Wait message 1... finished\n\n"
)
assert capsys.readouterr().out == expected
@pytest.mark.parametrize(
("message", "transient", "output"),
(
("Wait message...", False, "Wait message... done\n\n"),
("", False, "\n"),
("Wait Message...", True, "\n"),
("", True, "\n"),
),
)
def test_wait_bar_transient_interactive(console, message, transient, output, capsys):
"""Output is present or absent based on presence of message and transient value."""
with console.wait_bar(message, transient=transient):
pass
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message", "transient", "output"),
(
("Wait message...", False, "Wait message... started\nWait message... done\n\n"),
("", False, "\n"),
("Wait message...", True, "Wait message... started\nWait message... done\n\n"),
("", True, "\n"),
),
)
def test_wait_bar_transient_non_interactive(
non_interactive_console,
message,
transient,
output,
capsys,
):
"""Output is present or absent based on presence of message and transient value."""
with non_interactive_console.wait_bar(message, transient=transient):
pass
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message_one", "message_two", "transient", "output"),
(
(
"Wait message 1...",
"Wait message 2...",
False,
"Wait message 2... done\nWait message 1... done\n\n",
),
("", "", False, "\n"),
("Wait message 1...", "Wait message 2...", True, "\n"),
("", "", True, "\n"),
),
)
def test_wait_bar_transient_nested_interactive(
console,
message_one,
message_two,
transient,
output,
capsys,
):
"""Output is present or absent based on presence of message and transient value."""
with console.wait_bar(message_one, transient=transient):
with console.wait_bar(message_two, transient=transient):
pass
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message_one", "message_two", "transient", "output"),
(
(
"Wait message 1...",
"Wait message 2...",
False,
(
"Wait message 1... started\n"
"Wait message 2... started\n"
"Wait message 2... done\n"
"Wait message 1... done\n\n"
),
),
("", "", False, "\n"),
(
"Wait message 1...",
"Wait message 2...",
True,
(
"Wait message 1... started\n"
"Wait message 2... started\n"
"Wait message 2... done\n"
"Wait message 1... done\n\n"
),
),
("", "", True, "\n"),
),
)
def test_wait_bar_transient_nested_non_interactive(
non_interactive_console,
message_one,
message_two,
transient,
output,
capsys,
):
"""Output is present or absent based on presence of message and transient value."""
with non_interactive_console.wait_bar(message_one, transient=transient):
with non_interactive_console.wait_bar(message_two, transient=transient):
pass
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message", "transient", "output"),
(
("Wait message...", False, "Wait message... aborted\n\n"),
("", False, "\n"),
("Wait Message...", True, "\n"),
("", True, "\n"),
),
)
def test_wait_bar_keyboard_interrupt_interactive(
console,
message,
transient,
output,
capsys,
):
"""If the wait bar is interrupted, output is present or absent based on presence of
message and transient value."""
with pytest.raises(KeyboardInterrupt):
with console.wait_bar(message, transient=transient):
raise KeyboardInterrupt
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message", "transient", "output"),
(
(
"Wait message...",
False,
"Wait message... started\nWait message... aborted\n\n",
),
("", False, "\n"),
(
"Wait message...",
True,
"Wait message... started\nWait message... aborted\n\n",
),
("", True, "\n"),
),
)
def test_wait_bar_keyboard_interrupt_non_interactive(
non_interactive_console,
message,
transient,
output,
capsys,
):
"""If the wait bar is interrupted, output is present or absent based on presence of
message and transient value."""
with pytest.raises(KeyboardInterrupt):
with non_interactive_console.wait_bar(message, transient=transient):
raise KeyboardInterrupt
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message_one", "message_two", "transient", "output"),
(
(
"Wait message 1...",
"Wait message 2...",
False,
"Wait message 2... aborted\nWait message 1... aborted\n\n",
),
("", "", False, "\n"),
("Wait message 1...", "Wait message 2...", True, "\n"),
("", "", True, "\n"),
),
)
def test_wait_bar_keyboard_interrupt_nested_interactive(
console,
message_one,
message_two,
transient,
output,
capsys,
):
"""If the wait bar is interrupted, output is present or absent based on presence of
message and transient value."""
with pytest.raises(KeyboardInterrupt):
with console.wait_bar(message_one, transient=transient):
with console.wait_bar(message_two, transient=transient):
raise KeyboardInterrupt
assert capsys.readouterr().out == output
@pytest.mark.parametrize(
("message_one", "message_two", "transient", "output"),
(
(
"Wait message 1...",
"Wait message 2...",
False,
(
"Wait message 1... started\n"
"Wait message 2... started\n"
"Wait message 2... aborted\n"
"Wait message 1... aborted\n\n"
),
),
("", "", False, "\n"),
(
"Wait message 1...",
"Wait message 2...",
True,
(
"Wait message 1... started\n"
"Wait message 2... started\n"
"Wait message 2... aborted\n"
"Wait message 1... aborted\n\n"
),
),
("", "", True, "\n"),
),
)
def test_wait_bar_keyboard_interrupt_nested_non_interactive(
non_interactive_console,
message_one,
message_two,
transient,
output,
capsys,
):
"""If the wait bar is interrupted, output is present or absent based on presence of
message and transient value."""
with pytest.raises(KeyboardInterrupt):
with non_interactive_console.wait_bar(message_one, transient=transient):
with non_interactive_console.wait_bar(message_two, transient=transient):
raise KeyboardInterrupt
assert capsys.readouterr().out == output
def test_wait_bar_always_interactive(console):
"""Wait Bar is not disabled when console is interactive."""
with console.wait_bar():
assert console._wait_bar.disable is False
with console.wait_bar():
assert console._wait_bar.disable is False
def test_wait_bar_non_interactive(non_interactive_console):
"""Wait Bar is disabled when console is non-interactive."""
with non_interactive_console.wait_bar():
assert non_interactive_console._wait_bar.disable is True
with non_interactive_console.wait_bar():
assert non_interactive_console._wait_bar.disable is True
def test_wait_bar_alive_messages_interactive(
console,
non_interactive_console,
capsys,
monkeypatch,
):
"""Wait Bar keep_alive prints keep alive messages."""
for test_console in [console, non_interactive_console]:
# initialization will set interval to a small number
# update() will see time at a large number and print the message
# then interval is reset back to a small number
monkeypatch.setattr(
briefcase.console.time,
"time",
MagicMock(side_effect=[0] + [1e42, 0] * 2),
)
with test_console.wait_bar("task") as keep_alive:
for _ in range(2):
keep_alive.update()
assert capsys.readouterr().out.endswith(
"... still waiting\n... still waiting\ntask done\n\n"
)
assert capsys.readouterr().out == ""
|
