refactoring

Author: Andyg79

tests/regression/communications_production/test_basic_active_batch_list_functionality.py

@@ -11,29 +11,28 @@
 )
 
 
-@pytest.fixture
-def select_user(page: Page):
-    def _login_as(user_role: str):
-        # Log in with the specified user
-        UserTools.user_login(page, user_role)
-        # Navigate to Active Batch List
-        BasePage(page).go_to_communications_production_page()
-        CommunicationsProductionPage(page).go_to_active_batch_list_page()
-        return page
+@pytest.fixture(scope="function", autouse=True)
+def before_each(page: Page):
+    """
+    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the active batch list page
+    """
+    # Log in to BCSS
+    UserTools.user_login(page, "Hub Manager at BCS01")
 
-    return _login_as
+    # Go to active batch list page
+    BasePage(page).go_to_communications_production_page()
+    CommunicationsProductionPage(page).go_to_active_batch_list_page()
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_headings_on_active_batch_list_screen(select_user) -> None:
+def test_headings_on_active_batch_list_screen(page: Page) -> None:
     """
     Scenario: Check headings on Active Batch List Screen
     Given I log in to BCSS "England" as user role "HubManager"
     When I view the active batch list
     Then the table contains a sortable and filterable column for "<Column Name>"
     """
-    page = select_user("Hub Manager at BCS01")
     batch_list_page = ActiveBatchListPage(page)
 
     expected_columns = [
@@ -49,37 +48,36 @@ def test_headings_on_active_batch_list_screen(select_user) -> None:
         "Deadline",
         "Count",
     ]
-
+    # The table contains a sortable and filterable column for each expected header
     for column in expected_columns:
-        # Step 1: Ensure the column is present
+        # Ensure the column is present
         batch_list_page.assert_column_present(column)
 
-        # Step 2: Assert sortable UI attribute is present
+        # Assert sortable UI attribute is present
         batch_list_page.assert_column_sortable(column)
 
-        # Step 3: Assert filterable control is rendered
+        # Assert filterable control is rendered
         batch_list_page.assert_column_filterable(column)
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_navigation_to_manage_active_batch_screen(select_user) -> None:
+def test_navigation_to_manage_active_batch_screen(page: Page) -> None:
     """
     Scenario: Check navigation from Active Batch List Screen to Manage Active Batch Screen
     Given I log in to BCSS "England" as user role "HubManager"
     When I view the active batch list
     And I select an active batch
     Then I view the details of an active batch
     """
-    page = select_user("Hub Manager at BCS01")
     batch_list_page = ActiveBatchListPage(page)
 
-    # Step 1: Ensure the batch list table is visible
+    # Ensure the batch list table is visible
     batch_list_page.assert_batch_table_visible()
 
-    # Step 2: Click into the first available batch link (usually ID column)
+    # Click into the first available batch link
     batch_list_page.select_first_active_batch()
 
-    # Step 3: Assert navigation to the Manage Active Batch page
+    # Assert navigation to the Manage Active Batch page
     manage_batch_page = ManageActiveBatchPage(page)
     manage_batch_page.assert_active_batch_details_visible()

tests/regression/communications_production/test_basic_archived_batch_list_functionality.py

@@ -13,29 +13,28 @@
 )
 
 
-@pytest.fixture
-def select_user(page: Page):
-    def _login_as(user_role: str):
-        # Log in with the specified user
-        UserTools.user_login(page, user_role)
-        # Navigate to Active Batch List
-        BasePage(page).go_to_communications_production_page()
-        CommunicationsProductionPage(page).go_to_archived_batch_list_page()
-        return page
+@pytest.fixture(scope="function", autouse=True)
+def before_each(page: Page):
+    """
+    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the archived batch list page
+    """
+    # Log in to BCSS
+    UserTools.user_login(page, "Hub Manager at BCS01")
 
-    return _login_as
+    # Go to active batch list page
+    BasePage(page).go_to_communications_production_page()
+    CommunicationsProductionPage(page).go_to_archived_batch_list_page()
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_headings_on_archived_batch_list_screen(select_user) -> None:
+def test_headings_on_archived_batch_list_screen(page: Page) -> None:
     """
     Scenario: Check headings on Archived Batch List Screen
     Given I log in to BCSS "England" as user role "HubManager"
     When I view the archived batch list
     Then the table contains a sortable and filterable column for each expected header
     """
-    page = select_user("Hub Manager at BCS01")
 
     archived_batch_list_page = ArchivedBatchListPage(page)
 
@@ -54,37 +53,36 @@ def test_headings_on_archived_batch_list_screen(select_user) -> None:
         "Date Archived",
         "Count",
     ]
-
+    # The table contains a sortable and filterable column for each expected header
     for column in expected_columns:
-        # Step 1: Ensure the column is present
+        # Ensure the column is present
         archived_batch_list_page.assert_column_present(column)
 
-        # Step 2: Assert sortable UI attribute is present
+        # Assert sortable UI attribute is present
         archived_batch_list_page.assert_column_sortable(column)
 
