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 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
|
import datetime
import os
import subprocess
import sys
from unittest import mock
import pytest
import tomli_w
import briefcase
from briefcase.commands.create import _is_local_path
from briefcase.console import LogLevel
from briefcase.exceptions import BriefcaseCommandError, RequirementsInstallError
from briefcase.integrations.subprocess import Subprocess
GENERATED_DATETIME = "# Generated 2024-05-02 12:00:00.000500"
@pytest.fixture
def create_command(create_command, myapp):
# mock subprocess app context for this app
create_command.tools[myapp].app_context = mock.MagicMock(spec_set=Subprocess)
return create_command
@pytest.fixture
def mock_now(monkeypatch):
"""Monkeypatch the ``datetime.now`` inside ``briefcase.commands.create``.
When this fixture is used, the datetime is locked to 2024 May 2 @ 12:00:00:000500.
"""
now = datetime.datetime(2024, 5, 2, 12, 0, 0, 500)
datetime_mock = mock.MagicMock(wraps=datetime.datetime)
datetime_mock.now.return_value = now
monkeypatch.setattr(briefcase.commands.create, "datetime", datetime_mock)
return now
def create_installation_artefacts(app_packages_path, packages):
"""Utility method for generating a function that will mock installation artefacts.
Creates a function that when invoked, creates a dummy ``__init__.py``
and ``__main__.py`` for each package named in ``packages``.
:param app_packages_path: The pathlib object where app packages will be installed
:param packages: A list of package names to mock.
:returns: A function that will create files to mock the named installed packages.
"""
def _create_installation_artefacts(*args, **kwargs):
for package in packages:
package_path = app_packages_path / package
package_path.mkdir(parents=True)
with (package_path / "__init__.py").open("w", encoding="utf-8") as f:
f.write("")
with (package_path / "__main__.py").open("w", encoding="utf-8") as f:
f.write('print("I am {package}")')
return _create_installation_artefacts
def test_bad_path_index(create_command, myapp, bundle_path, app_requirements_path):
"""If the app's path index doesn't declare a destination for requirements, an error
is raised."""
# Write a briefcase.toml that is missing app_packages_path and app_requirements_path
with (bundle_path / "briefcase.toml").open("wb") as f:
index = {
"paths": {
"app_path": "path/to/app",
"support_path": "path/to/support",
}
}
tomli_w.dump(index, f)
# Set up requirements for the app
myapp.requires = ["first", "second", "third"]
# Install requirements
with pytest.raises(
BriefcaseCommandError,
match=r"Application path index file does not define `app_requirements_path` or `app_packages_path`",
):
create_command.install_app_requirements(myapp, test_mode=False)
# pip wasn't invoked
create_command.tools[myapp].app_context.run.assert_not_called()
# requirements.txt doesn't exist either
assert not app_requirements_path.exists()
# Original app definitions haven't changed
assert myapp.requires == ["first", "second", "third"]
assert myapp.test_requires is None
def test_app_packages_no_requires(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app has no requirements, install_app_requirements is a no-op."""
myapp.requires = None
create_command.install_app_requirements(myapp, test_mode=False)
# No request was made to install requirements
create_command.tools[myapp].app_context.run.assert_not_called()
def test_app_packages_empty_requires(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app has an empty requirements list, install_app_requirements is a no-op."""
myapp.requires = []
create_command.install_app_requirements(myapp, test_mode=False)
# No request was made to install requirements
create_command.tools[myapp].app_context.run.assert_not_called()
def test_app_packages_valid_requires(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app has a valid list of requirements, pip is invoked."""
myapp.requires = ["first", "second==1.2.3", "third>=3.2.1"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"first",
"second==1.2.3",
"third>=3.2.1",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires == ["first", "second==1.2.3", "third>=3.2.1"]
assert myapp.test_requires is None
def test_app_packages_requirement_installer_args_no_paths(
create_command,
myapp,
app_packages_path,
app_path,
app_packages_path_index,
):
"""If an app has requirement installer arguments, they are used in pip install."""
(create_command.base_path / "packages").mkdir(exist_ok=True)
myapp.requirement_installer_args = ["--no-cache"]
myapp.requires = ["package"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"--no-cache",
"package",
],
check=True,
encoding="UTF-8",
)
def test_app_packages_requirement_installer_args_path_transformed(
create_command,
myapp,
app_packages_path,
app_path,
app_packages_path_index,
):
"""If an app's requirement installer arguments includes a relative path that exists,
it is transformed to an absolute path."""
(create_command.base_path / "packages").mkdir(exist_ok=True)
myapp.requirement_installer_args = ["--extra-index-url", "./packages"]
myapp.requires = ["package"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"--extra-index-url",
os.path.abspath(create_command.base_path / "packages"),
"package",
],
check=True,
encoding="UTF-8",
)
def test_app_packages_requirement_installer_args_coincidental_path_not_transformed(
create_command,
myapp,
app_packages_path,
app_path,
app_packages_path_index,
):
"""If an app's requirement installer arguments includes a path that exists,
but it starts with `-`, it is used as-is."""
(create_command.base_path / "-f" / "wheels").mkdir(parents=True, exist_ok=True)
myapp.requirement_installer_args = ["-f./wheels"]
myapp.requires = ["package"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"-f./wheels",
"package",
],
check=True,
encoding="UTF-8",
)
def test_app_packages_requirement_installer_args_path_not_transformed(
create_command,
myapp,
app_packages_path,
app_path,
app_packages_path_index,
):
"""If an app's requirement installer arguments have an argument that looks like a local path,
but does not resolve to an existing path, it is used as-is."""
(create_command.base_path / "packages").unlink(missing_ok=True)
myapp.requirement_installer_args = ["--extra-index-url", "./packages"]
myapp.requires = ["package"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"--extra-index-url",
"./packages",
"package",
],
check=True,
encoding="UTF-8",
)
def test_app_packages_requirement_installer_args_combined_argument_not_transformed(
create_command,
myapp,
app_packages_path,
app_path,
app_packages_path_index,
):
"""If an app's requirement installer arguments use a combined argument,
paths are not modified."""
(create_command.base_path / "packages").mkdir(exist_ok=True)
myapp.requirement_installer_args = ["--extra-index-url=./packages"]
myapp.requires = ["package"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"--extra-index-url=./packages",
"package",
],
check=True,
encoding="UTF-8",
)
def test_app_packages_valid_requires_no_support_package(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If the template doesn't specify a support package, the cross-platform site isn't
specified."""
myapp.requires = ["first", "second==1.2.3", "third>=3.2.1"]
# Override the cache of paths to specify an app packages path, but no support package path
create_command._briefcase_toml[myapp] = {
"paths": {"app_packages_path": "path/to/app_packages"}
}
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"first",
"second==1.2.3",
"third>=3.2.1",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires == ["first", "second==1.2.3", "third>=3.2.1"]
assert myapp.test_requires is None
def test_app_packages_invalid_requires(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app has a valid list of requirements, pip is invoked."""
myapp.requires = ["does-not-exist"]
# Unfortunately, no way to tell the difference between "offline" and
# "your requirements are invalid"; pip returns status code 1 for all
# failures.
create_command.tools[myapp].app_context.run.side_effect = (
subprocess.CalledProcessError(
cmd=["python", "-u", "-m", "pip", "..."], returncode=1
)
)
with pytest.raises(RequirementsInstallError):
create_command.install_app_requirements(myapp, test_mode=False)
# But the request to install was still made
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"does-not-exist",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires == ["does-not-exist"]
assert myapp.test_requires is None
def test_app_packages_offline(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If user is offline, pip fails."""
myapp.requires = ["first", "second", "third"]
# Unfortunately, no way to tell the difference between "offline" and
# "your requirements are invalid"; pip returns status code 1 for all
# failures.
create_command.tools[myapp].app_context.run.side_effect = (
subprocess.CalledProcessError(
cmd=["python", "-u", "-m", "pip", "..."], returncode=1
)
)
with pytest.raises(RequirementsInstallError):
create_command.install_app_requirements(myapp, test_mode=False)
# But the request to install was still made
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"first",
"second",
"third",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires == ["first", "second", "third"]
assert myapp.test_requires is None
@pytest.mark.parametrize("logging_level", [LogLevel.INFO, LogLevel.DEEP_DEBUG])
def test_app_packages_install_requirements(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
logging_level,
):
"""Requirements can be installed."""
# Configure logging level
create_command.console.verbosity = logging_level
# Set up the app requirements
myapp.requires = ["first", "second", "third"]
# The side effect of calling pip is creating installation artefacts
create_command.tools[myapp].app_context.run.side_effect = (
create_installation_artefacts(app_packages_path, myapp.requires)
)
# Install the requirements
create_command.install_app_requirements(myapp, test_mode=False)
# The request to install was made
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
]
+ (["-vv"] if logging_level == LogLevel.DEEP_DEBUG else [])
+ ["first", "second", "third"],
check=True,
encoding="UTF-8",
)
# The new app packages have installation artefacts created
assert (app_packages_path / "first").exists()
assert (app_packages_path / "first/__main__.py").exists()
assert (app_packages_path / "second").exists()
assert (app_packages_path / "second/__main__.py").exists()
assert (app_packages_path / "third").exists()
assert (app_packages_path / "third/__main__.py").exists()
# Original app definitions haven't changed
assert myapp.requires == ["first", "second", "third"]
assert myapp.test_requires is None
def test_app_packages_replace_existing_requirements(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If the app has already had requirements installed, they are removed first."""
# Create some existing requirements
create_installation_artefacts(app_packages_path, ["old", "ancient"])()
# Set up the app requirements
myapp.requires = ["first", "second", "third"]
# The side effect of calling pip is creating installation artefacts
create_command.tools[myapp].app_context.run.side_effect = (
create_installation_artefacts(app_packages_path, myapp.requires)
)
# Install the requirements
create_command.install_app_requirements(myapp, test_mode=False)
# The request to install was still made
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"first",
"second",
"third",
],
check=True,
encoding="UTF-8",
)
# The new app packages have installation artefacts created
assert (app_packages_path / "first").exists()
assert (app_packages_path / "first/__main__.py").exists()
assert (app_packages_path / "second").exists()
assert (app_packages_path / "second/__main__.py").exists()
assert (app_packages_path / "third").exists()
assert (app_packages_path / "third/__main__.py").exists()
# The old app packages no longer exist.
assert not (app_packages_path / "old").exists()
assert not (app_packages_path / "ancient").exists()
# Original app definitions haven't changed
assert myapp.requires == ["first", "second", "third"]
assert myapp.test_requires is None
def test_app_requirements_no_requires(
create_command,
myapp,
app_requirements_path,
app_requirements_path_index,
mock_now,
):
"""If an app has no requirements, a requirements file is still written."""
myapp.requires = None
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt doesn't exist either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\n"
# Original app definitions haven't changed
assert myapp.requires is None
assert myapp.test_requires is None
def test_app_requirements_empty_requires(
create_command,
myapp,
app_requirements_path,
app_requirements_path_index,
mock_now,
):
"""If an app has an empty requirements list, a requirements file is still
written."""
myapp.requires = []
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt doesn't exist either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\n"
# Original app definitions haven't changed
assert myapp.requires == []
assert myapp.test_requires is None
def test_app_requirements_requires(
create_command,
myapp,
app_requirements_path,
app_requirements_path_index,
mock_now,
):
"""If an app has an empty requirements list, a requirements file is still
written."""
myapp.requires = ["first", "second==1.2.3", "third>=3.2.1"]
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt doesn't exist either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\nfirst\nsecond==1.2.3\nthird>=3.2.1\n"
# Original app definitions haven't changed
assert myapp.requires == ["first", "second==1.2.3", "third>=3.2.1"]
assert myapp.test_requires is None
def test_app_requirements_requirement_installer_args_no_template_support(
create_command,
myapp,
app_path,
app_requirements_path,
mock_now,
app_requirements_path_index,
):
"""If an app has requirement install args, a requirements file is still written,
but no requirement installer args file is written if the template does not support it.
"""
myapp.requirement_installer_args = ["--no-cache"]
myapp.requires = ["my-favourite-package"]
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt exists either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\nmy-favourite-package\n"
# Original app definitions haven't changed
assert myapp.requires == ["my-favourite-package"]
assert myapp.test_requires is None
def test_app_requirements_requirement_installer_args_with_template_support(
create_command,
myapp,
app_path,
app_requirements_path,
app_requirement_installer_args_path,
mock_now,
app_requirement_installer_args_path_index,
):
"""If an app has requirement install args, a requirements file is still written,
and requirement installer args file is written if the template supports it."""
myapp.requirement_installer_args = ["--no-cache", "-f", "wheels with space"]
myapp.requires = ["my-favourite-package"]
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt exists either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\nmy-favourite-package\n"
assert app_requirement_installer_args_path.exists()
assert (
app_requirement_installer_args_path.read_text(encoding="utf-8")
== "--no-cache\n-f\nwheels with space\n"
)
# Original app definitions haven't changed
assert myapp.requires == ["my-favourite-package"]
assert myapp.test_requires is None
def test_app_requirements_requirement_installer_args_without_requires_no_template_support(
create_command,
myapp,
app_path,
app_requirements_path,
app_requirement_installer_args_path,
mock_now,
app_requirements_path_index,
):
"""If an app has requirement install args and no requires,
a requirements file is still written with the timestamp,
and does not write a requirement installer args file."""
myapp.requirement_installer_args = ["--no-cache"]
myapp.requires = []
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt exists either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\n"
assert not app_requirement_installer_args_path.exists()
# Original app definitions haven't changed
assert myapp.requires == []
assert myapp.test_requires is None
def test_app_requirements_requirement_installer_args_without_requires_with_template_support(
create_command,
myapp,
app_path,
app_requirements_path,
app_requirement_installer_args_path,
mock_now,
app_requirement_installer_args_path_index,
):
"""If an app has requirement install args and no requires,
a requirements file is still written with the timestamp,
as well as requirement installer args file when the template supports it."""
myapp.requirement_installer_args = ["--no-cache", "-f", "wheels with space"]
myapp.requires = []
# Install requirements into the bundle
create_command.install_app_requirements(myapp, test_mode=False)
# requirements.txt exists either
assert app_requirements_path.exists()
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == f"{GENERATED_DATETIME}\n"
assert app_requirement_installer_args_path.exists()
assert (
app_requirement_installer_args_path.read_text(encoding="utf-8")
== "--no-cache\n-f\nwheels with space\n"
)
# Original app definitions haven't changed
assert myapp.requires == []
assert myapp.test_requires is None
@pytest.mark.parametrize(
"altsep, requirement, expected",
[
(None, "asdf/xcvb", True),
(None, "asdf>xcvb", False),
(">", "asdf/xcvb", True),
(">", "asdf>xcvb", True),
(">", "asdf+xcvb", False),
],
)
def test__is_local_path_altsep_respected(
altsep,
requirement,
expected,
monkeypatch,
):
"""``os.altsep`` is included as a separator when available."""
monkeypatch.setattr(os, "sep", "/")
monkeypatch.setattr(os, "altsep", altsep)
assert _is_local_path(requirement) is expected
def _test_app_requirements_paths(
create_command,
myapp,
app_requirements_path,
tmp_path,
requirement,
):
"""A utility method that can be used to test expansion of a specific requirement."""
if isinstance(requirement, tuple):
requirement, converted = requirement
else:
converted = requirement
myapp.requires = ["first", requirement, "third"]
create_command.install_app_requirements(myapp, test_mode=False)
with app_requirements_path.open(encoding="utf-8") as f:
assert f.read() == (
"\n".join(
[
GENERATED_DATETIME,
"first",
converted.format(tmp_path),
"third",
]
)
+ "\n"
)
# Original app definitions haven't changed
assert myapp.requires == ["first", requirement, "third"]
assert myapp.test_requires is None
@pytest.mark.parametrize(
"requirement",
[
# Simple PyPI package references
"my-package",
"my-package==1.2.3",
"my-package<=1.2.3",
# More complex PyPI references
"my-package[optional]<=1.2.3",
"my-package[optional]<=1.2.3; python_version<3.7",
# References to git packages
"git+https://github.com/project/package",
"git+https://github.com/project/package#egg=my-package",
"git+https://github.com/project/package@deadbeef#egg=my-package",
"git+https://github.com/project/package@some-branch#egg=my-package",
# URL references to wheels
"http://example.com/path/to/mypackage-1.2.3-py3-none-any.whl",
"https://example.com/path/to/mypackage-1.2.3-py3-none-any.whl",
# Zip file source installs
"my-package @ https://example.com/path/to/1.2.3.zip",
],
)
def test_app_requirements_non_paths(
create_command,
myapp,
app_requirements_path,
app_requirements_path_index,
tmp_path,
requirement,
mock_now,
):
"""Requirements which are not paths are left unchanged."""
_test_app_requirements_paths(
create_command,
myapp,
app_requirements_path,
tmp_path,
requirement,
)
@pytest.mark.skipif(os.name != "posix", reason="Unix specific tests")
@pytest.mark.parametrize(
"requirement",
[
# A reference that involves an absolute path
"/absolute/path/to/package",
# Relative paths.
("./package/inside/project", "{}/base_path/package/inside/project"),
("../package/outside/project", "{}/package/outside/project"),
("sub/package/inside/project", "{}/base_path/sub/package/inside/project"),
],
)
def test_app_requirements_paths_unix(
create_command,
myapp,
app_requirements_path,
app_requirements_path_index,
tmp_path,
requirement,
mock_now,
):
"""Requirement paths in Unix format are expanded correctly."""
_test_app_requirements_paths(
create_command,
myapp,
app_requirements_path,
tmp_path,
requirement,
)
@pytest.mark.skipif(os.name != "nt", reason="Windows specific tests")
@pytest.mark.parametrize(
"requirement",
[
# A reference that involves an absolute path
r"C:\absolute\path\to\package",
("C:/absolute/path/to/package", r"C:\absolute\path\to\package"),
("/absolute/path/to/package", r"C:\absolute\path\to\package"),
# Relative paths using forward slash separators
("./package/inside/project", r"{}\base_path\package\inside\project"),
("../package/outside/project", r"{}\package\outside\project"),
("sub/package/inside/project", r"{}\base_path\sub\package\inside\project"),
# Relative paths using backslash separators
(r".\package\inside\project", r"{}\base_path\package\inside\project"),
(r"..\package\outside\project", r"{}\package\outside\project"),
(r"sub\package\inside\project", r"{}\base_path\sub\package\inside\project"),
],
)
def test_app_requirements_paths_windows(
create_command,
myapp,
app_requirements_path,
app_requirements_path_index,
tmp_path,
requirement,
mock_now,
):
"""Requirement paths in Windows format are expanded correctly."""
_test_app_requirements_paths(
create_command,
myapp,
app_requirements_path,
tmp_path,
requirement,
)
def test_app_packages_test_requires(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app has test requirements, they're not included unless we are in test
mode."""
myapp.requires = ["first", "second==1.2.3", "third>=3.2.1"]
myapp.test_requires = ["pytest", "pytest-tldr"]
create_command.install_app_requirements(myapp, test_mode=False)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"first",
"second==1.2.3",
"third>=3.2.1",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires == ["first", "second==1.2.3", "third>=3.2.1"]
assert myapp.test_requires == ["pytest", "pytest-tldr"]
def test_app_packages_test_requires_test_mode(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app has test requirements and we're in test mode, they are installed."""
myapp.requires = ["first", "second==1.2.3", "third>=3.2.1"]
myapp.test_requires = ["pytest", "pytest-tldr"]
create_command.install_app_requirements(myapp, test_mode=True)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"first",
"second==1.2.3",
"third>=3.2.1",
"pytest",
"pytest-tldr",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires == ["first", "second==1.2.3", "third>=3.2.1"]
assert myapp.test_requires == ["pytest", "pytest-tldr"]
def test_app_packages_only_test_requires_test_mode(
create_command,
myapp,
app_packages_path,
app_packages_path_index,
):
"""If an app only has test requirements and we're in test mode, they are
installed."""
myapp.requires = None
myapp.test_requires = ["pytest", "pytest-tldr"]
create_command.install_app_requirements(myapp, test_mode=True)
# A request was made to install requirements
create_command.tools[myapp].app_context.run.assert_called_with(
[
sys.executable,
"-u",
"-X",
"utf8",
"-m",
"pip",
"install",
"--disable-pip-version-check",
"--upgrade",
"--no-user",
f"--target={app_packages_path}",
"pytest",
"pytest-tldr",
],
check=True,
encoding="UTF-8",
)
# Original app definitions haven't changed
assert myapp.requires is None
assert myapp.test_requires == ["pytest", "pytest-tldr"]
|