Fix: [AEA-0000] - Fix header link behaviour (#218)

## Summary

- Routine Change

### Details

The header link behaviour was getting unwieldy and straying a bit too
far from what we intended. This brings it back in line.

Author: wildjames

features/cpts_ui/change_role_no_access.feature

@@ -1,6 +1,6 @@
 @cpts_ui @change_role @no_access @regression @blocker @smoke @ui
 @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4653
-Feature: Users are able to change their roles, if they have no role with access.
+Feature: Users are unable to change their roles, if they have no role with access.
 
   Background:
     Given I am logged in without access
@@ -15,10 +15,6 @@ Feature: Users are able to change their roles, if they have no role with access.
   ############################################################################
   # Expanding/collapsing the summary
   ############################################################################
-  Scenario: User can expand the change role 'Roles without access' to see table contents
-    When I click on the change role summary expander
-    Then I see the change role roles without access table
-
   Scenario: User can collapse the change role 'Roles without access' to hide table contents
     Given the summary table body is displayed
     When I click on the change role summary expander

features/cpts_ui/change_role_one_with_access.feature

@@ -5,10 +5,9 @@ Feature: Users are able to change their roles, if they have one role with access
   Background:
     Given I am logged in with a single access role
 
-  
   Scenario: User is automatically redirected to the 'search for a prescription' page
-    When I navigate to the change your role page
     Then I am on the search for a prescription page
+    And I do not see the "Change Role" link
 
   Scenario: User does not have the change role link in the header
     Then I do not see the change role page header link

features/cpts_ui/header_links.feature

@@ -0,0 +1,79 @@
+@cpts_ui @header_links @regression @blocker @smoke @ui
+@allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-XXXX
+Feature: Header links are displayed according to the user's state and the current page
+
+  ############################################################################
+  # EXIT
+  ############################################################################
+  Scenario: Exit link is shown on the logout page once the user signs out
+    Given I am logged in
+    And The logout confirmation modal is displayed
+    When I confirm the logout
+    Then I see the "Exit" link
+
+  Scenario: Exit link is shown on the select your role page if the user has no roles with access
+    Given I am logged in without access
+    Then I see the "Exit" link
+
+  Scenario: Exit link is not shown if user has at least one role with access on the select your role page
+    Given I am logged in with a single access role
+    Then I do not see the "Exit" link
+
+  ############################################################################
+  # LOGOUT
+  ############################################################################
+  Scenario: Logout link is shown for a logged in user
+    Given I am logged in
+    Then I see the "Logout" link
+
+  Scenario: Logout link is not shown if user is not logged in
+    Given I am on the home page
+    Then I do not see the "Logout" link
+
+  ############################################################################
+  # SELECT YOUR ROLE
+  ############################################################################
+  Scenario: Select Your Role link is shown on the homepage, if we dont select a role
+    Given I am logged in
+    And I am on the home page
+    Then I see the "Select Your Role" link
+
+  Scenario: Select Your Role link is not shown if I go to the select your role page
+    Given I am logged in
+    And I go to the select your role page
+    Then I do not see the "Select Your Role" link
+
+  Scenario: Select Your Role link is not shown if I already have a selected role
+    Given I am logged in
+    And I have a selected role
+    And I am on the homepage
+    Then I do not see the "Select Your Role" link
+
+  ############################################################################
+  # CHANGE ROLE
+  ############################################################################
+  Scenario: Change Role link is shown if the user has a selected role
+    Given I am logged in
+    And I have a selected role
+    And I am on the home page
+    Then I see the "Change Role" link
+
+  Scenario: Change Role link is not shown if the user has no selected role
+    Given I am logged in
+    And I am on the homepage
+    Then I do not see the "Change Role" link
+
+  # FIXME: Address this when the SPA is fixed!
+  # Since the SPA is broken, there's actually no reliable way to navigate to the SYR page 
+  # once you've selected a role!
+  # @fixme
+  # Scenario: Change Role link is not shown if I go to the select your role page
+  #   Given I am logged in
+  #   And I have a selected role
+  #   And I go to the select your role page
+  #   Then I do not see the "Change Role" link
+
+  Scenario: Change Role link is not shown if I am on the change role page
+    Given I am logged in
+    When I go to change my role
+    Then I do not see the "Change Role" link

features/cpts_ui/home.feature

@@ -15,7 +15,6 @@ Feature: I can visit the Clinical Prescription Tracker Service Website
   Scenario: user can see the header
     Given I am on the homepage
     Then I can see the header
-    # And I can see the links on the header
 
   @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4513
   Scenario: user sees a menu with links when the screen size is small

features/steps/__init__.py

@@ -4,3 +4,4 @@
 from cpts_ui.select_your_role_steps import *  # noqa: F403,F401
 from cpts_ui.change_role_steps import *  # noqa: F403,F401
 from cpts_ui.logout_steps import *  # noqa: F403,F401
+from cpts_ui.header_steps import *  # noqa: F403,F401

features/steps/cpts_ui/change_role_steps.py

@@ -1,5 +1,6 @@
 # pylint: disable=no-name-in-module
 import re
+from time import sleep
 from behave import given, when, then  # pyright: ignore [reportAttributeAccessIssue]
 from playwright.sync_api import expect
 
@@ -17,10 +18,10 @@
 
 @given("I am on the change your role page")
 def given_i_am_on_the_change_role_page(context):
-    context.execute_steps("when I navigate to the change your role page")
+    context.execute_steps("when I go to change my role")
     change_role_page = ChangeRole(context.page)
 
-    change_role_page.page.wait_for_url(change_role_url_pattern)
+    expect(change_role_page.change_role_title).to_be_visible(timeout=60000)
 
 
 @given("the summary table body is displayed")
@@ -68,13 +69,15 @@ def when_i_click_change_role_header_link(context):
     change_role_page.page.get_by_test_id("eps_header_changeRoleLink").click()
 
 
-@when("I navigate to the change your role page")
-def when_i_navigate_to_the_change_your_role_page(context):
+@when("I go to change my role")
+def i_go_to_change_my_role(context):
+    context.execute_steps("Given I have a selected role")
     change_role_page = ChangeRole(context.page)
 
-    change_role_page.page.goto(context.cpts_ui_base_url + "site")
+    # We need to give the backend time to catch up?
+    sleep(1)
     change_role_page.change_role_header.click()
-    change_role_page.page.wait_for_url(change_role_url_pattern, timeout=5000)
+    change_role_page.page.wait_for_url(change_role_url_pattern)
 
 
 ############################################################################

features/steps/cpts_ui/header_steps.py

@@ -0,0 +1,53 @@
+# pylint: disable=no-name-in-module
+from behave import then  # pyright: ignore [reportAttributeAccessIssue]
+from playwright.sync_api import expect
+
+from pages.header_links import HeaderLinks
+
+
+@then('I see the "Exit" link')
+def i_see_exit_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.exit_link).to_be_visible()
+
+
+@then('I do not see the "Exit" link')
+def dont_see_exit_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.exit_link).not_to_be_visible()
+
+
+@then('I see the "Logout" link')
+def i_see_logout_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.logout_link).to_be_visible()
+
+
+@then('I do not see the "Logout" link')
+def dont_see_logout_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.logout_link).not_to_be_visible()
+
+
+@then('I see the "Select Your Role" link')
+def i_see_select_role_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.select_role_link).to_be_visible()
+
+
+@then('I do not see the "Select Your Role" link')
+def dont_see_select_role_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.select_role_link).not_to_be_visible()
+
+
+@then('I see the "Change Role" link')
+def i_see_change_role_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.change_role_link).to_be_visible()
+
+
+@then('I do not see the "Change Role" link')
+def dont_see_change_role_link(context):
+    header_links = HeaderLinks(context.page)
+    expect(header_links.change_role_link).not_to_be_visible()

