Merge branch 'feature/BCSS-20580-selenium-to-playwright-non-invitation-days' into feature/BCSS-20580-selenium-to-playwright-generate_fobt_invitations

to resolve merge conflicts

Author: Andyg79

tests_utils/test_date_time_utils.py

@@ -32,31 +32,26 @@ def test_add_days():
     assert new_date == date + timedelta(days=5)
 
 
-def test_get_day_of_week_for_today():
+# Valid weekdays for testing get_day_of_week
+VALID_WEEKDAYS = [
+    "Monday",
+    "Tuesday",
+    "Wednesday",
+    "Thursday",
+    "Friday",
+    "Saturday",
+    "Sunday",
+]
+
+
+def test_get_day_of_week_with_specific_date():
     dtu = utils.date_time_utils.DateTimeUtils()
-    date = datetime.now()
-    day_of_week = dtu.get_a_day_of_week(date)
-    assert day_of_week in [
-        "Monday",
-        "Tuesday",
-        "Wednesday",
-        "Thursday",
-        "Friday",
-        "Saturday",
-        "Sunday",
-    ]
-
-
-def test_get_a_day_of_week():
+    date = datetime(2023, 11, 8)  # Known Wednesday
+    day_of_week = dtu.get_day_of_week(date)
+    assert day_of_week in VALID_WEEKDAYS
+
+
+def test_get_day_of_week_with_default_today():
     dtu = utils.date_time_utils.DateTimeUtils()
-    date = datetime(2023, 11, 8)
-    day_of_week = dtu.get_a_day_of_week(date)
-    assert day_of_week in [
-        "Monday",
-        "Tuesday",
-        "Wednesday",
-        "Thursday",
-        "Friday",
-        "Saturday",
-        "Sunday",
-    ]
+    day_of_week = dtu.get_day_of_week()
+    assert day_of_week in VALID_WEEKDAYS

utils/date_time_utils.py

@@ -1,4 +1,5 @@
 from datetime import datetime, timedelta
+from typing import Optional
 import random
 
 
@@ -46,27 +47,18 @@ def add_days(date: datetime, days: float) -> datetime:
         return date + timedelta(days=days)
 
     @staticmethod
-    def get_day_of_week_for_today(date: datetime) -> str:
-        """Gets the day of the week (e.g., Monday, Tuesday) from the specified date.
-
-        Args:
-            date (datetime): The current date using the now function
-
-        Returns:
-            str: The day of the week relating to the specified date.
+    def get_day_of_week(date: Optional[datetime] = None) -> str:
         """
-        return date.strftime("%A")
-
-    @staticmethod
-    def get_a_day_of_week(date: datetime) -> str:
-        """Gets the day of the week (e.g., Monday, Tuesday) from the specified date.
+        Returns the day of the week (e.g., Monday, Tuesday) for the given date.
+        If no date is provided, uses today’s date.
 
         Args:
-            date (datetime): The date for which the day of the week will be returned.
+            date (Optional[datetime]): The date to inspect. Defaults to now.
 
         Returns:
-            str: The day of the week relating to the specified date.
+            str: Day of week corresponding to the date.
         """
+        date = date or datetime.now()
         return date.strftime("%A")
 
     @staticmethod
@@ -99,7 +91,8 @@ def screening_practitioner_appointments_report_timestamp_date_format() -> str:
 
         return DateTimeUtils.format_date(datetime.now(), "%d.%m.%Y at %H:%M:%S")
 
-    def month_string_to_number(self, string: str) -> int:
+    @staticmethod
+    def month_string_to_number(string: str) -> int:
         """
         This is used to convert a month from a string to an integer.
         It accepts the full month or the short version and is not case sensitive
@@ -124,22 +117,17 @@ def month_string_to_number(self, string: str) -> int:
             out = months[month_short]
             return out
         except Exception:
-            raise ValueError("Not a month")
+            raise ValueError(
+                f"'{string}' is not a valid month name. Accepted values are: {', '.join(months.keys())}"
+            )
 
-    def generate_unique_weekday_date(self, start_year: int = 2025) -> str:
+    @staticmethod
+    def generate_unique_weekday_date(start_year: int = 2025) -> str:
         """
-        Generates a future weekday date from the specified year onward.
-
-        This function returns a dynamically generated date string in the format 'dd/mm/yyyy'
-        that always falls on a weekday (Monday–Friday) and is suitable for use in automated tests
-        where the date must differ on each run to avoid duplication issues.
-
-        A small pseudorandom offset is added to ensure uniqueness between runs.
+        Returns a random future weekday (Mon–Fri) date from the given year onward.
 
-        Note:
-            This function uses Python's built-in `random` module to add variability.
-            Since this is for test-only purposes and does not involve security-sensitive logic,
-            the use of a non-cryptographic PRNG is appropriate and intentional.
+        The result is in 'dd/mm/yyyy' format and useful for automated tests needing
+        unique, non-weekend dates. Uses non-cryptographic randomness for variability between runs.
 
         Args:
             start_year (int): The minimum year from which the date may be generated. Defaults to 2025.