Merge pull request #2596 from IFRCGo/feature/timeframe-validations

Feature/Timeframe and value validations

Author: susilnem

eap/admin.py

@@ -64,9 +64,9 @@ class SimplifiedEAPAdmin(admin.ModelAdmin):
     )
     readonly_fields = (
         "cover_image",
-        "hazard_impact_file",
-        "risk_selected_protocols_file",
-        "selected_early_actions_file",
+        "hazard_impact_images",
+        "risk_selected_protocols_images",
+        "selected_early_actions_images",
         "planned_operations",
         "enable_approaches",
         "parent",

eap/enums.py

@@ -5,5 +5,9 @@
     "eap_type": models.EAPType,
     "sector": models.PlannedOperation.Sector,
     "timeframe": models.OperationActivity.TimeFrame,
+    "years_timeframe_value": models.OperationActivity.YearsTimeFrameChoices,
+    "months_timeframe_value": models.OperationActivity.MonthsTimeFrameChoices,
+    "days_timeframe_value": models.OperationActivity.DaysTimeFrameChoices,
+    "hours_timeframe_value": models.OperationActivity.HoursTimeFrameChoices,
     "approach": models.EnableApproach.Approach,
 }

eap/factories.py

@@ -1,5 +1,3 @@
-from random import random
-
 import factory
 from factory import fuzzy
 
@@ -66,7 +64,6 @@ class Meta:
 
     activity = fuzzy.FuzzyText(length=50, prefix="Activity-")
     timeframe = fuzzy.FuzzyChoice(OperationActivity.TimeFrame)
-    time_value = factory.LazyFunction(lambda: [random.randint(1, 12) for _ in range(3)])
 
 
 class EnableApproachFactory(factory.django.DjangoModelFactory):

eap/migrations/0008_remove_simplifiedeap_hazard_impact_file_and_more.py

@@ -0,0 +1,54 @@
+# Generated by Django 4.2.19 on 2025-11-25 10:51
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("eap", "0007_alter_eapfile_options_alter_eapregistration_options_and_more"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="simplifiedeap",
+            name="hazard_impact_file",
+        ),
+        migrations.RemoveField(
+            model_name="simplifiedeap",
+            name="risk_selected_protocols_file",
+        ),
+        migrations.RemoveField(
+            model_name="simplifiedeap",
+            name="selected_early_actions_file",
+        ),
+        migrations.AddField(
+            model_name="simplifiedeap",
+            name="hazard_impact_images",
+            field=models.ManyToManyField(
+                blank=True,
+                related_name="simplified_eap_hazard_impact_images",
+                to="eap.eapfile",
+                verbose_name="Hazard Impact Images",
+            ),
+        ),
+        migrations.AddField(
+            model_name="simplifiedeap",
+            name="risk_selected_protocols_images",
+            field=models.ManyToManyField(
+                blank=True,
+                related_name="simplified_eap_risk_selected_protocols_images",
+                to="eap.eapfile",
+                verbose_name="Risk Selected Protocols Images",
+            ),
+        ),
+        migrations.AddField(
+            model_name="simplifiedeap",
+            name="selected_early_actions_images",
+            field=models.ManyToManyField(
+                blank=True,
+                related_name="simplified_eap_selected_early_actions_images",
+                to="eap.eapfile",
+                verbose_name="Selected Early Actions Images",
+            ),
+        ),
+    ]

eap/models.py

@@ -233,12 +233,76 @@ class Meta:
 
 
 class OperationActivity(models.Model):
+    # NOTE: `timeframe` and `time_value` together represent the time span for an activity.
+    # Make sure to keep them in sync.
     class TimeFrame(models.IntegerChoices):
         YEARS = 10, _("Years")
         MONTHS = 20, _("Months")
         DAYS = 30, _("Days")
         HOURS = 40, _("Hours")
 
