From 1a2ab96ddcb8ae998659dae3dab6e3655efdc851 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 18 Nov 2026 10:08:26 -0800 Subject: [PATCH] tests --- src/documents/tests/test_api_release_notes.py | 67 +++++++++++++++++-- .../tests/test_api_remote_version.py | 11 +-- 2 files changed, 69 insertions(+), 9 deletions(-) diff --git a/src/documents/tests/test_api_release_notes.py b/src/documents/tests/test_api_release_notes.py index 888810fb60..8ef32065bd 100644 --- a/src/documents/tests/test_api_release_notes.py +++ b/src/documents/tests/test_api_release_notes.py @@ -6,9 +6,8 @@ from rest_framework.test import APIClient from paperless import version -RELEASES_URL = ( - "https://api.github.com/repos/paperless-ngx/paperless-ngx/releases?per_page=10" -) +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: @@ -55,6 +54,12 @@ class TestApiReleaseNotes: ) return httpx_mock + @pytest.fixture + def stars(self, httpx_mock: HTTPXMock) -> HTTPXMock: + httpx_mock.add_response(url=REPO_URL, json={"stargazers_count": 1234}) + return httpx_mock + + @pytest.mark.usefixtures("stars") def test_since_returns_newer_up_to_current( self, rest_api_client: APIClient, @@ -83,6 +88,7 @@ class TestApiReleaseNotes: == f"

paperless-ngx v{CURRENT}

" ) + @pytest.mark.usefixtures("stars") def test_without_since_returns_current_only( self, rest_api_client: APIClient, @@ -93,6 +99,7 @@ class TestApiReleaseNotes: assert response.status_code == status.HTTP_200_OK assert [r["version"] for r in response.data["releases"]] == [CURRENT] + @pytest.mark.usefixtures("stars") def test_releases_are_cached( self, rest_api_client: APIClient, @@ -101,7 +108,8 @@ class TestApiReleaseNotes: rest_api_client.get(self.ENDPOINT, {"since": OLDER}) rest_api_client.get(self.ENDPOINT) - assert len(releases.get_requests()) == 1 + assert len(releases.get_requests(url=RELEASES_URL)) == 1 + assert len(releases.get_requests(url=REPO_URL)) == 1 def test_invalid_since( self, @@ -132,6 +140,11 @@ class TestApiReleaseNotes: ) -> None: httpx_mock.add_response(url=RELEASES_URL, **mock_kwargs) httpx_mock.add_response(url=RELEASES_URL, json=[_release(f"v{CURRENT}")]) + httpx_mock.add_response( + url=REPO_URL, + json={"stargazers_count": 1234}, + is_reusable=True, + ) response = rest_api_client.get(self.ENDPOINT) assert response.status_code == status.HTTP_200_OK @@ -139,3 +152,49 @@ class TestApiReleaseNotes: response = rest_api_client.get(self.ENDPOINT) assert [r["version"] for r in response.data["releases"]] == [CURRENT] + + @pytest.mark.usefixtures("releases", "stars") + def test_stars_are_returned_and_cached( + self, + rest_api_client: APIClient, + httpx_mock: HTTPXMock, + ) -> None: + """ + GIVEN: + - The GitHub repository reports a star count + WHEN: + - Release notes are requested twice + THEN: + - The star count is included and GitHub is only asked once + """ + response = rest_api_client.get(self.ENDPOINT) + assert response.data["stars"] == 1234 + + response = rest_api_client.get(self.ENDPOINT) + assert response.data["stars"] == 1234 + assert len(httpx_mock.get_requests(url=REPO_URL)) == 1 + + @pytest.mark.usefixtures("releases") + def test_stars_failure_returns_none_and_is_not_cached( + self, + rest_api_client: APIClient, + httpx_mock: HTTPXMock, + ) -> None: + """ + GIVEN: + - The GitHub repository request fails, then succeeds + WHEN: + - Release notes are requested twice + THEN: + - Stars are null at first, then fetched again rather than cached + """ + httpx_mock.add_response(url=REPO_URL, status_code=503) + httpx_mock.add_response(url=REPO_URL, json={"stargazers_count": 1234}) + + response = rest_api_client.get(self.ENDPOINT) + assert response.status_code == status.HTTP_200_OK + assert response.data["stars"] is None + assert len(response.data["releases"]) == 1 + + response = rest_api_client.get(self.ENDPOINT) + assert response.data["stars"] == 1234 diff --git a/src/documents/tests/test_api_remote_version.py b/src/documents/tests/test_api_remote_version.py index 08eada4526..f51e1fa139 100644 --- a/src/documents/tests/test_api_remote_version.py +++ b/src/documents/tests/test_api_remote_version.py @@ -7,9 +7,8 @@ from rest_framework.test import APIClient from paperless import version -RELEASES_URL = ( - "https://api.github.com/repos/paperless-ngx/paperless-ngx/releases?per_page=10" -) +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: @@ -163,12 +162,13 @@ class TestApiRemoteVersion: 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()) == 1 + assert len(httpx_mock.get_requests(url=RELEASES_URL)) == 1 def test_new_running_version_refetches_releases( self, @@ -190,10 +190,11 @@ class TestApiRemoteVersion: 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()) == 2 + assert len(httpx_mock.get_requests(url=RELEASES_URL)) == 2 assert [r["version"] for r in response.data["releases"]] == [upgraded]