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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
|
import subprocess
from signal import SIGTERM
from unittest import mock
import pytest
from briefcase.console import LogLevel
from briefcase.exceptions import BriefcaseCommandError
from briefcase.integrations.subprocess import Subprocess
from briefcase.platforms.macOS import macOS_log_clean_filter
from briefcase.platforms.macOS.app import macOSAppRunCommand
@pytest.fixture
def run_command(dummy_console, tmp_path):
command = macOSAppRunCommand(
console=dummy_console,
base_path=tmp_path / "base_path",
data_path=tmp_path / "briefcase",
)
command.tools.home_path = tmp_path / "home"
command.tools.subprocess = mock.MagicMock(spec_set=Subprocess)
command._stream_app_logs = mock.MagicMock()
# To satisfy coverage, the stop function must be invoked
# at least once when streaming app logs.
def mock_stream_app_logs(app, stop_func=lambda: 1 + 1, **kwargs):
stop_func()
command._stream_app_logs.side_effect = mock_stream_app_logs
command.tools.os.kill = mock.MagicMock()
return command
def test_run_gui_app(run_command, first_app_config, sleep_zero, tmp_path, monkeypatch):
"""A macOS GUI app can be started."""
# Mock a popen object that represents the log stream
log_stream_process = mock.MagicMock(spec_set=subprocess.Popen)
run_command.tools.subprocess.Popen.return_value = log_stream_process
# Monkeypatch the tools get the process ID
monkeypatch.setattr(
"briefcase.platforms.macOS.get_process_id_by_command", lambda *a, **kw: 100
)
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
sender = bin_path / "Contents/MacOS/First App"
run_command.tools.subprocess.Popen.assert_called_with(
[
"log",
"stream",
"--style",
"compact",
"--predicate",
f'senderImagePath=="{sender}"'
f' OR (processImagePath=="{sender}"'
' AND senderImagePath=="/usr/lib/libffi.dylib")',
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
run_command.tools.subprocess.run.assert_called_with(
["open", "-n", bin_path],
cwd=tmp_path / "home",
check=True,
)
# The log stream was started
run_command._stream_app_logs.assert_called_with(
first_app_config,
popen=log_stream_process,
clean_filter=macOS_log_clean_filter,
clean_output=True,
stop_func=mock.ANY,
log_stream=True,
)
# The app process was killed on exit.
run_command.tools.os.kill.assert_called_with(100, SIGTERM)
def test_run_gui_app_with_passthrough(
run_command,
first_app_config,
sleep_zero,
tmp_path,
monkeypatch,
):
"""A macOS app can be started in debug mode with args."""
run_command.console.verbosity = LogLevel.DEBUG
# Mock a popen object that represents the log stream
log_stream_process = mock.MagicMock(spec_set=subprocess.Popen)
run_command.tools.subprocess.Popen.return_value = log_stream_process
# Monkeypatch the tools get the process ID
monkeypatch.setattr(
"briefcase.platforms.macOS.get_process_id_by_command", lambda *a, **kw: 100
)
# Run the app with args
run_command.run_app(
first_app_config,
passthrough=["foo", "--bar"],
)
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
sender = bin_path / "Contents/MacOS/First App"
run_command.tools.subprocess.Popen.assert_called_with(
[
"log",
"stream",
"--style",
"compact",
"--predicate",
f'senderImagePath=="{sender}"'
f' OR (processImagePath=="{sender}"'
' AND senderImagePath=="/usr/lib/libffi.dylib")',
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
run_command.tools.subprocess.run.assert_called_with(
["open", "-n", bin_path, "--args", "foo", "--bar"],
cwd=tmp_path / "home",
check=True,
env={"BRIEFCASE_DEBUG": "1"},
)
# The log stream was started
run_command._stream_app_logs.assert_called_with(
first_app_config,
popen=log_stream_process,
clean_filter=macOS_log_clean_filter,
clean_output=True,
stop_func=mock.ANY,
log_stream=True,
)
# The app process was killed on exit.
run_command.tools.os.kill.assert_called_with(100, SIGTERM)
def test_run_gui_app_failed(run_command, first_app_config, sleep_zero, tmp_path):
"""If there's a problem started the app, an exception is raised."""
# Mock a failure opening the app
run_command.tools.subprocess.run.side_effect = subprocess.CalledProcessError(
cmd=["open", "-n", run_command.binary_path(first_app_config)],
returncode=1,
)
with pytest.raises(BriefcaseCommandError):
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
sender = bin_path / "Contents/MacOS/First App"
run_command.tools.subprocess.Popen.assert_called_with(
[
"log",
"stream",
"--style",
"compact",
"--predicate",
f'senderImagePath=="{sender}"'
f' OR (processImagePath=="{sender}"'
' AND senderImagePath=="/usr/lib/libffi.dylib")',
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
run_command.tools.subprocess.run.assert_called_with(
["open", "-n", bin_path],
cwd=tmp_path / "home",
check=True,
)
# No attempt was made to stream the log or cleanup
run_command._stream_app_logs.assert_not_called()
run_command.tools.os.kill.assert_not_called()
def test_run_gui_app_find_pid_failed(
run_command,
first_app_config,
sleep_zero,
tmp_path,
monkeypatch,
capsys,
):
"""If after app is started, its pid is not found, do not stream output."""
# Mock a failed PID lookup
monkeypatch.setattr(
"briefcase.platforms.macOS.get_process_id_by_command",
lambda *a, **kw: None,
)
with pytest.raises(BriefcaseCommandError) as exc_info:
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
sender = bin_path / "Contents/MacOS/First App"
run_command.tools.subprocess.Popen.assert_called_with(
[
"log",
"stream",
"--style",
"compact",
"--predicate",
f'senderImagePath=="{sender}"'
f' OR (processImagePath=="{sender}"'
' AND senderImagePath=="/usr/lib/libffi.dylib")',
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
run_command.tools.subprocess.run.assert_called_with(
["open", "-n", bin_path],
cwd=tmp_path / "home",
check=True,
)
assert exc_info.value.msg == (
"Unable to find process for app first-app to start log streaming."
)
# No attempt was made to stream the log or cleanup
run_command._stream_app_logs.assert_not_called()
run_command.tools.os.kill.assert_not_called()
def test_run_gui_app_test_mode(
run_command,
first_app_config,
sleep_zero,
tmp_path,
monkeypatch,
):
"""A macOS GUI app can be started in test mode."""
first_app_config.test_mode = True
# Mock a popen object that represents the log stream
log_stream_process = mock.MagicMock(spec_set=subprocess.Popen)
run_command.tools.subprocess.Popen.return_value = log_stream_process
# Monkeypatch the tools get the process ID
monkeypatch.setattr(
"briefcase.platforms.macOS.get_process_id_by_command", lambda *a, **kw: 100
)
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
sender = bin_path / "Contents/MacOS/First App"
run_command.tools.subprocess.Popen.assert_called_with(
[
"log",
"stream",
"--style",
"compact",
"--predicate",
f'senderImagePath=="{sender}"'
f' OR (processImagePath=="{sender}"'
' AND senderImagePath=="/usr/lib/libffi.dylib")',
],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
run_command.tools.subprocess.run.assert_called_with(
["open", "-n", bin_path],
cwd=tmp_path / "home",
check=True,
env={"BRIEFCASE_MAIN_MODULE": "tests.first_app"},
)
# The log stream was started
run_command._stream_app_logs.assert_called_with(
first_app_config,
popen=log_stream_process,
clean_filter=macOS_log_clean_filter,
clean_output=True,
stop_func=mock.ANY,
log_stream=True,
)
# The app process was killed on exit.
run_command.tools.os.kill.assert_called_with(100, SIGTERM)
def test_run_console_app(run_command, first_app_config, tmp_path):
"""A macOS console app can be started."""
# Set the app to be a console app
first_app_config.console_app = True
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
run_command.tools.subprocess.run.assert_called_with(
[bin_path / "Contents/MacOS/First App"],
cwd=tmp_path / "home",
check=True,
stream_output=False,
)
# The log stream was not started
run_command._stream_app_logs.assert_not_called()
def test_run_console_app_with_passthrough(
run_command,
first_app_config,
tmp_path,
):
"""A macOS console app can be started in debug mode with args."""
run_command.console.verbosity = LogLevel.DEBUG
# Set the app to be a console app
first_app_config.console_app = True
# Run the app with args
run_command.run_app(
first_app_config,
passthrough=["foo", "--bar"],
)
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
run_command.tools.subprocess.run.assert_called_with(
[bin_path / "Contents/MacOS/First App", "foo", "--bar"],
cwd=tmp_path / "home",
check=True,
stream_output=False,
env={"BRIEFCASE_DEBUG": "1"},
)
# The log stream was not started
run_command._stream_app_logs.assert_not_called()
def test_run_console_app_test_mode(run_command, first_app_config, sleep_zero, tmp_path):
"""A macOS console app can be started in test mode."""
first_app_config.console_app = True
first_app_config.test_mode = True
# Mock a popen object that represents the app
app_process = mock.MagicMock(spec_set=subprocess.Popen)
run_command.tools.subprocess.Popen.return_value = app_process
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
run_command.tools.subprocess.Popen.assert_called_with(
[bin_path / "Contents/MacOS/First App"],
cwd=tmp_path / "home",
env={"BRIEFCASE_MAIN_MODULE": "tests.first_app"},
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
# The log stream was not started
run_command._stream_app_logs.assert_called_with(
first_app_config,
popen=app_process,
)
def test_run_console_app_test_mode_with_passthrough(
run_command,
first_app_config,
sleep_zero,
tmp_path,
):
"""A macOS console app can be started in test mode with parameters and debug
mode."""
run_command.console.verbosity = LogLevel.DEBUG
first_app_config.console_app = True
first_app_config.test_mode = True
# Mock a popen object that represents the app
app_process = mock.MagicMock(spec_set=subprocess.Popen)
run_command.tools.subprocess.Popen.return_value = app_process
run_command.run_app(first_app_config, passthrough=["foo", "--bar"])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
run_command.tools.subprocess.Popen.assert_called_with(
[bin_path / "Contents/MacOS/First App", "foo", "--bar"],
cwd=tmp_path / "home",
env={"BRIEFCASE_DEBUG": "1", "BRIEFCASE_MAIN_MODULE": "tests.first_app"},
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
bufsize=1,
)
# The log stream was not started
run_command._stream_app_logs.assert_called_with(
first_app_config,
popen=app_process,
)
def test_run_console_app_failed(run_command, first_app_config, sleep_zero, tmp_path):
"""If there's a problem started a console app, an exception is raised."""
# Set the app to be a console app
first_app_config.console_app = True
# Mock a failure opening the app
run_command.tools.subprocess.run.side_effect = subprocess.CalledProcessError(
cmd=[run_command.binary_path(first_app_config) / "Contents/MacOS/First App"],
returncode=1,
)
# Although the command raises an error, this could be because the script itself
# raised an error.
run_command.run_app(first_app_config, passthrough=[])
# Calls were made to start the app and to start a log stream.
bin_path = run_command.binary_path(first_app_config)
run_command.tools.subprocess.run.assert_called_with(
[bin_path / "Contents/MacOS/First App"],
cwd=tmp_path / "home",
stream_output=False,
check=True,
)
# No attempt was made to stream the log or cleanup
run_command._stream_app_logs.assert_not_called()
|
