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 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
|
import os
import platform
import subprocess
from datetime import date
from unittest import mock
import pytest
from cookiecutter import exceptions as cookiecutter_exceptions
from git import exc as git_exceptions
import briefcase
from briefcase.exceptions import (
BriefcaseCommandError,
BriefcaseConfigError,
InvalidTemplateBranch,
NetworkFailure,
)
@pytest.fixture
def full_context():
return {
"format": "dummy",
"app_name": "my-app",
"formal_name": "My App",
"bundle": "com.example",
"bundle_identifier": "com.example.my-app",
"version": "1.2.3",
"description": "This is a simple app",
"long_description": None,
"sources": ["src/my_app"],
"test_sources": None,
"test_requires": None,
"url": "https://example.com",
"author": "First Last",
"author_email": "first@example.com",
"requires": None,
"icon": None,
"supported": True,
"console_app": False,
"permissions": {},
"custom_permissions": {},
"requests": {},
"document_types": {},
"license": {"file": "LICENSE"},
"requirement_installer_args": [],
# Properties of the generating environment
"python_version": platform.python_version(),
"host_arch": "gothic",
"briefcase_version": briefcase.__version__,
# Properties of the template
"template_source": "https://github.com/beeware/briefcase-Tester-Dummy-template.git",
"template_branch": f"v{briefcase.__version__}",
# Fields generated from other properties
"module_name": "my_app",
"class_name": "MyApp",
"package_name": "com.example",
# Date-based fields added at time of generation
"year": date.today().strftime("%Y"),
"month": date.today().strftime("%B"),
# Fields added by the output format.
"output_format": "dummy",
# These tests don't do a full finalization, so the context will still be
# marked as draft.
"__draft__": True,
}
@pytest.mark.parametrize(
"briefcase_version, expected_branch",
[
("37.42.1", "v37.42.1"),
("37.42.2.dev0+gad61a29.d20220919", "v37.42.2"),
("37.42.3.dev73+gad61a29.d20220919", "v37.42.3"),
("37.42.4a1", "v37.42.4"),
("37.42.5b2", "v37.42.5"),
("37.42.6rc3", "v37.42.6"),
("37.42.7.post1", "v37.42.7"),
],
)
def test_default_template(
monkeypatch,
create_command,
myapp,
full_context,
briefcase_version,
expected_branch,
tmp_path,
):
"""Absent of other information, the briefcase version (without suffixes) is used as
the template branch."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", briefcase_version)
full_context["briefcase_version"] = briefcase_version
full_context["template_branch"] = expected_branch
# There won't be a cookiecutter cache, so there won't be a cache path (yet).
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout=expected_branch,
output_dir=str(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
@pytest.mark.parametrize(
"briefcase_version,template_branch",
[
("37.42.7.dev0+gad61a29.d20220919", "v37.42.7"),
("37.42.7.dev73+gad61a29.d20220919", "v37.42.7"),
],
)
def test_default_template_dev(
monkeypatch,
create_command,
myapp,
full_context,
briefcase_version,
template_branch,
tmp_path,
):
"""In a dev version, template will fall back to the 'main' branch if a versioned
template doesn't exist."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", briefcase_version)
full_context["briefcase_version"] = briefcase_version
full_context["template_branch"] = template_branch
full_context2 = full_context.copy()
full_context2["template_branch"] = "main"
# There won't be a cookiecutter cache, so there won't be a cache path (yet).
# There will be two calls to cookiecutter; one on the versioned branch,
# and one on the `main` branch. The first call will fail because the
# template doesn't exist yet; the second will succeed.
create_command.tools.cookiecutter.side_effect = [
cookiecutter_exceptions.RepositoryCloneFailed,
None,
]
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
assert create_command.tools.cookiecutter.mock_calls == [
mock.call(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
),
mock.call(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="main",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context2,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
),
]
@pytest.mark.parametrize(
"briefcase_version",
("37.42.7.dev0+gad61a29.d20220919", "37.42.7.dev73+gad61a29.d20220919"),
)
def test_default_template_dev_explicit_branch(
monkeypatch,
create_command,
myapp,
full_context,
briefcase_version,
tmp_path,
):
"""In a dev version, if an explicit branch is provided, it is used."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", briefcase_version)
full_context["briefcase_version"] = briefcase_version
# Set an explicit branch
branch = "some_branch"
myapp.template_branch = branch
full_context["template_branch"] = branch
# There won't be a cookiecutter cache, so there won't be
# a cache path (yet).
create_command.tools.git.Repo.side_effect = git_exceptions.NoSuchPathError
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked (once) with the expected template name and context.
assert create_command.tools.cookiecutter.mock_calls == [
mock.call(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout=branch,
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
),
]
@pytest.mark.parametrize(
"briefcase_version",
("37.42.7.dev0+gad61a29.d20220919", "37.42.7.dev73+gad61a29.d20220919"),
)
def test_default_template_dev_explicit_invalid_branch(
monkeypatch,
create_command,
myapp,
full_context,
briefcase_version,
tmp_path,
):
"""In a dev version, if an explicit (but invalid) branch is provided, the fallback
to the 'main' branch will not occur."""
# Set the Briefcase version to a dev version
monkeypatch.setattr(briefcase, "__version__", briefcase_version)
full_context["briefcase_version"] = briefcase_version
# Set an explicit branch
branch = "some_branch"
myapp.template_branch = branch
full_context["template_branch"] = branch
# There won't be a cookiecutter cache, so there won't be
# a cache path (yet).
create_command.tools.git.Repo.side_effect = git_exceptions.NoSuchPathError
# There will be only 1 call to cookiecutter; the one on the versioned branch.
create_command.tools.cookiecutter.side_effect = (
cookiecutter_exceptions.RepositoryCloneFailed
)
# Generate the template.
with pytest.raises(InvalidTemplateBranch):
create_command.generate_app_template(myapp)
# Cookiecutter was invoked (once) with the expected template name and context.
assert create_command.tools.cookiecutter.mock_calls == [
mock.call(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout=branch,
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
),
]
def test_explicit_branch(monkeypatch, create_command, myapp, full_context, tmp_path):
"""User can choose which branch to take the template from."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
# Set an explicit branch
branch = "some_branch"
myapp.template_branch = branch
full_context["template_branch"] = branch
# There won't be a cookiecutter cache, so there won't be
# a cache path (yet).
create_command.tools.git.Repo.side_effect = git_exceptions.NoSuchPathError
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout=branch,
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_platform_exists(monkeypatch, create_command, myapp, full_context, tmp_path):
"""If the platform directory already exists, it's ok."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
# There won't be a cookiecutter cache, so there won't be
# a cache path (yet).
create_command.tools.git.Repo.side_effect = git_exceptions.NoSuchPathError
# Create the build directory
create_command.build_path(myapp).mkdir(parents=True)
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_explicit_repo_template(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
"""If a template is specified in the app config, it is used."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
template = "https://example.com/magic/special-template.git"
myapp.template = template
full_context["template_source"] = template
# There won't be a cookiecutter cache, so there won't be a repo path (yet).
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/special-template"),
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_explicit_repo_template_and_branch(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
"""If a template and branch is specified in the app config, it is used."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
# Set an explicit template and branch
template = "https://example.com/magic/special-template.git"
myapp.template = template
full_context["template_source"] = template
branch = "some_branch"
myapp.template_branch = branch
full_context["template_branch"] = branch
# There won't be a cookiecutter cache, so there won't be a repo path (yet).
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/special-template"),
no_input=True,
checkout=branch,
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_explicit_local_template(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
"""If a local template path is specified in the app config, it is used."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
template = "/path/to/special-template"
myapp.template = template
full_context["template_source"] = template
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
"/path/to/special-template",
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
# The template is a local directory, so there won't be any calls on git.
assert create_command.tools.git.Repo.call_count == 0
def test_explicit_local_template_and_branch(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
"""If a local template path and branch is specified in the app config, it is
used."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
template = "/path/to/special-template"
myapp.template = template
full_context["template_source"] = template
branch = "some_branch"
myapp.template_branch = branch
full_context["template_branch"] = branch
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
"/path/to/special-template",
no_input=True,
checkout=branch,
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
# The template is a local directory, so there won't be any calls on git.
assert create_command.tools.git.Repo.call_count == 0
def test_offline_repo_template(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
"""If the user is offline the first time a repo template is requested, an error is
raised."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
# There won't be a cookiecutter cache, so there won't be a repo path (yet).
# Calling cookiecutter on a repository while offline causes a CalledProcessError
create_command.tools.cookiecutter.side_effect = subprocess.CalledProcessError(
cmd=[
"git",
"clone",
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
],
returncode=128,
)
# Generating the template under these conditions raises an error
with pytest.raises(NetworkFailure):
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_invalid_repo_template(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
"""If the provided template URL isn't valid, an error is raised."""
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
template = "https://example.com/somewhere/not-a-repo.git"
myapp.template = template
full_context["template_source"] = template
# Prime git to respond to a bad URL.
create_command.tools.git.Repo.clone_from.side_effect = (
git_exceptions.GitCommandError("git", 128)
)
# Generating the template under there conditions raises an error
with pytest.raises(BriefcaseCommandError, match=r"..."):
create_command.generate_app_template(myapp)
# No attempt is made to create a template.
create_command.tools.cookiecutter.assert_not_called()
def test_cached_template(monkeypatch, create_command, myapp, full_context, tmp_path):
"""If a template has already been used, the cached version will be used."""
# Set up a pre-cached template directory
(create_command.data_path / "templates/briefcase-Tester-Dummy-template").mkdir(
parents=True
)
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
mock_repo = mock.MagicMock()
mock_remote = mock.MagicMock()
mock_remote_head = mock.MagicMock()
# Git returns a Repo, that repo can return a remote, and it has
# heads that can be accessed.
create_command.tools.git.Repo.return_value = mock_repo
mock_repo.remote.return_value = mock_remote
mock_remote.refs.__getitem__.return_value = mock_remote_head
# Generate the template.
create_command.generate_app_template(myapp)
# The origin of the repo was fetched
mock_repo.remote.assert_called_once_with(name="origin")
mock_remote.fetch.assert_called_once_with()
# The remote head was checked out.
mock_remote_head.checkout.assert_called_once_with()
# Cookiecutter was invoked with the path to the *cached* template name
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_cached_template_offline(
monkeypatch,
create_command,
myapp,
full_context,
capsys,
tmp_path,
):
"""If the user is offline, a cached template won't be updated, but will still
work."""
# Set up a pre-cached template directory
(create_command.data_path / "templates/briefcase-Tester-Dummy-template").mkdir(
parents=True
)
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
mock_repo = mock.MagicMock()
mock_remote = mock.MagicMock()
mock_remote_head = mock.MagicMock()
# Git returns a Repo, that repo can return a remote, and it has
# heads that can be accessed. However, calling fetch on the remote
# will cause a git error (error code 128).
create_command.tools.git.Repo.return_value = mock_repo
mock_repo.remote.return_value = mock_remote
mock_remote.refs.__getitem__.return_value = mock_remote_head
mock_remote.fetch.side_effect = git_exceptions.GitCommandError("git", 128)
# Generate the template.
create_command.generate_app_template(myapp)
# An attempt to fetch the repo origin was made
mock_repo.remote.assert_called_once_with(name="origin")
mock_remote.fetch.assert_called_once_with()
# A warning was raised to the user about the fetch problem
output = capsys.readouterr().out
assert "** WARNING: Unable to update template" in output
# The remote head was checked out.
mock_remote_head.checkout.assert_called_once_with()
# Cookiecutter was invoked with the path to the *cached* template name
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="v37.42.7",
output_dir=str(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_cached_missing_branch_template(monkeypatch, create_command, myapp):
"""If the cached repo doesn't have a branch for this Briefcase version, an error is
raised."""
# Set up a pre-cached template directory
(create_command.data_path / "templates/briefcase-Tester-Dummy-template").mkdir(
parents=True
)
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
mock_repo = mock.MagicMock()
mock_remote = mock.MagicMock()
# Git returns a Repo, that repo can return a remote. However, it doesn't
# have a head corresponding to the requested Python version, so it
# raises an IndexError
create_command.tools.git.Repo.return_value = mock_repo
mock_repo.remote.return_value = mock_remote
mock_remote.refs.__getitem__.side_effect = IndexError
# Generating the template under there conditions raises an error
with pytest.raises(InvalidTemplateBranch):
create_command.generate_app_template(myapp)
def test_x_permissions(
monkeypatch,
create_command,
myapp,
full_context,
tmp_path,
):
# Set the Briefcase version
monkeypatch.setattr(briefcase, "__version__", "37.42.7")
full_context["briefcase_version"] = "37.42.7"
full_context["template_branch"] = "v37.42.7"
# Define some permissions and requests. The original "permission" and "request"
# definitions will be hidden from the final template context.
myapp.permission = {
# Cross-platform permissions
"camera": "I need to see you",
"microphone": "I need to hear you",
"coarse_location": "I need to know approximately where you are",
"fine_location": "I need to know exactly where you are",
"background_location": "I need to know where you are constantly",
"photo_library": "I need to see your photos",
# Custom permissions
"DUMMY_sit": "I can't sit without an invitation",
"DUMMY.leave.the.dinner.table": "It would be impolite.",
}
myapp.request = {"tasty.beverage": True}
# In the final context, all cross-platform permissions have been converted to upper
# case, prefixed with "DUMMY", and moved to the `permissions` key. Custom
# permissions have been moved to the "custom_permissions" key
full_context["permissions"] = {
"DUMMY_CAMERA": "I NEED TO SEE YOU",
"DUMMY_MICROPHONE": "I NEED TO HEAR YOU",
"DUMMY_COARSE_LOCATION": "I NEED TO KNOW APPROXIMATELY WHERE YOU ARE",
"DUMMY_FINE_LOCATION": "I NEED TO KNOW EXACTLY WHERE YOU ARE",
"DUMMY_BACKGROUND_LOCATION": "I NEED TO KNOW WHERE YOU ARE CONSTANTLY",
"DUMMY_PHOTO_LIBRARY": "I NEED TO SEE YOUR PHOTOS",
}
full_context["custom_permissions"] = {
"DUMMY_sit": "I can't sit without an invitation",
"DUMMY.leave.the.dinner.table": "It would be impolite.",
}
# An extra request has been added because of the camera permission, and the
# custom request has been preserved.
full_context["requests"] = {
"good.lighting": True,
"tasty.beverage": True,
}
# There won't be a cookiecutter cache, so there won't be
# a cache path (yet).
create_command.tools.git.Repo.side_effect = git_exceptions.NoSuchPathError
# Generate the template.
create_command.generate_app_template(myapp)
# Cookiecutter was invoked with the expected template name and context.
create_command.tools.cookiecutter.assert_called_once_with(
str(create_command.data_path / "templates/briefcase-Tester-Dummy-template"),
no_input=True,
checkout="v37.42.7",
output_dir=os.fsdecode(tmp_path / "base_path/build/my-app/tester"),
extra_context=full_context,
default_config={"replay_dir": str(tmp_path / "data/templates/.replay")},
)
def test_cookiecutter_undefined_variable_in_template(
myapp,
create_command,
):
"""If the cookiecutter template has an undefined variable, a breifcase configuration
error is raised."""
cookiecutter_exception_message = "undefined document type"
create_command.tools.cookiecutter.side_effect = (
cookiecutter_exceptions.UndefinedVariableInTemplate(
cookiecutter_exception_message, "error", "context"
)
)
with pytest.raises(
BriefcaseConfigError,
match=f"Briefcase configuration error: {cookiecutter_exception_message}",
):
# Generating the template with an undefined cookiecutter variable generates an error
create_command.generate_app_template(myapp)
|