cornflow 1.1.2__py3-none-any.whl → 1.1.5a1__py3-none-any.whl

cornflow/tests/unit/test_cases.py

@@ -1,5 +1,34 @@
 """
-Unit test for the cases models and endpoints
+Unit tests for the cases models and endpoints.
+
+This module contains tests for the cases functionality, including:
+- Case model operations and relationships
+- Case API endpoints
+- Case data manipulation and validation
+- Case tree structure management
+
+Classes
+-------
+TestCasesModels
+    Tests for the case model functionality and relationships
+TestCasesFromInstanceExecutionEndpoint
+    Tests for creating cases from instances and executions
+TestCasesRawDataEndpoint
+    Tests for handling raw case data
+TestCaseCopyEndpoint
+    Tests for case copying functionality
+TestCaseListEndpoint
+    Tests for case listing functionality
+TestCaseDetailEndpoint
+    Tests for case detail operations
+TestCaseToInstanceEndpoint
+    Tests for converting cases to instances
+TestCaseJsonPatch
+    Tests for JSON patch operations on cases
+TestCaseDataEndpoint
+    Tests for case data operations
+TestCaseCompare
+    Tests for case comparison functionality
 """
 
 # Import from libraries
@@ -33,7 +62,24 @@ from cornflow.tests.custom_test_case import CustomTestCase, BaseTestCases
 
 
 class TestCasesModels(CustomTestCase):
+    """
+    Test cases for the case model functionality.
+
+    This class tests the core case model operations including:
+    - Case creation and relationships
+    - Case tree structure management
+    - Case deletion and cascading effects
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes test data including:
+        - Base test case setup
+        - Test case data and relationships
+        - Case tree structure
+        """
         super().setUp()
 
         def load_file(_file):
@@ -53,6 +99,13 @@ class TestCasesModels(CustomTestCase):
             node.save()
 
     def test_new_case(self):
+        """
+        Test creating new cases with parent-child relationships.
+
+        Verifies:
+        - Correct path generation for cases
+        - Proper parent-child relationships
+        """
         user = UserModel.get_one_user(self.user)
         case = CaseModel.get_one_object(user=user, idx=6)
         self.assertEqual(case.path, "1/3/")
@@ -60,6 +113,13 @@ class TestCasesModels(CustomTestCase):
         self.assertEqual(case.path, "1/7/")
 
     def test_move_case(self):
+        """
+        Test moving cases within the case tree.
+
+        Verifies:
+        - Cases can be moved to new parents
+        - Path updates correctly after move
+        """
         user = UserModel.get_one_user(self.user)
         case6 = CaseModel.get_one_object(user=user, idx=6)
         case11 = CaseModel.get_one_object(user=user, idx=11)
@@ -67,6 +127,14 @@ class TestCasesModels(CustomTestCase):
         self.assertEqual(case6.path, "1/7/11/")
 
     def test_move_case2(self):
+        """
+        Test complex case movement scenarios.
+
+        Verifies:
+        - Multiple case movements
+        - Nested path updates
+        - Path integrity after moves
+        """
         user = UserModel.get_one_user(self.user)
         case3 = CaseModel.get_one_object(user=user, idx=3)
         case11 = CaseModel.get_one_object(user=user, idx=11)
@@ -77,6 +145,13 @@ class TestCasesModels(CustomTestCase):
         self.assertEqual(case10.path, "1/7/11/3/9/")
 
     def test_delete_case(self):
+        """
+        Test case deletion with cascading effects.
+
+        Verifies:
+        - Case deletion removes the case
+        - Child cases are properly handled
+        """
         user = UserModel.get_one_user(self.user)
         case7 = CaseModel.get_one_object(user=user, idx=7)
         case7.delete()
@@ -84,18 +159,49 @@ class TestCasesModels(CustomTestCase):
         self.assertIsNone(case11)
 
     def test_descendants(self):
+        """
+        Test retrieval of case descendants.
+
+        Verifies:
+        - Correct counting of descendants
+        - Proper descendant relationships
+        """
         user = UserModel.get_one_user(self.user)
         case7 = CaseModel.get_one_object(user=user, idx=7)
         self.assertEqual(len(case7.descendants), 4)
 
     def test_depth(self):
