Refactoring utils used in compartment 4

Author: adrianoaru-nhs

pages/base_page.py

@@ -1,4 +1,4 @@
-from playwright.sync_api import Page, expect, Locator
+from playwright.sync_api import Page, expect, Locator, Dialog
 import logging
 
 
@@ -167,3 +167,24 @@ def click(self, locator: Locator) -> None:
                 f"Failed to click element with error: {locatorClickError}, trying again..."
             )
             locator.click()
+
+    def _accept_dialog(self, dialog: Dialog) -> None:
+        """
+        This method is used to accept dialogs
+        If it has already been accepted then it is ignored
+        """
+        try:
+            dialog.accept()
+        except Exception:
+            logging.info("Dialog already accepted")
+
+    def safe_accept_dialog(self, locator: Locator) -> None:
+        """
+        This is used to accept dialogs multiple times without getting the error:
+        playwright._impl._errors.Error: Dialog.accept: Cannot accept dialog which is already handled!
+        """
+        self.page.once("dialog", self._accept_dialog)
+        try:
+            self.click(locator)
+        except Exception as e:
+            logging.error(f"Click failed: {e}")

pages/screening_practitioner_appointments/book_appointment_page.py

@@ -10,29 +10,24 @@ def __init__(self, page: Page):
         # Book Appointment - page locators
         self.screening_center_dropdown = page.locator("#UI_NEW_SCREENING_CENTRE")
         self.site_dropdown = page.locator("#UI_NEW_SITE")
-        self.day_with_available_slots = page.locator(
-            'input.twoColumnCalendar[style*="background-color: rgb(102, 255, 153);"]'
-        )
-        self.day_with_some_available_slots = page.locator(
-            'input.twoColumnCalendar[style*="background-color: rgb(255, 220, 144);"]'
-        )
         self.appointment_time_radio_button = page.locator(
             page.get_by_role("radio", name="UI_NEW_SLOT_SELECTION_ID")
         )
         self.save_button = page.get_by_role("button", name="Save")
         self.appointments_table = TableUtils(self.page, "#displayRS")
         self.current_month_displayed = self.page.locator("#MONTH_AND_YEAR")
 
+        self.appointment_cell_locators = self.page.locator("input.twoColumnCalendar")
+        self.available_background_colour = "rgb(102, 255, 153)"
+        self.some_available_background_colour = "rgb(255, 220, 144)"
+
     def select_screening_centre_dropdown_option(self, screening_centre: str) -> None:
         self.screening_center_dropdown.select_option(label=screening_centre)
 
     def select_site_dropdown_option(self, screening_site: str) -> None:
         self.site_dropdown.select_option(label=screening_site)
         self.site_dropdown.press("Enter")
 
-    def choose_day_with_available_slots(self) -> None:
-        self.click(self.day_with_available_slots)
-
     def choose_appointment_time(self) -> None:
         self.appointment_time_radio_button.check()
 
@@ -42,8 +37,5 @@ def click_save_button(self) -> None:
     def appointment_booked_confirmation_is_displayed(self, message: str) -> None:
         expect(self.page.get_by_text(message)).to_be_visible()
 
-    def accept_dialog(self) -> None:
-        self.page.once("dialog", lambda dialog: dialog.accept())
-
     def get_current_month_displayed(self) -> str:
         return self.current_month_displayed.text_content()

pages/screening_practitioner_appointments/colonoscopy_assessment_appointments_page.py

@@ -8,13 +8,20 @@ def __init__(self, page: Page):
         self.page = page
         # Colonoscopy Assessment Appointments - page locators
         self.page_header = self.page.locator("#page-title")
+        self.page_header_with_title = self.page.locator(
+            "#page-title",
+            has_text="Patients that Require Colonoscopy Assessment Appointments",
+        )
         self.nhs_number_filter_text_field = self.page.locator("#nhsNumberFilter")
 
     def verify_page_header(self) -> None:
         expect(self.page_header).to_contain_text(
             "Patients that Require Colonoscopy Assessment Appointments"
         )
 
+    def wait_for_page_header(self) -> None:
+        self.page_header_with_title.wait_for()
+
     def filter_by_nhs_number(self, nhs_number: str) -> None:
         self.click(self.nhs_number_filter_text_field)
         self.nhs_number_filter_text_field.fill(nhs_number)

tests/smokescreen/bcss_smokescreen_tests.properties

@@ -26,7 +26,7 @@
 # ----------------------------------
 #   compartment 4
 # ----------------------------------
-#    c4_eng_org_id=23159
+     c4_eng_weeks_to_make_available = 6
 #    c4_eng_centre_name=Wolverhampton
 #    c4_eng_site_name=Royal Hospital
 #    c4_eng_practitioner_id=243

tests/smokescreen/test_compartment_4.py

@@ -55,7 +55,8 @@ def test_compartment_4(page: Page, smokescreen_properties: dict) -> None:
         smokescreen_properties["c4_eng_number_of_appointments_to_book"]
     )
 
