Merge pull request #1107 from alphagov/2081-ehrc-csv

2081: Add Export to equality body CSV for detailed cases

Author: ahernp

accessibility_monitoring_platform/apps/cases/forms.py

@@ -1,7 +1,5 @@
 """Forms - cases"""
 
-import re
-
 import requests
 from django import forms
 from django.contrib.auth.models import User
@@ -15,6 +13,7 @@
     BaseCase,
     Complaint,
     Sort,
+    extract_id_from_case_url,
 )
 from ..common.forms import (
     AMPCharFieldWide,
@@ -119,18 +118,19 @@ def clean_previous_case_url(self):
         if requests.head(previous_case_url, timeout=10).status_code >= 400:
             raise ValidationError("Previous case URL does not exist")
 
-        # Extract case id from view case URL
         try:
-            case_id: str = re.search(".*/(simplified|detailed)/(.+?)/(view|case-detail)/?", previous_case_url).group(  # type: ignore
-                2
-            )
+            case_id: int | None = extract_id_from_case_url(case_url=previous_case_url)
         except AttributeError:
             raise ValidationError(  # pylint: disable=raise-missing-from
                 "Previous case URL did not contain case id"
             )
+        if case_id is None:
+            raise ValidationError(  # pylint: disable=raise-missing-from
+                "Previous case URL did not contain case id"
+            )
 
         # Check if Case exists matching id from URL
-        if case_id.isdigit() and BaseCase.objects.filter(id=case_id).exists():
+        if case_id and BaseCase.objects.filter(id=case_id).exists():
             return previous_case_url
         else:
             raise ValidationError("Previous case not found in platform")

accessibility_monitoring_platform/apps/cases/models.py

@@ -2,6 +2,7 @@
 Models - cases
 """
 
+import re
 from dataclasses import dataclass
 from datetime import datetime
 
@@ -30,6 +31,25 @@
 UPDATE_SEPARATOR: str = " -> "
 
 
+def extract_id_from_case_url(case_url: str) -> int | None:
+    """Extract case id from case overview URL"""
+    regex_search_result = re.search(
+        ".*/(simplified|detailed)/(.+?)/(view|case-detail)/?", case_url
+    )
+    if regex_search_result is not None:
+        case_id: str = regex_search_result.group(2)
+        if case_id.isdigit():
+            return int(case_id)
+
+
+def get_previous_case_identifier(previous_case_url: str) -> str | None:
+    """Build case identifier from URL"""
+    case_id: int | None = extract_id_from_case_url(case_url=previous_case_url)
+    if case_id:
+        base_case: BaseCase = BaseCase.objects.get(id=case_id)
+        return base_case.case_identifier
+
+
 class DisablePyTestCollectionMixin(object):
     __test__ = False
 

accessibility_monitoring_platform/apps/cases/templates/cases/basecase_list.html

@@ -110,6 +110,14 @@ <h2 id="id_header_3" class="govuk-heading-m">Detailed</h2>
                                     Create detailed case
                                 </a>
                             </li>
+                            <li>
+                                <a
+                                    href="{% url 'detailed:case-export-list' %}{% if url_parameters %}?{{ url_parameters }}{% endif %}"
+                                    class="govuk-link govuk-link--no-visited-state"
+                                >
+                                    Export to CSV
+                                </a>
+                            </li>
                             <li>
                                 <a
                                     href="{% url 'detailed:export-feedback-survey-cases' %}{% if url_parameters %}?{{ url_parameters }}{% endif %}"
@@ -120,10 +128,10 @@ <h2 id="id_header_3" class="govuk-heading-m">Detailed</h2>
                             </li>
                             <li>
                                 <a
-                                    href="{% url 'detailed:case-export-list' %}{% if url_parameters %}?{{ url_parameters }}{% endif %}"
+                                    href="{% url 'detailed:export-equality-body-cases' %}{% if url_parameters %}?{{ url_parameters }}{% endif %}"
                                     class="govuk-link govuk-link--no-visited-state"
                                 >
-                                    Export to CSV
+                                    Export to equality body CSV
                                 </a>
                             </li>
                         </ul>

accessibility_monitoring_platform/apps/cases/tests/test_models.py

@@ -22,6 +22,8 @@
     MobileCaseStatus,
     SimplifiedCaseStatus,
     TestType,
+    extract_id_from_case_url,
+    get_previous_case_identifier,
 )
 
 REMINDER_DUE_DATE: date = date(2022, 1, 1)
@@ -289,3 +291,38 @@ def test_case_get_case():
     simplified_case: SimplifiedCase = SimplifiedCase.objects.create()
 
     assert isinstance(simplified_case.get_case(), SimplifiedCase) is True
+
+
+@pytest.mark.parametrize(
+    "case_url, case_id",
+    [
+        ("https://...gov.uk/simplified/1/view/", 1),
+        ("https://...gov.uk/detailed/2/case-detail/", 2),
+        ("", None),
+        ("https://...gov.uk/audit/191/view/", None),
+    ],
+)
+def test_extract_id_from_case_url(case_url, case_id):
+    """Test extracting case id from case overview URL"""
+
+    assert extract_id_from_case_url(case_url) == case_id
+
+
+@pytest.mark.parametrize(
+    "previous_case_url, previous_case_identifier",
+    [
+        ("https://...gov.uk/simplified/1/view/", "#S-1"),
+        ("https://...gov.uk/detailed/1/case-detail/", "#D-1"),
+        ("", None),
+        ("https://...gov.uk/audit/191/view/", None),
+    ],
+)
+@pytest.mark.django_db
+def test_previous_case_identifier(previous_case_url, previous_case_identifier):
+    """Test previous case identifier derived from url"""
+    if "detailed" in previous_case_url:
+        DetailedCase.objects.create()
+    else:
+        SimplifiedCase.objects.create()
+
+    assert get_previous_case_identifier(previous_case_url) == previous_case_identifier

accessibility_monitoring_platform/apps/detailed/csv_export.py

@@ -4,6 +4,159 @@
 from ..detailed.models import Contact as DetailedContact
 from ..detailed.models import DetailedCase
 
+DETAILED_EQUALITY_BODY_COLUMNS_FOR_EXPORT: list[CSVColumn] = [
+    CSVColumn(
+        column_header="Enforcement Body",
+        source_class=DetailedCase,
+        source_attr="enforcement_body",
+    ),
+    CSVColumn(
+        column_header="Test type",
+        source_class=DetailedCase,
+        source_attr="test_type",
+    ),
+    CSVColumn(
+        column_header="Case number",
+        source_class=DetailedCase,
+        source_attr="case_number",
+    ),
+    CSVColumn(
+        column_header="Organisation",
+        source_class=DetailedCase,
+        source_attr="organisation_name",
+    ),
+    CSVColumn(
+        column_header="Website URL",
+        source_class=DetailedCase,
+        source_attr="home_page_url",
+    ),
+    CSVColumn(
+        column_header="Parent organisation name",
+        source_class=DetailedCase,
+        source_attr="parental_organisation_name",
+    ),
+    CSVColumn(
+        column_header="Sub-category",
+        source_class=DetailedCase,
+        source_attr="subcategory",
+    ),
+    CSVColumn(
+        column_header="Website name",
+        source_class=DetailedCase,
+        source_attr="website_name",
+    ),
+    CSVColumn(
+        column_header="Previous Case Number",
+        source_class=DetailedCase,
+        source_attr="previous_case_identifier",
+    ),
+    CSVColumn(
+        column_header="Is it a complaint?",
+        source_class=DetailedCase,
+        source_attr="is_complaint",
+    ),
+    CSVColumn(
+        column_header="Published report",
+        source_class=DetailedCase,
+        source_attr="equality_body_report_url",
+    ),
+    CSVColumn(
+        column_header="Enforcement recommendation",
+        source_class=DetailedCase,
+        source_attr="recommendation_for_enforcement",
+    ),
+    CSVColumn(
+        column_header="Enforcement recommendation notes including exemptions",
+        source_class=DetailedCase,
+        source_attr="recommendation_info",
+    ),
+    CSVColumn(
+        column_header="Summary of progress made / response from PSB",
+        source_class=DetailedCase,
+        source_attr="psb_progress_info",
+    ),
+    CSVColumn(
+        column_header="Contact details",
+        source_class=DetailedCase,
+        source_attr="equality_body_export_contact_details",
+    ),
+    CSVColumn(
+        column_header="Organisation responded to report?",
+        source_class=DetailedCase,
+        source_attr="report_acknowledged_yes_no",
+    ),
+    CSVColumn(
+        column_header="Report sent on",
+        source_class=DetailedCase,
+        source_attr="report_sent_date",
+    ),
+    CSVColumn(
+        column_header="Report acknowledged",
+        source_class=DetailedCase,
+        source_attr="report_acknowledged_date",
+    ),
+    CSVColumn(
+        column_header="12-week deadline",
+        source_class=DetailedCase,
+        source_attr="twelve_week_deadline_date",
+    ),
+    CSVColumn(
+        column_header="Retest date",
+        source_class=DetailedCase,
+        source_attr="retest_start_date",
+    ),
+    CSVColumn(
+        column_header="Date when compliance decision email sent to public sector body",
+        source_class=DetailedCase,
+        source_attr="recommendation_decision_sent_date",
+    ),
+    CSVColumn(
+        column_header="Compliance decision email sent to",
+        source_class=DetailedCase,
+        source_attr="recommendation_decision_sent_to",
+    ),
+    CSVColumn(
+        column_header="Total number of accessibility issues",
+        source_class=DetailedCase,
+        source_attr="initial_total_number_of_issues",
+    ),
+    CSVColumn(
+        column_header="Number of issues fixed",
+        source_class=DetailedCase,
+        source_attr="number_of_issues_fixed",
+    ),
+    CSVColumn(
+        column_header="Number of issues unfixed",
+        source_class=DetailedCase,
+        source_attr="retest_total_number_of_issues",
+    ),
+    CSVColumn(
+        column_header="Issues fixed as a percentage",
+        source_class=DetailedCase,
+        source_attr="percentage_of_issues_fixed",
+    ),
+    CSVColumn(
+        column_header="Was an accessibility statement found during the 12-week assessment",
+        source_class=DetailedCase,
+        source_attr="equality_body_export_statement_found_at_retest",
+    ),
+    CSVColumn(
+        column_header="Retest Accessibility Statement Decision",
+        source_class=DetailedCase,
+        source_attr="retest_statement_compliance_state",
+    ),
+    CSVColumn(
+        column_header="Retest disproportionate burden claimed?",
+        source_class=DetailedCase,
+        source_attr="retest_disproportionate_burden_claim",
+    ),
+    CSVColumn(
+        column_header="Retest disproportionate burden details",
+        source_class=DetailedCase,
+        source_attr="retest_disproportionate_burden_information",
+    ),
+]
+
 DETAILED_CASE_COLUMNS_FOR_EXPORT: list[CSVColumn] = [
     # General
     CSVColumn(

accessibility_monitoring_platform/apps/detailed/models.py

@@ -12,7 +12,12 @@
 from django.urls import reverse
 from django.utils.safestring import mark_safe
 
-from ..cases.models import UPDATE_SEPARATOR, BaseCase, DetailedCaseStatus
+from ..cases.models import (
+    UPDATE_SEPARATOR,
+    BaseCase,
+    DetailedCaseStatus,
+    get_previous_case_identifier,
+)
 from ..common.models import Boolean, VersionModel
 from ..common.utils import extract_domain_from_url
 
@@ -274,6 +279,57 @@ def contacts(self) -> QuerySet["Contact"]:
     def preferred_contacts(self) -> QuerySet["Contact"]:
         return self.contacts.filter(preferred=Contact.Preferred.YES)
 
+    @property
+    def previous_case_identifier(self) -> str:
+        return get_previous_case_identifier(previous_case_url=self.previous_case_url)
+
+    @property
+    def equality_body_export_contact_details(self) -> str:
+        contacts_string: str = ""
+        for contact in self.contacts:
+            if contacts_string:
+                contacts_string += "\n"
+            if contact.name:
+                contacts_string += f"{contact.name}\n"
+            if contact.job_title:
+                contacts_string += f"{contact.job_title}\n"
+            if contact.contact_details:
+                contacts_string += f"{contact.contact_details}\n"
+            if contact.information:
+                contacts_string += f"{contact.information}\n"
+        return contacts_string
+
+    @property
+    def report_acknowledged_yes_no(self) -> str:
+        return (
+            "Yes"
+            if self.report_acknowledged_date and self.no_psb_contact == Boolean.NO
+            else "No"
+        )
+
+    @property
+    def number_of_issues_fixed(self) -> int | None:
+        if self.initial_total_number_of_issues and self.retest_total_number_of_issues:
+            return (
+                self.initial_total_number_of_issues - self.retest_total_number_of_issues
+            )
+
+    @property
+    def percentage_of_issues_fixed(self) -> int | None:
+        if self.initial_total_number_of_issues and self.number_of_issues_fixed:
+            return int(
+                self.number_of_issues_fixed * 100 / self.initial_total_number_of_issues
+            )
+
+    @property
+    def equality_body_export_statement_found_at_retest(self) -> str:
+        if self.retest_statement_compliance_state in [
+            DetailedCase.StatementCompliance.COMPLIANT,
+            DetailedCase.StatementCompliance.NOT_COMPLIANT,
+        ]:
+            return "Yes"
+        return "No"
+
 
 class DetailedEventHistory(models.Model):
     """Model to record events on platform"""

accessibility_monitoring_platform/apps/detailed/tests/test_forms.py

@@ -35,7 +35,7 @@
         (
             "https://platform.gov.uk/detailed/not-an-id/case-detail",
             200,
-            "Previous case not found in platform",
+            "Previous case URL did not contain case id",
         ),
     ],
 )