Merge pull request #223 from maykinmedia/feature/85-notify-all-assignees

[#85] Notify all assignees of deletion

Author: SilviaAmAm

backend/src/openarchiefbeheer/accounts/tests/factories.py

@@ -21,6 +21,7 @@ class UserFactory(DjangoModelFactory):
     last_name = factory.Faker("last_name")
     password = factory.PostGenerationMethodCall("set_password", "password")
     role = factory.SubFactory(RoleFactory)
+    email = factory.Faker("email")
 
     class Meta:
         model = User

backend/src/openarchiefbeheer/destruction/tasks.py

@@ -9,6 +9,7 @@
 from .constants import InternalStatus, ListItemStatus, ListStatus
 from .models import DestructionList, DestructionListItem, ReviewResponse
 from .signals import deletion_failure
+from .utils import notify_assignees_successful_deletion
 
 logger = logging.getLogger(__name__)
 
@@ -104,4 +105,4 @@ def complete_and_notify(pk: int) -> None:
 
     destruction_list.set_status(ListStatus.deleted)
 
-    # TODO notify
+    notify_assignees_successful_deletion(destruction_list)

backend/src/openarchiefbeheer/destruction/tests/test_tasks.py

@@ -21,6 +21,7 @@
     ListStatus,
 )
 from ..tasks import (
+    complete_and_notify,
     delete_destruction_list,
     delete_destruction_list_item,
     process_review_response,
@@ -335,3 +336,35 @@ def test_processing_list_with_failed_item(self):
             item.internal_results,
             {"deleted_resources": {}, "resources_to_delete": {}, "traceback": ""},
         )
+
+    def test_complete_and_notify(self):
+        list = DestructionListFactory.create(
+            processing_status=InternalStatus.processing,
+            status=ListStatus.ready_to_delete,
+        )
+        assignees = DestructionListAssigneeFactory.create_batch(
+            3, destruction_list=list
+        )
+
+        with (
+            patch(
+                "openarchiefbeheer.destruction.utils.EmailConfig.get_solo",
+                return_value=EmailConfig(
+                    subject_successful_deletion="DELETED!",
+                    body_successful_deletion="Wohoo deleted list",
+                ),
+            ),
+        ):
+            complete_and_notify(list.pk)
+
+        self.assertEqual(len(mail.outbox), 1)
+        self.assertEqual(
+            sorted(mail.outbox[0].to),
+            sorted([assignee.user.email for assignee in assignees]),
+        )
+        self.assertEqual(mail.outbox[0].subject, "DELETED!")
+
+        list.refresh_from_db()
+
+        self.assertEqual(list.status, ListStatus.deleted)
+        self.assertEqual(list.processing_status, InternalStatus.succeeded)

backend/src/openarchiefbeheer/destruction/utils.py

@@ -99,6 +99,20 @@ def notify_author_last_review(
     )
 
 
+def notify_assignees_successful_deletion(destruction_list: DestructionList) -> None:
+    config = EmailConfig.get_solo()
+    recipients = destruction_list.assignees.all().values_list("user__email", flat=True)
+
+    notify(
+        subject=config.subject_successful_deletion,
+        body=config.body_successful_deletion,
+        context={
+            "list": destruction_list,
+        },
+        recipients=list(recipients),
+    )
+
+
 class ObjectWithStatus(Protocol):
     def set_processing_status(self, status: InternalStatus) -> None: ...
 

backend/src/openarchiefbeheer/emails/admin.py

@@ -47,4 +47,13 @@ class EmailConfigAdmin(SingletonModelAdmin):
                 ]
             },
         ),
+        (
+            _("Templates successful deletion"),
+            {
+                "fields": [
+                    "subject_successful_deletion",
+                    "body_successful_deletion",
+                ]
+            },
+        ),
     ]

backend/src/openarchiefbeheer/emails/migrations/0004_emailconfig_body_successful_deletion_and_more.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.2.14 on 2024-07-26 14:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("emails", "0003_emailconfig_body_error_during_deletion_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="emailconfig",
+            name="body_successful_deletion",
+            field=models.TextField(
+                blank=True,
+                help_text="Body of the email that will be sent to all the assignees when a list is successfully deleted.",
+                verbose_name="body successful deletion",
+            ),
+        ),
+        migrations.AddField(
+            model_name="emailconfig",
+            name="subject_successful_deletion",
+            field=models.CharField(
+                blank=True,
+                help_text="Subject of the email that will be sent to all the assignees when a list is successfully deleted.",
+                max_length=250,
+                verbose_name="subject successful deletion",
+            ),
+        ),
+    ]

backend/src/openarchiefbeheer/emails/models.py

@@ -101,6 +101,23 @@ class EmailConfig(SingletonModel):
         ),
         blank=True,
     )
+    subject_successful_deletion = models.CharField(
+        max_length=250,
+        verbose_name=_("subject successful deletion"),
+        help_text=_(
+            "Subject of the email that will be sent to all the assignees "
+            "when a list is successfully deleted."
+        ),
+        blank=True,
+    )
+    body_successful_deletion = models.TextField(
+        verbose_name=_("body successful deletion"),
+        help_text=_(
+            "Body of the email that will be sent to all the assignees "
+            "when a list is successfully deleted."
+        ),
+        blank=True,
+    )
 
     class Meta:
         verbose_name = _("email configuration")

backend/src/openarchiefbeheer/fixtures/default_emails.json

@@ -14,7 +14,9 @@
       "subject_changes_requested": "Voorstel voor wijziging van uw vernietigingslijst",
       "body_changes_requested": "Beste {{ user }},\r\n\r\nEr is een voorstel tot aanpassing van uw vernietigingslijst {{ list }}. U kunt de lijst en de voorgestelde wijziging in de Open-Archiefbeheer web app bekijken en af te handelen.",
       "subject_error_during_deletion": "Fout tijdens vernietiging",
-      "body_error_during_deletion": "Beste {{ user }},\r\n\r\nEr is een fout opgetreden tijdens het vernietigen van vernietigingslijst {{ list }}. Probeer het opnieuw of neem contact op met de IT afdeling."
+      "body_error_during_deletion": "Beste {{ user }},\r\n\r\nEr is een fout opgetreden tijdens het vernietigen van vernietigingslijst {{ list }}. Probeer het opnieuw of neem contact op met de IT afdeling.",
+      "subject_successful_deletion": "Lijst succesvol verwerkt",
+      "body_successful_deletion": "Beste,\r\n\r\nLijst {{ list }} is succesvol verwerkt. Alle zaken en gerelateerde objecten zijn vernietigd."
     }
   }
 ]