| 1 |
from __future__ import annotations |
| 2 |
|
| 3 |
import sys |
| 4 |
from itertools import zip_longest |
| 5 |
from typing import TYPE_CHECKING |
| 6 |
|
| 7 |
import pytest |
| 8 |
from packaging.requirements import Requirement |
| 9 |
from pyproject_api import SubprocessFrontend |
| 10 |
|
| 11 |
from tox.tox_env.errors import Fail |
| 12 |
from tox.tox_env.python.virtual_env.package.util import dependencies_with_extras |
| 13 |
|
| 14 |
if TYPE_CHECKING: |
| 15 |
from pathlib import Path |
| 16 |
|
| 17 |
from importlib.metadata import Distribution, PathDistribution |
| 18 |
|
| 19 |
|
| 20 |
@pytest.fixture(scope="session") |
| 21 |
def pkg_with_extras(pkg_with_extras_project: Path) -> PathDistribution: |
| 22 |
frontend = SubprocessFrontend(*SubprocessFrontend.create_args_from_folder(pkg_with_extras_project)[:-1]) |
| 23 |
meta = pkg_with_extras_project / "meta" |
| 24 |
result = frontend.prepare_metadata_for_build_wheel(meta) |
| 25 |
assert result is not None |
| 26 |
return Distribution.at(result.metadata) |
| 27 |
|
| 28 |
|
| 29 |
def test_load_dependency_no_extra(pkg_with_extras: PathDistribution) -> None: |
| 30 |
requires = pkg_with_extras.requires |
| 31 |
assert requires is not None |
| 32 |
result = dependencies_with_extras([Requirement(i) for i in requires], set(), "") |
| 33 |
for left, right in zip_longest(result, (Requirement("platformdirs>=4.3.8"), Requirement("colorama>=0.4.6"))): |
| 34 |
assert isinstance(right, Requirement) |
| 35 |
assert str(left) == str(right) |
| 36 |
|
| 37 |
|
| 38 |
def test_load_dependency_many_extra(pkg_with_extras: PathDistribution) -> None: |
| 39 |
py_ver = ".".join(str(i) for i in sys.version_info[0:2]) |
| 40 |
requires = pkg_with_extras.requires |
| 41 |
assert requires is not None |
| 42 |
result = dependencies_with_extras([Requirement(i) for i in requires], {"docs", "testing"}, "") |
| 43 |
sphinx = [Requirement("sphinx>=3"), Requirement("sphinx-rtd-theme<1,>=0.4.3")] |
| 44 |
exp = [ |
| 45 |
Requirement("platformdirs>=4.3.8"), |
| 46 |
Requirement("colorama>=0.4.6"), |
| 47 |
*(sphinx if sys.version_info[0:2] <= (3, 8) else []), |
| 48 |
Requirement(f'covdefaults>=1.2; python_version == "2.7" or python_version == "{py_ver}"'), |
| 49 |
Requirement(f'pytest>=5.4.1; python_version == "{py_ver}"'), |
| 50 |
*(sphinx if sys.version_info[0:2] > (3, 8) else []), |
| 51 |
] |
| 52 |
for left, right in zip_longest(result, exp): |
| 53 |
assert isinstance(right, Requirement) |
| 54 |
assert str(left) == str(right) |
| 55 |
|
| 56 |
|
| 57 |
def test_loads_deps_recursive_extras() -> None: |
| 58 |
requires = [ |
| 59 |
Requirement("no-extra"), |
| 60 |
Requirement('dep1[magic]; extra=="dev"'), |
| 61 |
Requirement('dep1; extra=="test"'), |
| 62 |
Requirement('dep2[a,b]; extra=="test"'), |
| 63 |
Requirement('dep3; extra=="docs"'), |
| 64 |
Requirement('name; extra=="dev"'), |
| 65 |
Requirement('name[test]; extra=="dev"'), |
| 66 |
] |
| 67 |
result = dependencies_with_extras(requires, {"dev"}, "name") |
| 68 |
assert [str(i) for i in result] == ["no-extra", "dep1[magic]", "dep1", "dep2[a,b]"] |
| 69 |
|
| 70 |
|
| 71 |
def test_load_dependency_requirement_or_extras() -> None: |
| 72 |
requires = [Requirement('filelock<4.0.0,>=3.9.0; extra == "extras1" or extra == "extras2"')] |
| 73 |
for extras in ["extras1", "extras2"]: |
| 74 |
result = dependencies_with_extras(requires, {extras}, "") |
| 75 |
assert [str(r) for r in result] == ["filelock<4.0.0,>=3.9.0"] |
| 76 |
|
| 77 |
|
| 78 |
@pytest.mark.parametrize("extra", ["extras1", "extras2", "extras3"]) |
| 79 |
def test_load_dependency_requirement_many_or_extras(extra: str) -> None: |
| 80 |
requires = [Requirement('filelock<4.0.0,>=3.9.0; extra == "extras1" or extra == "extras2" or extra == "extras3"')] |
| 81 |
result = dependencies_with_extras(requires, {extra}, "") |
| 82 |
assert [str(r) for r in result] == ["filelock<4.0.0,>=3.9.0"] |
| 83 |
|
| 84 |
|
| 85 |
def test_validate_extras_unknown() -> None: |
| 86 |
with pytest.raises(Fail, match=r"extras not found for package pkg: typo \(available: alpha, beta\)"): |
| 87 |
dependencies_with_extras([], {"typo"}, "pkg", available_extras={"alpha", "beta"}) |
| 88 |
|
| 89 |
|
| 90 |
def test_validate_extras_valid() -> None: |
| 91 |
requires = [Requirement('A; extra == "alpha"')] |
| 92 |
result = dependencies_with_extras(requires, {"alpha"}, "pkg", available_extras={"alpha", "beta"}) |
| 93 |
assert [str(r) for r in result] == ["A"] |
| 94 |
|
| 95 |
|
| 96 |
def test_validate_extras_none_skips_validation() -> None: |
| 97 |
result = dependencies_with_extras([], {"nonexistent"}, "pkg", available_extras=None) |
| 98 |
assert result == [] |
| 99 |
|
| 100 |
|
| 101 |
def test_validate_extras_empty_requested() -> None: |
| 102 |
result = dependencies_with_extras([], set(), "pkg", available_extras={"alpha"}) |
| 103 |
assert result == [] |
| 104 |
|
| 105 |
|
| 106 |
def test_validate_extras_normalization() -> None: |
| 107 |
requires = [Requirement('A; extra == "my-extra"')] |
| 108 |
result = dependencies_with_extras(requires, {"my-extra"}, "pkg", available_extras={"my_extra"}) |
| 109 |
assert [str(r) for r in result] == ["A"] |
| 110 |
|
| 111 |
|
| 112 |
def test_validate_extras_no_available() -> None: |
| 113 |
with pytest.raises(Fail, match=r"extras not found for package pkg: alpha \(available: none\)"): |
| 114 |
dependencies_with_extras([], {"alpha"}, "pkg", available_extras=set()) |
| 115 |
|
| 116 |
|
| 117 |
def test_extras_underscore_hyphen_matching() -> None: |
| 118 |
"""Extras with underscores in tox.ini should match hyphens in metadata markers (#3433).""" |
| 119 |
requires = [ |
| 120 |
Requirement('dep-a; extra == "kebab-case"'), |
| 121 |
Requirement('dep-b; extra == "snake-case"'), |
| 122 |
Requirement('dep-c; extra == "kebab-case-2"'), |
| 123 |
] |
| 124 |
result = dependencies_with_extras(requires, {"kebab-case", "snake_case", "kebab-case-2"}, "pkg") |
| 125 |
assert sorted(str(r) for r in result) == ["dep-a", "dep-b", "dep-c"] |
| 126 |
|
| 127 |
|
| 128 |
def test_extras_underscore_in_markers() -> None: |
| 129 |
"""Extras with underscores in markers should match hyphens in tox.ini (#3433).""" |
| 130 |
requires = [ |
| 131 |
Requirement('dep-a; extra == "snake_case"'), |
| 132 |
] |
| 133 |
result = dependencies_with_extras(requires, {"snake-case"}, "pkg") |
| 134 |
assert [str(r) for r in result] == ["dep-a"] |
| 135 |
|
| 136 |
|
| 137 |
def test_extras_normalization_with_recursive() -> None: |
| 138 |
"""Recursive extras with underscores should be resolved correctly (#3433).""" |
| 139 |
requires = [ |
| 140 |
Requirement('dep1; extra == "my-extra"'), |
| 141 |
Requirement('name[sub_extra]; extra == "my-extra"'), |
| 142 |
Requirement('dep2; extra == "sub-extra"'), |
| 143 |
] |
| 144 |
result = dependencies_with_extras(requires, {"my_extra"}, "name") |
| 145 |
assert sorted(str(r) for r in result) == ["dep1", "dep2"] |