-    logging.info("Setting up appointments")
+    logging.info("Compartment 4 - Setting up appointments")
+    logging.info("Logging in as Screening Centre Manager at BCS001")
     UserTools.user_login(page, "Screening Centre Manager at BCS001")
     BasePage(page).go_to_screening_practitioner_appointments_page()
     ScreeningPractitionerAppointmentsPage(page).go_to_set_availability_page()
@@ -72,14 +73,18 @@ def test_compartment_4(page: Page, smokescreen_properties: dict) -> None:
     PractitionerAvailabilityPage(page).enter_start_time("09:00")
     PractitionerAvailabilityPage(page).enter_end_time("17:15")
     PractitionerAvailabilityPage(page).click_calculate_slots_button()
-    PractitionerAvailabilityPage(page).enter_number_of_weeks("6")
+    PractitionerAvailabilityPage(page).enter_number_of_weeks(
+        smokescreen_properties["c4_eng_weeks_to_make_available"]
+    )
     PractitionerAvailabilityPage(page).click_save_button()
     PractitionerAvailabilityPage(page).slots_updated_message_is_displayed(
-        "Slots Updated for 6 Weeks"
+        f"Slots Updated for {smokescreen_properties["c4_eng_weeks_to_make_available"]} Weeks"
     )
     Logout(page).log_out(close_page=False)
 
+    logging.info("Compartment 4 - Booking subjects to appointments")
     ScreeningPractitionerAppointmentsPage(page).go_to_log_in_page()
+    logging.info("Logging in as Hub Manager State Registered at BCS01")
     UserTools.user_login(page, "Hub Manager State Registered at BCS01")
 
     BasePage(page).go_to_screening_practitioner_appointments_page()
@@ -103,22 +108,29 @@ def test_compartment_4(page: Page, smokescreen_properties: dict) -> None:
         current_month_displayed = BookAppointmentPage(
             page
         ).get_current_month_displayed()
