Updated DateTimeUtils to allow for bcss displaying timestamps in UTC (#21)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description

<!-- Describe your changes in detail. -->
Our reports tests verify timestamps and not all of the timestamps in
bcss display the timestamp in DST so several tests are failing. I've
made some changes to the DateTimeUtil to allow us to assert timestamps
in either DST or UTC, depending on the current bcss app settings.

## Context

<!-- Why is this change required? What problem does it solve? -->
This allows the timestamp verification steps to pass, until the issue
has been resolved in the app.

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [x] Refactoring (non-breaking change)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would change existing
functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [x] I am familiar with the [contributing
guidelines](https://github.com/nhs-england-tools/playwright-python-blueprint/blob/main/CONTRIBUTING.md)
- [x] I have followed the code style of the project
- [x] I have added tests to cover my changes (where appropriate)
- [x] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming

---

## Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.

- [x] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.

---------

Co-authored-by: adrianoaru-nhs <[email protected]>
Co-authored-by: victor-soares-ibm <[email protected]>
Co-authored-by: Adriano Aru <[email protected]>
Co-authored-by: mepr1 <[email protected]>

Author: 4 people

pages/reports/reports_page.py

@@ -1,4 +1,5 @@
 from playwright.sync_api import Page
+import pytest
 from pages.base_page import BasePage
 from utils.table_util import TableUtils
 
@@ -10,7 +11,9 @@ def __init__(self, page):
 
         # Initialize TableUtils for different tables
         self.failsafe_reports_sub_links_table = TableUtils(page, "#listReportDataTable")
-        self.fail_safe_reports_screening_subjects_with_inactive_open_episodes_table = TableUtils(page, "#subjInactiveOpenEpisodes")
+        self.fail_safe_reports_screening_subjects_with_inactive_open_episodes_table = (
+            TableUtils(page, "#subjInactiveOpenEpisodes")
+        )
 
         # Reports page main menu links
         self.bureau_reports_link = self.page.get_by_text("Bureau Reports")
@@ -50,17 +53,18 @@ def __init__(self, page):
         )
 
         # Set patients screening centre dropdown locators
+        SCREENING_CENTRE = "Screening Centre"
         self.set_patients_screening_centre_dropdown = self.page.locator(
             "#cboScreeningCentre"
         )
         self.six_weeks_availability_not_set_up_set_patients_screening_centre_dropdown = self.page.get_by_label(
-            "Screening Centre"
+            SCREENING_CENTRE
         )
         self.practitioner_appointments_set_patients_screening_centre_dropdown = (
-            page.get_by_label("Screening Centre")
+            page.get_by_label(SCREENING_CENTRE)
         )
         self.attendance_not_updated_set_patients_screening_centre_dropdown = (
-            page.get_by_label("Screening Centre")
+            page.get_by_label(SCREENING_CENTRE)
         )
 
         # Select screening practitioner dropdown locators
@@ -192,14 +196,20 @@ def click_failsafe_reports_sub_links(self):
         """
         self.failsafe_reports_sub_links_table.click_first_link_in_column("NHS Number")
 
-    def click_fail_safe_reports_screening_subjects_with_inactive_open_episodes_link(self):
+    def click_fail_safe_reports_screening_subjects_with_inactive_open_episodes_link(
+        self,
+    ):
         """
         Clicks the first NHS number link from the primary report table.
         """
-        self.fail_safe_reports_screening_subjects_with_inactive_open_episodes_table.click_first_link_in_column("NHS Number")
+        self.fail_safe_reports_screening_subjects_with_inactive_open_episodes_table.click_first_link_in_column(
+            "NHS Number"
+        )
 
     def click_fail_safe_reports_identify_and_link_new_gp_practices_link(self):
         """
         Clicks the first Practice Code link from the primary report table.
         """
-        self.failsafe_reports_sub_links_table.click_first_link_in_column("Practice Code")
+        self.failsafe_reports_sub_links_table.click_first_link_in_column(
+            "Practice Code"
+        )

tests/test_reports_page.py

@@ -134,7 +134,7 @@ def test_failsafe_reports_screening_subjects_with_inactive_open_episode(
     ReportsPage(page).click_fail_safe_reports_screening_subjects_with_inactive_open_episodes_link()
 
     # Verify the page title is "Subject Screening Summary"
-    BasePage(page).bowel_cancer_screening_ntsh_page_title_contains_text(
+    BasePage(page).bowel_cancer_screening_page_title_contains_text(
         "Subject Screening Summary"
     )
 
@@ -219,7 +219,7 @@ def test_failsafe_reports_allocate_sc_for_patient_movements_within_hub_boundarie
     )
 
     # Select another screening centre
-    (ReportsPage(page).set_patients_screening_centre_dropdown).select_option(
+    ReportsPage(page).set_patients_screening_centre_dropdown.select_option(
         general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
@@ -346,9 +346,7 @@ def test_operational_reports_appointment_attendance_not_updated(
     ReportsPage(
         page
     ).attendance_not_updated_set_patients_screening_centre_dropdown.select_option(
-        ReportsPage(page).general_properties_properties[
-            "coventry_and_warwickshire_bcs_centre"
-        ]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report" button

utils/date_time_utils.py

@@ -1,7 +1,10 @@
-from datetime import datetime, timedelta
+from datetime import datetime, timedelta, tzinfo
+from zoneinfo import ZoneInfo
 
 
 class DateTimeUtils:
+    UTC_TIMEZONE = "UTC"
+    DST_TIMEZONE = "Europe/London"
     """
     A utility class for doing common actions with datetimes.
     """
@@ -69,16 +72,54 @@ def get_a_day_of_week(date: datetime) -> str:
         return date.strftime("%A")
 
     @staticmethod
-    def report_timestamp_date_format() -> str:
-        """Gets the current datetime in the timestamp format used on the report pages."""
-        return DateTimeUtils.format_date(datetime.now(), "%d/%m/%Y at %H:%M:%S")
+    def report_timestamp_date_format(use_utc: bool = True) -> str:
+        """Gets the current datetime in the timestamp format used on the report pages.
+        Based on the value of `use_utc`, it chooses the appropriate timezone.
+        """
+
+        if use_utc:
+            return DateTimeUtils.format_date(
+                datetime.now(ZoneInfo(DateTimeUtils.UTC_TIMEZONE)),
+                "%d/%m/%Y at %H:%M:%S",
+            )
+        else:
+            return DateTimeUtils.format_date(
+                datetime.now(ZoneInfo(DateTimeUtils.DST_TIMEZONE)),
+                "%d/%m/%Y at %H:%M:%S",
+            )
 
     @staticmethod
-    def fobt_kits_logged_but_not_read_report_timestamp_date_format() -> str:
-        """Gets the current datetime in the format used for FOBT Kits Logged but Not Read report."""
-        return DateTimeUtils.format_date(datetime.now(), "%d %b %Y %H:%M:%S")
+    def fobt_kits_logged_but_not_read_report_timestamp_date_format(
+        use_utc: bool = False,
+    ) -> str:
+        """Gets the current datetime in the format used for FOBT Kits Logged but Not Read report.
+        Based on the value of `use_utc`, it chooses the appropriate timezone.
+        """
+
+        if use_utc:
+            return DateTimeUtils.format_date(
+                datetime.now(ZoneInfo(DateTimeUtils.UTC_TIMEZONE)), "%d %b %Y %H:%M:%S"
+            )
+        else:
+            return DateTimeUtils.format_date(
+                datetime.now(ZoneInfo(DateTimeUtils.DST_TIMEZONE)), "%d %b %Y %H:%M:%S"
+            )
 
     @staticmethod
-    def screening_practitioner_appointments_report_timestamp_date_format() -> str:
-        """Gets the current datetime in the format used for Screening Practitioner Appointments report."""
-        return DateTimeUtils.format_date(datetime.now(), "%d.%m.%Y at %H:%M:%S")
+    def screening_practitioner_appointments_report_timestamp_date_format(
+        use_utc: bool = True,
+    ) -> str:
+        """Gets the current datetime in the format used for Screening Practitioner Appointments report.
+        Based on the value of `use_utc`, it chooses the appropriate timezone.
+        """
+
+        if use_utc:
+            return DateTimeUtils.format_date(
+                datetime.now(ZoneInfo(DateTimeUtils.UTC_TIMEZONE)),
+                "%d.%m.%Y at %H:%M:%S",
+            )
+        else:
+            return DateTimeUtils.format_date(
+                datetime.now(ZoneInfo(DateTimeUtils.DST_TIMEZONE)),
+                "%d.%m.%Y at %H:%M:%S",
+            )