|
| 1 | +""" |
| 2 | +Tests for file-level vs release-level yanking behavior per PEP 592. |
| 3 | +
|
| 4 | +PEP 592 distinguishes between: |
| 5 | +1. File-level yanking: Individual files are yanked, but other files for |
| 6 | + the same version are still available and should be selectable. |
| 7 | +2. Release-level yanking: All files for a version are yanked. The version |
| 8 | + is considered "yanked" and can only be selected if pinned with == or ===. |
| 9 | +""" |
| 10 | + |
| 11 | +from unittest.mock import MagicMock |
| 12 | + |
| 13 | +import pytest |
| 14 | +from pip._vendor.packaging.specifiers import SpecifierSet |
| 15 | +from pip._vendor.packaging.version import Version |
| 16 | + |
| 17 | +from pip._internal.index.package_finder import PackageFinder |
| 18 | +from pip._internal.models.candidate import InstallationCandidate |
| 19 | +from pip._internal.models.link import Link |
| 20 | +from pip._internal.models.selection_prefs import SelectionPreferences |
| 21 | +from pip._internal.models.target_python import TargetPython |
| 22 | + |
| 23 | + |
| 24 | +def make_test_link( |
| 25 | + filename: str, version: str, yanked_reason: str | None = None |
| 26 | +) -> Link: |
| 27 | + """Create a test Link object.""" |
| 28 | + return Link( |
| 29 | + url=f"https://example.com/packages/{filename}", |
| 30 | + yanked_reason=yanked_reason, |
| 31 | + ) |
| 32 | + |
| 33 | + |
| 34 | +def make_test_candidate( |
| 35 | + name: str, version: str, filename: str, yanked_reason: str | None = None |
| 36 | +) -> InstallationCandidate: |
| 37 | + """Create a test InstallationCandidate.""" |
| 38 | + link = make_test_link(filename, version, yanked_reason) |
| 39 | + return InstallationCandidate(name=name, version=version, link=link) |
| 40 | + |
| 41 | + |
| 42 | +class TestFileLevelYanking: |
| 43 | + """Test file-level yanking: some files for a version are yanked.""" |
| 44 | + |
| 45 | + def test_file_level_yanking_excludes_yanked_file(self) -> None: |
| 46 | + """ |
| 47 | + When only some files for a version are yanked (file-level yanking), |
| 48 | + the yanked files should be excluded but non-yanked files should |
| 49 | + still be available. |
| 50 | + """ |
| 51 | + # Version 1.0 has two files: wheel (not yanked) and tarball (yanked) |
| 52 | + candidates = [ |
| 53 | + make_test_candidate( |
| 54 | + "example", "1.0", "example-1.0-py3-none-any.whl", None |
| 55 | + ), |
| 56 | + make_test_candidate( |
| 57 | + "example", "1.0", "example-1.0.tar.gz", "bad tarball" |
| 58 | + ), |
| 59 | + ] |
| 60 | + |
| 61 | + # Group by version |
| 62 | + version_to_candidates: dict[Version, list[InstallationCandidate]] = {} |
| 63 | + for c in candidates: |
| 64 | + version_to_candidates.setdefault(c.version, []).append(c) |
| 65 | + |
| 66 | + # Determine yanked versions (release-level) |
| 67 | + yanked_versions: set[Version] = set() |
| 68 | + for version, version_cands in version_to_candidates.items(): |
| 69 | + if all(c.link.is_yanked for c in version_cands): |
| 70 | + yanked_versions.add(version) |
| 71 | + |
| 72 | + # Version 1.0 should NOT be in yanked_versions (file-level yanking) |
| 73 | + assert Version("1.0") not in yanked_versions |
| 74 | + |
| 75 | + # The wheel should still be available |
| 76 | + available = [c for c in candidates if not c.link.is_yanked] |
| 77 | + assert len(available) == 1 |
| 78 | + assert available[0].link.filename == "example-1.0-py3-none-any.whl" |
| 79 | + |
| 80 | + |
| 81 | +class TestReleaseLevelYanking: |
| 82 | + """Test release-level yanking: all files for a version are yanked.""" |
| 83 | + |
| 84 | + def test_release_level_yanking_detects_yanked_version(self) -> None: |
| 85 | + """ |
| 86 | + When all files for a version are yanked (release-level yanking), |
| 87 | + the version should be considered yanked. |
| 88 | + """ |
| 89 | + # Version 2.0 has all files yanked |
| 90 | + candidates = [ |
| 91 | + make_test_candidate( |
| 92 | + "example", "2.0", "example-2.0-py3-none-any.whl", "security issue" |
| 93 | + ), |
| 94 | + make_test_candidate( |
| 95 | + "example", "2.0", "example-2.0.tar.gz", "security issue" |
| 96 | + ), |
| 97 | + ] |
| 98 | + |
| 99 | + # Group by version |
| 100 | + version_to_candidates: dict[Version, list[InstallationCandidate]] = {} |
| 101 | + for c in candidates: |
| 102 | + version_to_candidates.setdefault(c.version, []).append(c) |
| 103 | + |
| 104 | + # Determine yanked versions |
| 105 | + yanked_versions: set[Version] = set() |
| 106 | + for version, version_cands in version_to_candidates.items(): |
| 107 | + if all(c.link.is_yanked for c in version_cands): |
| 108 | + yanked_versions.add(version) |
| 109 | + |
| 110 | + # Version 2.0 SHOULD be in yanked_versions (release-level yanking) |
| 111 | + assert Version("2.0") in yanked_versions |
| 112 | + |
| 113 | + def test_release_level_yanking_allows_pinned_version(self) -> None: |
| 114 | + """ |
| 115 | + A yanked release should be selectable if the specifier pins to |
| 116 | + that exact version using == or ===. |
| 117 | + """ |
| 118 | + |
| 119 | + def is_pinned(specifier: SpecifierSet) -> bool: |
| 120 | + for sp in specifier: |
| 121 | + if sp.operator == "===": |
| 122 | + return True |
| 123 | + if sp.operator != "==": |
| 124 | + continue |
| 125 | + if sp.version.endswith(".*"): |
| 126 | + continue |
| 127 | + return True |
| 128 | + return False |
| 129 | + |
| 130 | + # These specifiers should be considered "pinned" |
| 131 | + assert is_pinned(SpecifierSet("==2.0")) |
| 132 | + assert is_pinned(SpecifierSet("===2.0")) |
| 133 | + |
| 134 | + # These specifiers should NOT be considered "pinned" |
| 135 | + assert not is_pinned(SpecifierSet(">=2.0")) |
| 136 | + assert not is_pinned(SpecifierSet("==2.*")) |
| 137 | + assert not is_pinned(SpecifierSet("~=2.0")) |
| 138 | + assert not is_pinned(SpecifierSet(">1.0,<3.0")) |
| 139 | + |
| 140 | + |
| 141 | +class TestMixedYankingScenarios: |
| 142 | + """Test scenarios with mixed file-level and release-level yanking.""" |
| 143 | + |
| 144 | + def test_mixed_yanking_version_selection(self) -> None: |
| 145 | + """ |
| 146 | + With multiple versions having different yanking states: |
| 147 | + - Version 1.0: file-level yanking (one file yanked) |
| 148 | + - Version 2.0: release-level yanking (all files yanked) |
| 149 | + - Version 3.0: no yanking |
| 150 | +
|
| 151 | + Without pinning, versions 1.0 and 3.0 should be available, |
| 152 | + version 2.0 should be excluded. |
| 153 | + """ |
| 154 | + candidates = [ |
| 155 | + # Version 1.0: file-level yanking |
| 156 | + make_test_candidate( |
| 157 | + "example", "1.0", "example-1.0-py3-none-any.whl", None |
| 158 | + ), |
| 159 | + make_test_candidate( |
| 160 | + "example", "1.0", "example-1.0.tar.gz", "bad tarball" |
| 161 | + ), |
| 162 | + # Version 2.0: release-level yanking |
| 163 | + make_test_candidate( |
| 164 | + "example", "2.0", "example-2.0-py3-none-any.whl", "security" |
| 165 | + ), |
| 166 | + make_test_candidate( |
| 167 | + "example", "2.0", "example-2.0.tar.gz", "security" |
| 168 | + ), |
| 169 | + # Version 3.0: no yanking |
| 170 | + make_test_candidate( |
| 171 | + "example", "3.0", "example-3.0-py3-none-any.whl", None |
| 172 | + ), |
| 173 | + make_test_candidate( |
| 174 | + "example", "3.0", "example-3.0.tar.gz", None |
| 175 | + ), |
| 176 | + ] |
| 177 | + |
| 178 | + # Group by version |
| 179 | + version_to_candidates: dict[Version, list[InstallationCandidate]] = {} |
| 180 | + for c in candidates: |
| 181 | + version_to_candidates.setdefault(c.version, []).append(c) |
| 182 | + |
| 183 | + # Determine yanked versions |
| 184 | + yanked_versions: set[Version] = set() |
| 185 | + for version, version_cands in version_to_candidates.items(): |
| 186 | + if all(c.link.is_yanked for c in version_cands): |
| 187 | + yanked_versions.add(version) |
| 188 | + |
| 189 | + # Check yanked versions |
| 190 | + assert Version("1.0") not in yanked_versions # file-level, not release-level |
| 191 | + assert Version("2.0") in yanked_versions # release-level |
| 192 | + assert Version("3.0") not in yanked_versions # not yanked |
| 193 | + |
| 194 | + # Available candidates without pinning (release-level yanked excluded) |
| 195 | + pinned = False |
| 196 | + available = [] |
| 197 | + for c in candidates: |
| 198 | + version_is_yanked = c.version in yanked_versions |
| 199 | + file_is_yanked = c.link.is_yanked |
| 200 | + |
| 201 | + if file_is_yanked: |
| 202 | + if version_is_yanked and pinned: |
| 203 | + available.append(c) |
| 204 | + else: |
| 205 | + continue # Skip yanked files |
| 206 | + else: |
| 207 | + available.append(c) |
| 208 | + |
| 209 | + # Should have: 1.0 wheel, 3.0 wheel, 3.0 tarball |
| 210 | + assert len(available) == 3 |
| 211 | + versions = {c.version for c in available} |
| 212 | + assert Version("1.0") in versions |
| 213 | + assert Version("2.0") not in versions # Excluded (release-level yanked) |
| 214 | + assert Version("3.0") in versions |
| 215 | + |
| 216 | + def test_all_versions_yanked_allows_pinned(self) -> None: |
| 217 | + """ |
| 218 | + When ALL versions are yanked and the specifier is pinned, |
| 219 | + the pinned yanked version should be selectable. |
| 220 | + """ |
| 221 | + candidates = [ |
| 222 | + # Version 1.0: release-level yanking |
| 223 | + make_test_candidate( |
| 224 | + "example", "1.0", "example-1.0.tar.gz", "old version" |
| 225 | + ), |
| 226 | + # Version 2.0: release-level yanking |
| 227 | + make_test_candidate( |
| 228 | + "example", "2.0", "example-2.0.tar.gz", "has bug" |
| 229 | + ), |
| 230 | + ] |
| 231 | + |
| 232 | + # Group by version |
| 233 | + version_to_candidates: dict[Version, list[InstallationCandidate]] = {} |
| 234 | + for c in candidates: |
| 235 | + version_to_candidates.setdefault(c.version, []).append(c) |
| 236 | + |
| 237 | + # Determine yanked versions |
| 238 | + yanked_versions: set[Version] = set() |
| 239 | + for version, version_cands in version_to_candidates.items(): |
| 240 | + if all(c.link.is_yanked for c in version_cands): |
| 241 | + yanked_versions.add(version) |
| 242 | + |
| 243 | + # Both versions are yanked |
| 244 | + assert len(yanked_versions) == 2 |
| 245 | + |
| 246 | + # With pinned specifier ==2.0, version 2.0 should be allowed |
| 247 | + all_versions_yanked = all(v in yanked_versions for v in version_to_candidates) |
| 248 | + assert all_versions_yanked |
| 249 | + |
| 250 | + pinned = True # Simulating ==2.0 |
| 251 | + available = [] |
| 252 | + for c in candidates: |
| 253 | + version_is_yanked = c.version in yanked_versions |
| 254 | + file_is_yanked = c.link.is_yanked |
| 255 | + |
| 256 | + if file_is_yanked: |
| 257 | + if version_is_yanked and pinned: |
| 258 | + available.append(c) |
| 259 | + elif all_versions_yanked and pinned: |
| 260 | + available.append(c) |
| 261 | + else: |
| 262 | + continue |
| 263 | + else: |
| 264 | + available.append(c) |
| 265 | + |
| 266 | + # Both versions should be available when pinned and all are yanked |
| 267 | + assert len(available) == 2 |
0 commit comments