Release/uat/3.7.0

django/core/admin/__init__.py

@@ -32,6 +32,9 @@ class UserProfileInline(admin.StackedInline):
 
 
 class CustomUserAdmin(ExportActionMixin, UserAdmin):
+    from import_export_celery.admin_actions import create_export_job_action
+    create_export_job_action.short_description = "Generate export in the background"
+    actions = (create_export_job_action,)
     list_display = ('userprofile', 'country', 'type', 'organisation', 'is_staff', 'is_superuser')
     search_fields = ('userprofile__name', 'email', 'userprofile__country__name', 'userprofile__organisation__name')
     inlines = (UserProfileInline,)

django/project/management/commands/add_taxonomies.py

@@ -59,10 +59,12 @@ def handle(self, *args, **options):
 
         for block_name in data:
             if block_name in self.data_model_map:
-                self.fill_named_model(data[block_name], self.data_model_map[block_name])
+                self.fill_named_model(
+                    data[block_name], self.data_model_map[block_name])
             elif block_name == 'Currency':
                 self.fill_currencies(data[block_name])
             elif block_name in self.nonmodel_blocks:
-                pp.pprint(f"Warning: need to check {block_name} by hand as it's non-model")
+                pp.pprint(
+                    f"Warning: need to check {block_name} by hand as it's non-model")
             else:  # pragma: no cover
                 pp.pprint(f"Warning: unhandled block name: {block_name}")

django/project/migrations/0086_reload_data_rebuild_search_engine.py

@@ -7,10 +7,6 @@ def update_translation_fields(apps, schema_editor):
     call_command('update_translation_fields')
 
 
-def add_taxonomies(apps, schema_editor):
-    call_command('add_taxonomies', '--verbosity', 0)
-
-
 def rebuild_search(apps, schema_editor):
     call_command('rebuild_search')
 
@@ -31,8 +27,8 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.RunPython(update_translation_fields, reverse_code=migrations.RunPython.noop),
-        migrations.RunPython(add_taxonomies, reverse_code=migrations.RunPython.noop),
-        # migrations.RunPython(rebuild_search, reverse_code=migrations.RunPython.noop),
-        migrations.RunPython(reorder_stages, reverse_code=migrations.RunPython.noop),
+        migrations.RunPython(update_translation_fields,
+                             reverse_code=migrations.RunPython.noop),
+        migrations.RunPython(
+            reorder_stages, reverse_code=migrations.RunPython.noop),
     ]

django/project/migrations/0106_stage_completion_marks_an_initiative_as_inactive.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1 on 2023-07-20 18:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('project', '0105_delete_deltalink'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='stage',
+            name='completion_marks_an_initiative_as_inactive',
+            field=models.BooleanField(default=False, help_text='When this phase is marked as completed (with an end date) it means that the initiative is no longer active.<br>It will not move automatically to a following phase, but will stay in this phase.'),
+        ),
+    ]

django/project/migrations/0107_reorder_stages.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1 on 2023-07-20 18:43
+from django.core.management import call_command
+from django.db import migrations
+
+
+def add_taxonomies(apps, schema_editor):
+    call_command('add_taxonomies', '--verbosity', 0)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('project', '0106_stage_completion_marks_an_initiative_as_inactive'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            add_taxonomies, reverse_code=migrations.RunPython.noop),
+    ]

django/project/models.py

@@ -1013,6 +1013,8 @@ class Stage(InvalidateCacheMixin, ExtendedNameOrderedSoftDeletedModel):
     name = models.CharField(max_length=128)
     order = models.PositiveSmallIntegerField(default=0, blank=True, null=True)
     tooltip = models.CharField(max_length=256, blank=True, null=True)
+    completion_marks_an_initiative_as_inactive = models.BooleanField(
+        help_text="When this phase is marked as completed (with an end date) it means that the initiative is no longer active.<br>It will not move automatically to a following phase, but will stay in this phase.", default=False)
 
     class Meta:
         ordering = ["order", "name"]
@@ -1022,37 +1024,36 @@ class Meta:
     def __str__(self):  # pragma: no cover
         return self.name
 
-    @classmethod
-    def get_discontinued(cls):
-        """
-        Hardcoded for now. Object with this name must exist in the DB to work.
-        """
-        return cls.objects.get(name="Discontinued")
-
     @classmethod
     def calc_current_phase(cls, stages: List[Dict]):
-        discontinued_id = cls.get_discontinued().id
         all_stages = list(cls.objects.order_by(
             "order").values_list("id", flat=True))
-        one_before_discontinued_id = all_stages[all_stages.index(
-            discontinued_id) - 1]
-
         if not stages:  # when no phases are selected the current phase is the first one
             return all_stages[0]
 
         stage_ids = [stage["id"] for stage in stages]
+        # get the completed phases of the initiative and order them
         selected_stages = cls.objects.filter(
             id__in=stage_ids).order_by("order")
+        # get the last phase from initiative's completed phases
         last_stage = selected_stages.last()
 
