Merge branch 'main' into philimon/suite_refactor

Author: philimon-reset

.github/pull_request_template.md

@@ -1,28 +1,37 @@
-### Description
+### Relevant Links
 
-Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+Bugzilla: _
+TestRail: _
 
-### Bugzilla bug ID
+### Description of Code / Doc Changes
 
-**Testrail:**
-**Link:**
+_Leave a bullet-pointed list of changes you made._
 
-### Type of change
+### Process Changes Required
 
-Please delete options that are not relevant.
+_Mark the relevant boxes:_
 
-- [ ] New Test
-- [ ] New POM
-- [ ] Other Changes (Please specify)
+- [ ] Adds a dependency (rerun `pipenv install`)
+- [ ] Changes the BasePage
+- [ ] Changes or creates a BOM/POM (name the object model): _
+- [ ] Changes CI flow
+- [ ] Changes scheduled Beta or DevEdition
+- [ ] Changes Git hooks or Github settings
+- [ ] Changes L10n harness
 
-### How does this resolve / make progress on that bug?
+### Screenshots or Explanations
 
-Please describe the progress or significance with respect to the bug listed above.
+_If you need to explain your code, do it here._
 
-### Screenshots / Explanations
+### Comments or Future Work
 
-Please upload any relevant media or add a relevant description with respect to the bug listed above.
+_Do we need to start another PR soon to address something you saw while working on this?_
 
-### Comments / Concerns
+### Workflow Checklist
 
-Please add a short blurb about any comments or concerns that this change might cause.
+- [ ] Please request reviewers
+- [ ] If this is an unblocker, please post in Slack.
+- [ ] If asked to address comments, please resolve conversations.
+- [ ] If asked to change code, please re-request review from the person who wanted changes.
+
+Thank you!

.github/workflows/check-beta.yml

@@ -2,11 +2,11 @@ name: Check new beta version
 
 on:
   schedule:
-    - cron: "49 */1 * * *"
+    - cron: "12 */1 * * *"
 env:
   LATEST: ""
 permissions:
-  contents: 'write'
+  contents: "write"
 
 jobs:
   Check-Beta-Version:
@@ -19,7 +19,7 @@ jobs:
         uses: actions/checkout@v4
       - name: Check if the run is reportable
         id: reportable
-        env: 
+        env:
           TESTRAIL_REPORT: true
           TESTRAIL_BASE_URL: ${{ secrets.TESTRAIL_BASE_URL }}
           TESTRAIL_API_KEY: ${{ secrets.TESTRAIL_API_KEY }}
@@ -29,19 +29,18 @@ jobs:
           pipenv install
           echo win=$(pipenv run python -c 'from modules import testrail_integration as tri; print(tri.reportable("Windows"))') >> "$GITHUB_OUTPUT"
           echo mac=$(pipenv run python -c 'from modules import testrail_integration as tri; print(tri.reportable("Darwin"))') >> "$GITHUB_OUTPUT"
-  Run-Win-Smoke: 
+  Run-Win-Smoke:
     needs: Check-Beta-Version
     if: ${{ needs.Check-Beta-Version.outputs.win_reportable == 'True' }}
     uses: ./.github/workflows/smoke.yml
     with:
       job_to_run: Smoke-Windows
     secrets: inherit
 
-  Run-Mac-Smoke: 
+  Run-Mac-Smoke:
     needs: Check-Beta-Version
     if: ${{ needs.Check-Beta-Version.outputs.mac_reportable == 'True' }}
     uses: ./.github/workflows/smoke.yml
     with:
       job_to_run: Smoke-MacOS
     secrets: inherit
-            

.github/workflows/check-devedition.yml