-        # Step 3: Assert filterable control is rendered
+        # Assert filterable control is rendered
         archived_batch_list_page.assert_column_filterable(column)
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_navigation_to_manage_archived_batch_screen(select_user) -> None:
+def test_navigation_to_manage_archived_batch_screen(page: Page) -> None:
     """
     Scenario: Check navigation from Archived Batch List Screen to Manage Archived Batch Screen
     Given I log in to BCSS "England" as user role "HubManager"
     When I view the archived batch list
     And I select an archived batch
     Then I view the details of an archived batch
     """
-    page = select_user("Hub Manager at BCS01")
     archived_batch_list_page = ArchivedBatchListPage(page)
 
-    # Step 1: Ensure the archived batch table is visible
+    # Ensure the archived batch table is visible
     archived_batch_list_page.assert_batch_table_visible()
 
-    # Step 2: Click into the first available archived batch
+    # Click into the first available archived batch
     archived_batch_list_page.select_first_archived_batch()
 
-    # Step 3: Assert navigation to the Manage Archived Batch page
+    # Assert navigation to the Manage Archived Batch page
     manage_batch_page = ManageArchivedBatchPage(page)
     manage_batch_page.assert_archived_batch_details_visible()

tests/regression/communications_production/test_basic_manage_active_batch_functionality.py

@@ -12,22 +12,22 @@
 from utils.batch_processing import prepare_and_print_batch
 
 
-@pytest.fixture
-def select_user(page: Page):
-    def _login_as(user_role: str):
-        # Log in with the specified user
-        UserTools.user_login(page, user_role)
-        # Navigate to Active Batch List
-        BasePage(page).go_to_communications_production_page()
-        CommunicationsProductionPage(page).go_to_active_batch_list_page()
-        return page
+@pytest.fixture(scope="function", autouse=True)
+def before_each(page: Page):
+    """
+    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the active batch list page
+    """
+    # Log in to BCSS
+    UserTools.user_login(page, "Hub Manager at BCS01")
 
-    return _login_as
+    # Go to active batch list page
+    BasePage(page).go_to_communications_production_page()
+    CommunicationsProductionPage(page).go_to_active_batch_list_page()
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_prepare_retrieve_and_confirm_active_letter_batch(select_user) -> None:
+def test_prepare_retrieve_and_confirm_active_letter_batch(page: Page) -> None:
     """
     Scenario: I can prepare, retrieve and confirm a letter batch of any number of files
     Given I log in to BCSS "England" as user role "HubManagerStateRegistered"
@@ -37,25 +37,24 @@ def test_prepare_retrieve_and_confirm_active_letter_batch(select_user) -> None:
     And I prepare the letter batch
     And I retrieve and confirm the letters
     """
-    # Step 1: Log in as Hub Manager (State Registered) and access Active Batch List
-    page = select_user("Hub Manager State Registered at BCS01")
+    # Access Active Batch List
     batch_list_page = ActiveBatchListPage(page)
 
-    # Step 2: Ensure the active batch list table is visible
+    # Ensure the active batch list table is visible
     batch_list_page.assert_batch_table_visible()
 
-    # Step 3: Locate the first batch with type "Original" and status "Open"
+    # Locate the first batch with type "Original" and status "Open"
     row = batch_list_page.get_open_original_batch_row()
     if not row:
         pytest.skip("No open 'Original' batches found in the active batch list.")
 
-    # Step 4: Capture the batch ID from the selected row and click to open
+    # Capture the batch ID from the selected row and click to open
     batch_id = row.locator("a").first.inner_text()
     row.locator("a").first.click()
 
-    # Step 5: Assert that Manage Active Batch page has loaded
+    # Assert that Manage Active Batch page has loaded
     manage_page = ManageActiveBatchPage(page)
     manage_page.assert_active_batch_details_visible()
 
-    # Step 6: Prepare, retrieve and confirm the batch using utility method
+    # Prepare, retrieve and confirm the batch using utility method
     prepare_and_print_batch(page, link_text=batch_id)

tests/regression/communications_production/test_basic_manage_archived_batch_functionality.py

@@ -18,21 +18,21 @@
 from utils.batch_processing import prepare_and_print_batch
 
 
-@pytest.fixture
-def select_user(page: Page):
-    def _login_as(user_role: str):
-        # Log in with the specified user
-        UserTools.user_login(page, user_role)
-        # Navigate to communications production page
-        BasePage(page).go_to_communications_production_page()
-        return page
+@pytest.fixture(scope="function", autouse=True)
+def before_each(page: Page):
+    """
+    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the communications production page
+    """
+    # Log in to BCSS
+    UserTools.user_login(page, "Hub Manager at BCS01")
 
