Adding a new util to update a subjects DOB

Author: adrianoaru-nhs

docs/utility-guides/SubjectDemographics.md

@@ -0,0 +1,40 @@
+# Utility Guide: Subject Demographics
+
+The Subject Demographics utility allows for different updates to subjects to be made
+
+## Table of Contents
+
+- [Utility Guide: Subject Demographics](#utility-guide-subject-demographics)
+  - [Table of Contents](#table-of-contents)
+  - [Using the Subject Demographics class](#using-the-subject-demographics-class)
+  - [Updating DOB](#updating-dob)
+    - [Required Args](#required-args)
+    - [How to use this method](#how-to-use-this-method)
+
+## Using the Subject Demographics class
+
+You can initialise the Subject Demographics class by using the following code in your test file:
+
+    from utils.subject_demographics import SubjectDemographicUtil
+
+## Updating DOB
+
+Inside of the SubjectDemographicUtil class there is a method called `update_subject_dob`.<br>
+This is used to update the date of birth of a subject to a random age between 50-70 and 75-100 depending on if the argument `younger_subject` is set to True or False.<br>
+This method will navigate to the subject demographic page automatically and can be called from any page.
+
+### Required Args
+
+- nhs_no:
+  - Type: `str`
+  - This is the NHS number of the subject you want to update
+- younger_subject:
+  - Type: `bool`
+  - Whether you want the subject to be younger (50-70) or older (75-100).
+
+### How to use this method
+
+To use this method simply import the SubjectDemographicUtil class and call this method, providing the two arguments:
+
+    nhs_no = "9468743977"
+    SubjectDemographicUtil(page).update_subject_dob(nhs_no, False)

pages/screening_subject_search/subject_demographic_page.py

@@ -0,0 +1,99 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+from datetime import datetime
+from utils.calendar_picker import CalendarPicker
+
+
+class SubjectDemographicPage(BasePage):
+    """Subject Demographic Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # Subject Demographic - page filters
+        self.forename_field = self.page.get_by_role("textbox", name="Forename")
+        self.surname_field = self.page.get_by_role("textbox", name="Surname")
+        self.postcode_field = self.page.get_by_role("textbox", name="Postcode")
+        self.dob_field = self.page.get_by_role("textbox", name="Date of Birth")
+        self.update_subject_data_button = self.page.get_by_role(
+            "button", name="Update Subject Data"
+        )
+
+    def is_forename_filled(self) -> bool:
+        """
+        Checks if the forename textbox contains a value.
+
+        Returns:
+            True if the textbox has a non-empty value, False otherwise
+        """
+        forename_value = self.forename_field.input_value()
+        return bool(forename_value.strip())
+
+    def is_surname_filled(self) -> bool:
+        """
+        Checks if the surname textbox contains a value.
+
+        Returns:
+            True if the textbox has a non-empty value, False otherwise
+        """
+        surname_value = self.surname_field.input_value()
+        return bool(surname_value.strip())
+
+    def is_postcode_filled(self) -> bool:
+        """
+        Checks if the postcode textbox contains a value.
+
+        Returns:
+            True if the textbox has a non-empty value, False otherwise
+        """
+        postcode_value = self.postcode_field.input_value()
+        return bool(postcode_value.strip())
+
+    def fill_forename_input(self, name: str) -> None:
+        """
+        Enters a value into the forename input textbox
+
+        Args:
+            name (str): The name you want to enter
+        """
+        self.forename_field.fill(name)
+
+    def fill_surname_input(self, name: str) -> None:
+        """
+        Enters a value into the surname input textbox
+
+        Args:
+            name (str): The name you want to enter
+        """
+        self.surname_field.fill(name)
+
+    def fill_dob_input(self, date: datetime) -> None:
+        """
+        Enters a value into the date of birth input textbox
+
+        Args:
+            date (datetime): The date you want to enter
+        """
+        date = CalendarPicker(self.page).calendar_picker_ddmmyyyy(date, self.dob_field)
+
+    def fill_postcode_input(self, postcode: str) -> None:
+        """
+        Enters a value into the postcode input textbox
+
+        Args:
+            postcode (str): The postcode you want to enter
+        """
+        self.postcode_field.fill(postcode)
+
+    def click_update_subject_data_button(self) -> None:
+        """Clicks on the 'Update Subject Data' button"""
+        self.click(self.update_subject_data_button)
+
+    def get_dob_field_value(self) -> str:
+        """
+        Returns the value in the date of birth input textbox
+
+        Returns:
+            str: The subject's date of birth as a string
+        """
+        return self.dob_field.input_value()

requirements.txt

@@ -8,3 +8,4 @@ python-dotenv~=1.1.0
 sqlalchemy>=2.0.38
 jproperties~=2.1.2
 pypdf>=5.3.0
+faker>=37.3.0

utils/subject_demographics.py

@@ -0,0 +1,80 @@
+from playwright.sync_api import Page
+from datetime import datetime
+from faker import Faker
+from dateutil.relativedelta import relativedelta
+import logging
+from pages.base_page import BasePage
+from pages.screening_subject_search.subject_screening_search_page import (
+    SubjectScreeningPage,
+    SearchAreaSearchOptions,
+)
+from pages.screening_subject_search.subject_demographic_page import (
+    SubjectDemographicPage,
+)
+from utils.date_time_utils import DateTimeUtils
+
+
+class SubjectDemographicUtil:
+    """The class for holding all the util methods to be used on the subject demographic page"""
+
+    def __init__(self, page: Page):
+        self.page = page
+
+    def update_subject_dob(self, nhs_no: str, younger_subject: bool) -> None:
+        """
+        This updates a subjects age to a random age between 50-70 and 75-100 depending on if younger_subject is set to True or False.
+
+        Args:
+            nhs_no (str): The NHS number of the subject you want to update.
+            younger_subject (bool): whether you want the subject to be younger (50-70) or older (75-100).
+        """
+        if younger_subject:
+            end_date = datetime.today() - relativedelta(years=50)
+            start_date = datetime.today() - relativedelta(years=70)
+            date = self.random_datetime(start_date, end_date)
+        else:
+            end_date = datetime.today() - relativedelta(years=75)
+            start_date = datetime.today() - relativedelta(years=100)
+            date = self.random_datetime(start_date, end_date)
+
+        BasePage(self.page).click_main_menu_link()
+        BasePage(self.page).go_to_screening_subject_search_page()
+        SubjectScreeningPage(self.page).click_demographics_filter()
+        SubjectScreeningPage(self.page).click_nhs_number_filter()
+        SubjectScreeningPage(self.page).nhs_number_filter.fill(nhs_no)
+        SubjectScreeningPage(self.page).nhs_number_filter.press("Tab")
+        SubjectScreeningPage(self.page).select_search_area_option(
+            SearchAreaSearchOptions.SEARCH_AREA_WHOLE_DATABASE.value
+        )
+        SubjectScreeningPage(self.page).click_search_button()
+        postcode_filled = SubjectDemographicPage(self.page).is_postcode_filled()
+        if not postcode_filled:
+            fake = Faker("en_GB")
+            random_postcode = fake.postcode()
+            SubjectDemographicPage(self.page).fill_postcode_input(random_postcode)
+
+        current_dob = SubjectDemographicPage(self.page).get_dob_field_value()
+        date = DateTimeUtils.format_date(date)
+        logging.info(f"Current DOB: {current_dob}")
+        logging.info(f"New DOB: {date}")
+        SubjectDemographicPage(self.page).fill_dob_input(date)
+        SubjectDemographicPage(self.page).click_update_subject_data_button()
+        updated_dob = SubjectDemographicPage(self.page).get_dob_field_value()
+        if updated_dob == date:
+            logging.info("New date of birth matches as expect")
+        else:
+            logging.error("New date of birth does not match the expected.")
+
+    def random_datetime(self, start: datetime, end: datetime) -> datetime:
+        """
+        Generate a random datetime between two datetime objects.
+
+        Args:
+            start (datetime): the starting date
+            end (datetime): The end date
+
+        Returns:
+            datetime: the newly generated date
+        """
+        fake = Faker()
+        return fake.date_time_between(start, end)