Ensure form errors are rendered in a logical order

If multiple fields have errors, we should render them in the order
the fields appear on the page. Non-field errors should display
last.

Previously we were relying on `form.errors` to decide the order,
which means that errors were displayed in the order they happened
to be added in.

Author: MatMoore

manage_breast_screening/record_a_mammogram/forms.py

@@ -68,6 +68,12 @@ def __init__(self, *args, **kwargs):
         for field_name, _ in self.STOPPED_REASON_CHOICES:
             self.fields[f"{field_name}_details"] = forms.CharField(required=False)
 
+        # Ensure that the field order matches the order we want to render in
+        details_fields = [
+            f"{field_name}_details" for field_name, _ in self.STOPPED_REASON_CHOICES
+        ]
+        self.order_fields(["stopped_reasons"] + details_fields + ["decision"])
+
     stopped_reasons = forms.MultipleChoiceField(
         choices=STOPPED_REASON_CHOICES,
         required=True,

manage_breast_screening/templates/wizard_step.jinja

@@ -17,8 +17,11 @@
     {% if form.errors %}
       {% set ns = namespace(errors=[]) %}
 
-      {% for field, messages in form.errors | items %}
-        {% set ns.errors = ns.errors + [{"text": ",".join(messages), "href": "#" ~ messages.field_id}] %}
+      {% for field in form %}
+        {% set ns.errors = ns.errors + [{"text": ",".join(field.errors), "href": "#" ~ field.auto_id}] %}
+      {% endfor %}
+      {% for error_list in form.non_field_errors() %}
+        {% set ns.errors = ns.errors + [{"text": ",".join(error_list)}] %}
       {% endfor %}
 
       {{ errorSummary({