webserver implemented

philimon-reset · vsangereanMOZ · commit 1f5c92226a0f · 2025-05-05T10:07:57.000+03:00
diff --git a/l10n_CM/Unified/conftest.py b/l10n_CM/Unified/conftest.py
@@ -1,4 +1,7 @@
+import errno
+import logging
 import os
+import socket
 from json import load
 from typing import List
 
@@ -12,6 +15,28 @@
 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):
+    address_path_to_site = parent_dir + f"/sites/{live_site}/{live_site}_ad.html"
+    cc_path_to_site = parent_dir + f"/sites/{live_site}/{live_site}_cc.html"
+    if os.path.exists(address_path_to_site) and os.path.exists(cc_path_to_site):
+        address_html_file, cc_html_file = "", ""
+        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 ""
+
 
 @pytest.fixture()
 def region():
@@ -58,11 +83,6 @@ def ad_site_data(live_site, region):
         return live_site_data
 
 
-@pytest.fixture()
-def ad_is_live_site(live_site):
-    return live_site != "demo"
-
-
 @pytest.fixture()
 def cc_site_data(live_site):
     cc_live_site = f"{live_site}/{live_site}_cc"
@@ -72,11 +92,40 @@ def cc_site_data(live_site):
         return live_site_data
 
 
-@pytest.fixture()
-def cc_is_live_site(live_site):
+@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, 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:
+        http_server = request.getfixturevalue("httpserver")
+        ad_html_file, cc_html_file = get_html_files(live_site)
+        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")
@@ -98,7 +147,7 @@ def cc_form_field(cc_site_data):
 
 
 @pytest.fixture()
