refactor: add InvalidJSONResponseError

grader/config.py

@@ -20,3 +20,4 @@ class AGRubric:
     INCORRECT_RESPONSE_VALUE_PENALTY_PCT = float(os.getenv("AG_INCORRECT_RESPONSE_VALUE_PENALTY_PCT", "0.15"))
     RESPONSE_FAILED_PENALTY_PCT = float(os.getenv("AG_RESPONSE_FAILED_PENALTY_PCT", "0.20"))
     INVALID_RESPONSE_STRUCTURE_PENALTY_PCT = float(os.getenv("AG_INVALID_RESPONSE_STRUCTURE_PENALTY_PCT", "0.30"))
+    AG_INVALID_JSON_RESPONSE_PENALTY_PCT = float(os.getenv("AG_INVALID_JSON_RESPONSE_PENALTY_PCT", "0.50"))

grader/exceptions.py

@@ -24,6 +24,14 @@ def penalty_pct(self):
         return self._penalty_pct
 
 
+class InvalidJSONResponseError(AGException):
+    """A custom exception for the AutomatedGrader class."""
+
+    def __init__(self, message):
+        self.message = message
+        super().__init__(self.message, penalty_pct=AGRubric.AG_INVALID_JSON_RESPONSE_PENALTY_PCT)
+
+
 class InvalidResponseStructureError(AGException):
     """A custom exception for the AutomatedGrader class."""
 
@@ -58,6 +66,7 @@ def __init__(self, message):
 
 VALID_MESSAGE_TYPES = [
     "Success",
+    InvalidJSONResponseError.__name__,
     IncorrectResponseTypeError.__name__,
     IncorrectResponseValueError.__name__,
     InvalidResponseStructureError.__name__,

grader/grader.py

@@ -10,6 +10,7 @@
     AGException,
     IncorrectResponseTypeError,
     IncorrectResponseValueError,
+    InvalidJSONResponseError,
     InvalidResponseStructureError,
     ResponseFailedError,
 )
@@ -72,8 +73,8 @@ def grade(self):
             assignment_json = json.loads(self.assignment)
         except json.JSONDecodeError as e:
             try:
-                raise InvalidResponseStructureError("The assignment is not valid JSON") from e
-            except InvalidResponseStructureError as reraised_e:
+                raise InvalidJSONResponseError("The assignment is not valid JSON") from e
+            except InvalidJSONResponseError as reraised_e:
                 return self.grade_response(reraised_e)
 
         # 2.) attempt to validate the assignment using Pydantic

grader/tests/test_responses.py

@@ -59,8 +59,9 @@ def test_bad_data(self):
         grade = automated_grader.grade()
         self.grade_structure(grade)
 
-        assert grade["grade"] == 70, "The grade is not 70"
-        assert grade["message_type"] == "InvalidResponseStructureError"
+        assert grade["grade"] == 50, "The grade is not 50"
+        assert grade["message_type"] == "InvalidJSONResponseError"
+        assert grade["message"] == "The assignment is not valid JSON"
 
     def test_incorrect_response_type(self):
         """Test an assignment with an incorrect response type."""
@@ -69,8 +70,9 @@ def test_incorrect_response_type(self):
         grade = automated_grader.grade()
         self.grade_structure(grade)
 
-        assert grade["grade"] == 70, "The grade is not 70"
-        assert grade["message_type"] == "InvalidResponseStructureError"
+        assert grade["grade"] == 50, "The grade is not 50"
+        assert grade["message_type"] == "InvalidJSONResponseError"
+        assert grade["message"] == "The assignment is not valid JSON"
 
     def test_incorrect_response_statuscode(self):
         """Test an assignment with an incorrect response status code."""
@@ -81,6 +83,7 @@ def test_incorrect_response_statuscode(self):
 
         assert grade["message_type"] == "ResponseFailedError"
         assert grade["grade"] == 80, "The grade is not 80"
+        assert grade["message"] == "status_code must be 200. received: 403"
 
     def test_incorrect_messages(self):
         """Test an assignment with an incorrect message."""
@@ -91,6 +94,7 @@ def test_incorrect_messages(self):
 
         assert grade["message_type"] == "InvalidResponseStructureError"
         assert grade["grade"] == 70, "The grade is not 70"
+        assert grade["message"] == "The assignment failed pydantic validation."
 
     def test_incorrect_data_type(self):
         """Test an assignment with an incorrect data type."""
@@ -101,6 +105,7 @@ def test_incorrect_data_type(self):
 
         assert grade["message_type"] == "InvalidResponseStructureError"
         assert grade["grade"] == 70, "The grade is not 70"
+        assert grade["message"] == "The assignment failed pydantic validation."
 
     def test_bad_message_01(self):
         """Test an assignment with an incorrect message."""
@@ -111,6 +116,7 @@ def test_bad_message_01(self):
 
         assert grade["message_type"] == "InvalidResponseStructureError"
         assert grade["grade"] == 70, "The grade is not 70"
+        assert grade["message"] == "The assignment failed pydantic validation."
 
     def test_bad_message_02(self):
         """Test an assignment with an incorrect message."""
@@ -121,6 +127,7 @@ def test_bad_message_02(self):
 
         assert grade["message_type"] == "InvalidResponseStructureError"
         assert grade["grade"] == 70, "The grade is not 70"
+        assert grade["message"] == "messages must contain at least 2 objects"
 
     def test_bad_message_03(self):
         """Test an assignment with an incorrect message."""
@@ -131,6 +138,7 @@ def test_bad_message_03(self):
 
         assert grade["message_type"] == "InvalidResponseStructureError"
         assert grade["grade"] == 70, "The grade is not 70"
+        assert grade["message"] == "The assignment failed pydantic validation."
 
     def test_bad_message_04(self):
         """Test an assignment with an incorrect message."""
@@ -141,3 +149,4 @@ def test_bad_message_04(self):
 
         assert grade["message_type"] == "InvalidResponseStructureError"
         assert grade["grade"] == 70, "The grade is not 70"
+        assert grade["message"] == "The assignment failed pydantic validation."