+    class YearsTimeFrameChoices(models.IntegerChoices):
+        ONE_YEAR = 1, _("1")
+        TWO_YEARS = 2, _("2")
+        THREE_YEARS = 3, _("3")
+        FOUR_YEARS = 4, _("4")
+        FIVE_YEARS = 5, _("5")
+
+    class MonthsTimeFrameChoices(models.IntegerChoices):
+        ONE_MONTH = 1, _("1")
+        TWO_MONTHS = 2, _("2")
+        THREE_MONTHS = 3, _("3")
+        FOUR_MONTHS = 4, _("4")
+        FIVE_MONTHS = 5, _("5")
+        SIX_MONTHS = 6, _("6")
+        SEVEN_MONTHS = 7, _("7")
+        EIGHT_MONTHS = 8, _("8")
+        NINE_MONTHS = 9, _("9")
+        TEN_MONTHS = 10, _("10")
+        ELEVEN_MONTHS = 11, _("11")
+        TWELVE_MONTHS = 12, _("12")
+
+    class DaysTimeFrameChoices(models.IntegerChoices):
+        ONE_DAY = 1, _("1")
+        TWO_DAYS = 2, _("2")
+        THREE_DAYS = 3, _("3")
+        FOUR_DAYS = 4, _("4")
+        FIVE_DAYS = 5, _("5")
+        SIX_DAYS = 6, _("6")
+        SEVEN_DAYS = 7, _("7")
+        EIGHT_DAYS = 8, _("8")
+        NINE_DAYS = 9, _("9")
+        TEN_DAYS = 10, _("10")
+        ELEVEN_DAYS = 11, _("11")
+        TWELVE_DAYS = 12, _("12")
+        THIRTEEN_DAYS = 13, _("13")
+        FOURTEEN_DAYS = 14, _("14")
+        FIFTEEN_DAYS = 15, _("15")
+        SIXTEEN_DAYS = 16, _("16")
+        SEVENTEEN_DAYS = 17, _("17")
+        EIGHTEEN_DAYS = 18, _("18")
+        NINETEEN_DAYS = 19, _("19")
+        TWENTY_DAYS = 20, _("20")
+        TWENTY_ONE_DAYS = 21, _("21")
+        TWENTY_TWO_DAYS = 22, _("22")
+        TWENTY_THREE_DAYS = 23, _("23")
+        TWENTY_FOUR_DAYS = 24, _("24")
+        TWENTY_FIVE_DAYS = 25, _("25")
+        TWENTY_SIX_DAYS = 26, _("26")
+        TWENTY_SEVEN_DAYS = 27, _("27")
+        TWENTY_EIGHT_DAYS = 28, _("28")
+        TWENTY_NINE_DAYS = 29, _("29")
+        THIRTY_DAYS = 30, _("30")
+        THIRTY_ONE_DAYS = 31, _("31")
+
+    class HoursTimeFrameChoices(models.IntegerChoices):
+        ZERO_TO_FIVE_HOURS = 5, _("0-5")
+        FIVE_TO_TEN_HOURS = 10, _("5-10")
+        TEN_TO_FIFTEEN_HOURS = 15, _("10-15")
+        FIFTEEN_TO_TWENTY_HOURS = 20, _("15-20")
+        TWENTY_TO_TWENTY_FIVE_HOURS = 25, _("20-25")
+        TWENTY_FIVE_TO_THIRTY_HOURS = 30, _("25-30")
+
     activity = models.CharField(max_length=255, verbose_name=_("Activity"))
     timeframe = models.IntegerField(choices=TimeFrame.choices, verbose_name=_("Timeframe"))
     time_value = ArrayField(
@@ -732,10 +796,10 @@ class SimplifiedEAP(EAPBaseModel):
         null=True,
         blank=True,
     )
-    hazard_impact_file = models.ManyToManyField(
+    hazard_impact_images = models.ManyToManyField(
         EAPFile,
-        verbose_name=_("Hazard Impact Files"),
-        related_name="simplified_eap_hazard_impact_files",
+        verbose_name=_("Hazard Impact Images"),
+        related_name="simplified_eap_hazard_impact_images",
         blank=True,
     )
 
@@ -745,10 +809,10 @@ class SimplifiedEAP(EAPBaseModel):
         blank=True,
     )
 
-    risk_selected_protocols_file = models.ManyToManyField(
+    risk_selected_protocols_images = models.ManyToManyField(
         EAPFile,
-        verbose_name=_("Risk Selected Protocols Files"),
-        related_name="simplified_eap_risk_selected_protocols_files",
+        verbose_name=_("Risk Selected Protocols Images"),
+        related_name="simplified_eap_risk_selected_protocols_images",
         blank=True,
     )
 
@@ -758,10 +822,10 @@ class SimplifiedEAP(EAPBaseModel):
         null=True,
         blank=True,
     )