+        """
+        Test case depth calculation.
+
+        Verifies:
+        - Correct depth calculation in case tree
+        - Proper nesting level determination
+        """
         user = UserModel.get_one_user(self.user)
         case10 = CaseModel.get_one_object(user=user, idx=10)
         self.assertEqual(case10.depth, 4)
 
 
 class TestCasesFromInstanceExecutionEndpoint(CustomTestCase):
+    """
+    Test cases for creating cases from instances and executions.
+
+    This class tests the functionality of:
+    - Creating cases from existing instances
+    - Creating cases from executions
+    - Validating case data from different sources
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test instance and execution data
+        - API endpoints and models
+        - Response validation parameters
+        """
         super().setUp()
 
         payload = self.load_file(INSTANCE_PATH)
@@ -137,6 +243,14 @@ class TestCasesFromInstanceExecutionEndpoint(CustomTestCase):
         )
 
     def test_new_case_execution(self):
+        """
+        Test creating a new case from an execution.
+
+        Verifies:
+        - Case creation from execution data
+        - Proper data and solution mapping
+        - Correct metadata assignment
+        """
         self.payload.pop("instance_id")
 
         case_id = self.create_new_row(self.url, self.model, self.payload)
@@ -159,6 +273,14 @@ class TestCasesFromInstanceExecutionEndpoint(CustomTestCase):
             self.assertEqual(self.payload[key], created_case.json[key])
 
     def test_new_case_instance(self):
+        """
+        Test creating a new case from an instance.
+
+        Verifies:
+        - Case creation from instance data
+        - Proper data mapping
+        - Correct handling of missing solution
+        """
         self.payload.pop("execution_id")
         case_id = self.create_new_row(self.url, self.model, self.payload)
 
@@ -179,13 +301,35 @@ class TestCasesFromInstanceExecutionEndpoint(CustomTestCase):
             self.assertEqual(self.payload[key], created_case.json[key])
 
     def test_case_not_created(self):
+        """
+        Test case creation failure scenarios.
+
+        Verifies proper error handling when case creation fails.
+        """
         self.create_new_row(
             self.url, self.model, self.payload, expected_status=400, check_payload=False
         )
 
 
 class TestCasesRawDataEndpoint(CustomTestCase):
+    """
+    Test cases for handling raw case data operations.
+
+    This class tests the functionality of:
+    - Creating cases with raw data
+    - Handling cases with and without solutions
+    - Managing case parent-child relationships
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test case data
+        - API endpoints
+        - Test model configuration
+        """
         super().setUp()
         self.payload = self.load_file(CASE_PATH)
         self.url = CASE_URL
@@ -193,11 +337,26 @@ class TestCasesRawDataEndpoint(CustomTestCase):
         self.items_to_check = ["name", "description", "schema"]
 
     def test_new_case(self):
+        """
+        Test creating a new case with raw data.
+
+        Verifies:
+        - Case creation with complete data
+        - Solution data handling
+        """
         self.items_to_check = ["name", "description", "schema", "data", "solution"]
         self.payload["solution"] = self.payload["data"]
         self.create_new_row(self.url, self.model, self.payload)
 
     def test_new_case_without_solution(self):
+        """
+        Test creating a case without solution data.
+
+        Verifies:
+        - Case creation without solution
+        - Proper handling of missing solution fields
+        - Correct response structure
+        """
         self.payload.pop("solution")
         self.items_to_check = ["name", "description", "schema", "data"]
         _id = self.create_new_row(self.url, self.model, self.payload)
@@ -228,6 +387,14 @@ class TestCasesRawDataEndpoint(CustomTestCase):
         self.assertIsNone(data["solution"])
 
     def test_case_with_parent(self):
+        """
+        Test creating cases with parent-child relationships.
+
+        Verifies:
+        - Case creation with parent reference
+        - Proper path generation
+        - Correct relationship establishment
+        """
         payload = dict(self.payload)
         payload.pop("data")
         case_id = self.create_new_row(self.url, self.model, payload)
@@ -244,6 +411,11 @@ class TestCasesRawDataEndpoint(CustomTestCase):
         self.assertEqual(len(diff), 0)
 
     def test_case_with_bad_parent(self):
