l10n_CM/Unified/conftest.py

import errno
import logging
import os
import socket
from json import load
from typing import List

import pytest

from modules.browser_object_autofill_popup import AutofillPopup
from modules.page_object_autofill import AddressFill, CreditCardFill
from modules.page_object_prefs import AboutPrefs
from modules.util import Utilities

current_dir = os.path.dirname(__file__)
parent_dir = os.path.dirname(current_dir)

LOCALHOST = "127.0.0.1"
PORT = 8080


def is_port_in_use() -> bool:
    """Check if the port is already open (server running)."""
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
        return s.connect_ex((LOCALHOST, PORT)) == 0


def get_html_files(live_site, region):
    address_path_to_site = (
        parent_dir + f"/sites/{live_site}/{region}/{live_site}_ad.html"
    )
    cc_path_to_site = parent_dir + f"/sites/{live_site}/{region}/{live_site}_cc.html"
    address_html_file, cc_html_file = "", ""
    if os.path.exists(address_path_to_site) and os.path.exists(cc_path_to_site):
        with open(address_path_to_site, "r", encoding="utf-8") as fp:
            address_html_file = fp.read()
        with open(cc_path_to_site, "r", encoding="utf-8") as fp:
            cc_html_file = fp.read()
        return address_html_file, cc_html_file
    return address_html_file, cc_html_file


@pytest.fixture()
def region():
    return os.environ.get("FX_REGION", "US")


@pytest.fixture()
def live_site():
    return os.environ.get("CM_SITE", "demo")


@pytest.fixture()
def add_to_prefs_list(region: str):
    return []


@pytest.fixture()
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_to_prefs_list)
    return prefs


@pytest.fixture()
def ad_site_data(live_site, region):
    ad_live_site = (
        f"{live_site}/{region}/{live_site}_ad"
        if live_site != "demo"
        else f"{live_site}/{live_site}_ad"
    )
    path_to_site = parent_dir + "/constants/"
    with open(path_to_site + ad_live_site + ".json", "r") as fp:
        live_site_data = load(fp)
        # Remove address level 1 for regions other than US and CA
        if region not in {"US", "CA"} and live_site_data["field_mapping"].get(
            "address_level_1"
        ):
            live_site_data["fields"].remove(
                live_site_data["field_mapping"]["address_level_1"]
            )
            del live_site_data["field_mapping"]["address_level_1"]
        return live_site_data


@pytest.fixture()
def cc_site_data(live_site, region):
    cc_live_site = (
        f"{live_site}/{region}/{live_site}_cc"
        if live_site != "demo"
        else f"{live_site}/{live_site}_cc"
    )
    path_to_site = parent_dir + "/constants/"
    with open(path_to_site + cc_live_site + ".json", "r") as fp:
        live_site_data = load(fp)
        return live_site_data


@pytest.fixture
def is_live_site(live_site):
    """Determine if the site is live."""
    return live_site != "demo"


@pytest.fixture(scope="session")
def httpserver_listen_address():
    """Set port for local http server"""
    return LOCALHOST, PORT


@pytest.fixture()
def serve_live_site(is_live_site, live_site, region, request):
    """Serve the live site only if needed."""
    if not is_live_site or is_port_in_use():
        return
    # only serve content if url is already not served.
    try:
        ad_html_file, cc_html_file = get_html_files(live_site, region)
        http_server = request.getfixturevalue("httpserver")
        http_server.expect_request(f"/{live_site}_ad.html").respond_with_data(
            ad_html_file, content_type="text/html"
        )
        http_server.expect_request(f"/{live_site}_cc.html").respond_with_data(
            cc_html_file, content_type="text/html"
        )
    except OSError as e:
        if e == errno.EADDRINUSE:
            logging.info(f"{live_site} already served.")
    finally:
        return


@pytest.fixture()
def ad_form_field(ad_site_data):
    selector = ad_site_data.get("form_field")
    return (
        {"form-field": {"selectorData": selector, "strategy": "css", "groups": []}}
        if selector
        else {}
    )


@pytest.fixture()
def cc_form_field(cc_site_data):
    selector = cc_site_data.get("form_field")
    return (
        {"form-field": {"selectorData": selector, "strategy": "css", "groups": []}}
        if selector
        else {}
    )


@pytest.fixture()
def address_autofill(driver, ad_site_data, ad_form_field, serve_live_site):
    af = AddressFill(
        driver,
        url_template=ad_site_data.get("url"),
        field_mapping=ad_site_data.get("field_mapping"),
        fields=ad_site_data.get("fields"),
    )
    af.elements |= ad_form_field
    return af


@pytest.fixture()
def credit_card_autofill(driver, cc_site_data, cc_form_field, serve_live_site):
    cf = CreditCardFill(
        driver,
        url_template=cc_site_data.get("url"),
        field_mapping=cc_site_data.get("field_mapping"),
        fields=cc_site_data.get("fields"),
    )
    cf.elements |= cc_form_field
    return cf


@pytest.fixture()
def autofill_popup(driver):
    return AutofillPopup(driver)


@pytest.fixture()
def util():
    return Utilities()


@pytest.fixture()
def about_prefs_privacy(driver):
    return AboutPrefs(driver, category="privacy")


@pytest.fixture()
def about_prefs(driver):
    return AboutPrefs(driver)


@pytest.fixture()
def populate_saved_payments(
    about_prefs_privacy: AboutPrefs, util: Utilities, region: str
):
    """Fixture to add cc data through saved payments method."""
    # Go to about:preferences#privacy and open Saved Payment Methods
    about_prefs_privacy.open()
    about_prefs_privacy.open_and_switch_to_saved_payments_popup()

    # Save CC information using fake data
    credit_card_sample_data = util.fake_credit_card_data(region)

    # Add a new CC profile
    about_prefs_privacy.click_add_on_dialog_element()
    about_prefs_privacy.add_entry_to_saved_payments(credit_card_sample_data)
    return credit_card_sample_data


@pytest.fixture()
def populate_saved_addresses(
    about_prefs_privacy: AboutPrefs, util: Utilities, region: str
):
    """Fixture to add cc data through saved payments method."""
    # Go to about:preferences#privacy and open Saved Addresses Methods
    about_prefs_privacy.open()
    about_prefs_privacy.open_and_switch_to_saved_addresses_popup()

    # Save address information using fake data
    address_data_sample_data = util.fake_autofill_data(region)

    # Add a new address profile
    about_prefs_privacy.click_add_on_dialog_element()
    about_prefs_privacy.add_entry_to_saved_addresses(address_data_sample_data)
    return address_data_sample_data


@pytest.fixture()
def fill_and_save_address(
    address_autofill: AddressFill, ad_site_data, region: str, request
):
    """
    Fixture to populate address entry depending on whether the url is a live site.
    If live site, populate data through about:prefs, if not fill directly through page.
    """
    if ad_site_data.get("url"):
        return request.getfixturevalue("populate_saved_addresses")
    address_autofill.open()
    return address_autofill.fill_and_save(region)


@pytest.fixture()
def fill_and_save_payments(
    credit_card_autofill: CreditCardFill, cc_site_data, region: str, request
):
    """
    Fixture to populate cc entry depending on whether the url is a live site.
    If live site, populate data through about:prefs, if not fill directly through page.
    """
    if cc_site_data.get("url"):
        return request.getfixturevalue("populate_saved_payments")
    credit_card_autofill.open()
    return credit_card_autofill.fill_and_save(region)