feat(dref): update dref status

Author: sudip-khanal

dref/migrations/0084_alter_dref_status_alter_dreffinalreport_status_and_more.py

@@ -0,0 +1,62 @@
+# Generated by Django 4.2.19 on 2025-09-10 08:48
+
+from django.db import migrations, models
+
+
+def update_status(apps, schema_editor):
+    """
+    Update old status to new workflow:
+    - Not published or IN_PROGRESS → DRAFT
+    - Published or COMPLETED → APPROVED
+    Applies to Dref, DrefOperationalUpdate, and DrefFinalReport.
+    """
+    models = [
+        "Dref",
+        "DrefOperationalUpdate",
+        "DrefFinalReport",
+    ]
+    for model_name in models:
+        Model = apps.get_model("dref", model_name)
+        Model.objects.filter(is_published=True).update(status=4)  # Published → APPROVED
+        Model.objects.filter(is_published=False).update(status=1)  # Not published → DRAFT
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("dref", "0083_dreffinalreport_total_operation_timeframe_imminent"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="dref",
+            name="status",
+            field=models.IntegerField(
+                blank=True,
+                choices=[(1, "Draft"), (2, "Finalizing"), (3, "Finalized"), (4, "Approved")],
+                null=True,
+                verbose_name="status",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="dreffinalreport",
+            name="status",
+            field=models.IntegerField(
+                blank=True,
+                choices=[(1, "Draft"), (2, "Finalizing"), (3, "Finalized"), (4, "Approved")],
+                null=True,
+                verbose_name="status",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="drefoperationalupdate",
+            name="status",
+            field=models.IntegerField(
+                blank=True,
+                choices=[(1, "Draft"), (2, "Finalizing"), (3, "Finalized"), (4, "Approved")],
+                null=True,
+                verbose_name="status",
+            ),
+        ),
+        migrations.RunPython(update_status, reverse_code=migrations.RunPython.noop),
+    ]

dref/models.py

@@ -264,8 +264,13 @@ class DisasterCategory(models.IntegerChoices):
         RED = 2, _("Red")
 
     class Status(models.IntegerChoices):
-        IN_PROGRESS = 0, _("In Progress")
-        COMPLETED = 1, _("Completed")
+        # NOTE: Updated statuses for clarity:
+        # IN_PROGRESS → DRAFT, COMPLETED → APPROVED.
+        # Added FINALIZING and FINALIZED for translation/finalization.
+        DRAFT = 1, _("Draft")
+        FINALIZING = 2, _("Finalizing")
+        FINALIZED = 3, _("Finalized")
+        APPROVED = 4, _("Approved")
 
     created_at = models.DateTimeField(verbose_name=_("created at"), auto_now_add=True)
     modified_at = models.DateTimeField(verbose_name=_("modified at"), default=timezone.now, null=True)
@@ -748,8 +753,6 @@ def save(self, *args, **kwargs):
                 self.budget_file_preview.save(filename, thumb_data, save=False)
             else:
                 raise ValidationError({"budget_file": "Sorry cannot generate preview for empty pdf"})
-
-        self.status = Dref.Status.COMPLETED if self.is_published else Dref.Status.IN_PROGRESS
         self.__budget_file_id = self.budget_file_id
         super().save(*args, **kwargs)
 
@@ -1232,7 +1235,6 @@ def save(self, *args, **kwargs):
                 raise ValidationError({"budget_file": "Sorry cannot generate preview for empty pdf"})
 
         self.__budget_file_id = self.budget_file_id
-        self.status = Dref.Status.COMPLETED if self.is_published else Dref.Status.IN_PROGRESS
         super().save(*args, **kwargs)
 
     @staticmethod
@@ -1651,7 +1653,6 @@ def save(self, *args, **kwargs):
             else:
                 raise ValidationError({"financial_report": "Sorry cannot generate preview for empty pdf"})
 
-        self.status = Dref.Status.COMPLETED if self.is_published else Dref.Status.IN_PROGRESS
         self.__financial_report_id = self.financial_report_id
         super().save(*args, **kwargs)
 

dref/test_views.py

@@ -121,7 +121,7 @@ def test_post_dref_creation(self, send_notification):
             "title": "Dref test title",
             "type_of_onset": Dref.OnsetType.SLOW.value,
             "disaster_category": Dref.DisasterCategory.YELLOW.value,
-            "status": Dref.Status.IN_PROGRESS.value,
+            "status": Dref.Status.DRAFT.value,
             "num_assisted": 5666,
             "num_affected": 23,
             "amount_requested": 127771111,
@@ -237,7 +237,7 @@ def test_event_date_in_dref(self):
             "title": "Dref test title",
             "type_of_onset": Dref.OnsetType.SLOW.value,
             "disaster_category": Dref.DisasterCategory.YELLOW.value,
-            "status": Dref.Status.IN_PROGRESS.value,
+            "status": Dref.Status.DRAFT.value,
             "national_society": national_society.id,
             "num_assisted": 5666,
             "num_affected": 23,
@@ -356,27 +356,27 @@ def test_filter_dref_status(self):
         """
         Test to filter dref status
         """
-        DrefFactory.create(title="test", status=Dref.Status.COMPLETED, date_of_approval="2020-10-10", created_by=self.user)
-        DrefFactory.create(status=Dref.Status.COMPLETED, date_of_approval="2020-10-10", created_by=self.user)
-        DrefFactory.create(status=Dref.Status.COMPLETED, date_of_approval="2020-10-10", created_by=self.user)
-        DrefFactory.create(status=Dref.Status.IN_PROGRESS, created_by=self.user)
-        DrefFactory.create(status=Dref.Status.IN_PROGRESS, created_by=self.user)
+        DrefFactory.create(title="test", status=Dref.Status.APPROVED, date_of_approval="2020-10-10", created_by=self.user)
+        DrefFactory.create(status=Dref.Status.APPROVED, date_of_approval="2020-10-10", created_by=self.user)
+        DrefFactory.create(status=Dref.Status.APPROVED, date_of_approval="2020-10-10", created_by=self.user)
+        DrefFactory.create(status=Dref.Status.DRAFT, created_by=self.user)
+        DrefFactory.create(status=Dref.Status.DRAFT, created_by=self.user)
 
         # filter by `In Progress`
-        url = f"/api/v2/dref/?status={Dref.Status.IN_PROGRESS.value}"
+        url = f"/api/v2/dref/?status={Dref.Status.DRAFT.value}"
         self.client.force_authenticate(self.user)
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(len(response.data["results"]), 5)
+        self.assertEqual(len(response.data["results"]), 2)
 
     def test_dref_country_filter(self):
         country1 = Country.objects.create(name="country1")
         country2 = Country.objects.create(name="country2")
-        DrefFactory.create(title="test", status=Dref.Status.COMPLETED, created_by=self.user, country=country1)
-        DrefFactory.create(status=Dref.Status.COMPLETED, created_by=self.user)
-        DrefFactory.create(status=Dref.Status.COMPLETED, created_by=self.user, country=country2)
-        DrefFactory.create(status=Dref.Status.IN_PROGRESS, created_by=self.user, country=country1)
-        DrefFactory.create(status=Dref.Status.IN_PROGRESS, created_by=self.user)
+        DrefFactory.create(title="test", status=Dref.Status.APPROVED, created_by=self.user, country=country1)
+        DrefFactory.create(status=Dref.Status.APPROVED, created_by=self.user)
+        DrefFactory.create(status=Dref.Status.APPROVED, created_by=self.user, country=country2)
+        DrefFactory.create(status=Dref.Status.DRAFT, created_by=self.user, country=country1)
+        DrefFactory.create(status=Dref.Status.DRAFT, created_by=self.user)
         url = f"/api/v2/dref/?country={country1.id}"
         self.client.force_authenticate(self.user)
         response = self.client.get(url)
@@ -386,9 +386,10 @@ def test_dref_country_filter(self):
     @mock.patch("django.utils.timezone.now")
     def test_dref_is_published(self, mock_now):
         """
-        Test for dref if is_published = True
+        Test DREF publishing flow:
+        - Can only publish when status=FINALIZED
+        - Publishing sets status=APPROVED and is_published=True
         """
-
         initial_now = datetime.now()
         mock_now.return_value = initial_now
 
@@ -397,9 +398,12 @@ def test_dref_is_published(self, mock_now):
         dref = DrefFactory.create(
             title="test",
             created_by=self.user,
+            country=country,
+            status=Dref.Status.DRAFT,
             is_published=False,
             type_of_dref=Dref.DrefType.IMMINENT,
         )
+        # Normal PATCH
         url = f"/api/v2/dref/{dref.id}/"
         data = {
             "title": "New Update Title",
@@ -408,7 +412,6 @@ def test_dref_is_published(self, mock_now):
         self.client.force_authenticate(self.user)
         response = self.client.patch(url, data)
         self.assert_200(response)
-
         # create new dref with is_published = False
         not_published_dref = DrefFactory.create(
             title="test",
@@ -424,23 +427,28 @@ def test_dref_is_published(self, mock_now):
         data["modified_at"] = initial_now - timedelta(seconds=10)
         response = self.client.patch(url, data)
         self.assert_400(response)
-
-        # test dref published endpoint
-        url = f"/api/v2/dref/{not_published_dref.id}/publish/"
+        # ---- Test publishing ----
+        publish_url = f"/api/v2/dref/{dref.id}/publish/"
         data = {}
-        self.client.force_authenticate(self.user)
-        response = self.client.post(url, data)
+        response = self.client.post(publish_url, data)
         self.assert_403(response)
-
-        # add permission to request user
+        # Add permission to user
         self.dref_permission = Permission.objects.create(
             codename="dref_region_admin_0",
             content_type=ContentType.objects.get_for_model(Region),
             name="Dref Admin for 0",
         )
         self.user.user_permissions.add(self.dref_permission)
-        response = self.client.post(url, data)
+        # Try again while DRAFT. Should fail(not finalized yet)
+        response = self.client.post(publish_url, data)
+        self.assert_400(response)
+        # Update status to FINALIZED, then publish should succeed
+        dref.status = Dref.Status.FINALIZED
+        dref.save(update_fields=["status"])
+        response = self.client.post(publish_url, data)
+        dref.refresh_from_db()
         self.assert_200(response)
+        self.assertEqual(response.data["status"], Dref.Status.APPROVED)
         self.assertEqual(response.data["is_published"], True)
 
     def test_dref_operation_update_create(self):
@@ -672,6 +680,7 @@ def test_final_report_update_once_published(self):
             dref=dref,
             country=country,
             type_of_dref=Dref.DrefType.RESPONSE,
+            status=Dref.Status.FINALIZED,
         )
         final_report.users.set([user1])
         # try to publish this report
@@ -691,7 +700,7 @@ def test_final_report_update_once_published(self):
         response = self.client.post(url, data)
         self.assert_200(response)
         self.assertEqual(response.data["is_published"], True)
-
+        self.assertEqual(response.data["status"], Dref.Status.APPROVED)
         # now try to patch to the final report
         url = f"/api/v2/dref-final-report/{final_report.id}/"
         data = {
@@ -709,7 +718,7 @@ def test_dref_for_assessment_report(self):
             "type_of_onset": Dref.OnsetType.SLOW.value,
             "type_of_dref": Dref.DrefType.ASSESSMENT,
             "disaster_category": Dref.DisasterCategory.YELLOW.value,
-            "status": Dref.Status.IN_PROGRESS.value,
+            "status": Dref.Status.DRAFT.value,
             "num_assisted": 5666,
             "num_affected": 23,
             "amount_requested": 127771111,
@@ -1297,7 +1306,7 @@ def test_dref_imminent(self):
             "type_of_onset": Dref.OnsetType.SUDDEN.value,
             "type_of_dref": Dref.DrefType.IMMINENT,
             "disaster_category": Dref.DisasterCategory.YELLOW.value,
-            "status": Dref.Status.IN_PROGRESS.value,
+            "status": Dref.Status.DRAFT.value,
             "num_assisted": 5666,
             "num_affected": 23,
             "amount_requested": 127771111,

dref/views.py

@@ -88,9 +88,11 @@ def get_queryset(self):
     )
     def get_published(self, request, pk=None, version=None):
         dref = self.get_object()
+        if dref.status != Dref.Status.FINALIZED:
+            raise serializers.ValidationError(gettext("Must be finalized before publishing."))
         dref.is_published = True
-        dref.status = Dref.Status.COMPLETED
-        dref.save(update_fields=["is_published", "status"])
+        dref.status = Dref.Status.APPROVED
+        dref.save(update_fields=["status", "is_published"])
         serializer = DrefSerializer(dref, context={"request": request})
         return response.Response(serializer.data)
 
@@ -153,8 +155,10 @@ def get_queryset(self):
     )
     def get_published(self, request, pk=None, version=None):
         operational_update = self.get_object()
+        if operational_update.status != Dref.Status.FINALIZED:
+            raise serializers.ValidationError(gettext("Must be finalized before publishing."))
         operational_update.is_published = True
-        operational_update.status = Dref.Status.COMPLETED
+        operational_update.status = Dref.Status.APPROVED
         operational_update.save(update_fields=["is_published", "status"])
         serializer = DrefOperationalUpdateSerializer(operational_update, context={"request": request})
         return response.Response(serializer.data)
@@ -185,10 +189,12 @@ def get_queryset(self):
     )
     def get_published(self, request, pk=None, version=None):
         field_report = self.get_object()
+        if field_report.status != Dref.Status.FINALIZED:
+            raise serializers.ValidationError(gettext("Must be finalized before publishing."))
         if field_report.is_published:
             raise serializers.ValidationError(gettext("Final Report %s is already published" % field_report))
         field_report.is_published = True
-        field_report.status = Dref.Status.COMPLETED
+        field_report.status = Dref.Status.APPROVED
         field_report.save(update_fields=["is_published", "status"])
         field_report.dref.is_active = False
         field_report.date_of_approval = timezone.now().date()