@@ -0,0 +1,49 @@
+name: Check new devedition version
+
+on:
+  schedule:
+    - cron: "38 */12 * * *"
+env:
+  LATEST: ""
+permissions:
+  contents: "write"
+
+jobs:
+  Check-DevEdition-Version:
+    runs-on: ubuntu-latest
+    outputs:
+      win_reportable: ${{ steps.reportable.outputs.win }}
+      mac_reportable: ${{ steps.reportable.outputs.mac }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Check if the run is reportable
+        id: reportable
+        env:
+          TESTRAIL_REPORT: true
+          TESTRAIL_BASE_URL: ${{ secrets.TESTRAIL_BASE_URL }}
+          TESTRAIL_API_KEY: ${{ secrets.TESTRAIL_API_KEY }}
+          TESTRAIL_USERNAME: ${{ secrets.TESTRAIL_USERNAME }}
+          FX_CHANNEL: "devedition"
+        run: |
+          pip3 install 'pipenv==2023.11.15';
+          pipenv install
+          echo win=$(pipenv run python -c 'from modules import testrail_integration as tri; print(tri.reportable("Windows"))') >> "$GITHUB_OUTPUT"
+          echo mac=$(pipenv run python -c 'from modules import testrail_integration as tri; print(tri.reportable("Darwin"))') >> "$GITHUB_OUTPUT"
+  Run-Win-Smoke:
+    needs: Check-DevEdition-Version
+    if: ${{ needs.Check-DevEdition-Version.outputs.win_reportable == 'True' }}
+    uses: ./.github/workflows/smoke.yml
+    with:
+      channel: "devedition"
+      job_to_run: Smoke-Windows
+    secrets: inherit
+
+  Run-Mac-Smoke:
+    needs: Check-DevEdition-Version
+    if: ${{ needs.Check-DevEdition-Version.outputs.mac_reportable == 'True' }}
+    uses: ./.github/workflows/smoke.yml
+    with:
+      channel: "devedition"
+      job_to_run: Smoke-MacOS
+    secrets: inherit

.github/workflows/smoke.yml

@@ -6,17 +6,24 @@ on:
   pull_request:
   workflow_call:
     inputs:
-      job_to_run: 
+      channel:
+        description: "Channel to run tests against"
+        default: "beta"
+        type: string
+        required: false
+      job_to_run:
         required: true
         type: string
 env:
+  FX_CHANNEL: ${{ inputs.channel }}
   TESTRAIL_BASE_URL: ${{ secrets.TESTRAIL_BASE_URL }}
   TESTRAIL_API_KEY: ${{ secrets.TESTRAIL_API_KEY }}
   TESTRAIL_USERNAME: ${{ secrets.TESTRAIL_USERNAME }}
   SVC_ACCT_DECRYPT: ${{ secrets.SVC_ACCT_DECRYPT }}
 
 jobs:
   Smoke-Windows:
+    if: ${{ inputs.job_to_run == 'Smoke-Windows' || github.event_name == 'pull_request' }}
     runs-on: windows-latest
     steps:
       - name: Create app token
@@ -110,6 +117,7 @@ jobs:
           name: artifacts-win
           path: artifacts-win
   Smoke-MacOS:
+    if: ${{ inputs.job_to_run == 'Smoke-MacOS' || github.event_name == 'pull_request' }}
     runs-on: macos-latest
     steps:
       - name: Create app token
@@ -137,19 +145,19 @@ jobs:
           echo "TESTRAIL_REPORT='true'" >> "$GITHUB_ENV";
           echo "Running report for most recent Beta on MacOS";
       - name: Install dependencies
-        id: setup        
+        id: setup
         run: |
           mkdir -p artifacts;
           pip3 install 'pipenv==2023.11.15';
           pip3 install 'ruff>=0.4.8,<0.5';
           rm ./pyproject.toml;
           mv ./ci_pyproject.toml ./pyproject.toml;
           pipenv install;
-          bash ./collect_executables.sh;
+          echo app_name=$(bash ./collect_executables.sh | xargs -0 ./parse_executables.sh) >> "$GITHUB_OUTPUT"
       - name: Run Smoke Tests in MacOS
         if: steps.setup.conclusion == 'success'
         env:
-          FX_EXECUTABLE: /Volumes/Firefox/Firefox.app/Contents/MacOS/firefox
+          FX_EXECUTABLE: /Volumes/${{ steps.setup.outputs.app_name }}/${{ steps.setup.outputs.app_name }}.app/Contents/MacOS/firefox
         run: |
           /Volumes/Firefox/Firefox.app/Contents/MacOS/firefox --version
           pipenv run python choose_ci_set.py

SELECTOR_INFO.md

@@ -1403,6 +1403,13 @@ Location: Appears as part of the dropdown under the autofill panel, within any e
 Path to .json: modules/data/autofill_popup.components.json
 ```
 ```
+Selector Name: select-form-option-by-index
+Selector Data: ".autocomplete-richlistbox .autocomplete-richlistitem:nth:child({index})"
+Description: Select n individual entry within the autofill dropdown, using the index of the child.
+Location: Appears as part of the dropdown under the autofill panel, within any eligible form field when suggestions are available.
+Path to .json: modules/data/autofill_popup.components.json
+```
+```
 Selector Name: clear-form-option
 Selector Data: ".autocomplete-richlistbox .autocomplete-richlistitem[ac-value='Clear Autofill Form']"
 Description: The "Clear Autofill Form" option in the dropdown that appears when interacting with an autofill-enabled input field
@@ -2997,7 +3004,7 @@ Path to .json: modules/data/navigation.components.json
 ```
 ```
 Selector Name: search-mode-switcher-option
-Selector Data: toolbarbutton[label*='{title}']
+Selector Data: menuitem[label*='{title}']
 Description: Option by label in search mode list
 Location: Search mode of awesomebar
 Path to .json: modules/data/navigation.components.json

choose_ci_set.py

@@ -139,8 +139,8 @@ def dedupe(run_list: list, slash: str) -> list:
         .splitlines()
     )
 
