Move created and modified time e2e test check into helper class #90

Author: joelvdavies

test/e2e/conftest.py

@@ -2,11 +2,13 @@
 Module providing test fixtures for the e2e tests.
 """
 
+from datetime import datetime
 from test.conftest import VALID_ACCESS_TOKEN
 from typing import Optional
 
 import pytest
 from fastapi.testclient import TestClient
+from httpx import Response
 
 from inventory_management_system_api.core.database import get_database
 from inventory_management_system_api.main import app
@@ -78,3 +80,28 @@ def replace_unit_values_with_ids_in_properties(properties_without_ids: list[dict
         properties.append(property_without_id)
 
     return properties
+
+
+class E2ETestHelpers:
+    """
+    A utility class containing common helper methods for e2e tests
+
+    This class provides a set of static methods that encapsulate common functionality frequently used in the e2e tests
+    """
+
+    @staticmethod
+    def check_created_and_modified_times_updated_correctly(post_response: Response, patch_response: Response):
+        """Checks that an updated entity has a created_time that is the same as its original, but an updated_time
+        that is newer
+
+        :param post_response: Original response for the entity post request
+        :param patch_response: Updated response for the entity patch request
+        """
+
+        original_data = post_response.json()
+        updated_data = patch_response.json()
+
+        assert original_data["created_time"] == updated_data["created_time"]
+        assert datetime.fromisoformat(updated_data["modified_time"]) > datetime.fromisoformat(
+            original_data["modified_time"]
+        )

test/e2e/test_system.py

@@ -4,7 +4,7 @@
 
 from datetime import datetime
 from test.conftest import add_ids_to_properties
-from test.e2e.conftest import replace_unit_values_with_ids_in_properties
+from test.e2e.conftest import E2ETestHelpers, replace_unit_values_with_ids_in_properties
 from test.e2e.mock_schemas import USAGE_STATUS_POST_B
 from test.e2e.test_catalogue_item import CATALOGUE_CATEGORY_POST_A, CATALOGUE_ITEM_POST_A
 from test.e2e.test_item import ITEM_POST, MANUFACTURER_POST
@@ -374,16 +374,7 @@ def check_patch_system_response_success(self, expected_system_get_data: dict):
         assert self._patch_response.status_code == 200
         assert self._patch_response.json() == expected_system_get_data
 
-        # pylint:disable=fixme
-        # TODO: Move the below code into a utility or something later - will be wanted for other tests?
-        original_data = self._post_response.json()
-        new_data = self._patch_response.json()
-
-        # Created time should be unchanged, but new modified time should be greater than before
-        assert original_data["created_time"] == new_data["created_time"]
-        assert datetime.fromisoformat(new_data["modified_time"]) > datetime.fromisoformat(
-            original_data["modified_time"]
-        )
+        E2ETestHelpers.check_created_and_modified_times_updated_correctly(self._post_response, self._patch_response)
 
     def check_patch_system_failed_with_message(self, status_code: int, detail: str):
         """Checks that a prior call to 'patch_system' gave a failed response with the expected code and error message"""