Merge pull request #767 from NHSDigital/refactor-reports-tests

Refactor reconciliation query test

Author: steventux

manage_breast_screening/notifications/tests/queries/test_reconciliation_query.py

@@ -1,3 +1,4 @@
+import re
 from collections import namedtuple
 from datetime import datetime, timedelta
 
@@ -13,48 +14,6 @@
     MessageFactory,
 )
 
-
-def formatted(dt: datetime):
-    return dt.strftime("%Y-%m-%d %H:%M")
-
-
-def days_time(days: int):
-    return datetime.now(tz=ZONE_INFO) + timedelta(days=days)
-
-
-def create_appointment_set(
-    nhs_number: str,
-    date: datetime,
-    clinic: Clinic,
-    appointment_status: str,
-    episode_type: str,
-    message_status: str | None = None,
-    channel_statuses: dict[str, str] | None = None,
-):
-    now = datetime.now(tz=ZONE_INFO)
-    appt = AppointmentFactory(
-        clinic=clinic,
-        status=appointment_status,
-        episode_type=episode_type,
-        nhs_number=nhs_number,
-        starts_at=date,
-    )
-    if appointment_status == "C":
-        appt.cancelled_at = now
-        appt.save()
-
-    if message_status:
-        message = MessageFactory(appointment=appt, status=message_status, sent_at=now)
-        for channel, status in channel_statuses.items():
-            ChannelStatusFactory(
-                message=message,
-                channel=channel,
-                status=status,
-                status_updated_at=now,
-            )
-    return appt
-
-
 ResultRow = namedtuple(
     "ResultRow",
     [
@@ -95,118 +54,173 @@ def setup(self):
         }
 
         test_data = [
-            ["9991112211", days_time(4), clinic1, "B", "R"],
-            ["9991112214", days_time(6), clinic2, "C", "G"],
-            ["9991112221", days_time(5), clinic2, "B", "R", "failed", failed],
-            ["9991112222", days_time(6), clinic1, "B", "S", "delivered", nhsapp_read],
-            ["9991112223", days_time(5), clinic2, "B", "S", "delivered", sms_delivered],
-            ["9991112229", days_time(5), clinic1, "B", "R", "delivered", letter_sent],
-            ["9991112252", days_time(6), clinic2, "C", "S", "delivered", nhsapp_read],
+            ["9991112211", clinic1, "B", "R"],
+            ["9991112214", clinic2, "C", "G"],
+            ["9991112221", clinic2, "B", "R", "failed", failed],
+            ["9991112222", clinic1, "B", "S", "delivered", nhsapp_read],
+            ["9991112223", clinic2, "B", "S", "delivered", sms_delivered],
+            ["9991112229", clinic1, "B", "R", "delivered", letter_sent],
+            ["9991112252", clinic2, "C", "S", "delivered", nhsapp_read],
         ]
 
         for d in test_data:
-            create_appointment_set(*d)
+            self.create_appointment_set(*d)
 
-    @time_machine.travel(datetime.now(tz=ZONE_INFO), tick=False)
+    @time_machine.travel(datetime.now(tz=ZONE_INFO))
     def test_appointments_with_various_delivery_states(self):
-        now = datetime.now(tz=ZONE_INFO)
+        def formatted(dt: datetime):
+            return dt.strftime("%Y-%m-%d %H:%M")
+
         results = Helper.fetchall("reconciliation", ["1 week", "BSO1"])
 
-        r = ResultRow(*results[0])
+        date_pattern = r"^\d{4}\-\d{2}\-\d{2} \d{2}:\d{2}$"
+        sorted_results = sorted(results, key=lambda res: res[0])
+
+        r = ResultRow(*sorted_results[0])
         assert r.nhs_number == "9991112211"
         assert r.clinic == "BSU 1 (BU001)"
         assert r.episode_type == "Routine recall"
         assert r.status == "Booked"
         assert r.message_status == "Pending"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(4))
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
         assert r.cancelled_at is None
         assert r.message_sent_at is None
         assert r.nhs_app_read_at is None
         assert r.sms_delivered_at is None
         assert r.letter_sent_at is None
 
-        r = ResultRow(*results[1])
+        r = ResultRow(*sorted_results[1])
         assert r.nhs_number == "9991112214"
         assert r.clinic == "BSU 2 (BU002)"
         assert r.episode_type == "GP Referral"
         assert r.status == "Cancelled"
         assert r.message_status == "Pending"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(6))
-        assert r.cancelled_at == formatted(now)
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.cancelled_at), (
+            f"{r.cancelled_at} does not match {date_pattern}"
+        )
         assert r.message_sent_at is None
         assert r.nhs_app_read_at is None
         assert r.sms_delivered_at is None
         assert r.letter_sent_at is None
 
-        r = ResultRow(*results[2])
+        r = ResultRow(*sorted_results[2])
         assert r.nhs_number == "9991112221"
         assert r.clinic == "BSU 2 (BU002)"
         assert r.episode_type == "Routine recall"
         assert r.status == "Booked"
         assert r.message_status == "Failed"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(5))
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
         assert r.cancelled_at is None
