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 484 485 486 487 488 489 490 491 492 493 494 495 496
|
import os
import shutil
import sys
from unittest import mock
import httpx
import pytest
from briefcase.exceptions import (
InvalidSupportPackage,
MissingNetworkResourceError,
MissingSupportPackage,
NetworkFailure,
)
from ...utils import (
create_zip_file,
mock_file_download,
mock_tgz_download,
mock_zip_download,
)
def test_install_app_support_package(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""A support package can be downloaded and unpacked where it is needed."""
# Mock download.file to return a support package
create_command.tools.file.download = mock.MagicMock(
side_effect=mock_tgz_download(
"Python-3.X-tester-support.b37.tar.gz",
[("internal/file.txt", "hello world")],
)
)
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock(spec_set=shutil)
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# Confirm the right URL was used
create_command.tools.file.download.assert_called_with(
download_path=create_command.data_path / "support",
url="https://briefcase-support.s3.amazonaws.com/python/3.X/Tester/Python-3.X-Tester-support.b37.tar.gz",
role="support package",
)
# Confirm the right file was unpacked
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=tmp_path / "data/support/Python-3.X-tester-support.b37.tar.gz",
extract_dir=support_path,
**({"filter": "data"} if sys.version_info >= (3, 12) else {}),
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
def test_install_pinned_app_support_package(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""A pinned support package can be downloaded and unpacked where it is needed."""
# Pin the support revision
myapp.support_revision = "42"
# Mock download.file to return a support package
create_command.tools.file.download = mock.MagicMock(
side_effect=mock_tgz_download(
"Python-3.X-Tester-support.b42.tar.gz",
[("internal/file.txt", "hello world")],
)
)
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock(spec_set=shutil)
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# Confirm the right URL was used
create_command.tools.file.download.assert_called_with(
download_path=create_command.data_path / "support",
url="https://briefcase-support.s3.amazonaws.com/python/3.X/Tester/Python-3.X-Tester-support.b42.tar.gz",
role="support package",
)
# Confirm the right file was unpacked
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=tmp_path / "data/support/Python-3.X-Tester-support.b42.tar.gz",
extract_dir=support_path,
**({"filter": "data"} if sys.version_info >= (3, 12) else {}),
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
def test_install_custom_app_support_package_file(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""A custom support package can be specified as a local file."""
# Provide an app-specific override of the package URL
myapp.support_package = os.fsdecode(tmp_path / "custom/support.zip")
# Write a temporary support zip file
support_file = create_zip_file(
tmp_path / "custom/support.zip",
[("internal/file.txt", "hello world")],
)
# Modify download.file to return the temp zipfile
create_command.tools.file.download = mock.MagicMock()
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock(spec_set=shutil)
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# There should have been no download attempt,
# as the resource is local.
create_command.tools.file.download.assert_not_called()
# Confirm the right file was unpacked
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=support_file,
extract_dir=support_path,
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
def test_install_custom_app_support_package_file_with_revision(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
capsys,
):
"""If a custom support package file also specifies a revision, the revision is
ignored with a warning."""
# Provide an app-specific override of the package URL
myapp.support_package = os.fsdecode(tmp_path / "custom/support.zip")
myapp.support_revision = "42"
# Write a temporary support zip file
support_file = create_zip_file(
tmp_path / "custom/support.zip",
[("internal/file.txt", "hello world")],
)
# Modify download.file to return the temp zipfile
create_command.tools.file.download = mock.MagicMock()
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock()
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# There should have been no download attempt,
# as the resource is local.
create_command.tools.file.download.assert_not_called()
# Confirm the right file was unpacked
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=support_file,
extract_dir=support_path,
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
# A warning about the support revision was generated.
assert "support revision will be ignored." in capsys.readouterr().out
def test_support_package_url_with_invalid_custom_support_package_url(
create_command,
myapp,
app_requirements_path_index,
):
"""Invalid URL for a custom support package raises MissingNetworkResourceError."""
# Provide an custom support URL
url = "https://example.com/custom/support.zip"
myapp.support_package = url
# Modify download.file to raise an exception
create_command.tools.file.download = mock.MagicMock(
side_effect=MissingNetworkResourceError(url)
)
# The bad URL should raise a MissingNetworkResourceError
with pytest.raises(MissingNetworkResourceError):
create_command.install_app_support_package(myapp)
# However, there will have been a download attempt
create_command.tools.file.download.assert_called_with(
download_path=(
create_command.data_path
/ "support"
/ "55441abbffa311f65622df45a943afc347a21ab40e8dcec79472c92ef467db24"
),
url=url,
role="support package",
)
def test_support_package_url_with_unsupported_platform(
create_command,
myapp,
app_requirements_path_index,
):
"""An unsupported platform raises MissingSupportPackage."""
# Modify download.file to raise an exception due to missing support package
create_command.tools.file.download = mock.MagicMock(
side_effect=MissingNetworkResourceError(
url="https://briefcase-support.s3.amazonaws.com/python/3.X/Tester/Python-3.X-Tester-support.b37.tar.gz",
)
)
# The unknown platform should cause a missing support package error
with pytest.raises(MissingSupportPackage):
create_command.install_app_support_package(myapp)
# However, there will have been a download attempt
create_command.tools.file.download.assert_called_with(
download_path=create_command.data_path / "support",
url="https://briefcase-support.s3.amazonaws.com/python/3.X/Tester/Python-3.X-Tester-support.b37.tar.gz",
role="support package",
)
def test_install_custom_app_support_package_url(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""A custom support package can be specified as URL."""
# Provide an app-specific override of the package URL
myapp.support_package = "https://example.com/custom/custom-support.zip"
# Mock download.file to return a support package
create_command.tools.file.download = mock.MagicMock(
side_effect=mock_zip_download(
"custom-support.zip",
[("internal/file.txt", "hello world")],
)
)
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock(spec_set=shutil)
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# Confirm the right URL and download path was used
create_command.tools.file.download.assert_called_with(
download_path=(
create_command.data_path
/ "support"
/ "1d3ac0e09eb22abc63c4e7b699b6ab5d58e277015eeae61070e3f9f11512e6b3"
),
url="https://example.com/custom/custom-support.zip",
role="support package",
)
# Confirm the right file was unpacked into the hashed location
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=tmp_path
/ "data"
/ "support"
/ "1d3ac0e09eb22abc63c4e7b699b6ab5d58e277015eeae61070e3f9f11512e6b3"
/ "custom-support.zip",
extract_dir=support_path,
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
def test_install_custom_app_support_package_url_with_revision(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
capsys,
):
"""If a custom support package URL also specifies a revision, the revision is
ignored with a warning."""
# Provide an app-specific override of the package URL and revision
myapp.support_package = "https://example.com/custom/custom-support.zip"
myapp.support_revision = "42"
# Mock download.file to return a support package
create_command.tools.file.download = mock.MagicMock(
side_effect=mock_zip_download(
"custom-support.zip",
[("internal/file.txt", "hello world")],
)
)
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock(spec_set=shutil)
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# Confirm the right URL and download path was used
create_command.tools.file.download.assert_called_with(
download_path=(
create_command.data_path
/ "support"
/ "1d3ac0e09eb22abc63c4e7b699b6ab5d58e277015eeae61070e3f9f11512e6b3"
),
url="https://example.com/custom/custom-support.zip",
role="support package",
)
# Confirm the right file was unpacked into the hashed location
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=tmp_path
/ "data"
/ "support"
/ "1d3ac0e09eb22abc63c4e7b699b6ab5d58e277015eeae61070e3f9f11512e6b3"
/ "custom-support.zip",
extract_dir=support_path,
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
# A warning about the support revision was generated.
assert "support revision will be ignored." in capsys.readouterr().out
def test_install_custom_app_support_package_url_with_args(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""A custom support package can be specified as URL with args."""
# Provide an app-specific override of the package URL
myapp.support_package = "https://example.com/custom/custom-support.zip?cool=Yes"
# Mock download.file to return a support package
create_command.tools.file.download = mock.MagicMock(
side_effect=mock_zip_download(
"custom-support.zip",
[("internal/file.txt", "hello world")],
)
)
# Mock shutil so we can confirm that unpack is called,
# but we still want the side effect of calling it
create_command.tools.shutil = mock.MagicMock(spec_set=shutil)
create_command.tools.shutil.unpack_archive.side_effect = shutil.unpack_archive
# Install the support package
create_command.install_app_support_package(myapp)
# Confirm the right URL was used
create_command.tools.file.download.assert_called_with(
download_path=create_command.data_path
/ "support"
/ "f8cf64ad2ba249a1efbb63db60ebdc64f043035fbdd81934c6ad1e84a030c429",
url="https://example.com/custom/custom-support.zip?cool=Yes",
role="support package",
)
# Confirm the right file was unpacked
create_command.tools.shutil.unpack_archive.assert_called_with(
filename=tmp_path
/ "data"
/ "support"
/ "f8cf64ad2ba249a1efbb63db60ebdc64f043035fbdd81934c6ad1e84a030c429"
/ "custom-support.zip",
extract_dir=support_path,
)
# Confirm that the full path to the support file
# has been unpacked.
assert (support_path / "internal/file.txt").exists()
def test_offline_install(
create_command,
myapp,
support_path,
app_requirements_path_index,
):
"""If the computer is offline, an error is raised."""
stream_mock = create_command.tools.httpx.stream = mock.MagicMock()
stream_mock.return_value.__enter__.side_effect = httpx.TransportError(
"Unstable connection"
)
# Installing while offline raises an error
with pytest.raises(NetworkFailure):
create_command.install_app_support_package(myapp)
def test_invalid_support_package(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""If the support package isn't a valid zipfile, an error is raised."""
# Mock download.file to return a non-zip file
create_command.tools.file.download = mock.MagicMock(
side_effect=mock_file_download(
"not-a.zip",
"This isn't a zip file",
)
)
# Installing the bad support package raises an error
with pytest.raises(InvalidSupportPackage):
create_command.install_app_support_package(myapp)
def test_missing_support_package(
create_command,
myapp,
tmp_path,
support_path,
app_requirements_path_index,
):
"""If the path provided for the support package is bad, an error is raised."""
# Set a custom support package that doesn't exist
myapp.support_package = "/path/does/not/exist.zip"
# Installing the bad support package raises an error
with pytest.raises(InvalidSupportPackage):
create_command.install_app_support_package(myapp)
def test_no_support_path(create_command, myapp, no_support_path_index):
"""If support_path is not listed in briefcase.toml, a support package will not be
downloaded."""
create_command.tools.file.download = mock.MagicMock()
create_command.install_app_support_package(myapp)
create_command.tools.file.download.assert_not_called()
def test_no_support_revision(create_command, myapp, no_support_revision_index):
"""If support_revision is not listed in briefcase.toml, a support package will not
be downloaded."""
create_command.tools.file.download = mock.MagicMock()
# An error is raised when attempting to install the support package
with pytest.raises(MissingSupportPackage):
create_command.install_app_support_package(myapp)
# No download attempt is made.
create_command.tools.file.download.assert_not_called()
|