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
|
import os
from unittest.mock import MagicMock
import pytest
from briefcase.exceptions import (
BriefcaseCommandError,
MissingToolError,
NetworkFailure,
UnsupportedHostError,
)
from briefcase.integrations.wix import WiX
from ...utils import assert_url_resolvable, create_zip_file
from .conftest import WIX_DOWNLOAD_URL
def test_short_circuit(mock_tools):
"""Tool is not created if already cached."""
mock_tools.wix = "tool"
tool = WiX.verify(mock_tools)
assert tool == "tool"
assert tool == mock_tools.wix
@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"{WiX.name} is not supported on {host_os}",
):
WiX.verify(mock_tools)
def test_valid_wix_envvar(mock_tools, tmp_path):
"""If the WiX envvar points to a valid WiX install, the validator succeeds."""
# Mock the environment for a WiX install
wix_path = tmp_path / "wix"
mock_tools.os.environ.get.return_value = os.fsdecode(wix_path)
# Mock the interesting parts of a WiX install
(wix_path / "bin").mkdir(parents=True)
(wix_path / "bin/heat.exe").touch()
(wix_path / "bin/light.exe").touch()
(wix_path / "bin/candle.exe").touch()
# Verify the install
wix = WiX.verify(mock_tools)
# The environment was queried.
mock_tools.os.environ.get.assert_called_with("WIX")
# The returned paths are as expected (and are the full paths)
assert wix.heat_exe == tmp_path / "wix/bin/heat.exe"
assert wix.light_exe == tmp_path / "wix/bin/light.exe"
assert wix.candle_exe == tmp_path / "wix/bin/candle.exe"
def test_invalid_wix_envvar(mock_tools, tmp_path):
"""If the WiX envvar points to an invalid WiX install, the validator fails."""
# Mock the environment for a WiX install
wix_path = tmp_path / "wix"
mock_tools.os.environ.get.return_value = os.fsdecode(wix_path)
# Don't create the actual install, and then attempt to validate
with pytest.raises(BriefcaseCommandError, match="does not point to an install"):
WiX.verify(mock_tools)
def test_existing_wix_install(mock_tools, tmp_path):
"""If there's an existing managed WiX install, the validator succeeds."""
# Mock the environment as if there is not WiX variable
mock_tools.os.environ.get.return_value = None
# Create a mock of a previously installed WiX version.
wix_path = tmp_path / "tools/wix"
wix_path.mkdir(parents=True)
(wix_path / "heat.exe").touch()
(wix_path / "light.exe").touch()
(wix_path / "candle.exe").touch()
wix = WiX.verify(mock_tools)
# The environment was queried.
mock_tools.os.environ.get.assert_called_with("WIX")
# No download was attempted
assert mock_tools.file.download.call_count == 0
# The returned paths are as expected
assert wix.heat_exe == tmp_path / "tools/wix/heat.exe"
assert wix.light_exe == tmp_path / "tools/wix/light.exe"
assert wix.candle_exe == tmp_path / "tools/wix/candle.exe"
def test_download_wix(mock_tools, tmp_path):
"""If there's no existing managed WiX install, it is downloaded and unpacked."""
# Mock the environment as if there is not WiX variable
mock_tools.os.environ.get.return_value = None
# Mock the download
wix_path = tmp_path / "tools/wix"
wix_zip_path = create_zip_file(tmp_path / "tools/wix.zip", content=[("wix", "wix")])
mock_tools.file.download = MagicMock(return_value=wix_zip_path)
# Verify the install. This will trigger a download
wix = WiX.verify(mock_tools)
# The environment was queried.
mock_tools.os.environ.get.assert_called_with("WIX")
# A download was initiated
mock_tools.file.download.assert_called_with(
url=WIX_DOWNLOAD_URL,
download_path=tmp_path / "tools",
role="WiX",
)
# The download was unpacked.
mock_tools.shutil.unpack_archive.assert_called_with(
filename=os.fsdecode(wix_zip_path), extract_dir=os.fsdecode(wix_path)
)
# The zip file was removed
assert not wix_zip_path.exists()
# The returned paths are as expected
assert wix.heat_exe == tmp_path / "tools/wix/heat.exe"
assert wix.light_exe == tmp_path / "tools/wix/light.exe"
assert wix.candle_exe == tmp_path / "tools/wix/candle.exe"
# The WiX URL is resolvable
assert_url_resolvable(wix.download_url)
def test_dont_install(mock_tools, tmp_path):
"""If there's no existing managed WiX install, an install is not requested, verify
fails."""
# Mock the environment as if there is not WiX variable
mock_tools.os.environ.get.return_value = None
# Verify, but don't install. This will fail.
with pytest.raises(MissingToolError):
WiX.verify(mock_tools, install=False)
# The environment was queried.
mock_tools.os.environ.get.assert_called_with("WIX")
# No download was initiated
mock_tools.file.download.assert_not_called()
def test_download_fail(mock_tools, tmp_path):
"""If the download doesn't complete, the validator fails."""
# Mock the environment as if there is not WiX variable
mock_tools.os.environ.get.return_value = None
# Mock the download failure
mock_tools.file.download = MagicMock(side_effect=NetworkFailure("mock"))
# Verify the install. This will trigger a download
with pytest.raises(NetworkFailure, match="Unable to mock"):
WiX.verify(mock_tools)
# The environment was queried.
mock_tools.os.environ.get.assert_called_with("WIX")
# A download was initiated
mock_tools.file.download.assert_called_with(
url=WIX_DOWNLOAD_URL,
download_path=tmp_path / "tools",
role="WiX",
)
# ... but the unpack didn't happen
assert mock_tools.shutil.unpack_archive.call_count == 0
def test_unpack_fail(mock_tools, tmp_path):
"""If the download archive is corrupted, the validator fails."""
# Mock the environment as if there is not WiX variable
mock_tools.os.environ.get.return_value = None
# Mock the download
wix_path = tmp_path / "tools/wix"
wix_zip_path = create_zip_file(tmp_path / "tools/wix.zip", content=[("wix", "wix")])
mock_tools.file.download = MagicMock(return_value=wix_zip_path)
# Mock an unpack failure
mock_tools.shutil.unpack_archive.side_effect = EOFError
# Verify the install. This will trigger a download,
# but the unpack will fail
with pytest.raises(BriefcaseCommandError, match="interrupted or corrupted"):
WiX.verify(mock_tools)
# The environment was queried.
mock_tools.os.environ.get.assert_called_with("WIX")
# A download was initiated
mock_tools.file.download.assert_called_with(
url=WIX_DOWNLOAD_URL,
download_path=tmp_path / "tools",
role="WiX",
)
# The download was unpacked.
mock_tools.shutil.unpack_archive.assert_called_with(
filename=os.fsdecode(wix_zip_path), extract_dir=os.fsdecode(wix_path)
)
# The zip file was not removed
assert wix_zip_path.exists()
|
