clean up on tests to have them be consistent.

Author: philimon-reset

modules/browser_object_find_toolbar.py

@@ -84,9 +84,7 @@ def previous_match(self) -> BasePage:
     @BasePage.context_chrome
     def rewind_to_first_match(self) -> BasePage:
         """Go back to match 1 of n"""
-        print(self.match_dict)
         while self.match_dict["current"] != 1:
-            print(self.match_dict)
             self.previous_match()
         return self
 

tests/pdf_viewer/test_add_image_pdf.py

@@ -19,15 +19,14 @@ def test_case():
 
 
 @pytest.mark.headed
-def test_add_image_pdf(driver: Firefox, sys_platform, pdf_file_path: str):
+def test_add_image_pdf(driver: Firefox, sys_platform, pdf_viewer: GenericPdf):
     """
     C2228202: Verify that the user is able to add an image to a PDF file.
 
     Arguments:
         sys_platform: Current System Platform Type
-        pdf_file_path: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
     """
-    pdf_viewer = GenericPdf(driver, pdf_url=f"file://{pdf_file_path}").open()
     context_menu = ContextMenu(driver)
     image_path = Path("data") / IMAGE_FILE_NAME
     pdf_viewer.add_image(str(image_path.absolute()), sys_platform)

tests/pdf_viewer/test_download_pdf_with_form_fields.py

