Move reformat function and include validation on provided keys

Author: koopmant

app/grandchallenge/algorithms/serializers.py

@@ -22,16 +22,15 @@
     Job,
     annotate_input_output_counts,
 )
-from grandchallenge.cases.widgets import DICOMUploadWithName
 from grandchallenge.components.backends.exceptions import (
     CIVNotEditableException,
 )
-from grandchallenge.components.models import CIVData
 from grandchallenge.components.serializers import (
     ComponentInterfaceSerializer,
     ComponentInterfaceValuePostSerializer,
     ComponentInterfaceValueSerializer,
     HyperlinkedComponentInterfaceValueSerializer,
+    reformat_serialized_civ_data,
 )
 from grandchallenge.core.guardian import filter_by_permission
 from grandchallenge.core.templatetags.remove_whitespace import oxford_comma
@@ -241,7 +240,7 @@ def validate(self, data):
         data["algorithm_interface"] = (
             self.validate_inputs_and_return_matching_interface(inputs=inputs)
         )
-        self.inputs = self.reformat_inputs(serialized_civs=inputs)
+        self.inputs = reformat_serialized_civ_data(serialized_civ_data=inputs)
 
         if Job.objects.get_jobs_with_same_inputs(
             inputs=self.inputs,
@@ -307,39 +306,3 @@ def validate_inputs_and_return_matching_interface(self, *, inputs):
                 f"following input combinations: "
                 f"{oxford_comma([f'Interface {n}: {oxford_comma(interface.inputs.all())}' for n, interface in enumerate(self._algorithm.interfaces.all(), start=1)])}"
             )
-
-    @staticmethod
-    def reformat_inputs(*, serialized_civs):
-        """Takes serialized CIV data and returns list of CIVData objects."""
-
-        data = []
-        for civ in serialized_civs:
-            interface = civ["interface"]
-            upload_session = civ.get("upload_session")
-            user_upload = civ.get("user_upload")
-            image = civ.get("image")
-            file = civ.get("file")
-            value = civ.get("value")
-            user_uploads = civ.get("user_uploads")
-            image_name = civ.get("image_name")
-            dicom_upload_with_name = (
-                DICOMUploadWithName(name=image_name, user_uploads=user_uploads)
-                if user_uploads and image_name
-                else None
-            )
-            try:
-                data.append(
-                    CIVData(
-                        interface_slug=interface.slug,
-                        value=upload_session
-                        or user_upload
-                        or image
-                        or file
-                        or dicom_upload_with_name
-                        or value,
-                    )
-                )
-            except ValidationError as e:
-                raise serializers.ValidationError(e)
-
-        return data

app/grandchallenge/components/serializers.py

@@ -1,5 +1,6 @@
 import logging
 
+from django.core.exceptions import ValidationError
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError as DRFValidationError
 from rest_framework.fields import CharField, SerializerMethodField
@@ -26,6 +27,50 @@
 logger = logging.getLogger(__name__)
 
 
+def reformat_serialized_civ_data(*, serialized_civ_data):
+    """Takes serialized CIV data and returns list of CIVData objects."""
+
+    possible_keys = [
+        "image",
+        "value",
+        "file",
+        "user_upload",
+        "upload_session",
+        ("image_name", "user_uploads"),
+    ]
+
+    civ_data_objects = []
+    for civ in serialized_civ_data:
+        interface = civ["interface"]
+
+        keys = set(civ.keys()) - {"interface"}
+
+        if not keys:
+            raise serializers.ValidationError(
+                f"You must provide at least one of {possible_keys}"
+            )
+        elif keys == {"image_name", "user_uploads"}:
+            value = DICOMUploadWithName(
+                name=civ["image_name"],
+                user_uploads=civ["user_uploads"],
+            )
+        elif len(keys) > 1:
+            raise serializers.ValidationError(
+                f"You can only provide one of {possible_keys} for each interface."
+            )
+        else:
+            value = civ[list(keys)[0]]
+
+        try:
+            civ_data_objects.append(
+                CIVData(interface_slug=interface.slug, value=value)
+            )
+        except ValidationError as e:
+            raise serializers.ValidationError(e)
+
+    return civ_data_objects
+
+
 class ComponentInterfaceSerializer(serializers.ModelSerializer):
     kind = serializers.CharField(source="get_kind_display", read_only=True)
     super_kind = SerializerMethodField()
@@ -276,31 +321,10 @@ def update(self, instance, validated_data):
 
         request = self.context["request"]
 
-        civ_data_objects = []
-
-        for value in values:
-            interface = value["interface"]
-            upload_session = value.get("upload_session")
-            user_upload = value.get("user_upload")
-            image = value.get("image")
-            user_uploads = value.get("user_uploads")
-            image_name = value.get("image_name")
-            value = value.get("value")
-            dicom_upload_with_name = (
-                DICOMUploadWithName(name=image_name, user_uploads=user_uploads)
-                if user_uploads and image_name
-                else None
-            )
-            civ_data_objects.append(
-                CIVData(
-                    interface_slug=interface.slug,
-                    value=upload_session
-                    or user_upload
-                    or image
-                    or dicom_upload_with_name
-                    or value,
-                )
-            )
+        civ_data_objects = reformat_serialized_civ_data(
+            serialized_civ_data=values
+        )
+
         try:
             instance.validate_civ_data_objects_and_execute_linked_task(
                 civ_data_objects=civ_data_objects, user=request.user