add tests

Author: CHAS Technology

backend/ohq/serializers.py

@@ -4,6 +4,7 @@
 from django.core.exceptions import ObjectDoesNotExist
 from django.utils import timezone
 from django.utils.crypto import get_random_string
+from django.http import JsonResponse
 from phonenumber_field.serializerfields import PhoneNumberField
 from rest_framework import serializers
 from rest_live.signals import save_handler
@@ -51,17 +52,41 @@ def save(self):
         self.validated_data["queue"] = Queue.objects.get(pk=self.context["view"].kwargs["queue_pk"])
         return super().save()
 
-class QuestionRouteMixin(serializers.ModelSerializer):
+class QuestionReviewRouteMixin(serializers.ModelSerializer):
     """
     Mixin for serializers that overrides the save method to
     properly handle the URL parameter for questions.
     """
 
     def save(self):
         self.validated_data["question"] = Question.objects.get(pk=self.context["view"].kwargs["question_pk"])
-        return super().save()
-
-
+        
+        if self.validated_data["question"].status != "ANSWERED":
+            return  JsonResponse({"detail": "This question has not been answered by a TA yet"})
+
+        if self.context["request"].method == "POST" and "rating" in self.validated_data:
+            if "rating" not in self.validated_data:
+                return JsonResponse({"detail": "A rating must be provided"})
+            if self.validated_data["question"].review != None:
+                return  JsonResponse({"detail": "This question is already reviewed."})
+            review = Review(content="", rating=self.validated_data["rating"])
+            if "content" in self.validated_data:
+                review.content = self.validated_data["content"]
+            review.save()
+            self.validated_data["question"].review = review 
+            self.validated_data["question"].save()
+            return JsonResponse({"detail": "Your review has been posted."})
+
+        if self.context["request"].method == "PATCH":
+            self.validated_data["review"] = Review.objects.get(pk=self.context["view"].kwargs["pk"])
+            if "rating" not in self.validated_data and "content" not in self.validated_data:
+                return JsonResponse({"detail": "Your review does not contain any content or rating."})
+            if "rating" in self.validated_data:
+                self.validated_data["review"].rating = self.validated_data["rating"]
+            if "content" in self.validated_data:
+                self.validated_data["review"].content = self.validated_data["content"]
+            self.validated_data["review"].save()
+            return JsonResponse({"detail": "Your review is updated"})
 
 class SemesterSerializer(serializers.ModelSerializer):
     pretty = serializers.SerializerMethodField()
@@ -221,7 +246,7 @@ class Meta:
         fields = ("id", "name")
 
 
-class ReviewSerializer(QuestionRouteMixin):
+class ReviewSerializer(QuestionReviewRouteMixin):
     """
     Serializer for review
     """
@@ -240,7 +265,7 @@ class QuestionSerializer(QueueRouteMixin):
     responded_to_by = UserSerializer(read_only=True)
     tags = TagSerializer(many=True)
     position = serializers.IntegerField(default=-1, read_only=True)
-    review = ReviewSerializer()
+    review = ReviewSerializer(read_only=True)
 
     class Meta:
         model = Question
@@ -272,6 +297,7 @@ class Meta:
             "should_send_up_soon_notification",
             "resolved_note",
             "position",
+            "review",
         )
 
     def update(self, instance, validated_data):

backend/ohq/views.py

@@ -824,7 +824,6 @@ class ReviewViewSet(viewsets.ModelViewSet):
 
     def get_queryset(self):
         membership = Membership.objects.get(course=self.kwargs["course_pk"], user=self.request.user)
-        
         if membership.kind == "TA":
             return Review.objects.filter(question=self.kwargs["question_pk"], question__responded_to_by=self.request.user)
 

backend/tests/ohq/test_permissions.py

@@ -1311,3 +1311,105 @@ def test_modify(self, user):
             reverse("ohq:occurrence-detail", args=[self.occurrence.id]),
             {"title": self.new_title, "courseId": self.course.id},
         )