-    return _login_as
+    # Go to communications production page
+    BasePage(page).go_to_communications_production_page()
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_reprint_and_archive_letter_batch(select_user) -> None:
+def test_reprint_and_archive_letter_batch(page: Page) -> None:
     """
     Scenario: I can take an archived batch, reprint it, then archive that new batch
     Given I log in to BCSS "England" as user role "HubManagerStateRegistered"
@@ -43,13 +43,12 @@ def test_reprint_and_archive_letter_batch(select_user) -> None:
     And I retrieve and confirm the letters
     And my batch is now archived
     """
-    # Step 1: Log in as user and navigate to Archived Batch List
-    page = select_user("Hub Manager State Registered at BCS01")
+    # Navigate to Archived Batch List
     CommunicationsProductionPage(page).go_to_archived_batch_list_page()
-    batch_list_page = ArchivedBatchListPage(page)
+    archived_batch_list_page = ArchivedBatchListPage(page)
 
-    # Step 2: Ensure the archived batch list table is visible
-    batch_list_page.assert_batch_table_visible()
+    # Ensure the archived batch list table is visible
+    archived_batch_list_page.assert_batch_table_visible()
     # Wait for at least one row to appear
     page.wait_for_function(
         "document.querySelectorAll('table#batchList tbody tr').length > 1", timeout=8000
@@ -60,9 +59,9 @@ def test_reprint_and_archive_letter_batch(select_user) -> None:
     for i in range(row_count):
         row = rows.nth(i)
 
-    # Step 3: Find and open archived batch with Type "Original", Event Code "S1", and Description "Pre"
+    # Find and open archived batch with Type "Original", Event Code "S1", and Description "Pre"
     # You might want to use filters like:
-    row = batch_list_page.get_archived_batch_row(
+    row = archived_batch_list_page.get_archived_batch_row(
         "Original", "S1", "Pre-invitation (FIT)"
     )
     if not row:
@@ -71,27 +70,26 @@ def test_reprint_and_archive_letter_batch(select_user) -> None:
     batch_id = row.locator("a").first.inner_text()
     row.locator("a").first.click()
 
-    # Step 4: Perform reprint from Archived Batch detail screen
+    # Perform reprint from Archived Batch detail screen
     manage_archived_page = ManageArchivedBatchPage(page)  # Assuming reuse
     manage_archived_page.assert_archived_batch_details_visible()
     manage_archived_page.click_reprint_button()
     BasePage(page).safe_accept_dialog(page.get_by_role("button", name="Reprint Batch"))
 
-    # Step 5: Wait for navigation to new Active Batch screen
-    # You’ll likely land back in Active Batch context
+    # Wait for navigation to new Active Batch screen
     manage_active_page = ManageActiveBatchPage(page)
     manage_active_page.assert_active_batch_details_visible()
 
-    # Step 6: Prepare, retrieve and confirm new batch
+    # Prepare, retrieve and confirm new batch
     prepare_and_print_batch(page, link_text=batch_id)
 
-    # Step 7: Assert batch archived successfully
+    # Assert batch archived successfully
     manage_archived_page.confirm_archived_message_visible()
 
 
 @pytest.mark.letters_tests
 @pytest.mark.regression
-def test_check_that_s1_has_supplementary_batches(select_user) -> None:
+def test_check_that_s1_has_supplementary_batches(page: Page) -> None:
     """
     Scenario: I can create a supplementary batch for S1 and archive it
     Given I log in to BCSS "England" as user role "HubManagerStateRegistered"
@@ -101,14 +99,14 @@ def test_check_that_s1_has_supplementary_batches(select_user) -> None:
     And I Go to letter library index and filter by Supplementary Letters
     And I Open a supplementary letter
     """
-    # Step 1: Log in as user and navigate to Letter Library Index
-    page = select_user("Hub Manager State Registered at BCS01")
+
+    # Navigate to Letter Library Index
     CommunicationsProductionPage(page).go_to_letter_library_index_page()
 
-    # Step 2: Filter for "Invitation Letters" group
+    # Filter for "Invitation Letters" group
     LetterLibraryIndexPage(page).filter_by_letters_group("Invitation Letters")
 
-    # Step 3: Ensure S1 supplementary batches can be created
+    # Ensure S1 supplementary batches can be created
     LetterLibraryIndexPage(page).filter_by_event_code("S1")
     LetterLibraryIndexPage(page).click_first_letter_code_link_in_table()
     LetterLibraryIndexPage(page).click_define_supplementary_letter_button()
@@ -122,11 +120,11 @@ def test_check_that_s1_has_supplementary_batches(select_user) -> None:
     )
     expect(page.locator("#ntshPageTitle")).to_contain_text("Version History")
 
-    # Step 4: Go to letter library index and filter by Supplementary Letters
+    # Go to letter library index and filter by Supplementary Letters
     BasePage(page).click_main_menu_link()
     BasePage(page).go_to_communications_production_page()
     CommunicationsProductionPage(page).go_to_letter_library_index_page()
     LetterLibraryIndexPage(page).filter_by_letters_group("Supplementary Letters")
 
-    # Step 5: Open a supplementary letter
+    # Open a supplementary letter
     LetterLibraryIndexPage(page).click_first_letter_code_link_in_table()