Skip to content

Commit 869b6f2

Browse files
committed
tbs feedback
1 parent 1c18544 commit 869b6f2

3 files changed

Lines changed: 74 additions & 57 deletions

File tree

‎pulp_python/app/pypi/views.py‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
from rest_framework.response import Response
3030
from rest_framework.viewsets import ViewSet
3131

32+
from pulpcore.plugin.serializers import AsyncOperationResponseSerializer
3233
from pulpcore.plugin.tasking import dispatch
3334
from pulpcore.plugin.util import get_domain, get_url
3435
from pulpcore.plugin.viewsets import OperationPostponedResponse
@@ -620,7 +621,11 @@ class YankView(PyPIMixin, ViewSet):
620621
],
621622
}
622623

623-
@extend_schema(request=YankSerializer, summary="Yank a package version")
624+
@extend_schema(
625+
request=YankSerializer,
626+
responses={202: AsyncOperationResponseSerializer},
627+
summary="Yank a package version",
628+
)
624629
def yank(self, request, path):
625630
"""Yank a package version, marking all its files with data-yanked."""
626631
repo = self.distribution.repository
@@ -650,7 +655,11 @@ def yank(self, request, path):
650655
)
651656
return OperationPostponedResponse(result, request)
652657

653-
@extend_schema(request=YankSerializer, summary="Unyank a package version")
658+
@extend_schema(
659+
request=YankSerializer,
660+
responses={202: AsyncOperationResponseSerializer},
661+
summary="Unyank a package version",
662+
)
654663
def unyank(self, request, path):
655664
"""Unyank a package version, unmarking all its files with data-yanked."""
656665
repo = self.distribution.repository

‎pulp_python/app/utils.py‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -410,15 +410,15 @@ def python_content_to_json(
410410
return full_metadata
411411

412412

413-
def latest_content_version(content_query, version):
413+
def latest_content_version(all_content, version):
414414
"""
415-
Walks through the content QuerySet and finds the instances that is the latest version.
415+
Walks through the content list and finds the instances that are the latest version.
416416
If 'version' is specified, the function instead tries to find content instances
417417
with that version and will return an empty list if nothing is found
418418
"""
419419
latest_version = version
420420
latest_content = []
421-
for content in content_query:
421+
for content in all_content:
422422
if version and parse(version) == parse(content.version):
423423
latest_content.append(content)
424424
elif not latest_version or parse(content.version) > parse(latest_version):
@@ -476,8 +476,8 @@ def python_content_to_info(content):
476476
"platform": content.platform or "",
477477
"requires_dist": json_to_dict(content.requires_dist) or None,
478478
"classifiers": json_to_dict(content.classifiers) or None,
479-
"yanked": content.yanked,
480-
"yanked_reason": content.yanked_reason,
479+
"yanked": getattr(content, "yanked", False),
480+
"yanked_reason": getattr(content, "yanked_reason", None),
481481
# New core metadata (Version 2.1, 2.2, 2.4)
482482
"provides_extras": json_to_dict(content.provides_extras) or None,
483483
"dynamic": json_to_dict(content.dynamic) or None,
@@ -486,13 +486,13 @@ def python_content_to_info(content):
486486
}
487487

488488

489-
def python_content_to_releases(contents, base_path, domain=None):
489+
def python_content_to_releases(all_content, base_path, domain=None):
490490
"""
491491
Takes a list of PythonPackageContent and returns a dictionary of releases
492492
with each key being a version and value being a list of content for that version of the package
493493
"""
494494
releases = defaultdict(lambda: [])
495-
for content in contents:
495+
for content in all_content:
496496
releases[content.version].append(
497497
python_content_to_download_info(content, base_path, domain)
498498
)
@@ -549,8 +549,8 @@ def find_artifact():
549549
(getattr(content, "repo_added_time", None) or content.pulp_created).isoformat()
550550
),
551551
"url": url,
552-
"yanked": content.yanked,
553-
"yanked_reason": content.yanked_reason,
552+
"yanked": getattr(content, "yanked", False),
553+
"yanked_reason": getattr(content, "yanked_reason", None),
554554
}
555555

556556

‎pulp_python/tests/functional/api/test_yank.py‎

Lines changed: 54 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,13 @@
1212
TWINE_WHEEL_URL,
1313
)
1414

15-
YANK_AUTH = ("admin", "password")
1615
TWINE_NAME = "twine"
1716
TWINE_VERSION = "5.1.0"
1817