-        assert r.message_sent_at == formatted(now)
+        assert re.search(date_pattern, r.message_sent_at), (
+            f"{r.message_sent_at} does not match {date_pattern}"
+        )
         assert r.nhs_app_read_at is None
         assert r.sms_delivered_at is None
         assert r.letter_sent_at is None
 
-        r = ResultRow(*results[3])
+        r = ResultRow(*sorted_results[3])
         assert r.nhs_number == "9991112222"
         assert r.clinic == "BSU 1 (BU001)"
         assert r.episode_type == "Self referral"
         assert r.status == "Booked"
         assert r.message_status == "Notified"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(6))
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
         assert r.cancelled_at is None
-        assert r.message_sent_at == formatted(now)
-        assert r.nhs_app_read_at == formatted(now)
+        assert re.search(date_pattern, r.message_sent_at), (
+            f"{r.message_sent_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.nhs_app_read_at), (
+            f"{r.nhs_app_read_at} does not match {date_pattern}"
+        )
         assert r.sms_delivered_at is None
         assert r.letter_sent_at is None
 
-        r = ResultRow(*results[4])
+        r = ResultRow(*sorted_results[4])
         assert r.nhs_number == "9991112223"
         assert r.clinic == "BSU 2 (BU002)"
         assert r.episode_type == "Self referral"
         assert r.status == "Booked"
         assert r.message_status == "Notified"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(5))
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
         assert r.cancelled_at is None
-        assert r.message_sent_at == formatted(now)
+        assert re.search(date_pattern, r.message_sent_at), (
+            f"{r.message_sent_at} does not match {date_pattern}"
+        )
         assert r.nhs_app_read_at is None
-        assert r.sms_delivered_at == formatted(now)
+        assert re.search(date_pattern, r.sms_delivered_at), (
+            f"{r.sms_delivered_at} does not match {date_pattern}"
+        )
         assert r.letter_sent_at is None
 
-        r = ResultRow(*results[5])
+        r = ResultRow(*sorted_results[5])
         assert r.nhs_number == "9991112229"
         assert r.clinic == "BSU 1 (BU001)"
         assert r.episode_type == "Routine recall"
         assert r.status == "Booked"
         assert r.message_status == "Notified"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(5))
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
         assert r.cancelled_at is None
-        assert r.message_sent_at == formatted(now)
+        assert re.search(date_pattern, r.message_sent_at), (
+            f"{r.message_sent_at} does not match {date_pattern}"
+        )
         assert r.nhs_app_read_at is None
         assert r.sms_delivered_at is None
-        assert r.letter_sent_at == formatted(now)
+        assert re.search(date_pattern, r.letter_sent_at), (
+            f"{r.letter_sent_at} does not match {date_pattern}"
+        )
 
-        r = ResultRow(*results[6])
+        r = ResultRow(*sorted_results[6])
         assert r.nhs_number == "9991112252"
         assert r.clinic == "BSU 2 (BU002)"
         assert r.episode_type == "Self referral"
         assert r.status == "Cancelled"
         assert r.message_status == "Notified"
-        assert r.created_at == formatted(now)
-        assert r.appointment_starts_at == formatted(days_time(6))
-        assert r.cancelled_at == formatted(now)
-        assert r.message_sent_at == formatted(now)
-        assert r.nhs_app_read_at == formatted(now)
+        assert re.search(date_pattern, r.created_at), (
+            f"{r.created_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.appointment_starts_at), (
+            f"{r.appointment_starts_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.cancelled_at), (
+            f"{r.cancelled_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.message_sent_at), (
+            f"{r.message_sent_at} does not match {date_pattern}"
+        )
+        assert re.search(date_pattern, r.nhs_app_read_at), (
+            f"{r.nhs_app_read_at} does not match {date_pattern}"
+        )
         assert r.sms_delivered_at is None
         assert r.letter_sent_at is None
 
@@ -219,3 +233,35 @@ def test_appointments_filtered_for_specified_bso(self):
         results = Helper.fetchall("reconciliation", ["1 week", "MDB"])
         assert len(results) == 2
         assert ResultRow(*results[0]).clinic == "Breast Care Unit (BU001)"
+
+    def create_appointment_set(
+        self,
+        nhs_number: str,
+        clinic: Clinic,
+        appointment_status: str,
+        episode_type: str,
+        message_status: str | None = None,
+        channel_statuses: dict[str, str] | None = None,
+    ):
+        now = datetime.now(tz=ZONE_INFO)
+        appt = AppointmentFactory(
+            clinic=clinic,
+            status=appointment_status,
+            episode_type=episode_type,
+            nhs_number=nhs_number,
+            starts_at=now + timedelta(days=21),
+            cancelled_at=(now if appointment_status == "C" else None),
+        )
+
+        if message_status:
+            message = MessageFactory(
+                appointment=appt, status=message_status, sent_at=now
+            )
+            for channel, status in channel_statuses.items():
+                ChannelStatusFactory(
+                    message=message,
+                    channel=channel,
+                    status=status,
+                    status_updated_at=now,
+                )
+        return appt