-        CalendarPicker(page).select_first_eligble_appointment(
+        CalendarPicker(page).book_first_eligble_appointment(
             current_month_displayed,
-            BookAppointmentPage(page).day_with_available_slots,
-            BookAppointmentPage(page).day_with_some_available_slots,
+            BookAppointmentPage(page).appointment_cell_locators,
+            [
+                BookAppointmentPage(page).available_background_colour,
+                BookAppointmentPage(page).some_available_background_colour,
+            ],
         )
         BookAppointmentPage(page).appointments_table.click_first_input_in_column(
             "Appt/Slot Time"
         )
-        BookAppointmentPage(page).accept_dialog()
-        BookAppointmentPage(page).click_save_button()
-        BookAppointmentPage(page).appointment_booked_confirmation_is_displayed(
-            "Appointment booked"
-        )
+        BasePage(page).safe_accept_dialog(BookAppointmentPage(page).save_button)
+        try:
+            BookAppointmentPage(page).appointment_booked_confirmation_is_displayed(
+                "Appointment booked"
+            )
+            logging.info(f"Appointment successfully booked for: {nhs_number}")
+        except Exception as e:
+            pytest.fail(f"Appointment not booked successfully: {e}")
         BasePage(page).click_back_button()
-    BasePage(page).click_main_menu_link()
+    ColonoscopyAssessmentAppointments(page).wait_for_page_header()
 
+    logging.info("Compartment 4 - Sending out appointment invitations")
     batch_processing(
         page,
         "A183",

utils/batch_processing.py

@@ -1,7 +1,12 @@
 from pages.base_page import BasePage
-from pages.communication_production.communications_production_page import CommunicationsProduction
+from pages.communication_production.communications_production_page import (
+    CommunicationsProduction,
+)
 from pages.communication_production.manage_active_batch_page import ManageActiveBatch
-from pages.communication_production.batch_list_page import ActiveBatchList, ArchivedBatchList
+from pages.communication_production.batch_list_page import (
+    ActiveBatchList,
+    ArchivedBatchList,
+)
 from utils.screening_subject_page_searcher import verify_subject_event_status_by_nhs_no
 from utils.oracle.oracle_specific_functions import get_nhs_no_from_batch_id
 from utils.oracle.oracle import OracleDB
@@ -119,8 +124,9 @@ def prepare_and_print_batch(page: Page, link_text) -> None:
             logging.info(
                 f"Clicking confirm printed button {confirm_printed_button + 1}"
             )
-            page.once("dialog", lambda dialog: dialog.accept())
-            ManageActiveBatch(page).confirm_button.nth(0).click()
+            BasePage(page).safe_accept_dialog(
+                ManageActiveBatch(page).confirm_button.nth(0)
+            )
     except Exception as e:
         pytest.fail(f"No confirm printed button available to click: {str(e)}")
 

utils/calendar_picker.py

@@ -286,82 +286,81 @@ def v2_calendar_picker(self, date: datetime) -> None:
 
         self.select_day(date)
 
-    def month_string_to_number(self, string: str) -> None:
-        """
-        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
-        """
-        months = {
-            "jan": 1,
-            "feb": 2,
-            "mar": 3,
-            "apr": 4,
-            "may": 5,
-            "jun": 6,
-            "jul": 7,
-            "aug": 8,
-            "sep": 9,
-            "oct": 10,
-            "nov": 11,
-            "dec": 12,
-        }
-        month_short = string.strip()[:3].lower()
-
-        try:
-            out = months[month_short]
-            return out
-        except Exception:
-            raise ValueError("Not a month")
-
-    def select_first_eligble_appointment(
+    def book_first_eligble_appointment(
         self,
         current_month_displayed: str,
-        avialble_locator: Locator,
-        some_available_locator: Locator,
+        locator: Locator,
+        bg_colours: list,
     ) -> None:
         """
         This is used to select the first eligible appointment date
-        It first gets all available dates, and then clicks on the first one starting from today's date
+        It first sets the calendar to the current month
+        Then gets all available dates, and then clicks on the first one starting from today's date
+        If no available dates are found it moves onto the next month and repeats this 2 more times
+        If in the end no available dates are found the test will fail.
         """
-        current_month_displayed_int = self.month_string_to_number(
+        current_month_displayed_int = DateTimeUtils().month_string_to_number(
             current_month_displayed
         )
         if platform == "win32":  # Windows
-            current_month_int = int(datetime.now().strftime("%#d"))
+            current_month_int = int(datetime.now().strftime("%#m"))
         else:  # Linux or Mac
-            current_month_int = int(datetime.now().strftime("%-d"))
+            current_month_int = int(datetime.now().strftime("%-m"))
 
-        if current_month_displayed_int != current_month_int:
-            self.click(self.appointments_prev_month)
+        self.book_appointments_go_to_month(
+            current_month_displayed_int, current_month_int
+        )
 
         months_looped = 0
         appointment_clicked = False
         while (
             months_looped < 3 and not appointment_clicked
         ):  # This loops through this month + next two months to find available appointments. If none found it has failed
             appointment_clicked = self.check_for_eligible_appointment_dates(
-                avialble_locator
+                locator, bg_colours
             )
 
-            if not appointment_clicked:
-                appointment_clicked = self.check_for_eligible_appointment_dates(
-                    some_available_locator
-                )
-
             if not appointment_clicked:
                 self.click(self.appointments_next_month)
                 months_looped += 1
 
         if not appointment_clicked:
             pytest.fail("No available appointments found for the current month")
 
-    def check_for_eligible_appointment_dates(self, locator: Locator) -> bool:
+    def book_appointments_go_to_month(
+        self, current_displayed_month: int, wanted_month: int
+    ):
+        """
+        This is used to move the calendar on the appointments page to the wanted month
+        """
+        month_difference = current_displayed_month - wanted_month
+        if month_difference > 0:
+            for _ in range(month_difference):
+                self.click(self.appointments_prev_month)
+        elif month_difference < 0:
+            for _ in range(month_difference * -1):
+                self.click(self.appointments_next_month)
+
+    def check_for_eligible_appointment_dates(
+        self, locator: Locator, bg_colours: list
+    ) -> bool:
+        """
+        This function loops through all of the appointment date cells and if the bacground colour matches
+        It then checks that the length of the name is less than 5.
+        This is done the name length is the only differentiating factor between the two calendar tables on the page
+        - 1st table has a length of 4 (e.g. wed2, fri5) and the 2nd table has a length of 5 (e.g. wed11, fri14)
+        """
 
         locator_count = locator.count()
 
         for i in range(locator_count):
-            locator_number = locator_count - i - 1
-            value = locator.nth(locator_number).get_attribute("name")
-            if len(value) < 5:
-                self.click(locator.nth(locator_number))
-                return True
+            locator_element = locator.nth(i)
+            background_colour = locator_element.evaluate(
+                "el => window.getComputedStyle(el).backgroundColor"
+            )
+
+            if background_colour in bg_colours:
+                value = locator_element.get_attribute("name")
+                if len(value) < 5:
+                    self.click(locator.nth(i))
+                    return True

utils/date_time_utils.py

@@ -97,3 +97,30 @@ 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:
+        """
+        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
+        """
+        months = {
+            "jan": 1,
+            "feb": 2,
+            "mar": 3,
+            "apr": 4,
+            "may": 5,
+            "jun": 6,
+            "jul": 7,
+            "aug": 8,
+            "sep": 9,
+            "oct": 10,
+            "nov": 11,
+            "dec": 12,
+        }
+        month_short = string.strip()[:3].lower()
+
+        try:
+            out = months[month_short]
+            return out
+        except Exception:
+            raise ValueError("Not a month")