Merge branch 'add-spares-definition-put-#413' into calculate-number-o…

…f-spares-#417

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.12.7-alpine3.20@sha256:38e179a0f0436c97ecc76bcd378d7293ab3ee79e4b8c440fdc7113670cb6e204
+FROM python:3.12.7-alpine3.20@sha256:5049c050bdc68575a10bcb1885baa0689b6c15152d8a56a7e399fb49f783bf98
 
 WORKDIR /inventory-management-system-api-run
 

Dockerfile.prod

@@ -1,4 +1,4 @@
-FROM python:3.12.7-alpine3.20@sha256:38e179a0f0436c97ecc76bcd378d7293ab3ee79e4b8c440fdc7113670cb6e204
+FROM python:3.12.7-alpine3.20@sha256:5049c050bdc68575a10bcb1885baa0689b6c15152d8a56a7e399fb49f783bf98
 
 WORKDIR /inventory-management-system-api-run
 

test/e2e/conftest.py

@@ -91,22 +91,36 @@ class E2ETestHelpers:
     """
 
     @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
+    def check_created_and_modified_times_updated_correctly(post_response: Response, new_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
+        :param new_response: Updated response for the entity patch/get request
         """
 
         original_data = post_response.json()
-        updated_data = patch_response.json()
+        updated_data = new_response.json()
 
         assert original_data["created_time"] == updated_data["created_time"]
         assert datetime.fromisoformat(updated_data["modified_time"]) > datetime.fromisoformat(
             original_data["modified_time"]
         )
 
+    @staticmethod
+    def check_created_and_modified_times_not_updated(post_response: Response, new_response: Response):
+        """Checks that an entity still has the same `created_time` and `updated_time` as its original
+
+        :param post_response: Original response for the entity post request
+        :param new_response: Updated response for the entity patch/get request
+        """
+
+        original_data = post_response.json()
+        updated_data = new_response.json()
+
+        assert original_data["created_time"] == updated_data["created_time"]
+        assert original_data["modified_time"] == updated_data["modified_time"]
+
     @staticmethod
     def replace_unit_values_with_ids_in_properties(data: dict, unit_value_id_dict: dict[str, str]) -> dict:
         """Inserts unit IDs into some data that may have a 'properties' list within it while removing the unit value.

test/e2e/test_catalogue_category.py

@@ -35,10 +35,7 @@
 from httpx import Response
 
 from inventory_management_system_api.core.consts import BREADCRUMBS_TRAIL_MAX_LENGTH
-
-from inventory_management_system_api.schemas.catalogue_category import (
-    CATALOGUE_CATEGORY_WITH_CHILD_NON_EDITABLE_FIELDS,
-)
+from inventory_management_system_api.schemas.catalogue_category import CATALOGUE_CATEGORY_WITH_CHILD_NON_EDITABLE_FIELDS
 
 
 class CreateDSL(UnitCreateDSL):
@@ -232,16 +229,16 @@ def test_create_leaf_with_properties(self):
         self.check_post_catalogue_category_success(CATALOGUE_CATEGORY_GET_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM)
 
     def test_create_leaf_with_properties_with_non_existent_unit_id(self):
-        """Test creating a leaf catalogue category with a property with a non-existent unit ID provided."""
+        """Test creating a leaf catalogue category with a property with a non-existent unit ID."""
 
-        self.add_unit_value_and_id("mm", str(ObjectId()))
+        self.set_unit_value_and_id("mm", str(ObjectId()))
         self.post_catalogue_category(CATALOGUE_CATEGORY_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM)
         self.check_post_catalogue_category_failed_with_detail(422, "The specified unit does not exist")
 
     def test_create_leaf_with_properties_with_invalid_unit_id(self):
-        """Test creating a leaf catalogue category with a property with an invalid unit ID provided."""
+        """Test creating a leaf catalogue category with a property with an invalid unit ID."""
 
-        self.add_unit_value_and_id("mm", "invalid-id")
+        self.set_unit_value_and_id("mm", "invalid-id")
         self.post_catalogue_category(CATALOGUE_CATEGORY_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM)
         self.check_post_catalogue_category_failed_with_detail(422, "The specified unit does not exist")
 
@@ -296,7 +293,7 @@ def test_create_leaf_property_with_invalid_allowed_values_type(self):
         )
 
     def test_create_leaf_property_with_empty_allowed_values_list(self):
-        """Test creating a leaf catalogue category with a property with an allowed values list that is empty."""
+        """Test creating a leaf catalogue category with a property with an empty allowed values list."""
 
         self.post_leaf_catalogue_category_with_allowed_values("string", {"type": "list", "values": []})
         self.check_post_catalogue_category_failed_with_validation_message(
@@ -305,8 +302,8 @@ def test_create_leaf_property_with_empty_allowed_values_list(self):
         )
 
     def test_create_leaf_with_string_property_with_allowed_values_list_invalid_value(self):
-        """Test creating a leaf catalogue category with a string property with an allowed values list with an invalid
-        number value in it."""
+        """Test creating a leaf catalogue category with a string property with an allowed values list containing an
+        invalid number."""
 
         self.post_leaf_catalogue_category_with_allowed_values("string", {"type": "list", "values": ["1", "2", 3, "4"]})
         self.check_post_catalogue_category_failed_with_validation_message(
@@ -317,7 +314,7 @@ def test_create_leaf_with_string_property_with_allowed_values_list_invalid_value
 
     def test_create_leaf_with_string_property_with_allowed_values_list_duplicate_value(self):
         """Test creating a leaf catalogue category with a string property with an allowed values list with a duplicate