-    main_conftest = os.path.join(SCRIPT_DIR, "conftest.py")
-    base_page = os.path.join(SCRIPT_DIR, "modules", "page_base.py")
+    main_conftest = "conftest.py"
+    base_page = os.path.join("modules", "page_base.py")
 
     if main_conftest in committed_files or base_page in committed_files:
         # Run all the tests (no files as arguments) if main conftest or basepage changed

collect_executables.py

@@ -102,54 +102,81 @@ def get_gd_platform():
     if not language:
         language = "en-US"
 
-    candidate_exists = True
-    this_beta = BACKSTOP
-    while candidate_exists:
-        (major, minor_beta) = this_beta.split(".")
-        (minor, beta) = minor_beta.split("b")
-        major = int(major)
-        minor = int(minor)
-        beta = int(beta)
-
-        next_major = f"{major + 1}.0b1"
-        fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{next_major}-candidates/build1/"
-        rs = requests.get(fx_download_dir_url)
-        if rs.status_code < 300:
-            latest_beta_ver = next_major
-            this_beta = next_major
-            continue
+    if channel == "-devedition":
+        # Devedition has special requirements as it's testing a release
 
-        next_minor = f"{major}.{minor + 1}b1"
-        fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{next_minor}-candidates/build1/"
-        rs = requests.get(fx_download_dir_url)
-        if rs.status_code < 300:
-            latest_beta_ver = next_minor
-            this_beta = next_minor
-            continue
+        this_devedition = BACKSTOP
+        fx_download_dir_url = (
+            "https://archive.mozilla.org/pub/devedition/releases/135.0b5/"
+        )
 
-        next_beta = f"{major}.{minor}b{beta + 1}"
-        fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{next_beta}-candidates/build1/"
-        rs = requests.get(fx_download_dir_url)
-        if rs.status_code < 300:
-            latest_beta_ver = next_beta
-            this_beta = next_beta
-            continue
+        while True:
+            (major, _) = this_devedition.split(".")
+            major = int(major)
+            this_devedition = f"{major + 1}.0b5"
+            next_candidate = f"https://archive.mozilla.org/pub/devedition/releases/{this_devedition}/"
+
+            rs = requests.get(next_candidate)
+            if rs.status_code > 399:
+                break
 
