Inital commit - adding new util and fixture to setup appointments

Author: adrianoaru-nhs

conftest.py

@@ -14,6 +14,13 @@
 from utils.load_properties_file import PropertiesFile
 from _pytest.config.argparsing import Parser
 from _pytest.fixtures import FixtureRequest
+from playwright.sync_api import Page
+from utils.oracle.oracle_specific_functions import (
+    set_org_parameter_value,
+    check_parameter,
+)
+from utils.last_test_run import has_test_run_today
+from utils.appointments import setup_appointments
 
 # Environment Variable Handling
 
@@ -106,3 +113,34 @@ def subjects_to_run_for(request: FixtureRequest) -> int:
         int: The number of subjects specified via the CLI or default (10).
     """
     return int(request.config.getoption("--subjects-to-run-for"))  # type: ignore
+
+
+@pytest.fixture(scope="function")
+def setup_org_and_appointments(page: Page, request: FixtureRequest) -> None:
+    """
+    Ensures required org parameters and appointments are set up.
+    Only runs once per day per environment, regardless of which test calls it.
+
+    This fixture is designed to be used in tests that require a specific setup of the organisation and appointments.
+    Example usage:
+        @pytest.mark.usefixtures("setup_org_and_appointments")
+        def test_my_function(page: Page):
+            # Your test code here
+
+        def test_my_function(page: Page, setup_org_and_appointments):
+            # Your test code here
+    """
+    param_12_set_correctly = check_parameter(12, "23162", "10")
+    param_28_set_correctly = check_parameter(28, "23162", "07:00")
+    param_29_set_correctly = check_parameter(29, "23162", "20:00")
+    if not param_12_set_correctly:
+        set_org_parameter_value(12, "10", "23162")
+    if not param_28_set_correctly:
+        set_org_parameter_value(28, "07:00", "23162")
+    if not param_29_set_correctly:
+        set_org_parameter_value(29, "20:00", "23162")
+
+    base_url = request.config.getoption("--base-url")
+    fixture_name = "setup_org_and_appointments"
+    if not has_test_run_today(fixture_name, base_url):  # type: ignore
+        setup_appointments(page, 0, max=True)

docs/utility-guides/Appointments.md

@@ -0,0 +1,85 @@
+# Utility Guide: Appointments Utility
+
+This guide explains the purpose and usage of the `setup_appointments` utility found in [`utils/appointments.py`](../../utils/appointments.py).
+It is designed to automate the setup of practitioner appointments at a screening centre using Playwright.
+
+---
+
+## Table of Contents
+
+- [Utility Guide: Appointments Utility](#utility-guide-appointments-utility)
+  - [Table of Contents](#table-of-contents)
+  - [Overview](#overview)
+  - [Required Arguments](#required-arguments)
+  - [How It Works](#how-it-works)
+  - [Example Usage](#example-usage)
+  - [Best Practices](#best-practices)
+
+---
+
+## Overview
+
+The `setup_appointments` function automates the process of logging in as a Screening Centre Manager, navigating through the appointments workflow, and creating appointment slots for multiple practitioners at a specified screening centre.
+It is useful for preparing test data and ensuring practitioners have available appointment slots for test scenarios.
+
+---
+
+## Required Arguments
+
+```python
+def setup_appointments(page: Page, no_of_practitioners: int, max: bool = False) -> None:
+```
+
+- `page` (`Page`): The Playwright page object.
+- `no_of_practitioners` (`int`): Number of practitioners to set up appointments for.
+- `max` (`bool`, optional): If `True`, sets up appointments for all practitioners at the site. Defaults to `False`.
+
+---
+
+## How It Works
+
+1. **Login**
+
+   Logs in as "Screening Centre Manager at BCS001" using the `UserTools` utility.
+
+2. **Determine Practitioner Count**
+
+   If `max=True`, navigates to the practitioner availability page, selects the site, and counts the number of practitioners available.
+
+3. **Appointment Setup Loop**
+
+   For each practitioner:
+   - Navigates to the practitioner appointments workflow.
+   - Selects the site and practitioner.
+   - Opens the calendar and selects today's date.
+   - Sets start and end times, calculates slots, and saves the appointment for one week.
+
+4. **Logout**
+
+   Logs out after all appointments are set.
+
+---
+
+## Example Usage
+
+```python
+from playwright.sync_api import Page
+from utils.appointments import setup_appointments
+
+def test_setup_practitioner_appointments(page: Page):
+    # Set up appointments for the first 5 practitioners
+    setup_appointments(page, no_of_practitioners=5)
+
+def test_setup_all_practitioner_appointments(page: Page):
+    # Set up appointments for all practitioners at the site
+    setup_appointments(page, no_of_practitioners=0, max=True)
+```
+
+---
+
+## Best Practices
+
+- Use this utility in test setup steps to ensure practitioners have available slots before running appointment-related tests.
+- Use `max=True` for bulk setup, or specify `no_of_practitioners` for targeted setup.
+
+---

tests/regression/subject/episodes/datasets/investigation/endoscopy/polypcategories/test_setup.py

@@ -1,7 +1,6 @@
 from datetime import datetime, timedelta
 import pandas as pd
 import pytest
-from _pytest.fixtures import FixtureRequest
 import logging
 from playwright.sync_api import Page
 from classes.subject import Subject
@@ -23,15 +22,6 @@
 from pages.screening_practitioner_appointments.book_appointment_page import (
     BookAppointmentPage,
 )
-from pages.screening_practitioner_appointments.practitioner_availability_page import (
-    PractitionerAvailabilityPage,
-)
-from pages.screening_practitioner_appointments.screening_practitioner_appointments_page import (
-    ScreeningPractitionerAppointmentsPage,
-)
-from pages.screening_practitioner_appointments.set_availability_page import (
-    SetAvailabilityPage,
-)
 from pages.screening_subject_search.advance_fobt_screening_episode_page import (
     AdvanceFOBTScreeningEpisodePage,
 )
@@ -44,13 +34,10 @@
 from utils.batch_processing import batch_processing
 from utils.calendar_picker import CalendarPicker
 from utils.fit_kit import FitKitGeneration
-from utils.last_test_run import has_test_run_today
 from utils.oracle.oracle import OracleDB
 from utils.oracle.oracle_specific_functions import (
     update_kit_service_management_entity,
     execute_fit_kit_stored_procedures,
-    set_org_parameter_value,
-    check_parameter,
 )
 from utils.oracle.subject_selection_query_builder import SubjectSelectionQueryBuilder
 from utils.screening_subject_page_searcher import (
@@ -61,30 +48,7 @@
 from utils.datasets.investigation_datasets import go_from_a99_status_to_a259_status
 
 
-@pytest.fixture(scope="function", autouse=True)
-def before_each(page: Page, request: FixtureRequest) -> None:
-    """
-    Checks that the required organization parameters are set correctly before each test.
-    If not, it sets them to the expected values.
-    Also sets up appointments if the test has not been run today.
-    """
-    param_12_set_correctly = check_parameter(12, "23162", "10")
-    param_28_set_correctly = check_parameter(28, "23162", "07:00")
-    param_29_set_correctly = check_parameter(29, "23162", "20:00")
-    if not param_12_set_correctly:
-        set_org_parameter_value(12, "10", "23162")
-    if not param_28_set_correctly:
-        set_org_parameter_value(28, "07:00", "23162")
-    if not param_29_set_correctly:
-        set_org_parameter_value(29, "20:00", "23162")
-
-    base_url = request.config.getoption("--base-url")
-    if not has_test_run_today(
-        "subject/episodes/datasets/investigation/endoscopy/polypcategories/test_setup", base_url  # type: ignore
-    ):
-        setup_appointments(page)
-
-
+@pytest.mark.usefixtures("setup_org_and_appointments")
 @pytest.mark.vpn_required
 def test_setup_subjects_as_a99(page: Page, subjects_to_run_for: int) -> None:
     """
