Addressing the PR comments

Author: mepr1

pages/organisations/create_organisation.py

@@ -8,7 +8,6 @@ class CreateOrganisation(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
 
         # Create Organisation links
         self.organisation_code = self.page.get_by_label("Organisation Code*")
@@ -23,47 +22,43 @@ def __init__(self, page: Page):
     def fill_organisation_code(self, text: str) -> None:
         """
         This method is designed to fill in the Organisation Code field on the Create Organisation page.
-        Returns:
-            None
+        Args:
+        text (str): The organisation code to be entered. Example: "Z9Z1S"
         """
         logging.info("Filling Organisation Code on Create Organisation page")
         self.organisation_code.fill(text)
 
     def fill_organisation_name(self, text: str) -> None:
         """
         This method is designed to fill in the Organisation Name field on the Create Organisation page.
-        Returns:
-            None
+        Args:
+        text (str): The organisation name to be entered. Example: "Test ANANA ICB"
         """
         logging.info("Filling Organisation Name on Create Organisation page")
         self.organisation_name.fill(text)
 
     def click_start_date_calendar(self) -> None:
         """
         This method is designed to click the Start Date Calendar button on the Create Organisation page.
-        Returns:
-            None
         """
         logging.info("Clicking Start Date Calendar on Create Organisation page")
-        self.start_date_calendar.click()
+        self.click(self.start_date_calendar)
 
     def fill_audit_reason(self, text: str) -> None:
         """
         This method is designed to fill in the Audit Reason field on the Create Organisation page.
-        Returns:
-            None
+        Args:
+        text (str): The audit reason to be entered. Example: "Automated ANANA Test"
         """
         logging.info("Filling Audit Reason on Create Organisation page")
         self.audit_reason.fill(text)
 
     def click_save_button(self) -> None:
         """
         This method is designed to click the Save button on the Create Organisation page.
-        Returns:
-            None
         """
         logging.info("Clicking Save button on Create Organisation page")
-        self.save_button.click()
+        self.click(self.save_button)
 
     def verify_success_message(self) -> None:
         """Verifies that the success message is displayed after saving the organisation."""

pages/organisations/create_site.py

@@ -8,7 +8,6 @@ class CreateSite(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
 
         # Create Site links
         self.site_code = self.page.get_by_label("Site Code*")
@@ -20,44 +19,41 @@ def __init__(self, page: Page):
     def fill_site_code(self, text: str) -> None:
         """
         This method is designed to fill in the site Code field on the Create site page.
-        Returns:
-            None
+        Args:
+            text (str): The site code to be entered. Example: "Z9Z1X"
         """
-        logging.info("Filling Site Code on Create Organisation page")
+        logging.info("Filling Site Code on Create site page")
         self.site_code.fill(text)
 
     def fill_site_name(self, text: str) -> None:
         """
         This method is designed to fill in the Site Name field on the Create Site page.
-        Returns:
-            None
+        Args:
+            text (str): The site name to be entered. Example: "TEST ANANA NHS TRUST SITE"
         """
         logging.info("Filling Site Name on Create Site page")
         self.site_name.fill(text)
 
     def click_start_date_calendar(self) -> None:
         """
         This method is designed to click the Start Date Calendar button on the Create Site page.
-        Returns:
-            None
         """
         logging.info("Clicking Start Date Calendar on Create Site page")
         self.start_date_calendar.click()
 
     def fill_audit_reason(self, text: str) -> None:
         """
         This method is designed to fill in the Audit Reason field on the Create Site page.
-        Returns:
-            None
+        Args:
+            text (str): The audit reason to be entered. Example: "Automated ANANA Test"
         """
         logging.info("Filling Audit Reason on Create Site page")
         self.audit_reason.fill(text)
 
     def click_save_button(self) -> None:
         """
         This method is designed to click the Save button on the Create Site page.
-        Returns:
-            None
+
         """
         logging.info("Clicking Save button on Create Site page")
         self.save_button.click()

pages/organisations/list_all_organisations.py

@@ -10,7 +10,6 @@ class ListAllOrganisations(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
         # Initialize TableUtils for the table with id="displayRS"
         self.list_all_org_table = TableUtils(page, "#listAllOrgsTable")
 
@@ -24,8 +23,6 @@ def select_organisation_type_option(self, option: str) -> None:
         This method is designed to select a specific organisation type from the List All Organisations page.
         Args:
             option (str): The organisation type option to be selected. This should be a string that matches one of the available options in the dropdown menu.
-        Returns:
-            None
         """
         logging.info(f"Selecting Organisation Type: {option}")
         self.select_organisation_type.select_option(option)
@@ -47,15 +44,16 @@ def search_organisation_code(self, org_code: str) -> None:
         This method is designed to search for an organisation by its code.
         Args:
             org_code (str): The organisation code to search for.
-        Returns:
-            None
         """
         logging.info(f"Searching for Organisation with code: {org_code}")
         self.search_org_code.fill(org_code)
         self.search_org_code.press("Enter")
 
-    def verify_no_organisation_record_found(self, text: str) -> None:
-        """Verifies that no organisation record is found."""
+    def verify_no_organisation_record_found(self, text: str) -> None: 
+        """Verifies that no organisation record is found.
+        Args:
+            text (str): The text to verify is present indicating no records found. Example: "No organisation record found"
+        """
         logging.info("Verifying that no organisation record is found")
         expect(self.page.locator('form[name="frm"]')).to_contain_text(text)
 

pages/organisations/list_all_sites.py

@@ -10,8 +10,7 @@ class ListAllSites(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
-        # Initialize TableUtils for the table with id="displayRS"
+        # Initialize TableUtils for the table with id="listAllOrgsTable"
         self.list_all_org_table = TableUtils(page, "#listAllOrgsTable")
 
         # List All Site links
@@ -26,14 +25,14 @@ def select_site_type_option(self, option: str) -> None:
         self.select_site_type.select_option(option)
 
     def click_create_new_site(self) -> None:
-        """Clicks the 'Create New Org' button."""
+        """Clicks the 'Create New Site' button."""
         self.create_new_site.click()
 
     def search_site_code(self, site_code: str) -> None:
         """
         This method is designed to search for an site by its code.
         Args:
-            org_code (str): The site code to search for.
+            site_code (str): The site code to search for.
         Returns:
             None
         """

pages/organisations/organisations_and_site_details.py

@@ -8,7 +8,6 @@ class OrganisationsAndSiteDetails(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
 
         # Organisations And Site Details Page links
         self.my_organisation = self.page.get_by_role("link", name="My Organisation")

pages/organisations/organisations_page.py

@@ -7,7 +7,6 @@ class OrganisationsPage(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
 
         # Organisations page links
         self.screening_centre_parameters_page = self.page.get_by_role(

pages/organisations/view_organisation.py

@@ -1,5 +1,4 @@
 import logging
-from click import option
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
 
@@ -9,7 +8,6 @@ class ViewOrganisation(BasePage):
 
     def __init__(self, page: Page):
         super().__init__(page)
-        self.page = page
         # View Organisation links
         self.edit_button = self.page.get_by_role("button", name="Edit")
 

tests/regression/organisation/test_organisation_and_site_details.py

@@ -1,5 +1,3 @@
-from ast import List, Or
-from re import L
 import pytest
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
@@ -32,12 +30,17 @@ def before_each(page: Page):
     Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the call and recall page
     """
     # Log in to BCSS
-    UserTools.user_login(page, "Bureau Staff")
+    UserTools.user_login(page, "BCSS Bureau Staff")
 
     # Go to call and recall page
     BasePage(page).go_to_organisations_page()
 
 
+# Define constants for repeated values
+ICB_ORGANISATION_CODE = "Z9Z1S"
+NHS_TRUST_SITE_CODE = "Z9Z1X"
+
+@pytest.mark.wip
 @pytest.mark.regression
 @pytest.mark.organisations_users_and_contacts_tests
 @pytest.mark.organisations_and_contacts_build_level_tests
@@ -52,6 +55,7 @@ def test_check_list_all_organisations_page(page) -> None:
     ViewOrganisation(page).verify_page_title()
 
 
+@pytest.mark.wip
 @pytest.mark.regression
 @pytest.mark.organisations_users_and_contacts_tests
 @pytest.mark.organisations_and_contacts_develop_level_tests
@@ -63,7 +67,7 @@ def test_create_new_icb_z9z1s_using_create_new_org(page) -> None:
     OrganisationsAndSiteDetails(page).go_to_list_all_organisations()
     ListAllOrganisations(page).select_organisation_type_option(OrganisationType.ICB)
     ListAllOrganisations(page).click_create_new_org()
-    CreateOrganisation(page).organisation_code.fill("Z9Z1S")
+    CreateOrganisation(page).organisation_code.fill(ICB_ORGANISATION_CODE)
     CreateOrganisation(page).organisation_name.fill("Test ANANA ICB")
     CreateOrganisation(page).click_start_date_calendar()
     CalendarPicker(page).select_day(datetime.today())
@@ -72,18 +76,19 @@ def test_create_new_icb_z9z1s_using_create_new_org(page) -> None:
     CreateOrganisation(page).verify_success_message()
 
 
+@pytest.mark.wip
 @pytest.mark.regression
 @pytest.mark.organisations_users_and_contacts_tests
 @pytest.mark.organisations_and_contacts_develop_level_tests
-def test_create_new_nhs_trust_site_z9z1x_using_ccreate_site(page) -> None:
+def test_create_new_nhs_trust_site_z9z1x_using_create_site(page) -> None:
     """
     Verifies that the 'Create New Site' functionality works correctly for creating a new NHS Trust site.
     """
     OrganisationsPage(page).go_to_organisations_and_site_details_page()
     OrganisationsAndSiteDetails(page).go_to_list_all_sites()
     ListAllSites(page).select_site_type_option(SiteType.NHS_TRUST_SITE)
     ListAllSites(page).click_create_new_site()
-    CreateSite(page).fill_site_code("Z9Z1X")
+    CreateSite(page).fill_site_code(NHS_TRUST_SITE_CODE)
     CreateSite(page).fill_site_name("TEST ANANA NHS TRUST SITE")
     CreateSite(page).click_start_date_calendar()
     CalendarPicker(page).select_day(datetime.today())
@@ -92,6 +97,7 @@ def test_create_new_nhs_trust_site_z9z1x_using_ccreate_site(page) -> None:
     CreateSite(page).verify_success_message()
 
 
+@pytest.mark.wip
 @pytest.mark.regression
 @pytest.mark.organisations_users_and_contacts_tests
 @pytest.mark.organisations_and_contacts_develop_level_tests
@@ -102,15 +108,16 @@ def test_view_and_edit_organisation_values_z9z1s(page) -> None:
     OrganisationsPage(page).go_to_organisations_and_site_details_page()
     OrganisationsAndSiteDetails(page).go_to_list_all_organisations()
     ListAllOrganisations(page).select_organisation_type_option(OrganisationType.ICB)
-    ListAllOrganisations(page).search_organisation_code("Z9Z1S")
+    ListAllOrganisations(page).search_organisation_code(ICB_ORGANISATION_CODE)
     ListAllOrganisations(page).click_first_link_in_table()
-    ViewOrganisation(page).verify_organisation_type_details("Z9Z1S")
+    ViewOrganisation(page).verify_organisation_type_details(ICB_ORGANISATION_CODE)
     ViewOrganisation(page).verify_organisation_code_details("ICB")
     ViewOrganisation(page).click_edit_button()
-    ViewOrganisation(page).verify_organisation_type_details("Z9Z1S")
+    ViewOrganisation(page).verify_organisation_type_details(ICB_ORGANISATION_CODE)
     ViewOrganisation(page).verify_organisation_code_details("ICB")
 
 
+@pytest.mark.wip
 @pytest.mark.regression
 @pytest.mark.organisations_users_and_contacts_tests
 @pytest.mark.organisations_and_contacts_develop_level_tests
@@ -119,15 +126,16 @@ def test_remove_all_created_organisation(page) -> None:
     Verifies that the 'Remove All Created Organisation' functionality works correctly
     """
     OrganisationsPage(page).go_to_organisations_and_site_details_page()
-    delete_organisations_created_for_test(["Z9Z1S"])
+    delete_organisations_created_for_test([ICB_ORGANISATION_CODE])
     OrganisationsAndSiteDetails(page).go_to_list_all_organisations()
     ListAllOrganisations(page).select_organisation_type_option(OrganisationType.CCG)
-    ListAllOrganisations(page).search_organisation_code("Z9Z1X")
+    ListAllOrganisations(page).search_organisation_code(NHS_TRUST_SITE_CODE)
     ListAllOrganisations(page).verify_no_organisation_record_found(
         "Sorry, no records match your search criteria. Please refine your search and try again."
     )
 
 
+@pytest.mark.wip
 @pytest.mark.regression
 @pytest.mark.organisations_users_and_contacts_tests
 @pytest.mark.organisations_and_contacts_develop_level_tests
@@ -137,10 +145,10 @@ def test_remove_all_created_sites(page) -> None:
     Verifies that the 'Remove All Created Sites' functionality works correctly
     """
     OrganisationsPage(page).go_to_organisations_and_site_details_page()
-    delete_sites_created_for_test(["Z9Z1X"])
+    delete_sites_created_for_test([NHS_TRUST_SITE_CODE])
     OrganisationsAndSiteDetails(page).go_to_list_all_sites()
     ListAllSites(page).select_site_type_option(SiteType.NHS_TRUST_SITE)
-    ListAllSites(page).search_site_code("Z9Z1X")
+    ListAllSites(page).search_site_code(NHS_TRUST_SITE_CODE)
     ListAllSites(page).verify_no_site_record_found(
         "Sorry, no records match your search criteria. Please refine your search and try again."
     )

users.json

@@ -56,8 +56,10 @@
       "Hub Manager, Southern Bowel Cancer Screening Programme Hub"
     ]
   },
-    "Bureau Staff": {
+    "BCSS Bureau Staff": {
     "username": "BCSS33",
+    "role_id": 5042,
+    "org_code": "X26",
     "roles": [
       "BCSS Bureau Staff"
     ]