Skip to content

Commit

Permalink
fix: only count approved resources in subjects endpoint (#1493)
Browse files Browse the repository at this point in the history
  • Loading branch information
cgodwin1 authored Dec 3, 2024
1 parent 016a5be commit 2b52ab8
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 5 deletions.
74 changes: 74 additions & 0 deletions solution/backend/resources/tests/test_subjects_endpoint.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@

from django.contrib.auth.models import User
from django.test import TestCase
from rest_framework.test import APIClient

from resources.models import (
FederalRegisterLink,
InternalFile,
Subject,
)


class TestResourcesEndpoint(TestCase):
def login(self):
self.client = APIClient()
self.user = User.objects.create_superuser(username='test_user', password='test') # noqa: S106
self.client.force_authenticate(self.user)

def setUp(self):
subject1 = Subject.objects.create(full_name="Access to Services", short_name="Subj1", abbreviation="ATS")
subject2 = Subject.objects.create(full_name="Subject 2", short_name="Subj2", abbreviation="S2")

f1 = FederalRegisterLink.objects.create(approved=True)
f1.subjects.set([subject1])
f1.save()

f2 = FederalRegisterLink.objects.create(approved=True)
f2.subjects.set([subject1])
f2.save()

f3 = FederalRegisterLink.objects.create(approved=False)
f3.subjects.set([subject1, subject2])
f3.save()

file1 = InternalFile.objects.create(approved=True)
file1.subjects.set([subject1])
file1.save()

file2 = InternalFile.objects.create(approved=False)
file2.subjects.set([subject1, subject2])
file2.save()

def test_subjects_endpoint_logged_in(self):
self.login()
data = self.client.get("/v3/resources/subjects").data
self.assertEqual(data["count"], 2)

self.assertEqual(data["results"][0]["public_resources"], 2)
self.assertEqual(data["results"][0]["internal_resources"], 1)
self.assertEqual(data["results"][0]["full_name"], "Access to Services")
self.assertEqual(data["results"][0]["short_name"], "Subj1")
self.assertEqual(data["results"][0]["abbreviation"], "ATS")

self.assertEqual(data["results"][1]["public_resources"], 0)
self.assertEqual(data["results"][1]["internal_resources"], 0)
self.assertEqual(data["results"][1]["full_name"], "Subject 2")
self.assertEqual(data["results"][1]["short_name"], "Subj2")
self.assertEqual(data["results"][1]["abbreviation"], "S2")

def test_subjects_endpoint_logged_out(self):
data = self.client.get("/v3/resources/subjects").data
self.assertEqual(data["count"], 2)

self.assertEqual(data["results"][0]["public_resources"], 2)
self.assertEqual(data["results"][0]["internal_resources"], 0)
self.assertEqual(data["results"][0]["full_name"], "Access to Services")
self.assertEqual(data["results"][0]["short_name"], "Subj1")
self.assertEqual(data["results"][0]["abbreviation"], "ATS")

self.assertEqual(data["results"][1]["public_resources"], 0)
self.assertEqual(data["results"][1]["internal_resources"], 0)
self.assertEqual(data["results"][1]["full_name"], "Subject 2")
self.assertEqual(data["results"][1]["short_name"], "Subj2")
self.assertEqual(data["results"][1]["abbreviation"], "S2")
12 changes: 7 additions & 5 deletions solution/backend/resources/views/subjects.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,22 @@

@extend_schema(
tags=["resources/metadata"],
description="Retrieve a list of subjects, each annotated with the count of associated public and internal resources. "
"Authenticated users can see the count of both public and internal resources, while unauthenticated users "
"only see the count of public resources. The subjects are ordered by a predefined sort order.",
description="Retrieve a list of subjects, each annotated with the count of associated approved public and internal "
"resources. Authenticated users can see the count of both public and internal resources, while unauthenticated "
"users only see the count of public resources. The subjects are ordered by a predefined sort order.",
responses={200: SubjectWithCountsSerializer(many=True)},
)
class SubjectViewSet(viewsets.ReadOnlyModelViewSet):
serializer_class = SubjectWithCountsSerializer
pagination_class = ViewSetPagination

def get_queryset(self):
public_filter = Q(resources__abstractpublicresource__isnull=False) & Q(resources__approved=True)
internal_filter = Q(resources__abstractinternalresource__isnull=False) & Q(resources__approved=True)
return Subject.objects.annotate(**{
"public_resources": Count("resources", filter=Q(resources__abstractpublicresource__isnull=False)),
"public_resources": Count("resources", filter=public_filter),
"internal_resources": (
Count("resources", filter=Q(resources__abstractinternalresource__isnull=False))
Count("resources", filter=internal_filter)
if self.request.user.is_authenticated else
Value(0)
),
Expand Down

0 comments on commit 2b52ab8

Please sign in to comment.