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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
import json
import os
import subprocess
from pathlib import Path
from unittest.mock import call
import pytest
from briefcase.exceptions import BriefcaseCommandError, UnsupportedHostError
from briefcase.integrations.visualstudio import VisualStudio
MSBUILD_OUTPUT = """Microsoft (R) Build Engine version 17.2.1+52cd2da31 for .NET Framework
Copyright (C) Microsoft Corporation. All rights reserved.
17.2.1.25201
"""
@pytest.fixture
def custom_msbuild_path(tmp_path):
"""Create a dummy MSBuild executable at a custom location."""
msbuild_path = tmp_path / "custom/MSBuild.exe"
msbuild_path.parent.mkdir(parents=True)
with msbuild_path.open("w", encoding="utf-8") as f:
f.write("Dummy MSBuild")
return msbuild_path
@pytest.fixture
def vswhere_path(tmp_path):
"""Create a dummy vswhere executable."""
vswhere_path = (
tmp_path
/ "Program Files (x86)"
/ "Microsoft Visual Studio"
/ "Installer"
/ "vswhere.exe"
)
vswhere_path.parent.mkdir(parents=True)
with vswhere_path.open("w", encoding="utf-8") as f:
f.write("Dummy vswhere")
return vswhere_path
@pytest.fixture
def msbuild_path(tmp_path):
"""Create a dummy MSBuild executable."""
msbuild_path = tmp_path / "Visual Studio/MSBuild/Current/Bin/MSBuild.exe"
msbuild_path.parent.mkdir(parents=True)
with msbuild_path.open("w", encoding="utf-8") as f:
f.write("Dummy MSBuild")
return msbuild_path
def test_short_circuit(mock_tools):
"""Tool is not created if already cached."""
mock_tools.visualstudio = "tool"
tool = VisualStudio.verify(mock_tools)
assert tool == "tool"
assert tool == mock_tools.visualstudio
@pytest.mark.parametrize("host_os", ["Darwin", "Linux", "wonky"])
def test_unsupported_os(mock_tools, host_os):
"""When host OS is not supported, an error is raised."""
mock_tools.host_os = host_os
with pytest.raises(
UnsupportedHostError,
match=f"{VisualStudio.name} is not supported on {host_os}",
):
VisualStudio.verify(mock_tools)
def test_msbuild_on_path(mock_tools):
"""If MSBuild is on the path, that version is used."""
# MSBuild is on the path, so check_output succeeds
mock_tools.subprocess.check_output.return_value = MSBUILD_OUTPUT
# Verify the installation
visualstudio = VisualStudio.verify(mock_tools)
# Visual studio is configured to use an MSBuild with no path,
# which provides no metadata.
assert visualstudio.msbuild_path == Path("MSBuild.exe")
assert visualstudio.install_metadata is None
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[call(["MSBuild.exe", "--version"])],
any_order=False,
)
def test_msbuild_on_path_corrupt(mock_tools):
"""If MSBuild is on the path, but it cannot be invoked, an error is raised."""
# MSBuild is on the path, but raises an error when invoked
mock_tools.subprocess.check_output.side_effect = subprocess.CalledProcessError(
returncode=1,
cmd="MSBuild.exe",
)
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"MSBuild is on the path, but Briefcase cannot start it.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[call(["MSBuild.exe", "--version"])],
any_order=False,
)
def test_msbuild_envvar(mock_tools, custom_msbuild_path):
"""If MSBUILD is set in the environment, that executable is used."""
# Point at the dummy MSBuild executable
mock_tools.os.environ["MSBUILD"] = custom_msbuild_path
# MSBuild is not on the path, but the
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # Not on path
0, # Custom location succeeds
]
# Verify the installation
visualstudio = VisualStudio.verify(mock_tools)
# Visual studio is configured to use an MSBuild at the specified path
# which provides no metadata.
assert visualstudio.msbuild_path == custom_msbuild_path
assert visualstudio.install_metadata is None
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call([custom_msbuild_path, "--version"]),
],
any_order=False,
)
def test_msbuild_envvar_doesnt_exist(mock_tools, tmp_path):
"""If MSBUILD is set in the environment, but it points to a non-existent file, an
error is raised."""
# Point at an MSBuild that does not exist
mock_tools.os.environ["MSBUILD"] = tmp_path / "custom/MSBuild.exe"
# MSBuild is not on the path
mock_tools.subprocess.check_output.side_effect = FileNotFoundError
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"The location referenced by the environment variable MSBUILD:",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
],
any_order=False,
)
def test_msbuild_envvar_bad_executable(mock_tools, custom_msbuild_path):
"""If MSBUILD is set in the environment, but it can't be invoked, an error is
raised."""
# Point at the dummy MSBuild executable
mock_tools.os.environ["MSBUILD"] = custom_msbuild_path
# MSBuild is not on the path, and can't be invoked at the custom location
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # Not on path
subprocess.CalledProcessError(-1, custom_msbuild_path), # Custom location fails
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"MSBuild appears to exist, but Briefcase can't start it.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call([custom_msbuild_path, "--version"]),
],
any_order=False,
)
def test_vswhere_does_not_exist(mock_tools):
"""If VSWhere does not exist, an error is raised."""
# MSBuild is not on the path
mock_tools.subprocess.check_output.side_effect = FileNotFoundError
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Visual Studio does not appear to be installed.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
],
any_order=False,
)
def test_programfiles_envvar_does_not_exist(mock_tools):
"""If ProgramFiles(x86) env var is not set, an error is raised."""
# MSBuild is not on the path
mock_tools.subprocess.check_output.side_effect = FileNotFoundError
# ProgramFiles(x86) env var is not set
mock_tools.os.environ.pop("ProgramFiles(x86)", None)
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Visual Studio does not appear to be installed.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
],
any_order=False,
)
def test_vswhere_bad_executable(mock_tools, vswhere_path):
"""If VSWhere exists, but cannot be executed, an error is raised."""
# MSBuild is not on the path, and vswhere raises an error
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
subprocess.CalledProcessError(returncode=1, cmd=vswhere_path), # vswhere fails
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Visual Studio appears to exist, but Briefcase can't retrieve installation metadata.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
],
any_order=False,
)
def test_vswhere_bad_content(mock_tools, vswhere_path):
"""If VSWhere can be executed, but returns garbage content, an error is raised."""
# MSBuild is not on the path, and vswhere returns non-JSON content
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
"This is not JSON content", # vswhere returns non-JSON content
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Visual Studio appears to exist, but Briefcase can't retrieve installation metadata.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
],
any_order=False,
)
def test_vswhere_non_list_content(mock_tools, vswhere_path):
"""If VSWhere can be executed, but the outermost content isn't a list, an error is
raised."""
# MSBuild is not on the path, and vswhere returns JSON content, but not in the format expected
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
'{"problem": "JSON but not a list"}', # vswhere returns JSON content, but not as a list.
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Visual Studio appears to exist, but Briefcase can't retrieve installation metadata.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
],
any_order=False,
)
def test_vswhere_empty_list_content(mock_tools, vswhere_path):
"""If VSWhere can be executed, but the outermost content is an empty list, an error
is raised."""
# MSBuild is not on the path, and vswhere returns JSON content, but not in the format expected
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
"[]", # vswhere returns empty list JSON content
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Visual Studio appears to exist, but Briefcase can't retrieve installation metadata.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
],
any_order=False,
)
def test_vswhere_msbuild_not_installed(mock_tools, tmp_path, vswhere_path):
"""If VSWhere can be executed, but it doesn't point at an MSBuild executable, an
error is raised."""
# MSBuild is not on the path; vswhere a valid location, but there's no MSBuild there.
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
json.dumps(
[
{
"instanceId": "deadbeef",
"installDate": "2022-07-14T10:42:37Z",
"installationPath": os.fsdecode(tmp_path / "Visual Studio"),
}
]
), # vswhere returns JSON content
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"Your Visual Studio installation does not appear to provide MSBuild.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
],
any_order=False,
)
def test_vswhere_msbuild_bad_executable(
mock_tools,
tmp_path,
vswhere_path,
msbuild_path,
):
"""If VSWhere points at an MSBuild executable, but that exe can't be started, an
error is raised."""
# MSBuild is not on the path; vswhere a valid location, but MSBuild fails.
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
json.dumps(
[
{
"instanceId": "deadbeef",
"installDate": "2022-07-14T10:42:37Z",
"installationPath": os.fsdecode(tmp_path / "Visual Studio"),
}
]
), # vswhere returns JSON content
subprocess.CalledProcessError(
returncode=1,
cmd="MSBuild.exe",
), # MSBuild fails
]
# Verify the installation
with pytest.raises(
BriefcaseCommandError,
match=r"MSBuild appears to exist, but Briefcase can't start it.",
):
VisualStudio.verify(mock_tools)
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
call([msbuild_path, "--version"]),
],
any_order=False,
)
def test_vswhere_install(mock_tools, tmp_path, vswhere_path, msbuild_path):
"""If VSWhere points at a valid MSBuild executable, that executable is used."""
# MSBuild is not on the path; vswhere a valid location, and MSBuild succeeds.
mock_tools.subprocess.check_output.side_effect = [
FileNotFoundError, # MSBuild not on path
json.dumps(
[
{
"instanceId": "deadbeef",
"installDate": "2022-07-14T10:42:37Z",
"installationPath": os.fsdecode(tmp_path / "Visual Studio"),
}
]
), # vswhere returns JSON content
MSBUILD_OUTPUT, # MSBuild Succeeds
]
# Verify the installation
visualstudio = VisualStudio.verify(mock_tools)
assert visualstudio.msbuild_path == msbuild_path
assert visualstudio.install_metadata["instanceId"] == "deadbeef"
# Verification calls are as expected
mock_tools.subprocess.check_output.assert_has_calls(
[
call(["MSBuild.exe", "--version"]),
call(
[vswhere_path, "-latest", "-prerelease", "-format", "json"],
stderr=subprocess.STDOUT,
),
call([msbuild_path, "--version"]),
],
any_order=False,
)
|
