Chore: [AEA-4518] - and [AEA-4516] search for a prescription tabs and hero banner (#195)

## Summary

- Routine Change

### Details

- Tests for AEA-4516 and AEA-4518
- Refactoring of classes for page objects
- Steps for UI-related steps now in sub folders for better organisation

Author: seansteberisal

Makefile

@@ -70,8 +70,7 @@ pre-commit: git-secrets-docker-setup
 	poetry run pre-commit run --all-files
 
 git-secrets-docker-setup:
-	LOCAL_WORKSPACE_FOLDER=$(pwd)
-	export LOCAL_WORKSPACE_FOLDER=$(LOCAL_WORKSPACE_FOLDER)
+	export LOCAL_WORKSPACE_FOLDER=$(pwd)
 	docker build -f https://raw.githubusercontent.com/NHSDigital/eps-workflow-quality-checks/refs/tags/v4.0.4/dockerfiles/nhsd-git-secrets.dockerfile -t git-secrets .
 
 download-allure-report: guard-GITHUB_RUN_ID

features/cpts_ui/home_page.feature features/cpts_ui/home.featurefeatures/cpts_ui/home_page.feature renamed to features/cpts_ui/home.feature

@@ -20,5 +20,11 @@ Feature: I can visit the Clinical Prescription Tracker Service Website
   @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4513
   Scenario: user sees a menu with links when the screen size is small
     Given I am on the homepage
-    When I have a screen size of 900 pixels wide
+    When I have a screen size of 690 pixels wide
     Then I can see the header links in a dropdown menu
+
+  @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4518
+  Scenario: user can visit the search for a prescription page
+    Given I am on the homepage
+    When I click on Find a prescription
+    Then I am on the search for a prescription page

features/cpts_ui/search_for_a_prescription.feature

@@ -0,0 +1,22 @@
+@cpts_ui @home @regression @blocker @smoke @ui
+@allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4460
+Feature: I can visit the Clinical Prescription Tracker Service Website
+
+  @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4516
+  Scenario: User can view the Search For A Prescription Page
+    Given I am on the homepage
+    When I click on Find a prescription
+    Then I am on the search for a prescription page
+    And I can see the search for a prescription header
+
+
+  @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4518
+  Scenario Outline: user can switch between different tabs
+    Given I am on the search for a prescription page
+    When I click on tab <Tab Name>
+    Then I am on tab <Tab Name>
+    Examples:
+      | Tab Name               |
+      | Prescription ID search |
+      | NHS Number Search      |
+      | Basic Details Search   |

features/environment.py

@@ -91,6 +91,15 @@ def count_of_scenarios_to_run(context):
     return total_scenarios
 
 
+def before_scenario(context, scenario):
+    product = context.config.userdata["product"].upper()
+    if product == "CPTS-UI":
+        global _page
+        context.page = context.browser.new_page()
+        _page = context.page
+        set_page(context, _page)
+
+
 def before_all(context):
     product = context.config.userdata["product"].upper()
     if count_of_scenarios_to_run(context) != 0:
@@ -118,10 +127,7 @@ def before_all(context):
     if product == "CPTS-UI":
         global _page
         playwright = sync_playwright().start()
-        browser = playwright.chromium.launch(headless=True, channel="chrome")
-        context.page = browser.new_page()
-        _page = context.page
-        set_page(context, _page)
+        context.browser = playwright.chromium.launch(headless=True, channel="chrome")
 
     eps_api_methods.calculate_eps_fhir_base_url(context)
     print("CPTS-UI: ", context.cpts_ui_base_url)

features/steps/__init__.py

@@ -0,0 +1,2 @@
+from cpts_ui.search_for_a_prescription_steps import *  # noqa: F403,F401
+from cpts_ui.home_steps import *  # noqa: F403,F401

features/steps/cpts_ui/home_steps.py

@@ -0,0 +1,65 @@
+# pylint: disable=no-name-in-module
+from behave import given, when, then  # pyright: ignore [reportAttributeAccessIssue]
+from playwright.sync_api import expect
+
+from pages.home import Home
+
+
+@when("I go to the homepage")
+def goto_page(context):
+    context.page.goto(context.cpts_ui_base_url + "site/")
+
+
+@given("I am on the homepage")
+def i_am_on_the_home_page(context):
+    goto_page(context)
+    home_page = Home(context.page)
+    home_page.page.is_visible(home_page.header)
+
+
+@then("I am on the homepage")
+def verify_on_home_page(context):
+    home_page = Home(context.page)
+    home_page.page.is_visible(home_page.header)
+
+
+@then("I can see the footer")
+def i_can_see_the_footer(context):
+    home_page = Home(context.page)
+    home_page.page.is_visible(home_page.footer)
+
+
+@then("I can see the header")
+def i_can_see_the_header(context):
+    home_page = Home(context.page)
+    home_page.page.is_visible(home_page.header)
+
+
+@then("I can see the links on the header")
+def i_can_see_the_links_on_the_header(context):
+    home_page = Home(context.page)
+    expect(home_page.confirm_role_link).to_be_visible()
+    expect(home_page.find_a_prescription_link).to_be_visible()
+
+
+@when("I have a screen size of {pixel_width} pixels wide")
+def i_have_a_screen_size_of_x_pixels_wide(context, pixel_width):
+    context.page.set_viewport_size({"width": int(pixel_width), "height": 1200})
+
+
+@then("I can see the header links in a dropdown menu")
+def i_can_see_the_header_links_in_a_dropdown_menu(context):
+    home_page = Home(context.page)
+    expect(home_page.menu_button).to_be_visible()
+    home_page.menu_button.click()
+    expect(home_page.confirm_role_link).to_be_visible()
+    expect(home_page.find_a_prescription_link).to_be_visible()
+    home_page.menu_button.click()
+    expect(home_page.confirm_role_link).to_be_visible(visible=False)
+    expect(home_page.find_a_prescription_link).to_be_visible(visible=False)
+
+
+@when("I click on Find a prescription")
+def step_impl(context):
+    home_page = Home(context.page)
+    home_page.find_a_prescription_link.click()

features/steps/cpts_ui/search_for_a_prescription_steps.py

@@ -0,0 +1,80 @@
+# pylint: disable=no-name-in-module
+from behave import given, when, then  # pyright: ignore [reportAttributeAccessIssue]
+from playwright.sync_api import expect
+
+from pages.home import Home
+from pages.search_for_a_prescription import SearchForAPrescription
+
+
+@when("I go to the search for a prescription page")
+def goto_page(context):
+    context.page.goto(context.cpts_ui_base_url + "site/")
+    home = Home(context.page)
+    home.find_a_prescription_link.click()
+
+
+@given("I am on the search for a prescription page")
+def go_to_search_prescription_page(context):
+    context.execute_steps("when I go to the search for a prescription page")
+    expect(context.page).to_have_title("Search for a prescription")
+
+
+@then("I am on the search for a prescription page")
+def i_am_on_the_search_prescription_page(context):
+    expect(context.page).to_have_title("Search for a prescription")
+
+
+@when("I click on tab {}")
+def i_click_on_tab(context, tab_name):
+    search_for_a_prescription = SearchForAPrescription(context.page)
+    match tab_name.lower():
+        case "prescription id search":
+            search_for_a_prescription.prescription_id_search_tab.click()
+        case "nhs number search":
+            search_for_a_prescription.nhs_number_search_tab.click()
+        case "basic details search":
+            search_for_a_prescription.basic_details_search_tab.click()
+        case _:
+            raise AssertionError("Unknown tab {}".format(tab_name))
+
+
+@then("I am on tab {}")
+def i_am_on_tab(context, tab_name):
+    search_for_a_prescription = SearchForAPrescription(context.page)
+    match tab_name.lower():
+        case "prescription id search":
+            expect(
+                search_for_a_prescription.prescription_id_search_header
+            ).to_be_visible()
+            expect(search_for_a_prescription.nhs_number_search_header).to_be_visible(
+                visible=False
+            )
+            expect(search_for_a_prescription.basic_details_search_header).to_be_visible(
+                visible=False
+            )
+        case "nhs number search":
+            expect(
+                search_for_a_prescription.prescription_id_search_header
+            ).to_be_visible(visible=False)
+            expect(search_for_a_prescription.nhs_number_search_header).to_be_visible()
+            expect(search_for_a_prescription.basic_details_search_header).to_be_visible(
+                visible=False
+            )
+        case "basic details search":
+            expect(
+                search_for_a_prescription.prescription_id_search_header
+            ).to_be_visible(visible=False)
+            expect(search_for_a_prescription.nhs_number_search_header).to_be_visible(
+                visible=False
+            )
+            expect(
+                search_for_a_prescription.basic_details_search_header
+            ).to_be_visible()
+        case _:
+            raise AssertionError("Unknown tab {}".format(tab_name))
+
+
+@then("I can see the search for a prescription header")
+def i_can_see_the_search_for_a_prescription_header(context):
+    search_for_a_prescription = SearchForAPrescription(context.page)
+    expect(search_for_a_prescription.hero_banner).to_be_visible()

features/steps/cpts_ui_home_page_steps.py

@@ -0,0 +1,14 @@
+from playwright.sync_api import Page
+
+
+class Home:
+
+    def __init__(self, page: Page):
+        self.page = page
+        self.header = "[id='eps_header']"
+        self.footer = "[id='eps_footer']"
+        self.confirm_role_link = self.page.get_by_test_id("eps_header_confirmRoleLink")
+        self.find_a_prescription_link = self.page.get_by_test_id(
+            "eps_header_prescriptionSearchLink"
+        )
+        self.menu_button = self.page.get_by_role("button", name="Browse Menu")