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 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
|
import shutil
import subprocess
import sys
from unittest import mock
if sys.version_info >= (3, 11): # pragma: no-cover-if-lt-py311
import tomllib
else: # pragma: no-cover-if-gte-py311
import tomli as tomllib
import pytest
from briefcase.console import LogLevel
from briefcase.exceptions import BriefcaseCommandError, BriefcaseConfigError
from briefcase.integrations.subprocess import Subprocess
from briefcase.platforms.web.static import StaticWebBuildCommand
from ....utils import create_file, create_wheel
@pytest.fixture
def build_command(dummy_console, tmp_path):
command = StaticWebBuildCommand(
console=dummy_console,
base_path=tmp_path / "base_path",
data_path=tmp_path / "briefcase",
)
command.tools.subprocess = mock.MagicMock(spec_set=Subprocess)
command.tools.shutil = mock.MagicMock(spec_set=shutil)
return command
@pytest.mark.parametrize("logging_level", [LogLevel.INFO, LogLevel.DEEP_DEBUG])
def test_build_app(build_command, first_app_generated, logging_level, tmp_path):
"""An app can be built."""
# Configure logging level
build_command.console.verbosity = logging_level
bundle_path = tmp_path / "base_path/build/first-app/web/static"
# Invoking build will create wheels as a side effect.
def mock_run(*args, **kwargs):
if args[0][5] == "wheel":
create_wheel(
bundle_path / "www/static/wheels",
"first_app",
extra_content=[
("dependency/static/style.css", "span { margin: 10px; }\n"),
],
)
elif args[0][5] == "pip":
create_wheel(
bundle_path / "www/static/wheels",
"dependency",
extra_content=[
("dependency/static/style.css", "div { margin: 10px; }\n"),
],
)
create_wheel(
bundle_path / "www/static/wheels",
"other",
extra_content=[
("other/static/style.css", "div { padding: 10px; }\n"),
],
)
else:
raise ValueError("Unknown command")
build_command.tools.subprocess.run.side_effect = mock_run
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Build the web app.
build_command.build_app(first_app_generated)
# The old wheel folder was removed
build_command.tools.shutil.rmtree.assert_called_once_with(
bundle_path / "www/static/wheels"
)
# `wheel pack` and `pip wheel` was invoked
assert build_command.tools.subprocess.run.mock_calls == [
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"wheel",
"pack",
bundle_path / "app",
"--dest-dir",
bundle_path / "www/static/wheels",
],
check=True,
encoding="UTF-8",
),
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"wheel",
"--wheel-dir",
bundle_path / "www/static/wheels",
"-r",
bundle_path / "requirements.txt",
]
+ (["-vv"] if logging_level == LogLevel.DEEP_DEBUG else []),
check=True,
encoding="UTF-8",
),
]
# Pyscript.toml has been written
with (bundle_path / "www/pyscript.toml").open("rb") as f:
assert tomllib.load(f) == {
"existing-key-1": "value-1",
"existing-key-2": 2,
"packages": [
"/static/wheels/dependency-1.2.3-py3-none-any.whl",
"/static/wheels/first_app-1.2.3-py3-none-any.whl",
"/static/wheels/other-1.2.3-py3-none-any.whl",
],
}
# briefcase.css has been appended
with (bundle_path / "www/static/css/briefcase.css").open(encoding="utf-8") as f:
assert (
f.read()
== "\n".join(
[
"",
"#pyconsole {",
" display: None;",
"}",
"/*******************************************************************",
" ******************** Wheel contributed styles ********************/",
"",
"/*******************************************************",
" * dependency 1.2.3::style.css",
" *******************************************************/",
"",
"div { margin: 10px; }",
"",
"/*******************************************************",
" * first_app 1.2.3::style.css",
" *******************************************************/",
"",
"span { margin: 10px; }",
"",
"/*******************************************************",
" * other 1.2.3::style.css",
" *******************************************************/",
"",
"div { padding: 10px; }",
]
)
+ "\n"
)
def test_build_app_custom_pyscript_toml(build_command, first_app_generated, tmp_path):
"""An app with extra pyscript.toml content can be written."""
bundle_path = tmp_path / "base_path/build/first-app/web/static"
first_app_generated.extra_pyscript_toml_content = (
"\n".join(
[
# A custom top level key
'something = "custom"',
# A key overwriting something in the main namespace
'packages = ["something-custom"]',
# A table overwriting an existing value
"[splashscreen]",
"wiggle = false",
# A custom array of tables
"[[runtimes]]",
'src = "https://example.com/pyodide.js"',
]
)
+ "\n"
)
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Build the web app.
build_command.build_app(first_app_generated)
# Pyscript.toml has been written
with (bundle_path / "www/pyscript.toml").open("rb") as f:
assert tomllib.load(f) == {
"existing-key-1": "value-1",
"existing-key-2": 2,
"something": "custom",
"splashscreen": {"wiggle": False},
"packages": ["something-custom"],
"runtimes": [
{"src": "https://example.com/pyodide.js"},
],
}
def test_build_app_no_template_pyscript_toml(
build_command, first_app_generated, tmp_path
):
"""An app whose template doesn't provide pyscript.toml gets a basic config."""
# Remove the templated pyscript.toml
bundle_path = tmp_path / "base_path/build/first-app/web/static"
(bundle_path / "www/pyscript.toml").unlink()
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Build the web app.
build_command.build_app(first_app_generated)
# Pyscript.toml has been written with only the packages content
with (bundle_path / "www/pyscript.toml").open("rb") as f:
assert tomllib.load(f) == {
"packages": [],
}
def test_build_app_invalid_template_pyscript_toml(
build_command, first_app_generated, tmp_path
):
"""An app with an invalid pyscript.toml raises an error."""
# Re-write an invalid templated pyscript.toml
bundle_path = tmp_path / "base_path/build/first-app/web/static"
(bundle_path / "www/pyscript.toml").unlink()
create_file(
bundle_path / "www/pyscript.toml",
"""
This is not valid toml.
""",
)
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Building the web app raises an error
with pytest.raises(
BriefcaseConfigError,
match=r"Briefcase configuration error: pyscript.toml content isn't valid TOML: Expected",
):
build_command.build_app(first_app_generated)
def test_build_app_invalid_extra_pyscript_toml_content(
build_command, first_app_generated, tmp_path
):
"""An app with invalid extra pyscript.toml content raises an error."""
bundle_path = tmp_path / "base_path/build/first-app/web/static"
first_app_generated.extra_pyscript_toml_content = "This isn't toml"
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Building the web app raises an error
with pytest.raises(
BriefcaseConfigError,
match=r"Briefcase configuration error: Extra pyscript.toml content isn't valid TOML: Expected",
):
build_command.build_app(first_app_generated)
def test_build_app_missing_wheel_dir(build_command, first_app_generated, tmp_path):
"""If the template is corrupted, the wheels folder is still created."""
bundle_path = tmp_path / "base_path/build/first-app/web/static"
# Remove the wheels folder
shutil.rmtree(bundle_path / "www/static/wheels")
# Build the web app.
build_command.build_app(first_app_generated)
# No attempt was made to delete the folder
build_command.tools.shutil.rmtree.assert_not_called()
# `wheel pack` and `pip wheel` was invoked
assert build_command.tools.subprocess.run.mock_calls == [
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"wheel",
"pack",
bundle_path / "app",
"--dest-dir",
bundle_path / "www/static/wheels",
],
check=True,
encoding="UTF-8",
),
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"wheel",
"--wheel-dir",
bundle_path / "www/static/wheels",
"-r",
bundle_path / "requirements.txt",
],
check=True,
encoding="UTF-8",
),
]
# Wheels folder exists
assert (bundle_path / "www/static/wheels").is_dir()
# Pyscript.toml has been written
assert (bundle_path / "www/pyscript.toml").exists()
# briefcase.css has been appended
# (just check for existence; a full check is done in other tests)
assert (bundle_path / "www/static/css/briefcase.css").exists()
def test_build_app_no_requirements(build_command, first_app_generated, tmp_path):
"""An app with no requirements can be built."""
bundle_path = tmp_path / "base_path/build/first-app/web/static"
# Invoking build will create wheels as a side effect.
def mock_run(*args, **kwargs):
if args[0][5] == "wheel":
create_wheel(
bundle_path / "www/static/wheels",
"first_app",
extra_content=[
("dependency/static/style.css", "span { margin: 10px; }\n"),
],
)
elif args[0][5] == "pip":
pass
else:
raise ValueError("Unknown command")
build_command.tools.subprocess.run.side_effect = mock_run
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Build the web app.
build_command.build_app(first_app_generated)
# The old wheel folder was removed
build_command.tools.shutil.rmtree.assert_called_once_with(
bundle_path / "www/static/wheels"
)
# `wheel pack` and `pip wheel` was invoked
assert build_command.tools.subprocess.run.mock_calls == [
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"wheel",
"pack",
bundle_path / "app",
"--dest-dir",
bundle_path / "www/static/wheels",
],
check=True,
encoding="UTF-8",
),
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"wheel",
"--wheel-dir",
bundle_path / "www/static/wheels",
"-r",
bundle_path / "requirements.txt",
],
check=True,
encoding="UTF-8",
),
]
# Pyscript.toml has been written
with (bundle_path / "www/pyscript.toml").open("rb") as f:
assert tomllib.load(f) == {
"existing-key-1": "value-1",
"existing-key-2": 2,
"packages": [
"/static/wheels/first_app-1.2.3-py3-none-any.whl",
],
}
# briefcase.css has been appended
with (bundle_path / "www/static/css/briefcase.css").open(encoding="utf-8") as f:
assert (
f.read()
== "\n".join(
[
"",
"#pyconsole {",
" display: None;",
"}",
"/*******************************************************************",
" ******************** Wheel contributed styles ********************/",
"",
"/*******************************************************",
" * first_app 1.2.3::style.css",
" *******************************************************/",
"",
"span { margin: 10px; }",
]
)
+ "\n"
)
def test_app_package_fail(build_command, first_app_generated, tmp_path):
"""If the app can't be packaged as a wheel,an error is raised."""
bundle_path = tmp_path / "base_path/build/first-app/web/static"
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Mock the side effect of a successful package build, but failure
# downloading requirements
build_command.tools.subprocess.run.side_effect = [
subprocess.CalledProcessError(cmd=["wheel"], returncode=1),
]
# Build the web app.
with pytest.raises(
BriefcaseCommandError,
match=r"Unable to build wheel for app 'first-app'",
):
build_command.build_app(first_app_generated)
# The old wheel folder was removed
build_command.tools.shutil.rmtree.assert_called_once_with(
bundle_path / "www/static/wheels"
)
# `wheel pack` was invoked
assert build_command.tools.subprocess.run.mock_calls == [
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"wheel",
"pack",
bundle_path / "app",
"--dest-dir",
bundle_path / "www/static/wheels",
],
check=True,
encoding="UTF-8",
),
]
# Wheels folder still exists
assert (bundle_path / "www/static/wheels").is_dir()
# Pyscript.toml content has not changed
with (bundle_path / "www/pyscript.toml").open("rb") as f:
assert tomllib.load(f) == {
"existing-key-1": "value-1",
"existing-key-2": 2,
}
def test_dependency_fail(build_command, first_app_generated, tmp_path):
"""If dependencies can't be downloaded, an error is raised."""
bundle_path = tmp_path / "base_path/build/first-app/web/static"
# Mock the side effect of invoking shutil
build_command.tools.shutil.rmtree.side_effect = lambda *args: shutil.rmtree(
bundle_path / "www/static/wheels"
)
# Mock the side effect of a successful package build, but failure
# downloading requirements
build_command.tools.subprocess.run.side_effect = [
None,
subprocess.CalledProcessError(cmd=["pip", "wheel"], returncode=1),
]
# Build the web app.
with pytest.raises(
BriefcaseCommandError,
match=r"Unable to install requirements for app 'first-app'",
):
build_command.build_app(first_app_generated)
# The old wheel folder was removed
build_command.tools.shutil.rmtree.assert_called_once_with(
bundle_path / "www/static/wheels"
)
# `wheel pack` and `pip wheel` was invoked
assert build_command.tools.subprocess.run.mock_calls == [
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"wheel",
"pack",
bundle_path / "app",
"--dest-dir",
bundle_path / "www/static/wheels",
],
check=True,
encoding="UTF-8",
),
mock.call(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"wheel",
"--wheel-dir",
bundle_path / "www/static/wheels",
"-r",
bundle_path / "requirements.txt",
],
check=True,
encoding="UTF-8",
),
]
# Wheels folder still exists
assert (bundle_path / "www/static/wheels").is_dir()
# Pyscript.toml content has not changed
with (bundle_path / "www/pyscript.toml").open("rb") as f:
assert tomllib.load(f) == {
"existing-key-1": "value-1",
"existing-key-2": 2,
}
|