@@ -115,6 +79,7 @@ def test_setup_subjects_as_a99(page: Page, subjects_to_run_for: int) -> None:
     LogoutPage(page).log_out()
 
 
+@pytest.mark.usefixtures("setup_org_and_appointments")
 @pytest.mark.vpn_required
 def test_setup_subjects_as_a259(page: Page, subjects_to_run_for: int) -> None:
     """
@@ -173,35 +138,6 @@ def test_setup_subjects_as_a259(page: Page, subjects_to_run_for: int) -> None:
     LogoutPage(page).log_out()
 
 
-def setup_appointments(page: Page) -> None:
-    """
-    Set up appointments for multiple practitioners at a screening centre.
-    This function logs in as a Screening Centre Manager, sets availability for
-    practitioners, and creates appointments for the next 10 practitioners.
-    """
-    UserTools.user_login(page, "Screening Centre Manager at BCS001")
-    for index in range(10):
-        BasePage(page).go_to_screening_practitioner_appointments_page()
-        ScreeningPractitionerAppointmentsPage(page).go_to_set_availability_page()
-        SetAvailabilityPage(page).go_to_practitioner_availability_page()
-        PractitionerAvailabilityPage(page).select_site_dropdown_option(
-            "THE ROYAL HOSPITAL (WOLVERHAMPTON)"
-        )
-        PractitionerAvailabilityPage(
-            page
-        ).select_practitioner_dropdown_option_from_index(index + 1)
-        PractitionerAvailabilityPage(page).click_calendar_button()
-        CalendarPicker(page).select_day(datetime.today())
-        PractitionerAvailabilityPage(page).click_show_button()
-        PractitionerAvailabilityPage(page).enter_start_time("07:00")
-        PractitionerAvailabilityPage(page).enter_end_time("20:00")
-        PractitionerAvailabilityPage(page).click_calculate_slots_button()
-        PractitionerAvailabilityPage(page).enter_number_of_weeks("1")
-        PractitionerAvailabilityPage(page).click_save_button()
-        BasePage(page).click_main_menu_link()
-    LogoutPage(page).log_out()
-
-
 def setup_a99_status(page: Page, df: pd.DataFrame) -> pd.DataFrame:
     """
     Set up subjects to have status A99 - Suitable for Endoscopic Test.

