Merge pull request #494 from mozilla/tracy/set-add-prefs-refactor

tracy/ Standardize method to set and add prefs

Author: Tracy-Walker

conftest.py

@@ -394,7 +394,7 @@ def driver(
     fx_executable: str,
     opt_headless: bool,
     opt_implicit_timeout: int,
-    set_prefs: List[Tuple],
+    prefs_list: List[Tuple],
     opt_ci: bool,
     opt_window_size: str,
     use_profile: Union[bool, str],
@@ -426,7 +426,7 @@ def driver(
     opt_implicit_timeout: int
         Timeout, in seconds for driver-level wait attribute.
 
-    set_prefs: List[Tuple]
+    prefs_list: List[Tuple]
         Preferences to set before the Firefox object is created.
         Usually set in the conftest.py inside a test suite folder.
 
@@ -454,7 +454,7 @@ def driver(
             profile_path = tmp_path / use_profile
             unpack_archive(os.path.join("profiles", f"{use_profile}.zip"), profile_path)
             options.profile = profile_path
-        for opt, value in set_prefs:
+        for opt, value in prefs_list:
             options.set_preference(opt, value)
         driver = Firefox(options=options)
         separator = "x"

l10n_CM/Unified/conftest.py

@@ -15,20 +15,20 @@ def region():
 
 
 @pytest.fixture()
-def add_prefs(region: str):
+def add_to_prefs_list(region: str):
     return []
 
 
 @pytest.fixture()
-def set_prefs(add_prefs: List[tuple[str, str | bool]], region: str):
-    """Set prefs"""
+def prefs_list(add_to_prefs_list: List[tuple[str, str | bool]], region: str):
+    """List of prefs to send to main conftest.py driver fixture"""
     prefs = [
         ("extensions.formautofill.creditCards.reauth.optout", False),
         ("extensions.formautofill.reauth.enabled", False),
         ("browser.aboutConfig.showWarning", False),
         ("browser.search.region", region),
     ]
-    prefs.extend(add_prefs)
+    prefs.extend(add_to_prefs_list)
     return prefs
 
 

l10n_CM/Unified/test_demo_ad_autofill_name_org.py

@@ -30,12 +30,10 @@ def test_demo_ad_autofill_name_org(
     autofill_popup.click_doorhanger_button("save")
 
     # List of field labels to be autofilled and verified
-    fields_to_test = [
-        "name",
-        "organization"
-    ]
+    fields_to_test = ["name", "organization"]
 
     # Loop through each field and perform the autofill test
     for field in fields_to_test:
-        address_autofill.autofill_and_verify(autofill_popup, field,
-                                             address_autofill_data, util)
+        address_autofill.autofill_and_verify(
+            autofill_popup, field, address_autofill_data, util
+        )

l10n_CM/Unified/test_demo_ad_autofill_phone_email.py

@@ -31,12 +31,10 @@ def test_demo_ad_autofill_phone_email(
     autofill_popup.click_doorhanger_button("save")
 
     # List of field labels to be autofilled and verified
-    fields_to_test = [
-        "email",
-        "tel"
-    ]
+    fields_to_test = ["email", "tel"]
 
     # Loop through each field and perform the autofill test
     for field in fields_to_test:
-        address_autofill.autofill_and_verify(autofill_popup, field,
-                                             address_autofill_data, util)
+        address_autofill.autofill_and_verify(
+            autofill_popup, field, address_autofill_data, util
+        )

l10n_CM/Unified/test_demo_ad_clear_address_fields.py

@@ -12,11 +12,11 @@ def test_case():
 
 
 def test_demo_ad_clear_address_fields(
-        driver: Firefox,
-        region: str,
-        address_autofill: AddressFill,
-        util: Utilities,
-        autofill_popup: AutofillPopup
+    driver: Firefox,
+    region: str,
+    address_autofill: AddressFill,
+    util: Utilities,
+    autofill_popup: AutofillPopup,
 ):
     """
     C2888565 - Verify clear functionality after selecting an entry from address fields
@@ -35,7 +35,7 @@ def test_demo_ad_clear_address_fields(
         "address-level2",
         "address-level1",  # This will be skipped for DE/FR
         "postal-code",
-        "country"
+        "country",
     ]
 
     # Loop through each field and perform the autofill test

l10n_CM/Unified/test_demo_ad_clear_name_org.py

@@ -12,11 +12,11 @@ def test_case():
 
 
 def test_demo_ad_clear_name_org(
-        driver: Firefox,
-        region: str,
-        address_autofill: AddressFill,
-        util: Utilities,
-        autofill_popup: AutofillPopup
+    driver: Firefox,
+    region: str,
+    address_autofill: AddressFill,
+    util: Utilities,
+    autofill_popup: AutofillPopup,
 ):
     """
     C2888560 - Verify clear functionality after selecting an entry from name/org fields
@@ -30,10 +30,7 @@ def test_demo_ad_clear_name_org(
     autofill_popup.click_doorhanger_button("save")
 
     # List of field labels to be autofilled and verified
-    fields_to_test = [
-        "name",
-        "organization"
-    ]
+    fields_to_test = ["name", "organization"]
 
     # Loop through each field and perform the autofill test
     for field in fields_to_test:

l10n_CM/Unified/test_demo_ad_clear_tel_email.py

@@ -12,11 +12,11 @@ def test_case():
 
 
 def test_demo_ad_clear_tel_email(
-        driver: Firefox,
-        region: str,
-        address_autofill: AddressFill,
-        util: Utilities,
-        autofill_popup: AutofillPopup
+    driver: Firefox,
+    region: str,
+    address_autofill: AddressFill,
+    util: Utilities,
+    autofill_popup: AutofillPopup,
 ):
     """
     C2888571 - Verify clear functionality after selecting an entry from tele/email fields
@@ -31,10 +31,7 @@ def test_demo_ad_clear_tel_email(
     autofill_popup.click_doorhanger_button("save")
 
     # List of field labels to be autofilled and verified
-    fields_to_test = [
-        "email",
-        "tel"
-    ]
+    fields_to_test = ["email", "tel"]
 
     # Loop through each field and perform the autofill test
     for field in fields_to_test:

l10n_CM/Unified/test_demo_ad_verify_new_address_added.py

@@ -18,7 +18,7 @@ def region():
 
 
 @pytest.fixture()
-def add_prefs(region: str):
+def add_to_prefs_list(region: str):
     return [
         ("extensions.formautofill.creditCards.supportedCountries", region),
         ("extensions.formautofill.addresses.supported", "on"),

l10n_CM/Unified/test_demo_cc_autofill_from_dropdown.py

@@ -6,7 +6,6 @@
 from modules.util import Utilities
 
 
-
 @pytest.fixture()
 def test_case():
     return "2886600"
@@ -17,7 +16,6 @@ def test_cc_autofill_from_dropdown(
     util: Utilities,
     autofill_popup: AutofillPopup,
     credit_card_fill_obj: CreditCardFill,
-
 ):
     """
     Verify that saved credit card information is autofilled correctly when selected from the dropdown,
@@ -37,4 +35,4 @@ def test_cc_autofill_from_dropdown(
 
     # Step 5: Click the csc field (cc-csc), ensure autofill popup is not present
     credit_card_fill_obj.click_on("form-field", labels=["cc-csc"])  # Use single click
-    autofill_popup.ensure_autofill_dropdown_not_visible()
+    autofill_popup.ensure_autofill_dropdown_not_visible()

l10n_CM/conftest.py

@@ -7,6 +7,13 @@ def suite_id():
 
 
 @pytest.fixture()
-def set_prefs():
-    """Set prefs"""
+def prefs_list(add_to_prefs_list: dict):
+    """List of prefs to send to main conftest.py driver fixture"""
+    prefs = []
+    prefs.extend(add_to_prefs_list)
+    return prefs
+
+
+@pytest.fixture()
+def add_to_prefs_list():
     return []