Improve audit log message consistency

- Add periods at the end of all audit log messages for consistency
- Simplify [Review Session] pending status message to match other patterns
- Update all related tests to reflect the new message formats

Co-authored-by: Ester Beltrami <estyxx@users.noreply.github.com>

Author: github-actions[bot]

backend/api/grants/mutations.py

@@ -283,7 +283,7 @@ def send_grant(self, info: Info, input: SendGrantInput) -> SendGrantResult:
             },
         )
 
-        create_addition_admin_log_entry(request.user, instance, "Grant created")
+        create_addition_admin_log_entry(request.user, instance, "Grant created.")
 
         # hack because we return django models
         instance.__strawberry_definition__ = Grant.__strawberry_definition__
@@ -309,7 +309,7 @@ def update_grant(self, info: Info, input: UpdateGrantInput) -> UpdateGrantResult
 
         instance.save()
 
-        create_change_admin_log_entry(request.user, instance, "Grant updated")
+        create_change_admin_log_entry(request.user, instance, "Grant updated.")
 
         Participant.objects.update_or_create(
             user_id=request.user.id,
@@ -346,7 +346,7 @@ def send_grant_reply(
         grant.save()
 
         create_change_admin_log_entry(
-            request.user, grant, f"Grantee has replied with status {grant.status}"
+            request.user, grant, f"Grantee has replied with status {grant.status}."
         )
 
         admin_url = request.build_absolute_uri(grant.get_admin_url())

backend/api/grants/tests/test_send_grant.py

@@ -126,7 +126,7 @@ def test_send_grant(
     assert log_entry.user_id == user.id
     assert log_entry.user == user
     assert log_entry.object_id == str(grant.id)
-    assert log_entry.change_message == "Grant created"
+    assert log_entry.change_message == "Grant created."
 
     # Verify that the correct email template was used and email was sent
     emails_sent = sent_emails()

backend/api/grants/tests/test_send_grant_reply.py

@@ -90,7 +90,7 @@ def test_status_is_updated_when_reply_is_confirmed(graphql_client, user):
     assert LogEntry.objects.filter(
         user=user,
         object_id=grant.id,
-        change_message="Grantee has replied with status confirmed",
+        change_message="Grantee has replied with status confirmed.",
     ).exists()
 
 
@@ -109,7 +109,7 @@ def test_status_is_updated_when_reply_is_refused(graphql_client, user):
     assert LogEntry.objects.filter(
         user=user,
         object_id=grant.id,
-        change_message="Grantee has replied with status refused",
+        change_message="Grantee has replied with status refused.",
     ).exists()
 
 

backend/api/grants/tests/test_update_grant.py

@@ -135,7 +135,7 @@ def test_update_grant(graphql_client, user):
     assert log_entry.user_id == user.id
     assert log_entry.user == user
     assert log_entry.object_id == str(grant.id)
-    assert log_entry.change_message == "Grant updated"
+    assert log_entry.change_message == "Grant updated."
 
 
 def test_cannot_update_a_grant_if_user_is_not_owner(

backend/grants/admin.py

@@ -221,7 +221,7 @@ def send_reply_emails(modeladmin, request, queryset):
             create_change_admin_log_entry(
                 request.user,
                 grant,
-                change_message="Sent Approved reply email to applicant",
+                change_message="Sent Approved reply email to applicant.",
             )
             messages.info(request, f"Sent Approved reply email to {grant.name}")
 
@@ -233,7 +233,7 @@ def send_reply_emails(modeladmin, request, queryset):
             create_change_admin_log_entry(
                 request.user,
                 grant,
-                change_message="Sent Waiting List reply email to applicant",
+                change_message="Sent Waiting List reply email to applicant.",
             )
             messages.info(request, f"Sent Waiting List reply email to {grant.name}")
 
@@ -242,7 +242,7 @@ def send_reply_emails(modeladmin, request, queryset):
             create_change_admin_log_entry(
                 request.user,
                 grant,
-                change_message="Sent Rejected reply email to applicant",
+                change_message="Sent Rejected reply email to applicant.",
             )
             messages.info(request, f"Sent Rejected reply email to {grant.name}")
 
@@ -270,7 +270,7 @@ def send_grant_reminder_to_waiting_for_confirmation(modeladmin, request, queryse
         create_change_admin_log_entry(
             request.user,
             grant,
-            change_message="Sent Approved reminder email to applicant",
+            change_message="Sent Approved reminder email to applicant.",
         )
         messages.info(request, f"Grant reminder sent to {grant.name}")
 
@@ -290,7 +290,7 @@ def send_reply_email_waiting_list_update(modeladmin, request, queryset):
         create_change_admin_log_entry(
             request.user,
             grant,
-            change_message="Sent Waiting List update reply email to applicant",
+            change_message="Sent Waiting List update reply email to applicant.",
         )
         messages.info(request, f"Sent Waiting List update reply email to {grant.name}")
 
@@ -325,7 +325,7 @@ def create_grant_vouchers(modeladmin, request, queryset):
             create_addition_admin_log_entry(
                 request.user,
                 grant,
-                change_message="Created voucher for this grant",
+                change_message="Created voucher for this grant.",
             )
 
             vouchers_to_create.append(
@@ -346,12 +346,12 @@ def create_grant_vouchers(modeladmin, request, queryset):
             create_change_admin_log_entry(
                 request.user,
                 existing_voucher,
-                change_message="Upgraded Co-Speaker voucher to Grant voucher",
+                change_message="Upgraded Co-Speaker voucher to Grant voucher.",
             )
             create_change_admin_log_entry(
                 request.user,
                 grant,
-                change_message="Updated existing Co-Speaker voucher to grant",
+                change_message="Updated existing Co-Speaker voucher to grant.",
             )
             existing_voucher.voucher_type = ConferenceVoucher.VoucherType.GRANT
             vouchers_to_update.append(existing_voucher)
@@ -380,7 +380,7 @@ def mark_rejected_and_send_email(modeladmin, request, queryset):
         create_change_admin_log_entry(
             request.user,
             grant,
-            change_message=f"Status changed from '{old_status}' to 'rejected' and rejection email sent",
+            change_message=f"Status changed from '{old_status}' to 'rejected' and rejection email sent.",
         )
 
         send_grant_reply_rejected_email.delay(grant_id=grant.id)
@@ -441,7 +441,7 @@ def delete_model(self, request, obj):
         create_change_admin_log_entry(
             request.user,
             obj.grant,
-            change_message=f"Reimbursement removed: {obj.category.name}",
+            change_message=f"Reimbursement removed: {obj.category.name}.",
         )
         super().delete_model(request, obj)
 
@@ -456,7 +456,7 @@ def delete_model(self, request, obj):
         create_change_admin_log_entry(
             request.user,
             obj.grant,
-            change_message=f"Reimbursement removed: {obj.category.name}",
+            change_message=f"Reimbursement removed: {obj.category.name}.",
         )
         super().delete_model(request, obj)
 
@@ -573,19 +573,19 @@ def save_model(self, request, obj, form, change):
                 create_change_admin_log_entry(
                     request.user,
                     obj,
-                    change_message=f"Status changed from '{obj._original_status}' to '{obj.status}'",
+                    change_message=f"Status changed from '{obj._original_status}' to '{obj.status}'.",
                 )
             if obj.pending_status != obj._original_pending_status:
                 create_change_admin_log_entry(
                     request.user,
                     obj,
-                    change_message=f"Pending status changed from '{obj._original_pending_status}' to '{obj.pending_status}'",
+                    change_message=f"Pending status changed from '{obj._original_pending_status}' to '{obj.pending_status}'.",
                 )
         else:
             create_addition_admin_log_entry(
                 request.user,
                 obj,
-                change_message="Grant created",
+                change_message="Grant created.",
             )
         super().save_model(request, obj, form, change)
 

backend/grants/tests/test_admin.py

@@ -165,7 +165,7 @@ def test_send_reply_emails_approved_set_deadline_in_fourteen_days(
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Sent Approved reply email to applicant",
+        change_message="Sent Approved reply email to applicant.",
     ).exists()
 
 
@@ -189,7 +189,7 @@ def test_send_reply_emails_waiting_list(rf, mocker, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Sent Waiting List reply email to applicant",
+        change_message="Sent Waiting List reply email to applicant.",
     ).exists()
 
 
@@ -213,7 +213,7 @@ def test_send_reply_emails_waiting_list_maybe(rf, mocker, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Sent Waiting List reply email to applicant",
+        change_message="Sent Waiting List reply email to applicant.",
     ).exists()
 
 
@@ -237,7 +237,7 @@ def test_send_reply_emails_rejected(rf, mocker, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Sent Rejected reply email to applicant",
+        change_message="Sent Rejected reply email to applicant.",
     ).exists()
 
 
@@ -269,7 +269,7 @@ def test_send_grant_reminder_to_waiting_for_confirmation(rf, mocker, admin_user)
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Sent Approved reminder email to applicant",
+        change_message="Sent Approved reminder email to applicant.",
     ).exists()
 
 
@@ -299,7 +299,7 @@ def test_send_reply_email_waiting_list_update(rf, mocker, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Sent Waiting List update reply email to applicant",
+        change_message="Sent Waiting List update reply email to applicant.",
     ).exists()
 
 
@@ -341,12 +341,12 @@ def test_create_grant_vouchers(rf, mocker, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant_1.id,
-        change_message="Created voucher for this grant",
+        change_message="Created voucher for this grant.",
     ).exists()
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant_2.id,
-        change_message="Created voucher for this grant",
+        change_message="Created voucher for this grant.",
     ).exists()
 
 
@@ -577,12 +577,12 @@ def test_mark_rejected_and_send_email(rf, mocker, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant1.id,
-        change_message="Status changed from 'waiting_list' to 'rejected' and rejection email sent",
+        change_message="Status changed from 'waiting_list' to 'rejected' and rejection email sent.",
     ).exists()
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant2.id,
-        change_message="Status changed from 'waiting_list_maybe' to 'rejected' and rejection email sent",
+        change_message="Status changed from 'waiting_list_maybe' to 'rejected' and rejection email sent.",
     ).exists()
 
 
@@ -738,7 +738,7 @@ def test_delete_reimbursement_from_admin_logs_audit_log_entry(rf, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message=f"Reimbursement removed: {reimbursement.category.name}",
+        change_message=f"Reimbursement removed: {reimbursement.category.name}.",
     ).exists()
 
 
@@ -753,7 +753,7 @@ def test_save_grant_in_admin_logs_audit_log_entry(rf, admin_user):
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Grant created",
+        change_message="Grant created.",
     ).exists()
 
 
@@ -769,7 +769,7 @@ def test_save_grant_in_admin_logs_audit_log_entry_for_status_change(rf, admin_us
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Status changed from 'pending' to 'confirmed'",
+        change_message="Status changed from 'pending' to 'confirmed'.",
     ).exists()
 
 
@@ -787,5 +787,5 @@ def test_save_grant_in_admin_logs_audit_log_entry_for_pending_status_change(
     assert LogEntry.objects.filter(
         user=admin_user,
         object_id=grant.id,
-        change_message="Pending status changed from 'pending' to 'confirmed'",
+        change_message="Pending status changed from 'pending' to 'confirmed'.",
     ).exists()

backend/reviews/admin.py

@@ -325,7 +325,7 @@ def _review_grants_recap_view(self, request, review_session):
                             create_deletion_admin_log_entry(
                                 request.user,
                                 grant,
-                                change_message=f"[Review Session] Reimbursement removed: {reimbursement.category.name}",
+                                change_message=f"[Review Session] Reimbursement removed: {reimbursement.category.name}.",
                             )
                             reimbursement.delete()
                     else:
@@ -338,7 +338,7 @@ def _review_grants_recap_view(self, request, review_session):
                             create_deletion_admin_log_entry(
                                 request.user,
                                 grant,
-                                change_message=f"[Review Session] Reimbursement removed: {reimbursement.category.name}",
+                                change_message=f"[Review Session] Reimbursement removed: {reimbursement.category.name}.",
                             )
                         to_delete.delete()
 
@@ -357,7 +357,7 @@ def _review_grants_recap_view(self, request, review_session):
                     create_change_admin_log_entry(
                         request.user,
                         grant,
-                        change_message=f"[Review Session] Grant status updated: pending_status changed from '{original_pending_status}' to '{grant.pending_status}'.",
+                        change_message=f"[Review Session] Pending status changed from '{original_pending_status}' to '{grant.pending_status}'.",
                     )
 
                 # The frontend may send reimbursement categories as checked by default,

backend/reviews/tests/test_admin.py

@@ -375,7 +375,7 @@ def test_save_review_grants_updates_grant_and_creates_reimbursements(rf, mocker)
     assert LogEntry.objects.filter(
         user=user,
         object_id__in=[str(grant_1.id), str(grant_2.id)],
-        change_message="[Review Session] Grant status updated: pending_status changed from 'None' to 'approved'.",
+        change_message="[Review Session] Pending status changed from 'None' to 'approved'.",
     ).exists()
     assert LogEntry.objects.filter(
         user=user,
@@ -477,7 +477,7 @@ def test_save_review_grants_update_grants_status_to_rejected_removes_reimburseme
         assert LogEntry.objects.filter(
             user=user,
             object_id=str(reimbursement.id),
-            change_message=f"[Review Session] Reimbursement removed: {reimbursement.category.name}",
+            change_message=f"[Review Session] Reimbursement removed: {reimbursement.category.name}.",
         ).exists()
 
 
@@ -562,19 +562,19 @@ def test_save_review_grants_modify_reimbursements(rf, mocker):
     assert LogEntry.objects.filter(
         user=user,
         object_id=grant_1.id,
-        change_message=f"[Review Session] Reimbursement removed: {travel_category.name}",
+        change_message=f"[Review Session] Reimbursement removed: {travel_category.name}.",
     ).exists()
     assert LogEntry.objects.filter(
         user=user,
         object_id=grant_1.id,
-        change_message=f"[Review Session] Reimbursement removed: {accommodation_category.name}",
+        change_message=f"[Review Session] Reimbursement removed: {accommodation_category.name}.",
     ).exists()
 
     # pending_status change should not be logged because the grant status is not changed
     assert not LogEntry.objects.filter(
         user=user,
         object_id=grant_1.id,
-        change_message="[Review Session] Grant status updated: pending_status changed from 'approved' to 'None'.",
+        change_message="[Review Session] Pending status changed from 'approved' to 'None'.",
     ).exists()
 
 
@@ -721,5 +721,5 @@ def test_save_review_grants_two_times_does_not_create_duplicate_log_entries(rf,
     assert LogEntry.objects.filter(
         user=user,
         object_id=grant_1.id,
-        change_message="[Review Session] Grant status updated: pending_status changed from 'None' to 'approved'.",
+        change_message="[Review Session] Pending status changed from 'None' to 'approved'.",
     ).exists()