features/steps/cpts_ui/select_your_role_steps.py

@@ -11,6 +11,14 @@ def i_go_to_the_select_your_role_page(context):
     context.page.get_by_test_id("eps_header_selectYourRoleLink").click()
 
 
+@given("I have a selected role")
+def i_have_selected_role(context):
+    context.execute_steps("given I go to the select your role page")
+
+    select_your_role_page = SelectYourRole(context.page)
+    select_your_role_page.first_role_card.click()
+
+
 @then("I can see the summary container")
 def i_can_see_the_summary_container(context):
     select_your_role_page = SelectYourRole(context.page)

pages/change_role.py

@@ -9,6 +9,7 @@ def __init__(self, page: Page):
         self.page = page
 
         # Title and summary locators
+        self.change_role_title = page.get_by_text("Change your role")
         self.roles_without_access_table = page.locator("summary")
         self.roles_without_access_organisation_column_header = page.get_by_role(
             "columnheader", name="Organisation"

pages/header_links.py

@@ -0,0 +1,11 @@
+from playwright.sync_api import Page
+
+
+class HeaderLinks:
+    def __init__(self, page: Page):
+        self.page = page
+
+        self.exit_link = page.get_by_test_id("eps_header_exit")
+        self.logout_link = page.get_by_test_id("eps_header_logout")
+        self.select_role_link = page.get_by_test_id("eps_header_selectYourRoleLink")
+        self.change_role_link = page.get_by_test_id("eps_header_changeRoleLink")