-        if last_stage.id == discontinued_id:
-            current = discontinued_id
-        elif last_stage.id == one_before_discontinued_id:
-            current = last_stage.id
-        elif last_stage.id == all_stages[-1]:
-            current = last_stage.id
-        else:
-            current = all_stages[all_stages.index(last_stage.id) + 1]
+        # apply the business requirements
+        if not last_stage.completion_marks_an_initiative_as_inactive:  # selected phase's checkbox unchecked
+            # compute if there are already previous completed end phases (checkbox=checked)
+            completed_stages = selected_stages.filter(
+                completion_marks_an_initiative_as_inactive=True)
+            if completed_stages:  # if there completed end phases
+                current = last_stage.id
+            else:  # if there are not completed end phases
+                if last_stage.id != all_stages[-1]:  # not the last in list
+                    current = all_stages[all_stages.index(
+                        last_stage.id) + 1]  # get the next phase
+                else:  # the last in list
+                    current = last_stage.id  # set this phase as current
+        else:  # selected phase's checkbox checked
+            current = last_stage.id  # set this phase as current
+
         return current
 
 

django/project/tests/project_stage_tests.py

@@ -6,6 +6,8 @@
 
 from project.models import Stage
 from project.tests.setup import SetupTests
+from django.test import TestCase
+from project.views import ProjectPublicViewSet
 
 
 class ProjectStageTests(SetupTests):
@@ -16,15 +18,19 @@ def test_project_stages(self):
         data = copy.deepcopy(self.project_data)
 
         data['project']['name'] = 'Test Project 100'
-        data['project']['start_date'] = str((now - timezone.timedelta(days=10)).date())
-        data['project']['end_date'] = str((now - timezone.timedelta(days=1)).date())
+        data['project']['start_date'] = str(
+            (now - timezone.timedelta(days=10)).date())
+        data['project']['end_date'] = str(
+            (now - timezone.timedelta(days=1)).date())
         data['project']['end_date_note'] = "note for end date"
         del data['project']['stages']
 
         # create project
-        url = reverse("project-create", kwargs={"country_office_id": self.country_office.id})
+        url = reverse("project-create",
+                      kwargs={"country_office_id": self.country_office.id})
         response = self.test_user_client.post(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.json())
+        self.assertEqual(response.status_code,
+                         status.HTTP_201_CREATED, response.json())
 
         project_id = response.json()['id']
         self.assertIn("end_date_note", response.json()['draft'])
@@ -41,8 +47,10 @@ def test_project_stages(self):
         url = reverse("project-draft", kwargs={"project_id": project_id,
                                                "country_office_id": self.country_office.id})
         response = self.test_user_client.put(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST, response.json())
-        self.assertEqual(response.json(), {'project': {'stages': [{'date': ['This field may not be null.']}]}})
+        self.assertEqual(response.status_code,
+                         status.HTTP_400_BAD_REQUEST, response.json())
+        self.assertEqual(response.json(), {'project': {'stages': [
+                         {'date': ['This field may not be null.']}]}})
 
         stages = Stage.objects.all()
         # add stages