+
+class ReviewTestCase(TestCase):
+    def setUp(self):
+        setUp(self)
+        self.semester = Semester.objects.create(year=2020, term=Semester.TERM_SUMMER)
+        self.course = Course.objects.create(
+            course_code="000", department="Penn Labs", semester=self.semester
+        )
+        self.head_ta = User.objects.create(username="head_ta")
+        self.ta = User.objects.create(username="ta")
+        self.other_ta = User.objects.create(username="other_ta")
+        self.student = User.objects.create(username="student")
+        self.other_student = User.objects.create(username="other_student")
+        Membership.objects.create(
+            course=self.course, user=self.head_ta, kind=Membership.KIND_HEAD_TA
+        )
+        Membership.objects.create(course=self.course, user=self.ta, kind=Membership.KIND_TA)
+        Membership.objects.create(
+            course=self.course, user=self.student, kind=Membership.KIND_STUDENT
+        )
+        Membership.objects.create(
+            course=self.course, user=self.other_student, kind=Membership.KIND_STUDENT
+        )
+        self.queue = Queue.objects.create(name="Queue", course=self.course)
+        self.question_text = "This is a question"
+        self.question_1 = Question.objects.create(
+            queue=self.queue, asked_by=self.student, text=self.question_text, status="ANSWERED"
+        )
+        self.review_1 = Review.objects.create(content="TA was helpful", rating=5)
+        self.question_1.review = self.review_1
+        se;f.question_1.save()
+        self.question_2 = Question.objects.create(
+            queue=self.queue, asked_by=self.student, text=self.question_text, status="ANSWERED"
+        )
+        self.review_2 = Review.objects.create(content="TA was mid", rating=2)
+        self.question_2.review = self.review_2
+        se;f.question_2.save()
+        
+
+        # Expected results
+        self.expected = {
+            "list": {
+                "professor": 200,
+                "head_ta": 200,
+                "ta": 200,
+                "student": 200,
+                "non_member": 403,
+                "anonymous": 403,
+            },
+            "retrieve": {
+                "professor": 200,
+                "head_ta": 200,
+                "ta": 200,
+                "student": 200,
+                "non_member": 403,
+                "anonymous": 403,
+            },
+            "modify": {
+                "professor": 403,
+                "head_ta": 403,
+                "ta": 403,
+                "student": 200,
+                "non_member": 403,
+                "anonymous": 403,
+            },
+        }
+
+    @parameterized.expand(users, name_func=get_test_name)
+    def test_list(self, user):
+        test(
+            self,
+            user,
+            "list",
+            "get",
+            "/api/occurrences/?course="
+            + str(self.course.id)
+            + "&filter_start="
+            + self.filter_start
+            + "&filter_end="
+            + self.filter_end,
+        )
+
+    @parameterized.expand(users, name_func=get_test_name)
+    def test_retrieve(self, user):
+        test(
+            self,
+            user,
+            "retrieve",
+            "get",
+            reverse("ohq:occurrence-detail", args=[self.occurrence.id]),
+        )
+
+    @parameterized.expand(users, name_func=get_test_name)
+    def test_modify(self, user):
+        test(
+            self,
+            user,
+            "modify",
+            "patch",
+            reverse("ohq:occurrence-detail", args=[self.occurrence.id]),
+            {"title": self.new_title, "courseId": self.course.id},
+        )

backend/tests/ohq/test_serializers.py

@@ -16,6 +16,7 @@
     MembershipSerializer,
     SemesterSerializer,
     UserPrivateSerializer,
+    ReviewSerializer,
 )
 
 
@@ -302,7 +303,7 @@ def setUp(self):
 
     def test_create(self, mock_delay):
         self.client.force_authenticate(user=self.student2)
-        self.client.post(
+        response = self.client.post(
             reverse("ohq:question-list", args=[self.course.id, self.queue.id]),
             {"text": "Help me", "tags": [{"name": "Tag"}]},
         )
@@ -733,6 +734,7 @@ def setUp(self):
         )
         self.head_ta = User.objects.create(username="head_ta")
         self.ta = User.objects.create(username="ta")
+        self.other_ta = User.objects.create(username="other_ta")
         self.student = User.objects.create(username="student")
         self.other_student = User.objects.create(username="other_student")
         Membership.objects.create(
@@ -748,17 +750,17 @@ def setUp(self):
         self.queue = Queue.objects.create(name="Queue", course=self.course)
         self.question_text = "This is a question"
         self.question_1 = Question.objects.create(
-            queue=self.queue, asked_by=self.student, text=self.question_text
+            queue=self.queue, asked_by=self.student, text=self.question_text, status="ANSWERED"
         )
         self.review_content_1 = "TA was helpful"
         self.review_rating_1 = 5
         self.question_2 = Question.objects.create(
-            queue=self.queue, asked_by=self.student, text=self.question_text
+            queue=self.queue, asked_by=self.student, text=self.question_text, status="ANSWERED"
         )
         self.review_content_2 = "TA was mid"
         self.review_rating_2 = 2
         self.question_3 = Question.objects.create(
-            queue=self.queue, asked_by=self.student, text=self.question_text
+            queue=self.queue, asked_by=self.student, text=self.question_text, status="ANSWERED"
         )
         self.review_content_3 = "TA was decent"
         self.review_rating_3 = 4
@@ -777,6 +779,28 @@ def test_create(self):
         )
         self.assertEqual(1, Review.objects.all().count())
 
