mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-11-20 12:36:53 +00:00
Add until
This commit is contained in:
2 files changed
+47
-12
No files matched your search
@@ -111,11 +111,37 @@ class TestApiReleaseNotes:
|
||||
assert len(releases.get_requests(url=RELEASES_URL)) == 1
|
||||
assert len(releases.get_requests(url=REPO_URL)) == 1
|
||||
|
||||
def test_invalid_since(
|
||||
@pytest.mark.usefixtures("stars")
|
||||
def test_until_returns_newer_releases(
|
||||
self,
|
||||
rest_api_client: APIClient,
|
||||
releases: HTTPXMock,
|
||||
) -> None:
|
||||
response = rest_api_client.get(self.ENDPOINT, {"since": "not-a-version"})
|
||||
"""
|
||||
GIVEN:
|
||||
- A GitHub release newer than the running version
|
||||
WHEN:
|
||||
- Release notes are requested from the running version until the newer one
|
||||
THEN:
|
||||
- Only the newer release is returned, excluding prereleases
|
||||
"""
|
||||
response = rest_api_client.get(
|
||||
self.ENDPOINT,
|
||||
{"since": CURRENT, "until": _bump(minor=1)},
|
||||
)
|
||||
|
||||
assert response.status_code == status.HTTP_200_OK
|
||||
assert [r["version"] for r in response.data["releases"]] == [
|
||||
_bump(patch=1),
|
||||
]
|
||||
|
||||
@pytest.mark.parametrize("param", ["since", "until"])
|
||||
def test_invalid_version(
|
||||
self,
|
||||
rest_api_client: APIClient,
|
||||
param: str,
|
||||
) -> None:
|
||||
response = rest_api_client.get(self.ENDPOINT, {param: "not-a-version"})
|
||||
|
||||
assert response.status_code == status.HTTP_400_BAD_REQUEST
|
||||
|
||||
|
||||
+19
-10
@@ -4421,8 +4421,8 @@ class RemoteVersionView(GenericAPIView[Any]):
|
||||
get=extend_schema(
|
||||
description=(
|
||||
"Get release notes from GitHub for releases newer than `since`, "
|
||||
"up to and including the running version. Without `since`, only "
|
||||
"the running version's notes are returned."
|
||||
"up to and including `until` (default: the running version). "
|
||||
"Without `since`, only the `until` version's notes are returned."
|
||||
),
|
||||
parameters=[
|
||||
OpenApiParameter(
|
||||
@@ -4431,6 +4431,12 @@ class RemoteVersionView(GenericAPIView[Any]):
|
||||
location=OpenApiParameter.QUERY,
|
||||
required=False,
|
||||
),
|
||||
OpenApiParameter(
|
||||
name="until",
|
||||
type=OpenApiTypes.STR,
|
||||
location=OpenApiParameter.QUERY,
|
||||
required=False,
|
||||
),
|
||||
],
|
||||
responses={
|
||||
(200, "application/json"): OpenApiTypes.OBJECT,
|
||||
@@ -4440,21 +4446,24 @@ class RemoteVersionView(GenericAPIView[Any]):
|
||||
class ReleaseNotesView(GenericAPIView[Any]):
|
||||
def get(self, request, format=None):
|
||||
current_version = packaging_version.parse(version.__full_version_str__)
|
||||
since_param = request.query_params.get("since")
|
||||
since = None
|
||||
if since_param:
|
||||
try:
|
||||
since = until = None
|
||||
try:
|
||||
if since_param := request.query_params.get("since"):
|
||||
since = packaging_version.parse(since_param)
|
||||
except packaging_version.InvalidVersion:
|
||||
return HttpResponseBadRequest("Invalid since version")
|
||||
if until_param := request.query_params.get("until"):
|
||||
until = packaging_version.parse(until_param)
|
||||
except packaging_version.InvalidVersion:
|
||||
return HttpResponseBadRequest("Invalid version")
|
||||
# Newer releases can be requested e.g. for "update available"
|
||||
until = until or current_version
|
||||
|
||||
releases = get_github_releases(current_version) or []
|
||||
|
||||
def in_range(release_version: str) -> bool:
|
||||
v = packaging_version.parse(release_version)
|
||||
if since is None:
|
||||
return v == current_version
|
||||
return since < v <= current_version
|
||||
return v == until
|
||||
return since < v <= until
|
||||
|
||||
return Response(
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user