utils/appointments.py

@@ -0,0 +1,68 @@
+import logging
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from pages.logout.log_out_page import LogoutPage
+from pages.screening_practitioner_appointments.practitioner_availability_page import (
+    PractitionerAvailabilityPage,
+)
+from pages.screening_practitioner_appointments.screening_practitioner_appointments_page import (
+    ScreeningPractitionerAppointmentsPage,
+)
+from pages.screening_practitioner_appointments.set_availability_page import (
+    SetAvailabilityPage,
+)
+from utils.calendar_picker import CalendarPicker
+from utils.user_tools import UserTools
+from datetime import datetime
+
+
+def setup_appointments(page: Page, no_of_practitioners: int, max: bool = False) -> None:
+    """
+    Set up appointments for multiple practitioners at a screening centre.
+    This function logs in as a Screening Centre Manager, sets availability for
+    practitioners, and creates appointments for the next 10 practitioners.
+
+    Args:
+        no_of_practitioners (int): The number of practitioners to set up appointments for.
+        max (bool): If True, sets up appointments for all practitioners. Defaults to False.
+    """
+    UserTools.user_login(page, "Screening Centre Manager at BCS001")
+
+    if max:
+        BasePage(page).go_to_screening_practitioner_appointments_page()
+        ScreeningPractitionerAppointmentsPage(page).go_to_set_availability_page()
+        SetAvailabilityPage(page).go_to_practitioner_availability_page()
+        PractitionerAvailabilityPage(page).select_site_dropdown_option(
+            "THE ROYAL HOSPITAL (WOLVERHAMPTON)"
+        )
+        total_practitioners = (
+            PractitionerAvailabilityPage(page)
+            .screening_practitioner_dropdown.locator("option")
+            .count()
+        )
+        no_of_practitioners = total_practitioners - 1  # Exclude the first option
+        BasePage(page).click_main_menu_link()
+
+    logging.info(f"Setting up appointments for {no_of_practitioners} practitioners")
+    for index in range(no_of_practitioners):
+        logging.info(f"Setting up appointments for practitioner {index + 1}")
+        BasePage(page).go_to_screening_practitioner_appointments_page()
+        ScreeningPractitionerAppointmentsPage(page).go_to_set_availability_page()
+        SetAvailabilityPage(page).go_to_practitioner_availability_page()
+        PractitionerAvailabilityPage(page).select_site_dropdown_option(
+            "THE ROYAL HOSPITAL (WOLVERHAMPTON)"
+        )
+        PractitionerAvailabilityPage(
+            page
+        ).select_practitioner_dropdown_option_from_index(index + 1)
+        PractitionerAvailabilityPage(page).click_calendar_button()
+        CalendarPicker(page).select_day(datetime.today())
+        PractitionerAvailabilityPage(page).click_show_button()
+        PractitionerAvailabilityPage(page).enter_start_time("07:00")
+        PractitionerAvailabilityPage(page).enter_end_time("20:00")
+        PractitionerAvailabilityPage(page).click_calculate_slots_button()
+        PractitionerAvailabilityPage(page).enter_number_of_weeks("1")
+        PractitionerAvailabilityPage(page).click_save_button()
+        logging.info(f"Appointments set for practitioner {index + 1} at BCS001")
+        BasePage(page).click_main_menu_link()
+    LogoutPage(page).log_out()