add confirmation page

Author: joshuadavidthomas

src/django_github_app/admin.py

@@ -1,12 +1,15 @@
 from __future__ import annotations
 
+import datetime
+
 from django import forms
 from django.contrib import admin
 from django.contrib import messages
 from django.http import HttpResponseRedirect
 from django.shortcuts import render
 from django.urls import path
 from django.urls import reverse
+from django.utils import timezone
 
 from .conf import app_settings
 from .models import EventLog
@@ -40,17 +43,49 @@ def get_urls(self):
         return custom_urls + urls
 
     def cleanup_view(self, request):
+        # handle confirmation
+        if request.POST.get("post") == "yes":
+            days_to_keep = int(request.POST.get("days_to_keep", 0))
+            deleted_count, _ = EventLog.objects.cleanup_events(days_to_keep)
+            event_text = "event" if deleted_count == 1 else "events"
+            day_text = "day" if days_to_keep == 1 else "days"
+            messages.success(
+                request,
+                f"Successfully deleted {deleted_count} {event_text} older than {days_to_keep} {day_text}.",
+            )
+            return HttpResponseRedirect(
+                reverse("admin:django_github_app_eventlog_changelist")
+            )
+
+        # show form or confirmation
         if request.method == "POST":
             form = EventLogCleanupForm(request.POST)
             if form.is_valid():
                 days_to_keep = form.cleaned_data["days_to_keep"]