@@ -22,7 +22,7 @@ def delete_files_regex_string():
 @pytest.mark.headed
 def test_download_pdf_with_form_fields(
     driver: Firefox,
-    fillable_pdf_url: str,
+    pdf_viewer: GenericPdf,
     sys_platform,
     delete_files,
     downloads_folder: str,
@@ -34,23 +34,21 @@ def test_download_pdf_with_form_fields(
 
     Arguments:
         sys_platform: Current System Platform Type
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
         downloads_folder: downloads folder path
         delete_files: fixture to remove the files after the test finishes
     """
-
-    pdf_page = GenericPdf(driver, pdf_url=fillable_pdf_url).open()
     keyboard = Controller()
 
     # Fill in the name field and click on download button
-    pdf_page.fill_element("first-name-field", "Mark")
+    pdf_viewer.fill_element("first-name-field", "Mark")
     sleep(2)
 
-    pdf_page.click_download_button()
+    pdf_viewer.click_download_button()
 
     # Allow time for the download dialog to appear and handle the prompt
     sleep(2)
-    pdf_page.handle_os_download_confirmation(keyboard, sys_platform)
+    pdf_viewer.handle_os_download_confirmation(keyboard, sys_platform)
 
     # Allow time for the download to complete
     sleep(3)
@@ -66,4 +64,4 @@ def test_download_pdf_with_form_fields(
     # Open the saved pdf and check if the edited field is displayed
     driver.get("file://" + os.path.realpath(saved_pdf_location))
 
-    pdf_page.element_visible("edited-name-field")
+    pdf_viewer.element_visible("edited-name-field")

tests/pdf_viewer/test_download_triggered_on_content_disposition_attachment.py

@@ -2,8 +2,6 @@
 
 import pytest
 from selenium.webdriver import Firefox
-from selenium.webdriver.common.by import By
-from selenium.webdriver.common.keys import Keys
 
 from modules.browser_object import Navigation, TabBar
 from modules.page_object import AboutPrefs, GenericPdf

tests/pdf_viewer/test_open_pdf_in_FF.py

@@ -16,18 +16,13 @@ def file_name():
     return PDF_FILE_NAME
 
 
-def test_open_pdf_in_fx(driver: Firefox, pdf_file_path: str):
+def test_open_pdf_in_fx(driver: Firefox, pdf_viewer: GenericPdf):
     """
     C936503: PDF files can be successfully opened in Firefox
 
     Arguments:
-        pdf_file_path: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
     """
-
-    file_url = f"file://{pdf_file_path}"
-    pdf = GenericPdf(driver, pdf_url=file_url)
-    pdf.open()
-
     # Verify that the PDF viewer is loaded
-    pdf.url_contains("pdf")
-    pdf.title_contains(PDF_FILE_NAME)
+    pdf_viewer.url_contains("pdf")
+    pdf_viewer.title_contains(PDF_FILE_NAME)

tests/pdf_viewer/test_pdf_data_can_be_cleared.py

@@ -4,6 +4,8 @@
 
 from modules.page_object import GenericPdf
 
+TEST_NAME = "John Doe"
+
 
 @pytest.fixture()
 def test_case():
@@ -20,13 +22,15 @@ def hard_quit():
     return True
 
 
-TEST_NAME = "John Doe"
+@pytest.fixture()
+def file_name():
+    return "i-9.pdf"
 
 
 @pytest.mark.ci
 def test_pdf_data_can_be_cleared(
     driver: Firefox,
-    fillable_pdf_url: str,
+    pdf_viewer: GenericPdf,
     downloads_folder: str,
     sys_platform,
     delete_files,
@@ -36,48 +40,40 @@ def test_pdf_data_can_be_cleared(
 
     Arguments:
         sys_platform: Current System Platform Type
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
         downloads_folder: downloads folder path
         delete_files: fixture to remove the files after the test finishes
     """
-
-    pdf = GenericPdf(driver, pdf_url=fillable_pdf_url)
-    pdf.open()
-
     # Step 1: Click and type inside the text field for the name section
 
-    pdf.fill("first-name-field", TEST_NAME)
-    pdf.element_attribute_contains("first-name-field", "value", TEST_NAME)
+    pdf_viewer.fill("first-name-field", TEST_NAME)
+    pdf_viewer.element_attribute_contains("first-name-field", "value", TEST_NAME)
 
     # Step 2: Click over any checkbox and assert the status is updated
 
-    checkbox = pdf.select_and_return_checkbox("first-checkbox")
-    pdf.element_selected("first-checkbox")
+    checkbox = pdf_viewer.select_and_return_checkbox("first-checkbox")
+    pdf_viewer.element_selected("first-checkbox")
 
     # Step 3: Select an option from a dropdown and verify the selection
 
-    dropdown_option = pdf.select_and_return_dropdown_option(
+    dropdown_option = pdf_viewer.select_and_return_dropdown_option(
         "state-dropdown-field", By.XPATH, "//option[@value='CA']"
     )
-    pdf.expect(lambda _: dropdown_option.is_displayed())
+    pdf_viewer.expect(lambda _: dropdown_option.is_displayed())
 
     # Step 4: Delete the text added in step 1 and ensure the input field is empty
-    pdf.get_element("first-name-field").clear()
-    pdf.expect(lambda _: not pdf.get_element("first-name-field").get_attribute("value"))
+    pdf_viewer.get_element("first-name-field").clear()
+    pdf_viewer.expect(
+        lambda _: not pdf_viewer.get_element("first-name-field").get_attribute("value")
+    )
 
     # Step 5: Click the checkbox from step 2 again and ensure it returns to its previous state
     checkbox.click()
-    pdf.expect(lambda _: not checkbox.is_selected())
+    pdf_viewer.expect(lambda _: not checkbox.is_selected())
 
     # Step 6: Clear the state selection and ensure the field is empty
-    default_option = pdf.select_and_return_dropdown_option(
+    default_option = pdf_viewer.select_and_return_dropdown_option(
         "state-dropdown-field", By.XPATH, "//option[@value=' ']"
     )
     default_option.click()
-    pdf.expect(lambda _: default_option.is_selected())
-
-    # Assert that all fields are reset to their default state
-    assert (
-        pdf.get_element("first-name-field").get_attribute("value") == ""
-    ), "Text field did not reset."
-    assert not checkbox.is_selected(), "Checkbox did not reset."
+    pdf_viewer.expect(lambda _: default_option.is_selected())

tests/pdf_viewer/test_pdf_download.py

@@ -13,11 +13,6 @@ def test_case():
     return "3932"
 
 
-@pytest.fixture()
-def add_prefs():
-    return []
-
-
 @pytest.fixture()
 def delete_files_regex_string():
     return r"i-9.*\.pdf"
@@ -31,7 +26,7 @@ def file_name():
 @pytest.mark.headed
 def test_pdf_download(
     driver: Firefox,
-    fillable_pdf_url: str,
+    pdf_viewer: GenericPdf,
     downloads_folder: str,
     sys_platform,
     delete_files,
@@ -43,28 +38,25 @@ def test_pdf_download(
 
     Arguments:
         sys_platform: Current System Platform Type
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
         downloads_folder: downloads folder path
         delete_files: fixture to remove the files after the test finishes
         file_name: pdf file name
     """
     from pynput.keyboard import Controller
 
-    pdf = GenericPdf(driver, pdf_url=fillable_pdf_url)
-    pdf.open()
-
     keyboard = Controller()
 
     # Click the download button
-    pdf.click_download_button()
+    pdf_viewer.click_download_button()
 
     # Allow time for the download dialog m to appear and pressing enter to download
     sleep(2)
-    pdf.handle_os_download_confirmation(keyboard, sys_platform)
+    pdf_viewer.handle_os_download_confirmation(keyboard, sys_platform)
 
     # Set the expected download path and the expected PDF name
     saved_pdf_location = os.path.join(downloads_folder, file_name)
-    pdf.expect(lambda _: os.path.exists(saved_pdf_location))
+    pdf_viewer.expect(lambda _: os.path.exists(saved_pdf_location))
 
     # Verify if the file exists
     assert os.path.exists(

tests/pdf_viewer/test_pdf_input_numbers.py

@@ -22,9 +22,14 @@ def hard_quit():
     return True
 
 
+@pytest.fixture()
+def file_name():
+    return "i-9.pdf"
+
+
 def test_pdf_input_numbers(
     driver: Firefox,
-    fillable_pdf_url: str,
+    pdf_viewer: GenericPdf,
     downloads_folder: str,
     sys_platform,
     delete_files,
@@ -34,15 +39,13 @@ def test_pdf_input_numbers(
 
     Arguments:
         sys_platform: Current System Platform Type
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
         downloads_folder: downloads folder path
         delete_files: fixture to remove the files after the test finishes
     """
 
-    pdf = GenericPdf(driver, pdf_url=fillable_pdf_url)
-
     # Clear the field and enter the test value
-    pdf.fill_element("zipcode-field", TEST_VALUE + Keys.TAB)
+    pdf_viewer.fill_element("zipcode-field", TEST_VALUE + Keys.TAB)
 
     # Verify the value is still present
-    pdf.element_attribute_contains("zipcode-field", "value", TEST_VALUE)
+    pdf_viewer.element_attribute_contains("zipcode-field", "value", TEST_VALUE)

tests/pdf_viewer/test_zoom_pdf_viewer.py

@@ -13,63 +13,59 @@ def test_case():
 
 
 @pytest.mark.parametrize("control", controls)
-def test_zoom_pdf_viewer_toolbar(driver: Firefox, fillable_pdf_url: str, control: str):
+def test_zoom_pdf_viewer_toolbar(driver: Firefox, pdf_viewer: GenericPdf, control: str):
     """
     C3928: ensure that in the pdf viewer you can zoom in and out
 
     Arguments:
         control: zoom controls
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
     """
-    zoom_pdf_viewer(driver, fillable_pdf_url, control, "Tools")
+    zoom_pdf_viewer(pdf_viewer, control, "Tools")
 
 
 @pytest.mark.parametrize("control", controls)
-def test_zoom_pdf_viewer_keys(driver: Firefox, fillable_pdf_url: str, control: str):
+def test_zoom_pdf_viewer_keys(driver: Firefox, pdf_viewer: GenericPdf, control: str):
     """
     C3928: ensure that in the pdf viewer you can zoom in and out
 
     Arguments:
         control: zoom controls
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
     """
-    zoom_pdf_viewer(driver, fillable_pdf_url, control, "Keys")
+    zoom_pdf_viewer(pdf_viewer, control, "Keys")
 
 
-def zoom_pdf_viewer(
-    driver: Firefox, fillable_pdf_url: str, control: str, input_type: str
-):
+def zoom_pdf_viewer(pdf_viewer: GenericPdf, control: str, input_type: str):
     """
     zoom base function to change based on input_type
 
     Arguments:
-        driver: Firefox webdriver
         control: zoom controls
-        fillable_pdf_url: pdf file directory path
+        pdf_viewer: instance of GenericPdf with correct path.
         input_type: Keys or Tool
     """
-    pdf_page = GenericPdf(driver, pdf_url=fillable_pdf_url).open()
     pdf_zoom = {
-        "zoom_out": pdf_page.zoom_out_keys
+        "zoom_out": pdf_viewer.zoom_out_keys
         if input_type == "Keys"
-        else pdf_page.zoom_out_toolbar,
-        "zoom_in": pdf_page.zoom_in_keys
+        else pdf_viewer.zoom_out_toolbar,
+        "zoom_in": pdf_viewer.zoom_in_keys
         if input_type == "Keys"
-        else pdf_page.zoom_in_toolbar,
+        else pdf_viewer.zoom_in_toolbar,
     }
-    body = pdf_page.get_element("pdf-body")
+    body = pdf_viewer.get_element("pdf-body")
     before_scale_factor = float(body.value_of_css_property("--scale-factor"))
 
     if control == "out":
         pdf_zoom["zoom_out"]()
-        pdf_page.wait.until(
+        pdf_viewer.wait.until(
             lambda _: float(body.value_of_css_property("--scale-factor"))
             < before_scale_factor
         )
         assert float(body.value_of_css_property("--scale-factor")) < before_scale_factor
     else:
         pdf_zoom["zoom_in"]()
-        pdf_page.wait.until(
+        pdf_viewer.wait.until(
             lambda _: float(body.value_of_css_property("--scale-factor"))
             > before_scale_factor
         )