-        string value in it."""
+        string value."""
 
         # Capitalisation is different as it shouldn't matter for this test
         self.post_leaf_catalogue_category_with_allowed_values(
@@ -329,8 +326,8 @@ def test_create_leaf_with_string_property_with_allowed_values_list_duplicate_val
         )
 
     def test_create_leaf_with_number_property_with_allowed_values_list_invalid_value(self):
-        """Test creating a leaf catalogue category with a number property with an allowed values list with an invalid
-        number value in it."""
+        """Test creating a leaf catalogue category with a number property with an allowed values list containing an
+        invalid number."""
 
         self.post_leaf_catalogue_category_with_allowed_values("number", {"type": "list", "values": [1, 2, "3", 4]})
         self.check_post_catalogue_category_failed_with_validation_message(
@@ -341,7 +338,7 @@ def test_create_leaf_with_number_property_with_allowed_values_list_invalid_value
 
     def test_create_leaf_with_number_property_with_allowed_values_list_duplicate_value(self):
         """Test creating a leaf catalogue category with a number property with an allowed values list with a duplicate
-        number value in it."""
+        number value."""
 
         self.post_leaf_catalogue_category_with_allowed_values("number", {"type": "list", "values": [1, 2, 1, 3]})
         self.check_post_catalogue_category_failed_with_validation_message(
@@ -380,9 +377,9 @@ def check_get_catalogue_category_success(self, expected_catalogue_category_get_d
         Checks that a prior call to `get_catalogue_category` gave a successful response with the expected data returned.
 
         :param expected_catalogue_category_get_data: Dictionary containing the expected catalogue category data returned
-                                                     as would be required for a `CatalogueCategorySchema`. Does not need
-                                                     unit IDs as they will be added automatically to check they are as
-                                                     expected.
+                                        as would be required for a `CatalogueCategorySchema` but with any `unit_id`'s
+                                        replaced by the `unit` value in its properties as the IDs will be added
+                                        automatically.
         """
 
         assert self._get_response_catalogue_category.status_code == 200
@@ -746,7 +743,7 @@ def patch_properties_with_property_with_allowed_values(
             },
         )
 