-                deleted_count, _ = EventLog.objects.cleanup_events(days_to_keep)
-                messages.success(
+                cutoff_date = timezone.now() - datetime.timedelta(days=days_to_keep)
+                events_to_delete = EventLog.objects.filter(received_at__lte=cutoff_date)
+                delete_count = events_to_delete.count()
+
+                context = {
+                    **self.admin_site.each_context(request),
+                    "title": "Confirm Event Cleanup",
+                    "days_to_keep": days_to_keep,
+                    "delete_count": delete_count,
+                    "cutoff_date": cutoff_date,
+                    "opts": self.model._meta,
+                    "object_name": self.model._meta.verbose_name,
+                    "model_count": [
+                        (self.model._meta.verbose_name_plural, delete_count)
+                    ]
+                    if delete_count
+                    else [],
+                    "perms_lacking": None,
+                    "protected": None,
+                }
+                return render(
                     request,
-                    f"Successfully deleted {deleted_count} event(s) older than {days_to_keep} days.",
-                )
-                return HttpResponseRedirect(
-                    reverse("admin:django_github_app_eventlog_changelist")
+                    "admin/django_github_app/eventlog/cleanup_confirmation.html",
+                    context,
                 )
         else:
             form = EventLogCleanupForm()

src/django_github_app/templates/admin/django_github_app/eventlog/cleanup.html

@@ -19,7 +19,7 @@
         <div class="submit-row">
             <input type="submit"
                    value="{% translate 'Delete Events' %}"
-                   class="default"
+                   class="deletelink"
                    name="_save">
             {% url opts|admin_urlname:'changelist' as changelist_url %}
             <a role="button"

src/django_github_app/templates/admin/django_github_app/eventlog/cleanup_confirmation.html

@@ -0,0 +1,30 @@
+{% extends "admin/delete_confirmation.html" %}
+{% load i18n admin_urls %}
+
+{% block breadcrumbs %}
+<div class="breadcrumbs">
+<a href="{% url 'admin:index' %}">{% translate 'Home' %}</a>
+&rsaquo; <a href="{% url 'admin:app_list' app_label=opts.app_label %}">{{ opts.app_config.verbose_name }}</a>
+&rsaquo; <a href="{% url opts|admin_urlname:'changelist' %}">{{ opts.verbose_name_plural|capfirst }}</a>
+&rsaquo; {% translate 'Clean up Events' %}
+</div>
+{% endblock %}
+
+{% block delete_confirm %}
+<p>{% blocktranslate count counter=delete_count %}You are about to delete {{ counter }} event older than {{ days_to_keep }} days.{% plural %}You are about to delete {{ counter }} events older than {{ days_to_keep }} days.{% endblocktranslate %}</p>
+
+<p>{% blocktranslate %}All events received before {{ cutoff_date }} will be permanently deleted.{% endblocktranslate %}</p>
+
+{% if model_count %}
+    {% include "admin/includes/object_delete_summary.html" %}
+{% endif %}
+
+<form method="post">{% csrf_token %}
+    <div>
+        <input type="hidden" name="post" value="yes">
+        <input type="hidden" name="days_to_keep" value="{{ days_to_keep }}">
+        <input type="submit" value="{% translate "Yes, I'm sure" %}">
+        <a href="#" class="button cancel-link">{% translate "No, take me back" %}</a>
+    </div>
+</form>
+{% endblock %}

tests/test_admin.py

@@ -60,14 +60,30 @@ def test_cleanup_view_get(self, factory, admin_user, eventlog_admin):
         assert b"Clean up Events" in response.content
         assert b"Days to keep events" in response.content
 
+    def test_cleanup_view_post_shows_confirmation(self, client, admin_user, baker):
+        # Create some test events
+        now = timezone.now()
+        baker.make(EventLog, _quantity=3, received_at=now - datetime.timedelta(days=10))
+        baker.make(EventLog, _quantity=2, received_at=now - datetime.timedelta(days=2))
+
+        client.login(username="admin", password="adminpass")
+        response = client.post(
+            reverse("admin:django_github_app_eventlog_cleanup"),
+            {"days_to_keep": "5"},
+        )
+
+        assert response.status_code == 200
+        assert b"You are about to delete 3 events" in response.content
+        assert b"Yes, I" in response.content and b"m sure" in response.content
+
     @patch("django_github_app.models.EventLog.objects.cleanup_events")
-    def test_cleanup_view_post(self, mock_cleanup, client, admin_user):
+    def test_cleanup_view_confirm_deletion(self, mock_cleanup, client, admin_user):
         mock_cleanup.return_value = (5, {"django_github_app.EventLog": 5})
 
         client.login(username="admin", password="adminpass")
         response = client.post(
             reverse("admin:django_github_app_eventlog_cleanup"),
-            {"days_to_keep": "3"},
+            {"post": "yes", "days_to_keep": "3"},
         )
 
         assert response.status_code == 302
@@ -77,7 +93,45 @@ def test_cleanup_view_post(self, mock_cleanup, client, admin_user):
         # Check success message
         messages = list(get_messages(response.wsgi_request))
         assert len(messages) == 1
-        assert "Successfully deleted 5 event(s)" in str(messages[0])
+        assert "Successfully deleted 5 events older than 3 days" in str(messages[0])
+
+    @patch("django_github_app.models.EventLog.objects.cleanup_events")
+    def test_cleanup_view_confirm_deletion_singular_day(
+        self, mock_cleanup, client, admin_user
+    ):
+        mock_cleanup.return_value = (2, {"django_github_app.EventLog": 2})
+
+        client.login(username="admin", password="adminpass")
+        response = client.post(
+            reverse("admin:django_github_app_eventlog_cleanup"),
+            {"post": "yes", "days_to_keep": "1"},
+        )
+
+        assert response.status_code == 302
+
+        # Check success message uses singular "day" and plural "events"
+        messages = list(get_messages(response.wsgi_request))
+        assert len(messages) == 1
+        assert "Successfully deleted 2 events older than 1 day" in str(messages[0])
+
+    @patch("django_github_app.models.EventLog.objects.cleanup_events")
+    def test_cleanup_view_confirm_deletion_zero_events(
+        self, mock_cleanup, client, admin_user
+    ):
+        mock_cleanup.return_value = (0, {})
+
+        client.login(username="admin", password="adminpass")
+        response = client.post(
+            reverse("admin:django_github_app_eventlog_cleanup"),
+            {"post": "yes", "days_to_keep": "7"},
+        )
+
+        assert response.status_code == 302
+
+        # Check success message uses plural "events" for zero
+        messages = list(get_messages(response.wsgi_request))
+        assert len(messages) == 1
+        assert "Successfully deleted 0 events older than 7 days" in str(messages[0])
 
     def test_cleanup_view_integration(self, client, admin_user, baker):
         now = timezone.now()
@@ -102,11 +156,19 @@ def test_cleanup_view_integration(self, client, admin_user, baker):
         response = client.get(reverse("admin:django_github_app_eventlog_cleanup"))
         assert response.status_code == 200
 
-        # Test POST request
+        # Test POST request - Step 1: Show confirmation
         response = client.post(
             reverse("admin:django_github_app_eventlog_cleanup"),
             {"days_to_keep": "5"},
         )
+        assert response.status_code == 200
+        assert b"You are about to delete 1 event" in response.content
+
+        # Test POST request - Step 2: Confirm deletion
+        response = client.post(
+            reverse("admin:django_github_app_eventlog_cleanup"),
+            {"post": "yes", "days_to_keep": "5"},
+        )
         assert response.status_code == 302
 
         # Check that old event was deleted and recent event remains
@@ -116,4 +178,4 @@ def test_cleanup_view_integration(self, client, admin_user, baker):
         # Check success message
         messages = list(get_messages(response.wsgi_request))
         assert len(messages) == 1
-        assert "Successfully deleted 1 event(s)" in str(messages[0])
+        assert "Successfully deleted 1 event older than 5 days" in str(messages[0])