-    selected_early_actions_file = models.ManyToManyField(
+    selected_early_actions_images = models.ManyToManyField(
         EAPFile,
-        verbose_name=_("Selected Early Actions Files"),
-        related_name="simplified_eap_selected_early_actions_files",
+        verbose_name=_("Selected Early Actions Images"),
+        related_name="simplified_eap_selected_early_actions_images",
         blank=True,
     )
 

eap/serializers.py

@@ -193,15 +193,67 @@ def validate_file(self, file):
         return file
 
 
+# NOTE: Separate serializer for partial updating EAPFile instance
+class EAPFileUpdateSerializer(BaseEAPSerializer):
+    id = serializers.IntegerField(required=True)
+    file = serializers.FileField(required=False)
+
+    class Meta:
+        model = EAPFile
+        fields = "__all__"
+        read_only_fields = (
+            "created_by",
+            "modified_by",
+        )
+
+    def validate_file(self, file):
+        validate_file_type(file)
+        return file
+
+
+ALLOWED_MAP_TIMEFRAMES_VALUE = {
+    OperationActivity.TimeFrame.YEARS: list(OperationActivity.YearsTimeFrameChoices.values),
+    OperationActivity.TimeFrame.MONTHS: list(OperationActivity.MonthsTimeFrameChoices.values),
+    OperationActivity.TimeFrame.DAYS: list(OperationActivity.DaysTimeFrameChoices.values),
+    OperationActivity.TimeFrame.HOURS: list(OperationActivity.HoursTimeFrameChoices.values),
+}
+
+
 class OperationActivitySerializer(
     serializers.ModelSerializer,
 ):
     id = serializers.IntegerField(required=False)
+    timeframe = serializers.ChoiceField(
+        choices=OperationActivity.TimeFrame.choices,
+        required=True,
+    )
+    time_value = serializers.ListField(
+        child=serializers.IntegerField(),
+        required=True,
+    )
 
     class Meta:
         model = OperationActivity
         fields = "__all__"
 
+    # NOTE: Custom validation for `timeframe` and `time_value`
+    # Make sure time_value is within the allowed range for the selected timeframe
+    def validate(self, validated_data: dict[str, typing.Any]) -> dict[str, typing.Any]:
+        timeframe = validated_data["timeframe"]
+        time_value = validated_data["time_value"]
+
+        allowed_values = ALLOWED_MAP_TIMEFRAMES_VALUE.get(timeframe, [])
+        invalid_values = [value for value in time_value if value not in allowed_values]
+
+        if invalid_values:
+            raise serializers.ValidationError(
+                {
+                    "time_value": gettext("Invalid time_value(s) %s for the selected timeframe %s.")
+                    % (invalid_values, OperationActivity.TimeFrame(timeframe).label)
+                }
+            )
+        return validated_data
+
 
 class PlannedOperationSerializer(
     NestedUpdateMixin,
@@ -252,35 +304,35 @@ class SimplifiedEAPSerializer(
     enable_approaches = EnableApproachSerializer(many=True, required=False)
 
     # FILES
-    cover_image_details = EAPFileSerializer(source="cover_image", read_only=True)
-    hazard_impact_file_details = EAPFileSerializer(source="hazard_impact_file", many=True, read_only=True)
-    selected_early_actions_file_details = EAPFileSerializer(source="selected_early_actions_file", many=True, read_only=True)
-    risk_selected_protocols_file_details = EAPFileSerializer(source="risk_selected_protocols_file", many=True, read_only=True)
+    cover_image_file = EAPFileUpdateSerializer(source="cover_image", required=False, allow_null=True)
+    hazard_impact_images_details = EAPFileSerializer(source="hazard_impact_images", many=True, read_only=True)
+    selected_early_actions_file_details = EAPFileSerializer(source="selected_early_actions_images", many=True, read_only=True)
+    risk_selected_protocols_file_details = EAPFileSerializer(source="risk_selected_protocols_images", many=True, read_only=True)
 
     # Admin2
     admin2_details = Admin2Serializer(source="admin2", many=True, read_only=True)
 
     class Meta:
         model = SimplifiedEAP
-        fields = "__all__"
         read_only_fields = [
             "version",
             "is_locked",
         ]
+        exclude = ("cover_image",)
 
-    def validate_hazard_impact_file(self, images):
+    def validate_hazard_impact_images(self, images):
         if images and len(images) > self.MAX_NUMBER_OF_IMAGES:
             raise serializers.ValidationError(f"Maximum {self.MAX_NUMBER_OF_IMAGES} images are allowed to upload.")
         validate_file_type(images)
         return images
 
-    def validate_risk_selected_protocols_file(self, images):
+    def validate_risk_selected_protocols_images(self, images):
         if images and len(images) > self.MAX_NUMBER_OF_IMAGES:
             raise serializers.ValidationError(f"Maximum {self.MAX_NUMBER_OF_IMAGES} images are allowed to upload.")
         validate_file_type(images)
         return images
 
-    def validate_selected_early_actions_file(self, images):
+    def validate_selected_early_actions_images(self, images):
         if images and len(images) > self.MAX_NUMBER_OF_IMAGES:
             raise serializers.ValidationError(f"Maximum {self.MAX_NUMBER_OF_IMAGES} images are allowed to upload.")
         validate_file_type(images)