Changed issues to alerts, added docstring to check_invalid_... function, changed call in nav_subtitle to get_stats

Author: bkdekoning

debug_toolbar/panels/alerts.py

@@ -51,20 +51,26 @@ class AlertsPanel(Panel):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.issues = []
+        self.alerts = []
 
     @property
     def nav_subtitle(self):
-        if self.issues:
-            issue_text = "issue" if len(self.issues) == 1 else "issues"
-            return f"{len(self.issues)} {issue_text} found"
+        alerts = self.get_stats()["alerts"]
+        if alerts:
+            alert_text = "alert" if len(alerts) == 1 else "alerts"
+            return f"{len(alerts)} {alert_text}"
         else:
             return ""
 
-    def add_issue(self, issue):
-        self.issues.append(issue)
+    def add_alert(self, alert):
+        self.alerts.append(alert)
 
     def check_invalid_file_form_configuration(self, html_content):
+        """
+        Inspects HTML content for a form that includes a file input but does
+        not have the encoding type set to multipart/form-data, and warns the
+        user if so.
+        """
         parser = FormParser()
         parser.feed(html_content)
 
@@ -78,18 +84,18 @@ def check_invalid_file_form_configuration(self, html_content):
                 )
             ):
                 form_id = form["form_attrs"].get("id", "no form id")
-                issue = (
+                alert = (
                     f'Form with id "{form_id}" contains file input but '
                     "does not have multipart/form-data encoding."
                 )
-                self.add_issue({"issue": issue})
-        return self.issues
+                self.add_alert({"alert": alert})
+        return self.alerts
 
     def generate_stats(self, request, response):
         html_content = response.content.decode(response.charset)
         self.check_invalid_file_form_configuration(html_content)
 
-        # Further issue checks can go here
+        # Further alert checks can go here
 
-        # Write all issues to record_stats
-        self.record_stats({"issues": self.issues})
+        # Write all alerts to record_stats
+        self.record_stats({"alerts": self.alerts})

debug_toolbar/templates/debug_toolbar/panels/alerts.html

@@ -1,12 +1,12 @@
 {% load i18n %}
 
-{% if issues %}
-  <h4>{% trans "Issues found" %}</h4>
-  {% for issue in issues %}
+{% if alerts %}
+  <h4>{% trans "alerts found" %}</h4>
+  {% for alert in alerts %}
     <ul>
-      <li>{{ issue.issue }}</li>
+      <li>{{ alert.alert }}</li>
     </ul>
   {% endfor %}
 {% else %}
-  <p>No issues found.</p>
+  <p>No alerts found.</p>
 {% endif %}

example/templates/index.html

@@ -23,6 +23,13 @@ <h1>Index of Tests</h1>
       <button id="incrementFetch" data-url="{% url 'ajax_increment' %}" type="button">Increment via fetch</button>
       <button id="incrementXHR" data-url="{% url 'ajax_increment' %}" type="button">Increment via XHR</button>
     </p>
+    <form id="hi1" action="/submit1" method="get">
+      <form id="hi2" action="/submit2" method="get">
+        <input type="text" name="test_input">
+        <input type="submit" value="Submit">
+      </form>
+  </form>
+  <input type = "file" form = "hi1">
   <script>
     const incrementFetch = document.querySelector("#incrementFetch");
     const incrementXHR = document.querySelector("#incrementXHR");

tests/panels/test_alerts.py

@@ -7,18 +7,16 @@
 class AlertsPanelTestCase(BaseTestCase):
     panel_id = "AlertsPanel"
 
-    def test_issue_warning_display(self):
+    def test_alert_warning_display(self):
         """
-        Test that the panel (does not) display[s] a warning when there are
-        (no) issues.
+        Test that the panel (does not) display[s] an alert when there are
+        (no) problems.
         """
-        self.panel.issues = 0
-        nav_subtitle = self.panel.nav_subtitle
-        self.assertNotIn("issues found", nav_subtitle)
+        self.panel.record_stats({"alerts": []})
+        self.assertNotIn("alerts", self.panel.nav_subtitle)
 
-        self.panel.issues = ["Issue 1", "Issue 2"]
-        nav_subtitle = self.panel.nav_subtitle
-        self.assertIn("2 issues found", nav_subtitle)
+        self.panel.record_stats({"alerts": ["Alert 1", "Alert 2"]})
+        self.assertIn("2 alerts", self.panel.nav_subtitle)
 
     def test_file_form_without_enctype_multipart_form_data(self):
         """
@@ -31,7 +29,7 @@ def test_file_form_without_enctype_multipart_form_data(self):
             'Form with id "test-form" contains file input '
             "but does not have multipart/form-data encoding."
         )
-        self.assertEqual(result[0]["issue"], expected_error)
+        self.assertEqual(result[0]["alert"], expected_error)
         self.assertEqual(len(result), 1)
 
     def test_file_form_with_enctype_multipart_form_data(self):
@@ -50,6 +48,7 @@ def test_integration_file_form_without_enctype_multipart_form_data(self):
 
         self.panel.generate_stats(self.request, response)
 
+        self.assertIn("1 alert", self.panel.nav_subtitle)
         self.assertIn(
             "Form with id "test-form" contains file input "
             "but does not have multipart/form-data encoding.",