mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-11-21 04:52:40 +00:00
go back to quick releases check
This commit is contained in:
3 files changed
+55
-102
No files matched your search
@@ -1,3 +1,5 @@
|
|||||||
|
from unittest import mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from pytest_httpx import HTTPXMock
|
from pytest_httpx import HTTPXMock
|
||||||
@@ -111,6 +113,30 @@ class TestApiReleaseNotes:
|
|||||||
assert len(releases.get_requests(url=RELEASES_URL)) == 1
|
assert len(releases.get_requests(url=RELEASES_URL)) == 1
|
||||||
assert len(releases.get_requests(url=REPO_URL)) == 1
|
assert len(releases.get_requests(url=REPO_URL)) == 1
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures("stars")
|
||||||
|
def test_new_running_version_refetches_releases(
|
||||||
|
self,
|
||||||
|
rest_api_client: APIClient,
|
||||||
|
releases: HTTPXMock,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- GitHub releases cached for the running version
|
||||||
|
WHEN:
|
||||||
|
- The running version changes (i.e. paperless was upgraded)
|
||||||
|
THEN:
|
||||||
|
- The cached releases are not reused and GitHub is queried again
|
||||||
|
"""
|
||||||
|
upgraded = _bump(patch=1)
|
||||||
|
releases.add_response(url=RELEASES_URL, json=[_release(f"v{upgraded}")])
|
||||||
|
|
||||||
|
rest_api_client.get(self.ENDPOINT)
|
||||||
|
with mock.patch.object(version, "__full_version_str__", upgraded):
|
||||||
|
response = rest_api_client.get(self.ENDPOINT)
|
||||||
|
|
||||||
|
assert len(releases.get_requests(url=RELEASES_URL)) == 2
|
||||||
|
assert [r["version"] for r in response.data["releases"]] == [upgraded]
|
||||||
|
|
||||||
@pytest.mark.usefixtures("stars")
|
@pytest.mark.usefixtures("stars")
|
||||||
def test_until_returns_newer_releases(
|
def test_until_returns_newer_releases(
|
||||||
self,
|
self,
|
||||||
|
|||||||
@@ -1,5 +1,3 @@
|
|||||||
from unittest import mock
|
|
||||||
|
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from pytest_httpx import HTTPXMock
|
from pytest_httpx import HTTPXMock
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
@@ -7,17 +5,6 @@ from rest_framework.test import APIClient
|
|||||||
|
|
||||||
from paperless import version
|
from paperless import version
|
||||||
|
|
||||||
REPO_URL = "https://api.github.com/repos/paperless-ngx/paperless-ngx"
|
|
||||||
RELEASES_URL = f"{REPO_URL}/releases?per_page=10"
|
|
||||||
|
|
||||||
|
|
||||||
def _release(tag: str, **kwargs) -> dict:
|
|
||||||
return {
|
|
||||||
"tag_name": tag,
|
|
||||||
"html_url": f"https://github.com/paperless-ngx/paperless-ngx/releases/tag/{tag}",
|
|
||||||
**kwargs,
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
class TestApiRemoteVersion:
|
class TestApiRemoteVersion:
|
||||||
ENDPOINT = "/api/remote_version/"
|
ENDPOINT = "/api/remote_version/"
|
||||||
@@ -31,8 +18,8 @@ class TestApiRemoteVersion:
|
|||||||
httpx_mock: HTTPXMock,
|
httpx_mock: HTTPXMock,
|
||||||
) -> None:
|
) -> None:
|
||||||
httpx_mock.add_response(
|
httpx_mock.add_response(
|
||||||
url=RELEASES_URL,
|
url="https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest",
|
||||||
json=[_release("ngx-1.6.0")],
|
json={"tag_name": "ngx-1.6.0"},
|
||||||
)
|
)
|
||||||
|
|
||||||
response = rest_api_client.get(self.ENDPOINT)
|
response = rest_api_client.get(self.ENDPOINT)
|
||||||
@@ -50,8 +37,8 @@ class TestApiRemoteVersion:
|
|||||||
httpx_mock: HTTPXMock,
|
httpx_mock: HTTPXMock,
|
||||||
) -> None:
|
) -> None:
|
||||||
httpx_mock.add_response(
|
httpx_mock.add_response(
|
||||||
url=RELEASES_URL,
|
url="https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest",
|
||||||
json=[_release(version.__full_version_str__)],
|
json={"tag_name": version.__full_version_str__},
|
||||||
)
|
)
|
||||||
|
|
||||||
response = rest_api_client.get(self.ENDPOINT)
|
response = rest_api_client.get(self.ENDPOINT)
|
||||||
@@ -76,8 +63,8 @@ class TestApiRemoteVersion:
|
|||||||
new_version_str = ".".join(map(str, new_version))
|
new_version_str = ".".join(map(str, new_version))
|
||||||
|
|
||||||
httpx_mock.add_response(
|
httpx_mock.add_response(
|
||||||
url=RELEASES_URL,
|
url="https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest",
|
||||||
json=[_release(new_version_str)],
|
json={"tag_name": new_version_str},
|
||||||
)
|
)
|
||||||
|
|
||||||
response = rest_api_client.get(self.ENDPOINT)
|
response = rest_api_client.get(self.ENDPOINT)
|
||||||
@@ -123,78 +110,3 @@ class TestApiRemoteVersion:
|
|||||||
|
|
||||||
assert "update_available" in response.data
|
assert "update_available" in response.data
|
||||||
assert not response.data["update_available"]
|
assert not response.data["update_available"]
|
||||||
|
|
||||||
def test_remote_version_uses_highest_published_release(
|
|
||||||
self,
|
|
||||||
rest_api_client: APIClient,
|
|
||||||
httpx_mock: HTTPXMock,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- A backport release listed before a newer release, and a newer prerelease
|
|
||||||
WHEN:
|
|
||||||
- The remote version is requested
|
|
||||||
THEN:
|
|
||||||
- The highest non-prerelease version is reported
|
|
||||||
"""
|
|
||||||
major, minor, patch = version.__version__
|
|
||||||
newer = f"{major}.{minor}.{patch + 1}"
|
|
||||||
httpx_mock.add_response(
|
|
||||||
url=RELEASES_URL,
|
|
||||||
json=[
|
|
||||||
_release(f"v{major + 1}.0.0-beta.1", prerelease=True),
|
|
||||||
_release(f"v{major - 1}.9.9"),
|
|
||||||
_release(f"v{newer}"),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
response = rest_api_client.get(self.ENDPOINT)
|
|
||||||
|
|
||||||
assert response.data["version"] == newer
|
|
||||||
assert response.data["update_available"]
|
|
||||||
|
|
||||||
def test_remote_version_and_release_notes_share_request(
|
|
||||||
self,
|
|
||||||
rest_api_client: APIClient,
|
|
||||||
httpx_mock: HTTPXMock,
|
|
||||||
) -> None:
|
|
||||||
httpx_mock.add_response(
|
|
||||||
url=RELEASES_URL,
|
|
||||||
json=[_release(f"v{version.__full_version_str__}")],
|
|
||||||
)
|
|
||||||
httpx_mock.add_response(url=REPO_URL, json={"stargazers_count": 1234})
|
|
||||||
|
|
||||||
rest_api_client.get(self.ENDPOINT)
|
|
||||||
response = rest_api_client.get("/api/release_notes/")
|
|
||||||
|
|
||||||
assert len(response.data["releases"]) == 1
|
|
||||||
assert len(httpx_mock.get_requests(url=RELEASES_URL)) == 1
|
|
||||||
|
|
||||||
def test_new_running_version_refetches_releases(
|
|
||||||
self,
|
|
||||||
rest_api_client: APIClient,
|
|
||||||
httpx_mock: HTTPXMock,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- GitHub releases cached for the running version
|
|
||||||
WHEN:
|
|
||||||
- The running version changes (i.e. paperless was upgraded)
|
|
||||||
THEN:
|
|
||||||
- The cached releases are not reused and GitHub is queried again
|
|
||||||
"""
|
|
||||||
major, minor, patch = version.__version__
|
|
||||||
upgraded = f"{major}.{minor}.{patch + 1}"
|
|
||||||
httpx_mock.add_response(
|
|
||||||
url=RELEASES_URL,
|
|
||||||
json=[_release(f"v{version.__full_version_str__}")],
|
|
||||||
)
|
|
||||||
httpx_mock.add_response(url=RELEASES_URL, json=[_release(f"v{upgraded}")])
|
|
||||||
httpx_mock.add_response(url=REPO_URL, json={"stargazers_count": 1234})
|
|
||||||
|
|
||||||
rest_api_client.get(self.ENDPOINT)
|
|
||||||
with mock.patch.object(version, "__full_version_str__", upgraded):
|
|
||||||
response = rest_api_client.get("/api/release_notes/")
|
|
||||||
|
|
||||||
assert len(httpx_mock.get_requests(url=RELEASES_URL)) == 2
|
|
||||||
assert [r["version"] for r in response.data["releases"]] == [upgraded]
|
|
||||||
+23
-8
@@ -4394,16 +4394,31 @@ def get_github_stars() -> int | None:
|
|||||||
),
|
),
|
||||||
)
|
)
|
||||||
class RemoteVersionView(GenericAPIView[Any]):
|
class RemoteVersionView(GenericAPIView[Any]):
|
||||||
|
cache_key = "remote_version_view_latest_release"
|
||||||
|
|
||||||
def get(self, request, format=None):
|
def get(self, request, format=None):
|
||||||
current_version = packaging_version.parse(version.__full_version_str__)
|
current_version = packaging_version.parse(version.__full_version_str__)
|
||||||
releases = get_github_releases(current_version)
|
remote_version = cache.get(self.cache_key)
|
||||||
remote_version = (
|
if remote_version is None:
|
||||||
max(releases, key=lambda r: packaging_version.parse(r["version"]))[
|
try:
|
||||||
"version"
|
resp = httpx.get(
|
||||||
]
|
"https://api.github.com/repos/paperless-ngx/paperless-ngx/releases/latest",
|
||||||
if releases
|
headers={"Accept": "application/json"},
|
||||||
else "0.0.0"
|
)
|
||||||
)
|
resp.raise_for_status()
|
||||||
|
data = resp.json()
|
||||||
|
remote_version = data["tag_name"]
|
||||||
|
# Some early tags used ngx-x.y.z
|
||||||
|
remote_version = remote_version.removeprefix("ngx-")
|
||||||
|
except ValueError as e:
|
||||||
|
logger.debug(f"An error occurred parsing remote version json: {e}")
|
||||||
|
except httpx.HTTPError as e:
|
||||||
|
logger.debug(f"An error occurred checking for available updates: {e}")
|
||||||
|
|
||||||
|
if remote_version:
|
||||||
|
cache.set(self.cache_key, remote_version, 60 * 15)
|
||||||
|
else:
|
||||||
|
remote_version = "0.0.0"
|
||||||
|
|
||||||
is_greater_than_current = (
|
is_greater_than_current = (
|
||||||
packaging_version.parse(remote_version) > current_version
|
packaging_version.parse(remote_version) > current_version
|
||||||
|
|||||||
Reference in new issue
Block a user