-        candidate_exists = False
+            fx_download_dir_url = next_candidate
 
-    status = 200
-    build = 0
-    while status < 400 and build < 20:
-        build += 1
-        fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{latest_beta_ver}-candidates/build{build}/"
+        devedition_version = fx_download_dir_url.split("/")[-2]
+        fx_download_dir_url = f"{fx_download_dir_url}{get_fx_platform()}/{language}/"
 
-        # Fetch the page
-        response = requests.get(fx_download_dir_url)
-        status = response.status_code
+    else:
+        # Anything but devedition
+
+        candidate_exists = True
+        this_beta = BACKSTOP
+        while candidate_exists:
+            (major, minor_beta) = this_beta.split(".")
+            (minor, beta) = minor_beta.split("b")
+            major = int(major)
+            minor = int(minor)
+            beta = int(beta)
+
+            next_major = f"{major + 1}.0b1"
+            fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{next_major}-candidates/build1/"
+            rs = requests.get(fx_download_dir_url)
+            if rs.status_code < 300:
+                latest_beta_ver = next_major
+                this_beta = next_major
+                continue
+
+            next_minor = f"{major}.{minor + 1}b1"
+            fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{next_minor}-candidates/build1/"
+            rs = requests.get(fx_download_dir_url)
+            if rs.status_code < 300:
+                latest_beta_ver = next_minor
+                this_beta = next_minor
+                continue
+
+            next_beta = f"{major}.{minor}b{beta + 1}"
+            fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{next_beta}-candidates/build1/"
+            rs = requests.get(fx_download_dir_url)
+            if rs.status_code < 300:
+                latest_beta_ver = next_beta
+                this_beta = next_beta
+                continue
+
+            candidate_exists = False
+
+        status = 200
+        build = 0
+        while status < 400 and build < 20:
+            build += 1
+            fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{latest_beta_ver}-candidates/build{build}/"
+
+            # Fetch the page
+            response = requests.get(fx_download_dir_url)
+            status = response.status_code
+
+        # Correct build is the last one that didn't 404
+        build -= 1
+        fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{latest_beta_ver}-candidates/build{build}/{get_fx_platform()}/{language}/"
 
-    # Correct build is the last one that didn't 404
-    build -= 1
-    fx_download_dir_url = f"https://archive.mozilla.org/pub/firefox/candidates/{latest_beta_ver}-candidates/build{build}/{get_fx_platform()}/{language}/"
     response = requests.get(fx_download_dir_url)
     status = response.status_code
     response_text = None
@@ -179,8 +206,11 @@ def get_gd_platform():
 
     fx_download_executable_url = rf"{fx_download_dir_url}{executable_name}"
     if NUMBER_ONLY:
-        number_cand = fx_download_dir_url.split("/")[6]
-        number = number_cand.split("-")[0]
-        print(f"{number}-build{build}")
+        if channel == "-devedition":
+            print(devedition_version)
+        else:
+            number_cand = fx_download_dir_url.split("/")[6]
+            number = number_cand.split("-")[0]
+            print(f"{number}-build{build}")
     else:
         print(fx_download_executable_url)

collect_executables.sh

@@ -7,6 +7,7 @@ then
     curl -o Firefox.dmg -L "$(pipenv run python collect_executables.py)"
     hdiutil attach Firefox.dmg
 else
+    pipenv run python collect_executables.py
     curl -o firefox.tar.xz -L "$(pipenv run python collect_executables.py)"
     tar xf firefox.tar.xz
 fi

l10n_CM/Unified/conftest.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture()
 def region():
-    return os.environ.get("STARFOX_REGION", "US")
+    return os.environ.get("FX_REGION", "US")
 
 
 @pytest.fixture()