@@ -68,7 +76,8 @@ def test_project_stages(self):
         url = reverse("project-draft", kwargs={"project_id": project_id,
                                                "country_office_id": self.country_office.id})
         response = self.test_user_client.put(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+        self.assertEqual(response.status_code,
+                         status.HTTP_200_OK, response.json())
         resp_data = response.json()
         self.assertIn('stages', resp_data['draft'])
         self.assertEqual(len(resp_data['draft']['stages']), 3)
@@ -78,7 +87,8 @@ def test_project_stages(self):
         url = reverse("project-publish", kwargs={"project_id": project_id,
                                                  "country_office_id": self.country_office.id})
         response = self.test_user_client.put(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+        self.assertEqual(response.status_code,
+                         status.HTTP_200_OK, response.json())
         resp_data = response.json()
         self.assertNotIn('stages', resp_data['draft'])
         self.assertIn("end_date_note", response.json()['draft'])
@@ -88,7 +98,8 @@ def test_project_stages(self):
         url = reverse("project-publish", kwargs={"project_id": project_id,
                                                  "country_office_id": self.country_office.id})
         response = self.test_user_client.put(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+        self.assertEqual(response.status_code,
+                         status.HTTP_200_OK, response.json())
         resp_data = response.json()
         self.assertIn('stages', resp_data['draft'])
         self.assertEqual(len(resp_data['draft']['stages']), 3)
@@ -102,62 +113,13 @@ def test_stage_list(self):
 
         url = reverse("get-project-structure")
         response = self.test_user_client.get(url, format="json")
-        self.assertEqual(response.status_code, status.HTTP_200_OK, response.json())
+        self.assertEqual(response.status_code,
+                         status.HTTP_200_OK, response.json())
         data = response.json()['stages']
         self.assertEqual(data[0]['id'], stage_b.id)
         self.assertEqual(data[1]['id'], stage_a.id)
         self.assertEqual(data[2]['id'], stage_c.id)
 
-    def test_current_phase_discontinued(self):
-        now = timezone.now()
-        data = copy.deepcopy(self.project_data)
-        stage_1 = Stage.objects.all()[0]
-        stage_discontinued = Stage.objects.get(name='Discontinued')
-        # add stages
-        data['project']['stages'] = [
-            {
-                'id': stage_1.id,
-                'date': str((now - timezone.timedelta(days=10)).date()),
-                'note': 'preparation note'
-            },
-            {
-                'id': stage_discontinued.id,
-                'date': str((now - timezone.timedelta(days=7)).date()),
-                'note': 'analysis note'
-            }
-        ]
-
-        url = reverse("project-create", kwargs={"country_office_id": self.country_office.id})
-        response = self.test_user_client.post(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.json())
-        self.assertEqual(response.json()['draft']['current_phase'], stage_discontinued.id)
-
-    def test_current_phase_one_before_discontinued(self):
-        now = timezone.now()
-        data = copy.deepcopy(self.project_data)
-        stage_1 = Stage.objects.all()[0]
-        discontinued_id = Stage.objects.get(name='Discontinued').id
-        all_stages = list(Stage.objects.order_by('order').values_list('id', flat=True))
-        one_before_discontinued_id = all_stages[all_stages.index(discontinued_id) - 1]
-        # add stages
-        data['project']['stages'] = [
-            {
-                'id': stage_1.id,
-                'date': str((now - timezone.timedelta(days=10)).date()),
-                'note': 'preparation note'
-            },
-            {
-                'id': one_before_discontinued_id,
-                'date': str((now - timezone.timedelta(days=7)).date()),
-                'note': 'analysis note'
-            }
-        ]
-
-        url = reverse("project-create", kwargs={"country_office_id": self.country_office.id})
-        response = self.test_user_client.post(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.json())
-        self.assertEqual(response.json()['draft']['current_phase'], one_before_discontinued_id)
-
     def test_current_phase_normal_case(self):
         now = timezone.now()
         data = copy.deepcopy(self.project_data)
@@ -176,19 +138,24 @@ def test_current_phase_normal_case(self):
             }
         ]
 
-        url = reverse("project-create", kwargs={"country_office_id": self.country_office.id})
+        url = reverse("project-create",
+                      kwargs={"country_office_id": self.country_office.id})
         response = self.test_user_client.post(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.json())
-        self.assertEqual(response.json()['draft']['current_phase'], stages[2].id)
+        self.assertEqual(response.status_code,
+                         status.HTTP_201_CREATED, response.json())
+        self.assertEqual(response.json()['draft']
+                         ['current_phase'], stages[2].id)
 
     def test_current_phase_no_phase_selected(self):
         data = copy.deepcopy(self.project_data)
         stage_1 = Stage.objects.order_by('order').first()
         data['project']['stages'] = []
 
-        url = reverse("project-create", kwargs={"country_office_id": self.country_office.id})
+        url = reverse("project-create",
+                      kwargs={"country_office_id": self.country_office.id})
         response = self.test_user_client.post(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.json())
+        self.assertEqual(response.status_code,
+                         status.HTTP_201_CREATED, response.json())
         self.assertEqual(response.json()['draft']['current_phase'], stage_1.id)
 
     def test_current_phase_is_last_phase(self):
@@ -208,7 +175,42 @@ def test_current_phase_is_last_phase(self):
             }
         ]
 
-        url = reverse("project-create", kwargs={"country_office_id": self.country_office.id})
+        url = reverse("project-create",
+                      kwargs={"country_office_id": self.country_office.id})
         response = self.test_user_client.post(url, data, format="json")
-        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.json())
-        self.assertEqual(response.json()['draft']['current_phase'], stages.last().id)
+        self.assertEqual(response.status_code,
+                         status.HTTP_201_CREATED, response.json())
+        self.assertEqual(response.json()['draft']
+                         ['current_phase'], stages.last().id)
+
+
+class StageTestCase(TestCase):
+    def setUp(self):
+        self.stage_data = {
+            'name': 'Test Stage',
+            # Set the value accordingly for your test
+            'completion_marks_an_initiative_as_inactive': True
+        }
+
+    def test_completion_marks_an_initiative_as_inactive(self):
+        # Create a stage
+        stage = Stage.objects.create(**self.stage_data)
+
+        # Retrieve the created stage from the database
+        created_stage = Stage.objects.get(id=stage.id)
+
+        # Assert the field value matches the expected value
+        self.assertEqual(created_stage.completion_marks_an_initiative_as_inactive,
+                         self.stage_data['completion_marks_an_initiative_as_inactive'])
+
+        # Update the field value
+        new_value = False  # Set the new value accordingly for your test
+        created_stage.completion_marks_an_initiative_as_inactive = new_value
+        created_stage.save()
+
+        # Retrieve the updated stage from the database
+        updated_stage = Stage.objects.get(id=stage.id)
+
+        # Assert the field value has been updated
+        self.assertEqual(
+            updated_stage.completion_marks_an_initiative_as_inactive, new_value)