+        # Ensure only one review can be made for one question
+        self.client.post(
+            reverse("ohq:review-list", args=[self.course.id, self.queue.id, self.question_1.id]),
+            {
+                "content": self.review_content_2,
+                "rating": self.review_rating_2
+            },
+        )
+        self.assertEqual(1, Review.objects.all().count())
+
+        # Ensure review cannot be made to unanswered question
+        unanswered_question = Question.objects.create(
+            queue=self.queue, asked_by=self.student, text=self.question_text
+        )
+        self.client.post(
+            reverse("ohq:review-list", args=[self.course.id, self.queue.id, unanswered_question.id]),
+            {
+                "content": self.review_content_2,
+                "rating": self.review_rating_2
+            },
+        )
+        self.assertEqual(1, Review.objects.all().count())
 
         # Ensure TA cannot create a review
         self.client.force_authenticate(user=self.ta)
@@ -837,14 +861,64 @@ def test_list(self):
                 "rating": self.review_rating_1
             },
         )
-        response = self.client.get("/api/courses/" + self.course.id
-                                + "/queues/" + self.queue.id
-                                + "/questions/" + self.question_1.id + "/reviews/")
+        response = self.client.get("/api/courses/" +str( self.course.id)
+                                + "/queues/" + str(self.queue.id)
+                                + "/questions/" + str(self.question_1.id) + "/reviews/")
         data = json.loads(response.content)
         self.assertEqual(1, len(data))
 
+        # Student cannot get access to review made by other students
         self.client.force_authenticate(user=self.other_student)
+        response = self.client.get("/api/courses/" + str( self.course.id)
+                                + "/queues/" + str(self.queue.id)
+                                + "/questions/" + str(self.question_1.id) + "/reviews/")
+        data = json.loads(response.content)
+        self.assertEqual(0, len(data))
+    
+    def test_update(self):
+        """
+        Ensure students can update reviews
+        """
+        self.client.force_authenticate(user=self.student)
+        self.client.post(
+            reverse("ohq:review-list", args=[self.course.id, self.queue.id, self.question_1.id]),
+            {
+                "content": self.review_content_1,
+                "rating": self.review_rating_1
+            },
+        )
+        review = Review.objects.first()
+        response = self.client.patch(
+            reverse("ohq:review-detail", args=[self.course.id, self.queue.id, self.question_1.id, review.id]),
+            {"content": "hello"},
+        )
+        review = Review.objects.first()
+        self.assertEqual("hello", review.content)
+        response = self.client.patch(
+            reverse("ohq:review-detail", args=[self.course.id, self.queue.id, self.question_1.id, review.id]),
+            {"rating": 2},
+        )
+        review = Review.objects.first()
+        self.assertEqual(2, review.rating)
 
+        # Updating reviews without appropriate key will not work
+        response = self.client.patch(
+            reverse("ohq:review-detail", args=[self.course.id, self.queue.id, self.question_1.id, review.id]),
+            {"something": 3},
+        )
+        self.assertEqual("hello", review.content)
+        self.assertEqual(2, review.rating)
+
+        # Ensure TAs cannot update reviews
+        self.client.force_authenticate(user=self.ta)
+        review = Review.objects.first()
+        response = self.client.patch(
+            reverse("ohq:review-detail", args=[self.course.id, self.queue.id, self.question_1.id, review.id]),
+            {"content": "The best ta ever", "rating": 5},
+        )
+        review = Review.objects.first()
+        self.assertEqual("hello", review.content)
+        self.assertEqual(2, review.rating)
 
 
 

backend/tests/ohq/test_views.py

@@ -309,7 +309,7 @@ def test_list(self):
         response = self.client.get(
             "/api/occurrences/?course="
             + str(self.course.id)
-            + "&filter_start="b
+            + "&filter_start="
             + self.filter_start
             + "&filter_end="
             + self.filter_end