1918
TWINE_500_WHEEL_FILENAME = "twine-5.0.0-py3-none-any.whl"
2019
TWINE_500_WHEEL_URL = urljoin(urljoin(PYTHON_FIXTURES_URL, "packages/"), TWINE_500_WHEEL_FILENAME)
2120

2221

23-
def yank(distro, name, version, yanked_reason=""):
24-
url = urljoin(distro.base_url, "yank/")
25-
return requests.post(
26-
url, json={"name": name, "version": version, "yanked_reason": yanked_reason}, auth=YANK_AUTH
27-
)
28-
29-
30-
def unyank(distro, name, version):
31-
url = urljoin(distro.base_url, "unyank/")
32-
return requests.post(url, json={"name": name, "version": version}, auth=YANK_AUTH)
33-
34-
3522
def test_yank_and_unyank(
3623
delete_orphans_pre,
3724
monitor_task,
@@ -58,9 +45,11 @@ def test_yank_and_unyank(
5845
version_1 = repo.latest_version_href
5946

6047
# 1. Yank
61-
response = yank(distro, TWINE_NAME, TWINE_VERSION, yanked_reason="broken")
62-
assert response.status_code == 202
63-
monitor_task(response.json()["task"])
48+
response = python_bindings.PypiYankApi.yank(
49+
path=distro.base_path,
50+
yank={"name": TWINE_NAME, "version": TWINE_VERSION, "yanked_reason": "broken"},
51+
)
52+
monitor_task(response.task)
6453

6554
repo = python_bindings.RepositoriesPythonApi.read(repo.pulp_href)
6655
version_2 = repo.latest_version_href
@@ -92,17 +81,21 @@ def test_yank_and_unyank(
9281
assert f["yanked_reason"] == "broken"
9382

9483
# Yank again with same reason - idempotent, no new repo version
95-
response = yank(distro, TWINE_NAME, TWINE_VERSION, yanked_reason="broken")
96-
assert response.status_code == 202
97-
monitor_task(response.json()["task"])
84+
response = python_bindings.PypiYankApi.yank(
85+
path=distro.base_path,
86+
yank={"name": TWINE_NAME, "version": TWINE_VERSION, "yanked_reason": "broken"},
87+
)
88+
monitor_task(response.task)
9889

9990
repo = python_bindings.RepositoriesPythonApi.read(repo.pulp_href)
10091
assert repo.latest_version_href == version_2
10192

10293
# Yank again with different reason - updates the reason
103-
response = yank(distro, TWINE_NAME, TWINE_VERSION, yanked_reason="security fix")
104-
assert response.status_code == 202
105-
monitor_task(response.json()["task"])
94+
response = python_bindings.PypiYankApi.yank(
95+
path=distro.base_path,
96+
yank={"name": TWINE_NAME, "version": TWINE_VERSION, "yanked_reason": "security fix"},
97+
)
98+
monitor_task(response.task)
10699

107100
repo = python_bindings.RepositoriesPythonApi.read(repo.pulp_href)
108101
version_3 = repo.latest_version_href
@@ -117,9 +110,10 @@ def test_yank_and_unyank(
117110
assert response.text.count('data-yanked="security fix"') == 2
118111

119112
# 2. Unyank
120-
response = unyank(distro, TWINE_NAME, TWINE_VERSION)
121-
assert response.status_code == 202
122-
monitor_task(response.json()["task"])
113+
response = python_bindings.PypiUnyankApi.unyank(
114+
path=distro.base_path, yank={"name": TWINE_NAME, "version": TWINE_VERSION}
115+
)
116+
monitor_task(response.task)
123117

124118
repo = python_bindings.RepositoriesPythonApi.read(repo.pulp_href)
125119
version_4 = repo.latest_version_href
@@ -149,9 +143,10 @@ def test_yank_and_unyank(
149143
assert f["yanked_reason"] is None
150144

151145
# Unyank again - idempotent, no new repo version
152-
response = unyank(distro, TWINE_NAME, TWINE_VERSION)
153-
assert response.status_code == 202
154-
monitor_task(response.json()["task"])
146+
response = python_bindings.PypiUnyankApi.unyank(
147+
path=distro.base_path, yank={"name": TWINE_NAME, "version": TWINE_VERSION}
148+
)
149+
monitor_task(response.task)
155150

156151
repo = python_bindings.RepositoriesPythonApi.read(repo.pulp_href)
157152
assert repo.latest_version_href == version_4
@@ -207,9 +202,11 @@ def test_partial_yank(
207202
monitor_task(python_bindings.RepositoriesPythonApi.modify(repo.pulp_href, body).task)
208203
distro = python_distribution_factory(repository=repo)
209204

210-
response = yank(distro, TWINE_NAME, TWINE_VERSION, yanked_reason="broken 5.1.0")
211-
assert response.status_code == 202
212-
monitor_task(response.json()["task"])
205+
response = python_bindings.PypiYankApi.yank(
206+
path=distro.base_path,
207+
yank={"name": TWINE_NAME, "version": TWINE_VERSION, "yanked_reason": "broken 5.1.0"},
208+
)
209+
monitor_task(response.task)
213210

214211
summary = python_content_summary(repository=repo, version=2)
215212
assert summary.added["python.python_yank"]["count"] == 1
@@ -249,9 +246,10 @@ def test_yank_isolation_across_repositories(
249246
distro_b = python_distribution_factory(repository=repo_b)
250247

251248
# Yank in repo A only
252-
response = yank(distro_a, TWINE_NAME, TWINE_VERSION)
253-
assert response.status_code == 202
254-
monitor_task(response.json()["task"])
249+
response = python_bindings.PypiYankApi.yank(
250+
path=distro_a.base_path, yank={"name": TWINE_NAME, "version": TWINE_VERSION}
251+
)
252+
monitor_task(response.task)
255253

256254
# Repo A should have a yank marker, repo B should not
257255
summary_a = python_content_summary(repository=repo_a, version=2)
@@ -260,13 +258,15 @@ def test_yank_isolation_across_repositories(
260258
assert "python.python_yank" not in summary_b.present
261259

262260
# Yank in repo B too, then unyank only in repo A
263-
response = yank(distro_b, TWINE_NAME, TWINE_VERSION)
264-
assert response.status_code == 202
265-
monitor_task(response.json()["task"])
261+
response = python_bindings.PypiYankApi.yank(
262+
path=distro_b.base_path, yank={"name": TWINE_NAME, "version": TWINE_VERSION}
263+
)
264+
monitor_task(response.task)
266265

267-
response = unyank(distro_a, TWINE_NAME, TWINE_VERSION)
268-
assert response.status_code == 202
269-
monitor_task(response.json()["task"])
266+
response = python_bindings.PypiUnyankApi.unyank(
267+
path=distro_a.base_path, yank={"name": TWINE_NAME, "version": TWINE_VERSION}
268+
)
269+
monitor_task(response.task)
270270

271271
# Repo A should be not-yanked, repo B should remain yanked
272272
summary_a = python_content_summary(repository=repo_a, version=3)
@@ -276,23 +276,31 @@ def test_yank_isolation_across_repositories(
276276

277277

278278
@pytest.mark.parallel
279-
def test_yank_nonexistent_package(python_repo_factory, python_distribution_factory):
279+
def test_yank_nonexistent_package(
280+
python_bindings, python_repo_factory, python_distribution_factory
281+
):
280282
"""
281283
Yanking a package not in the repo should return 404.
282284
"""
283285
repo = python_repo_factory()
284286
distro = python_distribution_factory(repository=repo)
285287

286-
response = yank(distro, "nonexistent-package", "99.99.99")
287-
assert response.status_code == 404
288+
with pytest.raises(python_bindings.ApiException) as exc:
289+
python_bindings.PypiYankApi.yank(
290+
path=distro.base_path, yank={"name": "nonexistent-package", "version": "99.99.99"}
291+
)
292+
assert exc.value.status == 404
288293

289294

290295
@pytest.mark.parallel
291-
def test_yank_no_repository(python_distribution_factory):
296+
def test_yank_no_repository(python_bindings, python_distribution_factory):
292297
"""
293298
Yanking on a distribution with no repository should return 400.
294299
"""
295300
distro = python_distribution_factory()
296301

297-
response = yank(distro, TWINE_NAME, TWINE_VERSION)
298-
assert response.status_code == 400
302+
with pytest.raises(python_bindings.ApiException) as exc:
303+
python_bindings.PypiYankApi.yank(
304+
path=distro.base_path, yank={"name": TWINE_NAME, "version": TWINE_VERSION}
305+
)
306+
assert exc.value.status == 400

0 commit comments

Comments
 (0)