-def address_autofill(driver, ad_site_data, ad_form_field):
+def address_autofill(driver, ad_site_data, ad_form_field, serve_live_site):
     af = AddressFill(
         driver,
         url_template=ad_site_data.get("url"),
@@ -110,7 +159,7 @@ def address_autofill(driver, ad_site_data, ad_form_field):
 
 
 @pytest.fixture()
-def credit_card_autofill(driver, cc_site_data, cc_form_field):
+def credit_card_autofill(driver, cc_site_data, cc_form_field, serve_live_site):
     cf = CreditCardFill(
         driver,
         url_template=cc_site_data.get("url"),
diff --git a/l10n_CM/Unified/test_demo_ad_1a_dropdown_name_org_fields.py b/l10n_CM/Unified/test_demo_ad_1a_dropdown_name_org_fields.py
@@ -1,10 +1,8 @@
 import pytest
 from selenium.webdriver import Firefox
 
-from modules.browser_object_autofill_popup import AutofillPopup
 from modules.classes.autofill_base import AutofillAddressBase
 from modules.page_object_autofill import AddressFill
-from modules.util import Utilities
 
 
 @pytest.fixture()
@@ -16,8 +14,6 @@ def test_dropdown_presence_name_organization(
     driver: Firefox,
     region: str,
     address_autofill: AddressFill,
-    util: Utilities,
-    autofill_popup: AutofillPopup,
     fill_and_save_address: AutofillAddressBase,
 ):
     """
diff --git a/l10n_CM/Unified/test_demo_ad_6_capture_doorhanger_appearance.py b/l10n_CM/Unified/test_demo_ad_6_capture_doorhanger_appearance.py
@@ -17,12 +17,12 @@ def test_address_doorhanger_displayed_after_entering_valid_address(
     address_autofill: AddressFill,
     util: Utilities,
     autofill_popup: AutofillPopup,
-    ad_is_live_site: str,
+    is_live_site: str,
 ):
     """
     C2886581 - Verify the Capture Door hanger is displayed after entering valid Address data
     """
-    if not ad_is_live_site:
+    if not is_live_site:
         # Create fake data and fill it in
         address_autofill.open()
         # scroll to first form field
diff --git a/l10n_CM/Unified/test_demo_ad_7a_capture_doorhanger_stored_data_name_org_fields.py b/l10n_CM/Unified/test_demo_ad_7a_capture_doorhanger_stored_data_name_org_fields.py
@@ -19,12 +19,12 @@ def test_demo_ad_name_org_captured_in_doorhanger_and_stored(
     util: Utilities,
     autofill_popup: AutofillPopup,
     about_prefs_privacy: AboutPrefs,
-    ad_is_live_site: str,
+    is_live_site: str,
 ):
     """
     C2888701 - Verify name/org fields are captured in the Capture Doorhanger and stored in about:preferences
     """
-    if not ad_is_live_site:
+    if not is_live_site:
         # Create fake data and fill it in
         address_autofill.open()
         # scroll to first form field
diff --git a/l10n_CM/Unified/test_demo_ad_7b_capture_doorhanger_stored_data_address_fields.py b/l10n_CM/Unified/test_demo_ad_7b_capture_doorhanger_stored_data_address_fields.py
@@ -19,12 +19,12 @@ def test_demo_ad_address_data_captured_in_doorhanger_and_stored(
     util: Utilities,
     autofill_popup: AutofillPopup,
     about_prefs_privacy: AboutPrefs,
-    ad_is_live_site: str,
+    is_live_site: str,
 ):
     """
     C2888703 - Verify Address data are captured in the Capture Doorhanger and stored in about:preferences
     """
-    if not ad_is_live_site:
+    if not is_live_site:
         # Create fake data and fill it in
         address_autofill.open()
 
diff --git a/l10n_CM/Unified/test_demo_ad_7c_capture_doorhanger_stored_data_phone_email.py b/l10n_CM/Unified/test_demo_ad_7c_capture_doorhanger_stored_data_phone_email.py
@@ -19,12 +19,12 @@ def test_demo_ad_email_phone_captured_in_doorhanger_and_stored(
     util: Utilities,
     autofill_popup: AutofillPopup,
     about_prefs_privacy: AboutPrefs,
-    ad_is_live_site: str,
+    is_live_site: str,
 ):
     """
     C2888704 - Verify tele/email data are captured in the Capture Doorhanger and stored in about:preferences
     """
-    if not ad_is_live_site:
+    if not is_live_site:
         # Create fake data and fill it in
         address_autofill.open()
 
diff --git a/l10n_CM/Unified/test_demo_cc_6_capture_doorhanger_appearance.py b/l10n_CM/Unified/test_demo_cc_6_capture_doorhanger_appearance.py
@@ -17,12 +17,12 @@ def test_cc_check_door_hanger_is_displayed(
     util: Utilities,
     autofill_popup: AutofillPopup,
     credit_card_autofill: CreditCardFill,
-    cc_is_live_site: str,
+    is_live_site: str,
 ):
     """
     C2889441 - Ensures that the door hanger is displayed after filling credit card info
     """
-    if not cc_is_live_site:
+    if not is_live_site:
         # Navigate to page
         credit_card_autofill.open()
 
diff --git a/l10n_CM/Unified/test_demo_cc_7_capture_doorhanger_capture_and_stored_data.py b/l10n_CM/Unified/test_demo_cc_7_capture_doorhanger_capture_and_stored_data.py
@@ -19,12 +19,12 @@ def test_demo_cc_data_captured_in_doorhanger_and_stored(
     autofill_popup: AutofillPopup,
     util: Utilities,
     about_prefs_privacy: AboutPrefs,
-    cc_is_live_site: str,
+    is_live_site: str,
 ):
     """
     C2889999 - Verify credit card data is captured in the Capture Doorhanger and stored in about:preferences
     """
-    if not cc_is_live_site:
+    if not is_live_site:
         # Navigate to page
         credit_card_autofill.open()
 
diff --git a/l10n_CM/constants/walmart/walmart_ad.json b/l10n_CM/constants/walmart/walmart_ad.json
@@ -1,5 +1,5 @@
 {
-  "url": "http://127.0.0.1:8000/walmart_ad.html",
+  "url": "http://127.0.0.1:8080/walmart_ad.html",
   "field_mapping": {
     "given_name": "given-name",
     "family_name": "family-name",
diff --git a/l10n_CM/constants/walmart/walmart_cc.json b/l10n_CM/constants/walmart/walmart_cc.json
@@ -1,5 +1,5 @@
 {
-  "url": "http://127.0.0.1:8000/walmart_cc.html",
+  "url": "http://127.0.0.1:8080/walmart_cc.html",
   "field_mapping": {
     "card_number": "cc-number",
     "family_name": "cc-family-name",
diff --git a/l10n_CM/run_l10n.py b/l10n_CM/run_l10n.py
@@ -2,15 +2,66 @@
 import os
 import subprocess
 import sys
+import threading
+from contextlib import contextmanager
+from http.server import HTTPServer, SimpleHTTPRequestHandler
 from json import load
 
+import requests
+
 current_dir = os.path.dirname(__file__)
 valid_flags = {"--run-headless", "-n", "--reruns"}
 flag_with_parameter = {"-n", "--reruns"}
 valid_region = {"US", "CA", "DE", "FR"}
 valid_sites = {"demo", "amazon", "walmart"}
 live_sites = []
 
+LOCALHOST = "127.0.0.1"
+PORT = 8080
+
+logging.basicConfig(level=logging.INFO)
+
+
+class MyHttpRequestHandler(SimpleHTTPRequestHandler):
+    live_site = None
+
+    def translate_path(self, path):
+        """switch the default directory where the html files are served from."""
+        base_dir = os.path.join(current_dir, "sites", self.live_site)
+        return os.path.join(base_dir, path.lstrip("/"))
+
+    def log_message(self, format, *args):
+        """Remove logs from the server."""
+        pass
+
+
+def start_server(live_site):
+    # set live site attribute
+    MyHttpRequestHandler.live_site = live_site
+    # start web server on a separate thread to avoid blocking calls.
+    http = HTTPServer((LOCALHOST, PORT), MyHttpRequestHandler)
+
+    thread = threading.Thread(target=lambda: http.serve_forever())
+    thread.start()
+    return http, thread
+
+
+@contextmanager
+def running_server(live_site):
+    """Context manager to run a server and clean it up automatically."""
+    httpd, server_thread = start_server(live_site)
+    try:
+        yield  # control goes to the caller, server runs in the background
+    finally:
+        try:
+            # Send a dummy request to unblock the server if necessary
+            requests.get(f"http://{LOCALHOST}:{PORT}")
+        except Exception:
+            pass
+        httpd.shutdown()
+        server_thread.join()
+        logging.info(f"{live_site} server shutdown.")
+
 
 def run_tests(reg, site, flg, all_tests):
     """
@@ -108,27 +159,41 @@ def run_unified(regions, unified_flags):
         unified_flags (list[str]): A list of pytest flags to be used.
     """
     unified_tests = get_region_tests("Unified")
-    for unified_region in regions:
-        for live_site in live_sites:
-            run_tests(unified_region, live_site, unified_flags, unified_tests)
+    logging.info(f"Testing {live_sites} Sites.")
+    for live_site in live_sites:
+        # If the live_site is 'demo', skip starting the server
+        if live_site == "demo":
+            for unified_region in regions:
+                run_tests(unified_region, live_site, unified_flags, unified_tests)
+        else:
+            with running_server(live_site):
+                for unified_region in regions:
+                    run_tests(unified_region, live_site, unified_flags, unified_tests)
 
 
 if __name__ == "__main__":
     arguments = sys.argv[1:]
     flags = get_flags_and_sanitize(arguments)
     if len(live_sites) == 0:
+        # Run on all live sites.
         live_sites = valid_sites
         logging.info(f"Running Against all available live sites ({live_sites}).")
     if len(arguments) == 0:
+        ## Run on all Regions.
         logging.info(f"Running Unified Tests for {valid_region} Regions.")
         run_unified(list(valid_region), flags)
     else:
+        # run on given region and sites.
         logging.info(f"Running Unified Tests for {arguments} Regions.")
         run_unified(arguments, flags)
-    for region in arguments:
-        tests = get_region_tests(region)
-        logging.info(f"Running Specific Tests for {region}.")
-        # if additional testing sites are added.
-        # for a given region, run all supported tests on the live site.
-        for site in live_sites:
-            run_tests(region, site, flags, tests)
+    for site in live_sites:
+        # for a given site, run all region specific tests.
+        for region in arguments:
+            tests = get_region_tests(region)
+            logging.info(f"Running Specific Tests for {region}.")
+            # If the live_site is 'demo', skip starting the server
+            if site == "demo":
+                run_tests(region, site, flags, tests)
+            else:
+                with running_server(site):
+                    run_tests(region, site, flags, tests)
diff --git a/l10n_CM/sites/amazon/amazon_ad.html b/l10n_CM/sites/amazon/amazon_ad.html
diff --git a/l10n_CM/sites/amazon/amazon_cc.html b/l10n_CM/sites/amazon/amazon_cc.html
diff --git a/l10n_CM/sites/walmart/walmart_ad.html b/l10n_CM/sites/walmart/walmart_ad.html
diff --git a/l10n_CM/sites/walmart/walmart_cc.html b/l10n_CM/sites/walmart/walmart_cc.html
diff --git a/modules/page_object_autofill.py b/modules/page_object_autofill.py
@@ -225,7 +225,10 @@ def verify_form_data(self, sample_data: CreditCardBase | AutofillAddressBase):
                     autofilled_field_value = Select(
                         autofilled_field
                     ).first_selected_option.text
-                if field_name == "address-level1":
+                if (
+                    field_name == "address-level1"
+                    and autofilled_field_value != expected_value
+                ):
                     expected_value = self.util.get_state_province_abbreviation(
                         expected_value
                     )

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "url": "http://127.0.0.1:8000/walmart_ad.html",`
	`2`	`+ "url": "http://127.0.0.1:8080/walmart_ad.html",`
`3`	`3`	`"field_mapping": {`
`4`	`4`	`"given_name": "given-name",`
`5`	`5`	`"family_name": "family-name",`