+        """
+        Test case creation with invalid parent reference.
+
+        Verifies proper error handling for non-existent parent cases.
+        """
         payload = dict(self.payload)
         payload["parent_id"] = 1
         self.create_new_row(
@@ -251,6 +423,11 @@ class TestCasesRawDataEndpoint(CustomTestCase):
         )
 
     def test_case_with_case_parent(self):
+        """
+        Test case creation with invalid parent type.
+
+        Verifies proper error handling when using invalid parent references.
+        """
         case_id = self.create_new_row(self.url, self.model, self.payload)
         payload = dict(self.payload)
         payload["parent_id"] = case_id
@@ -260,7 +437,24 @@ class TestCasesRawDataEndpoint(CustomTestCase):
 
 
 class TestCaseCopyEndpoint(CustomTestCase):
+    """
+    Test cases for case copying functionality.
+
+    This class tests the functionality of:
+    - Copying existing cases
+    - Validating copied case data
+    - Handling metadata in copied cases
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Source case data
+        - Copy operation parameters
+        - Validation fields
+        """
         super().setUp()
         payload = self.load_file(CASE_PATH)
         self.model = CaseModel
@@ -283,6 +477,14 @@ class TestCaseCopyEndpoint(CustomTestCase):
         self.new_items = ["created_at", "updated_at"]
 
     def test_copy_case(self):
+        """
+        Test copying a case.
+
+        Verifies:
+        - Successful case duplication
+        - Correct copying of case attributes
+        - Proper handling of modified and new attributes
+        """
         new_case = self.create_new_row(
             self.url + str(self.case_id) + "/copy/", self.model, {}, check_payload=False
         )
@@ -305,7 +507,24 @@ class TestCaseCopyEndpoint(CustomTestCase):
 
 
 class TestCaseListEndpoint(BaseTestCases.ListFilters):
+    """
+    Test cases for case listing functionality.
+
+    This class tests the functionality of:
+    - Retrieving case listings
+    - Applying filters to case lists
+    - Validating case list responses
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test case data
+        - List operation parameters
+        - Response validation fields
+        """
         super().setUp()
         self.payload = self.load_file(CASE_PATH)
         self.payloads = [self.load_file(f) for f in CASES_LIST]
@@ -314,6 +533,14 @@ class TestCaseListEndpoint(BaseTestCases.ListFilters):
         self.url = CASE_URL
 
     def test_get_rows(self):
+        """
+        Test retrieving multiple cases.
+
+        Verifies:
+        - Successful retrieval of case listings
+        - Proper response structure
+        - Correct field validation
+        """
         keys_to_check = [
             "data_hash",
             "created_at",
@@ -332,7 +559,24 @@ class TestCaseListEndpoint(BaseTestCases.ListFilters):
 
 
 class TestCaseDetailEndpoint(BaseTestCases.DetailEndpoint):
+    """
+    Test cases for case detail operations.
+
+    This class tests the functionality of:
+    - Retrieving individual case details
+    - Updating case information
+    - Handling case deletion
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test case data
+        - Detail operation parameters
+        - Response validation fields
+        """
         super().setUp()
         self.payload = self.load_file(CASE_PATH)
         self.model = CaseModel
@@ -360,6 +604,14 @@ class TestCaseDetailEndpoint(BaseTestCases.DetailEndpoint):
         self.url = CASE_URL
 
     def test_delete_children(self):
+        """
+        Test case deletion with child cases.
+
+        Verifies:
+        - Successful deletion of parent case
+        - Proper handling of child cases
+        - Cascade deletion behavior
+        """
         payload = dict(self.payload)
         payload.pop("data")
         case_id = self.create_new_row(self.url, self.model, payload)
@@ -376,7 +628,24 @@ class TestCaseDetailEndpoint(BaseTestCases.DetailEndpoint):
 
 
 class TestCaseToInstanceEndpoint(CustomTestCase):
+    """
+    Test cases for converting cases to instances.
+
+    This class tests the functionality of:
+    - Converting cases to instances
+    - Validating converted instance data
+    - Handling conversion errors
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test case data
+        - Conversion parameters
+        - Response validation fields
+        """
         super().setUp()
         self.payload = self.load_file(CASE_PATH)
         self.model = CaseModel
@@ -393,6 +662,14 @@ class TestCaseToInstanceEndpoint(CustomTestCase):
         }
 
     def test_case_to_new_instance(self):