-    def check_patch_catalogue_category_response_success(self, expected_catalogue_category_get_data: dict) -> None:
+    def check_patch_catalogue_category_success(self, expected_catalogue_category_get_data: dict) -> None:
         """
         Checks that a prior call to `patch_catalogue_category` gave a successful response with the expected data
         returned.
@@ -798,7 +795,7 @@ def test_partial_update_name(self):
 
         catalogue_category_id = self.post_catalogue_category(CATALOGUE_CATEGORY_POST_DATA_NON_LEAF_REQUIRED_VALUES_ONLY)
         self.patch_catalogue_category(catalogue_category_id, {"name": "New Name"})
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_REQUIRED_VALUES_ONLY, "name": "New Name", "code": "new-name"}
         )
 
@@ -811,7 +808,7 @@ def test_partial_update_parent_id(self):
         )
 
         self.patch_catalogue_category(catalogue_category_id, {"parent_id": parent_id})
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_NO_PARENT_NO_PROPERTIES_B, "parent_id": parent_id}
         )
 
@@ -898,7 +895,7 @@ def test_partial_update_name_capitalisation(self):
             {**CATALOGUE_CATEGORY_POST_DATA_NON_LEAF_REQUIRED_VALUES_ONLY, "name": "Test catalogue category"}
         )
         self.patch_catalogue_category(catalogue_category_id, {"name": "Test Catalogue Category"})
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {
                 **CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_REQUIRED_VALUES_ONLY,
                 "name": "Test Catalogue Category",
@@ -919,7 +916,7 @@ def test_partial_update_non_leaf_all_valid_values_when_no_children(self):
             {**CATALOGUE_CATEGORY_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM, "parent_id": new_parent_id},
         )
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM, "parent_id": new_parent_id}
         )
 
@@ -931,7 +928,7 @@ def test_partial_update_non_leaf_to_leaf_without_properties(self):
 
         self.patch_catalogue_category(catalogue_category_id, {"is_leaf": True})
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_REQUIRED_VALUES_ONLY, "is_leaf": True}
         )
 
@@ -947,7 +944,7 @@ def test_partial_update_non_leaf_all_valid_values_when_has_child_catalogue_categ
 
         self.patch_catalogue_category(catalogue_category_id, update_data)
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_REQUIRED_VALUES_ONLY, **update_data, "code": "new-name"}
         )
 
@@ -978,7 +975,7 @@ def test_partial_update_leaf_all_valid_values_when_no_children(self):
             {**CATALOGUE_CATEGORY_POST_DATA_NON_LEAF_NO_PARENT_NO_PROPERTIES_A, "parent_id": new_parent_id},
         )
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_NO_PARENT_NO_PROPERTIES_A, "parent_id": new_parent_id}
         )
 
@@ -994,7 +991,7 @@ def test_partial_update_leaf_all_valid_values_when_has_child_catalogue_item(self
 
         self.patch_catalogue_category(catalogue_category_id, update_data)
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_LEAF_NO_PARENT_NO_PROPERTIES, **update_data, "code": "new-name"}
         )
 
@@ -1043,7 +1040,7 @@ def test_partial_update_leaf_to_non_leaf_with_properties(self):
             },
         )
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_NO_PARENT_NO_PROPERTIES_A, "parent_id": new_parent_id}
         )
 
@@ -1052,7 +1049,7 @@ def test_partial_update_is_leaf_no_children(self):
 
         catalogue_category_id = self.post_catalogue_category(CATALOGUE_CATEGORY_POST_DATA_NON_LEAF_REQUIRED_VALUES_ONLY)
         self.patch_catalogue_category(catalogue_category_id, {"is_leaf": True})
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {**CATALOGUE_CATEGORY_GET_DATA_NON_LEAF_REQUIRED_VALUES_ONLY, "is_leaf": True}
         )
 
@@ -1081,7 +1078,7 @@ def test_partial_update_leaf_properties(self):
             {"properties": CATALOGUE_CATEGORY_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM["properties"]},
         )
 
-        self.check_patch_catalogue_category_response_success(
+        self.check_patch_catalogue_category_success(
             {
                 **CATALOGUE_CATEGORY_GET_DATA_LEAF_NO_PARENT_NO_PROPERTIES,
                 "properties": CATALOGUE_CATEGORY_GET_DATA_LEAF_NO_PARENT_WITH_PROPERTIES_MM["properties"],
@@ -1091,17 +1088,17 @@ def test_partial_update_leaf_properties(self):
     def test_partial_update_leaf_with_properties_with_non_existent_unit_id(self):
         """Test updating a leaf catalogue category's properties to have a property with a non-existent unit ID."""
 
-        self.add_unit_value_and_id("mm", str(ObjectId()))
+        self.set_unit_value_and_id("mm", str(ObjectId()))
         catalogue_category_id = self.post_catalogue_category(CATALOGUE_CATEGORY_POST_DATA_LEAF_NO_PARENT_NO_PROPERTIES)
         self.patch_catalogue_category(
             catalogue_category_id, {"properties": [CATALOGUE_CATEGORY_PROPERTY_DATA_NUMBER_NON_MANDATORY_WITH_MM_UNIT]}
         )
         self.check_patch_catalogue_category_failed_with_detail(422, "The specified unit does not exist")
 
     def test_partial_update_leaf_with_properties_with_invalid_unit_id(self):
-        """Test updating a leaf catalogue category's properties to have a property with an invalid unit ID provided."""
+        """Test updating a leaf catalogue category's properties to have a property with an invalid unit ID."""
 
-        self.add_unit_value_and_id("mm", "invalid-id")
+        self.set_unit_value_and_id("mm", "invalid-id")
         catalogue_category_id = self.post_catalogue_category(CATALOGUE_CATEGORY_POST_DATA_LEAF_NO_PARENT_NO_PROPERTIES)
         self.patch_catalogue_category(
             catalogue_category_id, {"properties": [CATALOGUE_CATEGORY_PROPERTY_DATA_NUMBER_NON_MANDATORY_WITH_MM_UNIT]}