Bigpicture requested fixes. (merge commit)

Merge branch 'fix/bigpicture-22-may-rasko' into 'main'
* Addressed merge review comments.

* Allow image alias to have IMAGE_ prefix when checking image file directory.

* Allow image alias to have IMAGE_ prefix when checking image file directory.

See merge request https://gitlab.ci.csc.fi/sds-dev/sd-submit/metadata-submitter/-/merge_requests/1159

Approved-by: Joonatan Mäkinen <jmakine@csc.fi>
Co-authored-by: Rasko Leinonen <raskolei@csc.fi>
Merged by Joonatan Mäkinen <jmakine@csc.fi>

Author: Joonatan Mäkinen

metadata_backend/api/services/submission/bigpicture.py

@@ -510,12 +510,10 @@ def prepare_files(self, submission_id: str) -> list[File]:
 
             # Validate the image file paths and extensions
             alias = root.get("alias")
-            expected_dir = f"IMAGES/IMAGE_{alias}"
             for file_elem in xml.xpath("/IMAGE/FILES/FILE"):
                 filename = file_elem.get("filename")
+                self.check_image_file_dir(alias, filename)
                 dir_part, _, file_part = filename.rpartition("/")  # "IMAGES/IMAGE_{alias}", "/", "*.dcm.c4gh"
-                if dir_part != expected_dir:
-                    raise UserException(f"Image file '{filename}' must be in directory '{expected_dir}'.")
                 if not file_part.removesuffix(".c4gh").endswith(".dcm"):
                     raise UserException(f"Image file '{filename}' must have a .dcm extension.")
 
@@ -674,3 +672,18 @@ async def update(
             await self._delete_object(datacite_object.objectId)
 
         return submission
+
+    @staticmethod
+    def check_image_file_dir(alias: str, image_file_path: str) -> None:
+        """
+        Check if the image file is in the correct directory.
+
+        :param alias: The image metadata object alias.
+        :param image_file_path: The image file path.
+        :raises UserException: If the image file is not in the correct directory.
+        """
+        alias = alias.removeprefix("IMAGE_")  # Alias may contain IMAGE_ prefix.
+        expected_dir = f"IMAGES/IMAGE_{alias}"
+        dir_part, _, _ = image_file_path.rpartition("/")
+        if dir_part != expected_dir:
+            raise UserException(f"Image file '{image_file_path}' must be in directory '{expected_dir}'.")

tests/unit/api/services/submission/test_bigpicture.py

@@ -95,3 +95,23 @@ def test_prepare_files_wrong_extension_raises():
 
     with pytest.raises(UserException, match="Image file 'IMAGES/IMAGE_1/test.tif.c4gh' must have a .dcm extension"):
         _prepare_files(objects)
+
+
+def test_check_image_file_dir_invalid_dir():
+    alias = "TEST"
+    path = "IMAGES/INVALID/image"
+
+    with pytest.raises(UserException) as exc:
+        BigpictureObjectSubmissionService.check_image_file_dir(alias, path)
+
+    assert f"Image file '{path}' must be in directory 'IMAGES/IMAGE_TEST'" in str(exc.value)
+
+
+def test_check_image_file_dir_correct_dir():
+    alias = "TEST"
+    path = "IMAGES/IMAGE_TEST/image"
+    BigpictureObjectSubmissionService.check_image_file_dir(alias, path)
+
+    alias = "IMAGE_TEST"
+    path = "IMAGES/IMAGE_TEST/image"
+    BigpictureObjectSubmissionService.check_image_file_dir(alias, path)