+        """
+        Test converting a case to a new instance.
+
+        Verifies:
+        - Successful case to instance conversion
+        - Proper data mapping
+        - Correct response structure
+        """
         response = self.client.post(
             CASE_URL + str(self.case_id) + "/instance/",
             follow_redirects=True,
@@ -413,8 +690,8 @@ class TestCaseToInstanceEndpoint(CustomTestCase):
         result = self.get_one_row(
             INSTANCE_URL + payload["id"] + "/", payload, keys_to_check=keys_to_check
         )
-        dif = self.response_items.symmetric_difference(result.keys())
-        self.assertEqual(len(dif), 0)
+        diff = self.response_items.symmetric_difference(result.keys())
+        self.assertEqual(len(diff), 0)
 
         self.items_to_check = [
             "id",
@@ -450,6 +727,11 @@ class TestCaseToInstanceEndpoint(CustomTestCase):
         self.assertEqual(len(dif), 0)
 
     def test_case_does_not_exist(self):
+        """
+        Test conversion of non-existent case.
+
+        Verifies proper error handling when converting non-existent cases.
+        """
         response = self.client.post(
             CASE_URL + str(2) + "/instance/",
             follow_redirects=True,
@@ -460,7 +742,24 @@ class TestCaseToInstanceEndpoint(CustomTestCase):
 
 
 class TestCaseJsonPatch(CustomTestCase):
+    """
+    Test cases for JSON patch operations on cases.
+
+    This class tests the functionality of:
+    - Applying JSON patches to cases
+    - Validating patched case data
+    - Handling patch errors
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test case data
+        - Patch operation parameters
+        - Test payloads
+        """
         super().setUp()
         self.payload = self.load_file(CASE_PATH)
         self.model = CaseModel
@@ -476,6 +775,14 @@ class TestCaseJsonPatch(CustomTestCase):
         self.patch_file = self.load_file(JSON_PATCH_GOOD_PATH)
 
     def test_json_patch(self):
+        """
+        Test applying a JSON patch to a case.
+
+        Verifies:
+        - Successful patch application
+        - Correct data transformation
+        - Proper validation of patched data
+        """
         self.patch_row(
             self.url + str(self.case_id) + "/data/",
             self.patch,
@@ -490,6 +797,14 @@ class TestCaseJsonPatch(CustomTestCase):
         self.assertIsNone(row.json["checks"])
 
     def test_json_patch_complete(self):
+        """
+        Test applying a complete JSON patch.
+
+        Verifies:
+        - Complex patch operations
+        - Data and solution patching
+        - Response validation
+        """
         original = self.load_file(FULL_CASE_LIST[0])
         original["data"] = get_pulp_jsonschema("../tests/data/gc_input.json")
         original["solution"] = get_pulp_jsonschema("../tests/data/gc_output.json")
@@ -513,6 +828,11 @@ class TestCaseJsonPatch(CustomTestCase):
         self.assertIsNone(row.json["solution_checks"])
 
     def test_json_patch_file(self):
+        """
+        Test applying a JSON patch from a file.
+
+        Verifies successful patch application from file source.
+        """
         self.patch_row(
             self.url + str(self.case_id) + "/data/",
             self.patch_file,
@@ -520,6 +840,11 @@ class TestCaseJsonPatch(CustomTestCase):
         )
 
     def test_not_valid_json_patch(self):
+        """
+        Test handling of invalid JSON patches.
+
+        Verifies proper error handling for malformed patches.
+        """
         payload = {"patch": "Not a valid patch"}
         self.patch_row(
             self.url + str(self.case_id) + "/data/",
@@ -530,6 +855,11 @@ class TestCaseJsonPatch(CustomTestCase):
         )
 
     def test_not_valid_json_patch_2(self):
+        """
+        Test handling of invalid JSON patch structure.
+
+        Verifies proper error handling for patches with invalid structure.
+        """
         payload = {"some_key": "some_value"}
         self.patch_row(
             self.url + str(self.case_id) + "/data/",
@@ -540,6 +870,11 @@ class TestCaseJsonPatch(CustomTestCase):
         )
 
     def test_not_valid_json_patch_3(self):
+        """
+        Test handling of invalid patch operations.
+
+        Verifies proper error handling for invalid patch operations.
+        """
         patch = {
             "patch": jsonpatch.make_patch(self.payloads[0], self.payloads[1]).patch
         }
@@ -552,6 +887,11 @@ class TestCaseJsonPatch(CustomTestCase):
         )
 
     def test_not_valid_json_patch_4(self):
+        """
+        Test handling of bad patch file content.
+
+        Verifies proper error handling for invalid patch file content.
+        """
         patch = self.load_file(JSON_PATCH_BAD_PATH)
         self.patch_row(
             self.url + str(self.case_id) + "/data/",
@@ -562,6 +902,11 @@ class TestCaseJsonPatch(CustomTestCase):
         )
 
     def test_patch_non_existing_case(self):
+        """
+        Test patching non-existent case.
+
+        Verifies proper error handling when patching non-existent cases.
+        """
         self.patch_row(
             self.url + str(500) + "/data/",
             self.patch,
@@ -571,24 +916,49 @@ class TestCaseJsonPatch(CustomTestCase):
         )
 
     def test_patch_created_properly(self):
+        """
+        Test proper patch creation.
+
+        Verifies correct patch generation and structure.
+        """
         self.assertEqual(
             len(self.patch_file["data_patch"]), len(self.patch["data_patch"])
         )
 
     def test_patch_not_created_properly(self):
-        # Compares the number of operations, not the operations themselves
+        """
+        Test improper patch creation scenarios.
+
+        Verifies detection of improperly created patches.
+        """
         self.assertNotEqual(
             len(self.patch_file["data_patch"]),
             len(jsonpatch.make_patch(self.payloads[0], self.payloads[1]).patch),
         )
 
-        # Compares the number of operations, not the operations themselves
         patch = self.load_file(JSON_PATCH_BAD_PATH)
         self.assertNotEqual(len(patch["data_patch"]), len(self.patch["data_patch"]))
 
 
 class TestCaseDataEndpoint(CustomTestCase):
+    """
+    Test cases for case data operations.
+
+    This class tests the functionality of:
+    - Retrieving case data
+    - Handling compressed data
+    - Validating data responses
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test case data
+        - Data operation parameters
+        - Response validation fields
+        """
         super().setUp()
         self.payload = self.load_file(CASE_PATH)
         self.model = CaseModel
@@ -602,6 +972,14 @@ class TestCaseDataEndpoint(CustomTestCase):
         ]
 
     def test_get_data(self):
+        """
+        Test retrieving case data.
+
+        Verifies:
+        - Successful data retrieval
+        - Proper response structure
+        - Field validation
+        """
         keys_to_check = [
             "data",
             "solution_checks",
@@ -627,6 +1005,11 @@ class TestCaseDataEndpoint(CustomTestCase):
         )
 
     def test_get_no_data(self):
+        """
+        Test retrieving non-existent case data.
+
+        Verifies proper error handling for non-existent cases.
+        """
         self.get_one_row(
             self.url + str(500) + "/data/",
             {},
@@ -636,6 +1019,14 @@ class TestCaseDataEndpoint(CustomTestCase):
         )
 
     def test_get_compressed_data(self):
+        """
+        Test retrieving compressed case data.
+
+        Verifies:
+        - Successful compression
+        - Proper decompression
+        - Data integrity
+        """
         headers = self.get_header_with_auth(self.token)
         headers["Accept-Encoding"] = "gzip"
 
@@ -650,7 +1041,24 @@ class TestCaseDataEndpoint(CustomTestCase):
 
 
 class TestCaseCompare(CustomTestCase):
+    """
+    Test cases for case comparison functionality.
+
+    This class tests the functionality of:
+    - Comparing different cases
+    - Generating comparison patches
+    - Handling comparison errors
+    """
+
     def setUp(self):
+        """
+        Set up test environment before each test.
+
+        Initializes:
+        - Test cases for comparison
+        - Comparison parameters
+        - Validation fields
+        """
         super().setUp()
         self.payloads = [self.load_file(f) for f in FULL_CASE_LIST]
         self.payloads[0]["data"] = get_pulp_jsonschema("../tests/data/gc_input.json")
@@ -669,6 +1077,14 @@ class TestCaseCompare(CustomTestCase):
         self.items_to_check = ["name", "description", "schema"]
 
     def test_get_full_patch(self):
+        """
+        Test generating full comparison patch.
+
+        Verifies:
+        - Successful patch generation
+        - Correct patch structure
+        - Proper response format
+        """
         response = self.client.get(
             self.url + str(self.cases_id[0]) + "/" + str(self.cases_id[1]) + "/",
             follow_redirects=True,
@@ -680,6 +1096,11 @@ class TestCaseCompare(CustomTestCase):
         self.assertEqual(200, response.status_code)
 
     def test_same_case_error(self):
+        """
+        Test comparing a case with itself.
+
+        Verifies proper error handling for self-comparison.
+        """
         response = self.client.get(
             self.url + str(self.cases_id[0]) + "/" + str(self.cases_id[0]) + "/",
             follow_redirects=True,
@@ -689,6 +1110,14 @@ class TestCaseCompare(CustomTestCase):
         self.assertEqual(400, response.status_code)
 
     def test_get_only_data(self):
+        """
+        Test comparing only case data.
+
+        Verifies:
+        - Data-only comparison
+        - Proper exclusion of solution
+        - Correct response format
+        """
         response = self.client.get(
             self.url
             + str(self.cases_id[0])
@@ -705,6 +1134,14 @@ class TestCaseCompare(CustomTestCase):
         self.assertEqual(200, response.status_code)
 
     def test_get_only_solution(self):
+        """
+        Test comparing only case solutions.
+
+        Verifies:
+        - Solution-only comparison
+        - Proper exclusion of data
+        - Correct response format
+        """
         response = self.client.get(
             self.url + str(self.cases_id[0]) + "/" + str(self.cases_id[1]) + "/?data=0",
             follow_redirects=True,
@@ -717,6 +1154,11 @@ class TestCaseCompare(CustomTestCase):
         self.assertEqual(200, response.status_code)
 
     def test_patch_not_symmetric(self):
+        """
+        Test patch asymmetry.
+
+        Verifies that patches are direction-dependent.
+        """
         response = self.client.get(
             self.url + str(self.cases_id[1]) + "/" + str(self.cases_id[0]) + "/",
             follow_redirects=True,
@@ -728,6 +1170,11 @@ class TestCaseCompare(CustomTestCase):
         self.assertEqual(200, response.status_code)
 
     def test_case_does_not_exist(self):
+        """
+        Test comparing with non-existent case.
+
+        Verifies proper error handling for non-existent cases.
+        """
         response = self.client.get(
             self.url + str(self.cases_id[0]) + "/" + str(500) + "/",
             follow_redirects=True,
@@ -745,6 +1192,14 @@ class TestCaseCompare(CustomTestCase):
         self.assertEqual(404, response.status_code)
 
     def test_get_patch_and_apply(self):
+        """
+        Test generating and applying a patch.
+
+        Verifies:
+        - Patch generation
+        - Successful patch application
+        - Data consistency
+        """
         response = self.client.get(
             self.url + str(self.cases_id[0]) + "/" + str(self.cases_id[1]) + "/",
             follow_redirects=True,
@@ -764,6 +1219,14 @@ class TestCaseCompare(CustomTestCase):
         )
 
     def test_case_compare_compression(self):
+        """
+        Test case comparison with compression.
+
+        Verifies:
+        - Successful compression
+        - Proper decompression
+        - Data integrity
+        """
         headers = self.get_header_with_auth(self.token)
         headers["Accept-Encoding"] = "gzip"
         response = self.client.get(
@@ -780,6 +1243,11 @@ class TestCaseCompare(CustomTestCase):
 
 
 def modify_data(data):
+    """
+    Modify test case data.
+
+    Helper function to modify case data for testing.
+    """
     data["pairs"][16]["n2"] = 10
     data["pairs"][27]["n2"] = 3
     data["pairs"][30]["n1"] = 6
@@ -790,6 +1258,11 @@ def modify_data(data):
 
 
 def modify_solution(solution):
+    """
+    Modify test case solution.
+
+    Helper function to modify case solution for testing.
+    """
     solution["assignment"][4]["color"] = 3
     solution["assignment"][7]["color"] = 2
     solution["assignment"][24]["color"] = 1
@@ -797,6 +1270,11 @@ def modify_solution(solution):
 
 
 def modify_data_solution(data):
+    """
+    Modify both test case data and solution.
+
+    Helper function to modify both case data and solution for testing.
+    """
     modify_data(data["data"])
     modify_solution(data["solution"])
     return data