readme addition and change how the run_l10n script is ran

Author: philimon-reset

.github/workflows/l10n.yml

@@ -88,7 +88,7 @@ jobs:
           pipenv run python check_l10n_test_cases.py;
           while IFS= read -r line; do
             echo "Running tests for: $line";
-            pipenv run python l10n_CM/run_l10n.py --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
+            pipenv run python -m l10n_CM.run_l10n --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
           done < selected_l10n_mappings;
           mv artifacts artifacts-mac || true;
           EXIT_CODE=$(cat TEST_EXIT_CODE);
@@ -106,7 +106,7 @@ jobs:
           echo "0" > TEST_EXIT_CODE;
           while IFS= read -r line; do
             echo "Running tests for: $line";
-            pipenv run python l10n_CM/run_l10n.py --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
+            pipenv run python -m l10n_CM.run_l10n --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
           done < selected_l10n_mappings;
           mv -n artifacts/* artifacts-mac/ || true;
           EXIT_CODE=$(cat TEST_EXIT_CODE);
@@ -170,7 +170,7 @@ jobs:
           Xvfb :99 -screen 0 '1600x1200x24' > artifacts/xvfb.log &
           while IFS= read -r line; do
             echo "Running tests for: $line";
-            DISPLAY=:99 pipenv run python l10n_CM/run_l10n.py --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
+            DISPLAY=:99 pipenv run python -m l10n_CM.run_l10n --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
           done < selected_l10n_mappings;
           mv artifacts artifacts-linux || true;
           EXIT_CODE=$(cat TEST_EXIT_CODE);
@@ -188,7 +188,7 @@ jobs:
           echo "0" > TEST_EXIT_CODE;
           while IFS= read -r line; do
             echo "Running tests for: $line";
-            DISPLAY=:99 pipenv run python l10n_CM/run_l10n.py --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
+            DISPLAY=:99 pipenv run python -m l10n_CM.run_l10n --fx-executable="$FX_EXECUTABLE" $line || SCRIPT_EXIT_CODE=$?;
           done < selected_l10n_mappings;
           mv -n artifacts/* artifacts-linux/ || true;
           EXIT_CODE=$(cat TEST_EXIT_CODE);
@@ -284,7 +284,7 @@ jobs:
               $line = $_
               Write-Host "Running tests for: $line"
               try {
-                  pipenv run python l10n_CM/run_l10n.py --fx-executable="$env:FX_EXECUTABLE" $line
+                  pipenv run python -m l10n_CM.run_l10n --fx-executable="$env:FX_EXECUTABLE" $line
               } catch {
                   $SCRIPT_EXIT_CODE = $_.Exception.HResult
               }
@@ -311,7 +311,7 @@ jobs:
               $line = $_
               Write-Host "Running tests for: $line"
               try {
-                  pipenv run python l10n_CM/run_l10n.py --fx-executable="$env:FX_EXECUTABLE" $line
+                  pipenv run python -m l10n_CM.run_l10n --fx-executable="$env:FX_EXECUTABLE" $line
               } catch {
                   $SCRIPT_EXIT_CODE = $_.Exception.HResult
               }

l10n_CM/README.md

@@ -71,7 +71,7 @@ The harness relies on several configuration files:
 ## Usage
 
 ```bash
-python run_l10n.py [FLAGS] [REGIONS] [SITES]
+python -m l10n_CM.run_l10n [FLAGS] [REGIONS] [SITES]
 ```
 
 ### Parameters
@@ -92,22 +92,22 @@ python run_l10n.py [FLAGS] [REGIONS] [SITES]
 
 ```bash
 # Run tests for all regions and sites
-python run_l10n.py
+python -m l10n_CM.run_l10n
 
 # Run all tests for US region only across all available sites
-python run_l10n.py US
+python -m l10n_CM.run_l10n US
 
 # Run all tests for amazon site only across all regions
-python run_l10n.py US
+python -m l10n_CM.run_l10n US
 
 # Run tests for US region on amazon site
-python run_l10n.py US amazon
+python -m l10n_CM.run_l10n US amazon
 
 # Run tests for US and CA regions with 4 parallel workers
-python run_l10n.py -n 4 US CA
+python -m l10n_CM.run_l10n -n 4 US CA
 
 # Run tests for US region on amazon site in headless mode
-python run_l10n.py --run-headless US amazon
+python -m l10n_CM.run_l10n --run-headless US amazon
 ```
 
 ## Architecture
@@ -137,6 +137,7 @@ The framework sets the following environment variables during test execution:
 - `CM_SITE`: The site being tested
 - `FX_REGION`: The region being tested
 - `TEST_EXIT_CODE`: Exit code of the test execution
+- `FX_L10N`: Flag to check whether l10n workflow is being run.
 
 ## Adding New Tests
 
@@ -153,6 +154,10 @@ The framework sets the following environment variables during test execution:
 5. Create the necessary mapping files in `constants/{site_name}/{region}/`
    * The naming convention for both the mapping files and the HTML files are `{site}_ad` for Address Pages and `{site}_cc` for Credit Card Pages.
 
+## Useful Documents
+- [Sites/Regions to Automate](https://docs.google.com/spreadsheets/d/15_ejIC3YABnMGHafgkLeuuu_wakfpiLapOmUdBF2pVI/edit?usp=sharing)
+- [Skipped Automation Test Combinations](https://docs.google.com/document/d/18zYICZ3lbtUK7-LC-2Gt8jRbxQp0w0Is0ytM2BrcD7w/edit?usp=sharing)
+
 ## Troubleshooting
 
 - **Invalid Arguments**: Ensure all region codes, site names, and flags are valid

l10n_CM/run_l10n.py

@@ -32,8 +32,10 @@
     "zalando",
     "aldoshoes",
 }
+
 loaded_valid_sites = valid_l10n_mappings().keys()
 valid_sites = valid_sites.union(set(loaded_valid_sites))
+
 live_sites = []
 
 LOCALHOST = "127.0.0.1"
@@ -113,7 +115,7 @@ def run_tests(reg, site, flg, all_tests):
         logging.warning(f"Test run failed with exit code: {e.returncode}")
         # true failure instead of run not being reportable.
         if e.returncode != 2:
-            if os.environ.get("TEST_EXIT_CODE") == "0":
+            if os.environ.get("FX_L10N") and os.environ.get("TEST_EXIT_CODE") == "0":
                 with open("TEST_EXIT_CODE", "w") as f:
                     f.write(str(e.returncode))
             os.environ["TEST_EXIT_CODE"] = str(e.returncode)