mattermost-mobile-upstream/.github/workflows/e2e-detox-pr.yml
yasser khan 0f9beb0f95
ci(e2e): per-job TSIO report groups, commit statuses, and webhook sidecar (#9969)
* ci(e2e): per-job TSIO report groups and commit statuses

E2E jobs previously shared a single `e2e/mobile` commit status backed by one
TSIO report group, so concurrent platform legs raced to finalize the group and
clobbered each other's results. Give each Detox/Maestro job its own report
group (`mobile-<flow>-<job>`, total_reports_expected=1) and its own commit
status context (`detox-ios`, `detox-android`, `detox-ipad`, `maestro-ios`,
`maestro-android`); CMT reports per shard plus an umbrella context.

Channel notifications move to a single rollup step so N platform legs no
longer spam the webhook, and the five-server topology is dispatched with
explicit per-platform inputs that still resolve to the existing SITE_*_URL
contract consumed by the test config.

Also adds the webhook sidecar launcher, Android emulator CI prep, and TSIO
screenshot path linking that keeps folder basenames matching Jest full names.

The new detox type-check job surfaced pre-existing broken import paths in
maestro/fixtures/calls_seed.ts, which pointed at detox/detox/e2e; corrected so
the guard passes on its own first run.

Note: the CMT matrix now reads per-platform server URLs (`ios_site_1_url`,
`android_site_1_url`, `site_3_url`) instead of a single `url`, which needs the
matching Matterwick dispatch change to land alongside this.

Co-authored-by: Cursor <cursoragent@cursor.com>

* ci(e2e): aggregate CMT channel rollup from TSIO and wire notify secrets

The CMT umbrella posted a placeholder summary built from CI job outcomes
(passed:0, failed:0|1, reports:[]), so the release channel message carried no
per-leg detail. It now runs the same tsio-channel-notify-rollup.js path as
PR/main: cmt-identity emits a per-shard TSIO config map and the rollup polls
every shard group, so counts and per-leg rows come from TSIO. The rollup job
also needs id-token: write to mint its OIDC token.

Webhook secrets used by the per-job TSIO finalize steps were referenced but
never declared in the templates' workflow_call.secrets, so GitHub resolved them
to empty strings and channel notify silently no-opped. Declare them in the
iOS/Android/Maestro templates and forward them from e2e-detox.yml and the CMT
callers. The Maestro PR path worked only because its callers use
secrets: inherit.

Also from review:
- split-tests.js emitted two matrix jobs at parallelism=1 when mm_blocks specs
  were present; merge into one shard instead of exceeding the requested count.
- Move the Android ARTIFACT_RUN_ID emptiness check ahead of download-artifact,
  which consumes it and otherwise fails with an opaque API error.
- resolve-tsio-job-config.sh now reuses webhookBucketForReportName instead of
  re-deriving the bucket prefix with a looser startsWith check.

Co-authored-by: Cursor <cursoragent@cursor.com>

* ci(e2e): add local preflight for CI PRs

The webhook-secret and OIDC-permission gaps in this branch were invisible
locally and in a green CI run — the affected steps exit 0 and just skip the
notify or commit status. Add a script engineers can run before opening a PR that
touches .github/ or detox/utils:

  cd detox && npm run preflight:ci        # :ci-fast skips lint + tsc

It runs actionlint (which flags secrets not declared in a callee's
workflow_call.secrets), scans for exit-code capture broken by a trailing
backslash, asserts every job running a TSIO OIDC script declares
id-token: write, then runs the detox/utils tests and npm run check. actionlint
and the CodeRabbit CLI are optional and skipped with an install hint when absent.

Co-authored-by: Cursor <cursoragent@cursor.com>

* ci(e2e): use mktemp for preflight logs

Fixed /tmp log paths can be pre-created as symlinks, so the preflight
script would truncate whatever they point at (CWE-377). Create both logs
with mktemp and drop them on exit.

Co-authored-by: Cursor <cursoragent@cursor.com>

* ci(e2e): address review feedback on TSIO statuses and sidecar

A cancelled E2E run reached no conclusion, so posting `success` on its
commit statuses let a PR merge on a check that never ran. Cancelled runs
now post `pending`; `success` is reserved for the one deliberate bypass,
the E2E/Override label.

Commit-status contexts move into the `e2e-test/*` namespace to match the
mattermost monorepo, with the prefix owned by build-tsio-job-config.js and
mirrored in the cancel action's context list. Legacy unprefixed and `e2e/*`
contexts are dropped rather than carried forward.

The `preflight:ci` script and its OIDC-permission checker duplicated what
actionlint, the unit tests and `npm run check` already do, so they are
removed and detox/CLAUDE.md documents the underlying failure modes and the
commands to catch them instead.

cloudflared and the TSIO CLI are pinned to known-good releases rather than
`latest`, and detox/README.md now documents the webhook sidecar: when a
tunnel is needed, the WEBHOOK_PUBLIC_BASE_URL / CLOUDFLARED_TUNNEL_TOKEN
precedence, and why quick tunnels report callbacks as unreachable.

Co-authored-by: Cursor <cursoragent@cursor.com>

* ci(e2e): detect upstream cancellation and surface status reset failures

generate-report runs with always(), so job.status stays "success" when an
upstream job is cancelled and TSIO was published as a real failure. Read the
generate-specs/e2e-* needs results so a cancelled run is reported as such.

In cancel-e2e-runs, only reset the E2E commit statuses for runs that were
actually stopped — a run we failed to cancel keeps publishing its own results.
Aggregate createCommitStatus failures across every context and fail the action
afterwards instead of silently warning, so a stale check cannot go unnoticed.

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-29 13:45:06 +05:30

932 lines
39 KiB
YAML

# Matterwick E2E entry point (workflow_dispatch only).
#
# Matterwick dispatches this file via:
# POST /repos/{owner}/{repo}/actions/workflows/e2e-detox-pr.yml/dispatches
# and watches workflow_run "completed" events where workflow name is "E2E".
#
# Despite the `-pr` filename this is the entry point for *every* Matterwick E2E
# dispatch, not just PRs: run_type selects the flavour (PR, MAIN/MASTER for
# main-branch pushes, RELEASE). Renaming the file would break the dispatch URL
# above, so it needs a coordinated Matterwick change.
#
# Newer dispatches cancel older in-flight runs on the same branch (resolve-e2e-policy
# first step) so the latest SHA starts immediately instead of queueing behind a long run.
#
# Phase 1 — builds & setup (parallel):
# build-ios-simulator, build-android-apk-maestro, build-android-apk (Detox debug APK),
# provision-servers, validate-maestro-flow-headers
# Phase 2 — tests (parallel, after phase 1):
# run-detox-ios / run-detox-android → e2e-detox.yml
# run-maestro-ios / run-maestro-android → e2e-maestro-pr.yml (downloads phase-1 artifacts via artifact_run_id)
name: E2E
on:
workflow_dispatch:
inputs:
MOBILE_VERSION:
description: "The mobile app commit SHA to test"
required: true
type: string
PLATFORM:
description: "Mobile platform to test: ios, android, or both"
required: false
default: "both"
type: choice
options:
- ios
- android
- both
ANDROID_SITE_1_URL:
description: "URL of Android test server A (provisioned by Matterwick)"
required: true
type: string
ANDROID_SITE_2_URL:
description: "URL of Android test server B (provisioned by Matterwick)"
required: true
type: string
IOS_SITE_1_URL:
description: "URL of iOS test server A (provisioned by Matterwick)"
required: true
type: string
IOS_SITE_2_URL:
description: "URL of iOS test server B (provisioned by Matterwick)"
required: true
type: string
SITE_3_URL:
description: "URL of the shared fifth Mattermost test server"
required: true
type: string
pr_number:
description: "PR number to remove E2E label from after tests complete"
required: false
type: string
run_type:
description: "Run type for test reporting (PR/RELEASE/MAIN). MASTER is accepted as an alias for MAIN (Matterwick main-push)."
required: false
default: "PR"
type: string
version_name:
description: "Branch or version ref under test (e.g. feature-branch, main, release-2.40). Used as TSIO branch — not pr-{number}."
required: false
type: string
# Default least-privilege token; jobs that upload artifacts, post statuses, or
# manage PR labels declare the extra scopes they need.
permissions:
contents: read
# test-system-io-report-upload (in the nested detox templates) authenticates
# via the workflow's OIDC token and resolves gh_job_id via the GitHub API.
# Reusable workflows cannot escalate beyond the caller, so the root caller
# must grant these.
id-token: write
actions: read
env:
INTUNE_ENABLED: 'false'
DETOX_AWS_S3_BUCKET: "mattermost-detox-report"
jobs:
resolve-e2e-policy:
name: Resolve E2E policy (Override label)
runs-on: ubuntu-24.04
permissions:
actions: write
contents: read
pull-requests: read
issues: read
statuses: write
outputs:
e2e_override: ${{ steps.policy.outputs.e2e_override }}
steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
- name: Cancel superseded E2E runs on this branch
uses: ./.github/actions/cancel-e2e-runs
with:
head_branch: ${{ github.ref_name }}
pr_number: ${{ inputs.pr_number }}
max_run_id_exclusive: ${{ github.run_id }}
reason: E2E superseded by newer dispatch
- name: Check PR labels for E2E/Override
id: policy
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
PR_NUMBER: ${{ inputs.pr_number }}
MOBILE_VERSION: ${{ inputs.MOBILE_VERSION }}
with:
script: |
const prInput = parseInt(process.env.PR_NUMBER, 10);
let prNumber = Number.isFinite(prInput) ? prInput : null;
if (!prNumber && process.env.MOBILE_VERSION) {
try {
const {data: prs} = await github.rest.repos.listPullRequestsAssociatedWithCommit({
owner: context.repo.owner,
repo: context.repo.repo,
commit_sha: process.env.MOBILE_VERSION,
});
const openPr = prs.find((pr) => pr.state === 'open');
if (openPr) {
prNumber = openPr.number;
core.info(`Resolved PR #${prNumber} from commit ${process.env.MOBILE_VERSION}`);
}
} catch (err) {
core.warning(`Could not resolve PR from commit: ${err.message}`);
}
}
if (!prNumber) {
core.info('No PR number available — assuming E2E/Override is not set.');
core.setOutput('e2e_override', 'false');
return;
}
const {data: pr} = await github.rest.pulls.get({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: prNumber,
});
if (pr.base.ref !== 'main') {
core.info(`PR #${prNumber} targets ${pr.base.ref}, not main — skipping E2E.`);
core.setOutput('e2e_override', 'true');
return;
}
const {data: labels} = await github.rest.issues.listLabelsOnIssue({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: prNumber,
});
const override = labels.some((label) => label.name === 'E2E/Override');
core.info(`PR #${prNumber} E2E/Override=${override}`);
core.setOutput('e2e_override', override ? 'true' : 'false');
calculate-tsio-identity:
name: Calculate TSIO per-job identities
runs-on: ubuntu-24.04
permissions:
contents: read
pull-requests: read
needs: resolve-e2e-policy
if: needs.resolve-e2e-policy.outputs.e2e_override != 'true'
outputs:
job-configs: ${{ steps.id.outputs.job-configs }}
job-keys: ${{ steps.id.outputs.job-keys }}
steps:
- name: Sparse checkout TSIO job-config helper
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
ref: ${{ inputs.MOBILE_VERSION }}
persist-credentials: false
sparse-checkout: |
detox/utils/build-tsio-job-config.js
- name: Resolve branch ref for TSIO display URL
id: branch
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
env:
VERSION_NAME: ${{ inputs.version_name }}
PR_NUMBER: ${{ inputs.pr_number }}
RUN_TYPE: ${{ inputs.run_type || 'PR' }}
with:
script: |
const versionName = (process.env.VERSION_NAME || '').trim();
if (versionName) {
core.setOutput('branch', versionName.replace(/^refs\/heads\//, '').replace(/^refs\/tags\//, ''));
return;
}
const runType = (process.env.RUN_TYPE || 'PR').toUpperCase();
// Matterwick still sends MASTER for main-branch pushes; treat as MAIN.
if (runType === 'MAIN' || runType === 'MASTER') {
core.setOutput('branch', 'main');
return;
}
const prInput = parseInt(process.env.PR_NUMBER, 10);
if (Number.isFinite(prInput)) {
const {data: pr} = await github.rest.pulls.get({
owner: context.repo.owner,
repo: context.repo.repo,
pull_number: prInput,
});
core.setOutput('branch', pr.head.ref);
return;
}
core.setOutput('branch', context.ref_name || 'main');
- id: id
env:
PLATFORM: ${{ inputs.PLATFORM }}
GITHUB_REPOSITORY: ${{ github.repository }}
MM_SHA: ${{ inputs.MOBILE_VERSION }}
PR_NUMBER: ${{ inputs.pr_number }}
RUN_TYPE: ${{ inputs.run_type || 'PR' }}
BRANCH: ${{ steps.branch.outputs.branch }}
run: |
# Matterwick main-push still sends MASTER; canonicalize to MAIN → mobile-main.
if [ "${RUN_TYPE}" = "MASTER" ]; then
RUN_TYPE=MAIN
fi
RUN_TYPE_LOWER=$(echo "${RUN_TYPE}" | tr '[:upper:]' '[:lower:]')
RUN_NAME="mobile-${RUN_TYPE_LOWER}"
if [ -n "${PR_NUMBER}" ]; then
BASE=$(jq -nc \
--arg repo "$GITHUB_REPOSITORY" --arg sha "$MM_SHA" --arg run_id "$GITHUB_RUN_ID" \
--arg attempt "$GITHUB_RUN_ATTEMPT" --arg branch "$BRANCH" --arg pr "$PR_NUMBER" --arg name "$RUN_NAME" \
'{repository:$repo, commit_sha:$sha, gh_run_id:$run_id, gh_run_attempt:$attempt, branch:$branch, name:$name, run_group:$name, gh_pr_number:$pr, framework:"detox"}')
else
BASE=$(jq -nc \
--arg repo "$GITHUB_REPOSITORY" --arg sha "$MM_SHA" --arg run_id "$GITHUB_RUN_ID" \
--arg attempt "$GITHUB_RUN_ATTEMPT" --arg branch "$BRANCH" --arg name "$RUN_NAME" \
'{repository:$repo, commit_sha:$sha, gh_run_id:$run_id, gh_run_attempt:$attempt, branch:$branch, name:$name, run_group:$name, framework:"detox"}')
fi
export BASE PLATFORM
JOB_CONFIGS=$(node -e '
const {buildTsioJobConfigMap, jobKeysForPlatform} = require("./detox/utils/build-tsio-job-config.js");
const base = JSON.parse(process.env.BASE);
const keys = jobKeysForPlatform(process.env.PLATFORM);
process.stdout.write(JSON.stringify(buildTsioJobConfigMap(base, keys)));
')
echo "job-configs=$JOB_CONFIGS" >> "$GITHUB_OUTPUT"
echo "job-keys=$(echo "$JOB_CONFIGS" | jq -r 'keys | join(",")')" >> "$GITHUB_OUTPUT"
update-initial-tsio-status:
name: Set pending per-job TSIO commit statuses
runs-on: ubuntu-24.04
needs:
- resolve-e2e-policy
- calculate-tsio-identity
if: >-
needs.resolve-e2e-policy.outputs.e2e_override != 'true'
&& needs.calculate-tsio-identity.result == 'success'
&& (inputs.run_type == 'PR' || inputs.run_type == 'MAIN' || inputs.run_type == 'MASTER')
permissions:
contents: read
statuses: write
steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
ref: ${{ inputs.MOBILE_VERSION }}
persist-credentials: false
- name: Post pending status for each platform job
env:
GITHUB_TOKEN: ${{ github.token }}
JOB_CONFIGS: ${{ needs.calculate-tsio-identity.outputs.job-configs }}
COMMIT_SHA: ${{ inputs.MOBILE_VERSION }}
REPO: ${{ github.repository }}
TARGET_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
run: |
echo "$JOB_CONFIGS" | jq -c 'to_entries[]' | while read -r entry; do
CTX=$(echo "$entry" | jq -r '.value.status_context')
NAME=$(echo "$entry" | jq -r '.value.composite_identity.name')
gh api --method POST "repos/${REPO}/statuses/${COMMIT_SHA}" \
-f state=pending \
-f context="$CTX" \
-f description="Mobile E2E (${NAME}) — waiting for TSIO report" \
-f target_url="$TARGET_URL"
done
resolve-server-topology:
name: Resolve test server topology
runs-on: ubuntu-24.04
needs: resolve-e2e-policy
if: needs.resolve-e2e-policy.outputs.e2e_override != 'true'
outputs:
android-site-1-url: ${{ steps.topology.outputs.android-site-1-url }}
android-site-2-url: ${{ steps.topology.outputs.android-site-2-url }}
ios-site-1-url: ${{ steps.topology.outputs.ios-site-1-url }}
ios-site-2-url: ${{ steps.topology.outputs.ios-site-2-url }}
site-3-url: ${{ steps.topology.outputs.site-3-url }}
steps:
- name: Resolve five-server inputs
id: topology
env:
ANDROID_SITE_1_URL: ${{ inputs.ANDROID_SITE_1_URL }}
ANDROID_SITE_2_URL: ${{ inputs.ANDROID_SITE_2_URL }}
IOS_SITE_1_URL: ${{ inputs.IOS_SITE_1_URL }}
IOS_SITE_2_URL: ${{ inputs.IOS_SITE_2_URL }}
SITE_3_URL: ${{ inputs.SITE_3_URL }}
run: |
for name in ANDROID_SITE_1_URL ANDROID_SITE_2_URL IOS_SITE_1_URL IOS_SITE_2_URL SITE_3_URL; do
if [ -z "${!name}" ]; then
echo "::error::$name is required for the five-server topology"
exit 1
fi
done
{
echo "android-site-1-url=$ANDROID_SITE_1_URL"
echo "android-site-2-url=$ANDROID_SITE_2_URL"
echo "ios-site-1-url=$IOS_SITE_1_URL"
echo "ios-site-2-url=$IOS_SITE_2_URL"
echo "site-3-url=$SITE_3_URL"
} >> "$GITHUB_OUTPUT"
build-ios-simulator:
if: >-
!cancelled()
&& needs.resolve-e2e-policy.outputs.e2e_override != 'true'
&& (inputs.PLATFORM == 'ios' || inputs.PLATFORM == 'both')
runs-on: macos-26
needs:
- resolve-e2e-policy
permissions:
contents: read
actions: write
steps:
- name: Checkout Repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
ref: ${{ inputs.MOBILE_VERSION }}
- name: Prepare iOS Build
uses: ./.github/actions/prepare-ios-build
with:
intune-enabled: ${{ env.INTUNE_ENABLED }}
intune-ssh-private-key: ${{ secrets.MM_MOBILE_INTUNE_DEPLOY_KEY }}
- name: Set .env with RUNNING_E2E=true
run: echo "RUNNING_E2E=true" > .env
- name: Build iOS Simulator
env:
TAG: ${{ inputs.MOBILE_VERSION }}
GITHUB_TOKEN: ${{ secrets.MM_MOBILE_GITHUB_TOKEN }}
run: bundle exec fastlane ios simulator --env ios.simulator
working-directory: ./fastlane
- name: Upload iOS Simulator Build
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: ios-build-simulator-${{ github.run_id }}
path: Mattermost-simulator-*.app.zip
build-android-apk:
if: >-
!cancelled()
&& needs.resolve-e2e-policy.outputs.e2e_override != 'true'
&& (inputs.PLATFORM == 'android' || inputs.PLATFORM == 'both')
runs-on: ubuntu-latest-8-cores
needs:
- resolve-e2e-policy
permissions:
contents: read
actions: write
env:
ORG_GRADLE_PROJECT_jvmargs: -Xmx8g
steps:
- name: Prune Docker to free up space
run: docker system prune -af
- name: Checkout Repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
ref: ${{ inputs.MOBILE_VERSION }}
- name: Prepare Android Build
uses: ./.github/actions/prepare-android-build
env:
STORE_FILE: ${{ secrets.MM_MOBILE_STORE_FILE }}
STORE_ALIAS: ${{ secrets.MM_MOBILE_STORE_ALIAS }}
STORE_PASSWORD: ${{ secrets.MM_MOBILE_STORE_PASSWORD }}
MATTERMOST_BUILD_GH_TOKEN: ${{ secrets.MATTERMOST_BUILD_GH_TOKEN }}
# Cache Gradle dependencies — same key as e2e-detox-release.yml so the
# PR + release workflows share cache. Saves 3-5 min on warm runs by
# skipping gradle plugin resolution + Maven dep downloads.
- name: Cache Gradle dependencies
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: /home/runner/.gradle/caches/modules-2/
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
restore-keys: ${{ runner.os }}-gradle-
- name: Detox build
run: |
cd detox
npm ci --prefer-offline --no-audit --no-fund
npm run e2e:android-build
- name: Upload Android Build
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: android-build-files-${{ github.run_id }}
path: "android/app/build/**/*"
build-android-apk-maestro:
if: >-
!cancelled()
&& needs.resolve-e2e-policy.outputs.e2e_override != 'true'
&& (inputs.PLATFORM == 'android' || inputs.PLATFORM == 'both')
runs-on: ubuntu-latest-8-cores
needs:
- resolve-e2e-policy
permissions:
contents: read
actions: write
env:
ORG_GRADLE_PROJECT_jvmargs: -Xmx8g
steps:
- name: Prune Docker to free up space
run: docker system prune -af
- name: Checkout Repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
ref: ${{ inputs.MOBILE_VERSION }}
- name: Prepare Android Build
uses: ./.github/actions/prepare-android-build
env:
STORE_FILE: ${{ secrets.MM_MOBILE_STORE_FILE }}
STORE_ALIAS: ${{ secrets.MM_MOBILE_STORE_ALIAS }}
STORE_PASSWORD: ${{ secrets.MM_MOBILE_STORE_PASSWORD }}
MATTERMOST_BUILD_GH_TOKEN: ${{ secrets.MATTERMOST_BUILD_GH_TOKEN }}
- name: Build Maestro Android APK
uses: ./.github/actions/build-android-maestro-apk
- name: Upload Maestro Android Build
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: android-maestro-build-files-${{ github.run_id }}
path: android/app/build/outputs/apk/release/
provision-servers:
name: Provision test servers
needs:
- resolve-e2e-policy
- resolve-server-topology
if: >-
needs.resolve-e2e-policy.outputs.e2e_override != 'true'
runs-on: ubuntu-24.04
steps:
- name: Validate server URLs
run: |
validate_url() {
local url="$1" label="$2"
if [ -z "$url" ]; then return 0; fi
# Reject any whitespace (space, tab, newline). Without this, an input
# like "https://valid.cloud https://evil.example.com" would pass the
# rest of the validators (urlparse only inspects up to the first
# space) but then get word-split into two URLs by an unquoted shell
# iteration downstream — letting the second, unvalidated URL reach
# the provisioning sink. Whitespace is never legal in a URL anyway.
if [[ "$url" =~ [[:space:]] ]]; then
echo "::error::$label contains whitespace: $url"
exit 1
fi
# Must be HTTPS
if [[ ! "$url" =~ ^https:// ]]; then
echo "::error::$label must use HTTPS: $url"
exit 1
fi
# Extract hostname safely using Python URL parser to prevent SSRF bypass via userinfo.
# CRITICAL: the URL is passed as argv[1], NOT interpolated into the Python source.
# The Python code is single-quoted so bash performs no expansion inside it; "$url"
# is a separate argv argument, treated as a literal string by Python. This prevents
# injection of Python syntax (e.g. https://a.com')+__import__('os').system(...)+(' )
# that would escape the urlparse() call if the URL were interpolated.
hostname=$(python3 -c 'import sys; from urllib.parse import urlparse; print(urlparse(sys.argv[1]).hostname or "")' "$url" | tr '[:upper:]' '[:lower:]')
# Block private/internal IPs
if echo "$hostname" | grep -qE '^(127\.|10\.|172\.(1[6-9]|2[0-9]|3[01])\.|192\.168\.|0\.|localhost|::1$|::ffff:|fe80:)'; then
echo "::error::$label points to a private/internal address: $hostname"
exit 1
fi
# Allowlist: only Mattermost-operated domains
if ! echo "$hostname" | grep -qE '\.(cloud\.mattermost\.com|test\.mattermost\.cloud|mattermost\.com|mattermost\.cloud)$'; then
echo "::error::$label domain not in allowlist: $hostname"
exit 1
fi
echo "✓ $label validated: $hostname"
}
validate_url "$ANDROID_SITE_1_URL" "ANDROID_SITE_1_URL"
validate_url "$ANDROID_SITE_2_URL" "ANDROID_SITE_2_URL"
validate_url "$IOS_SITE_1_URL" "IOS_SITE_1_URL"
validate_url "$IOS_SITE_2_URL" "IOS_SITE_2_URL"
validate_url "$SITE_3_URL" "SITE_3_URL"
env:
ANDROID_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.android-site-1-url }}
ANDROID_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.android-site-2-url }}
IOS_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.ios-site-1-url }}
IOS_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.ios-site-2-url }}
SITE_3_URL: ${{ needs.resolve-server-topology.outputs.site-3-url }}
- name: Checkout Repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
ref: ${{ inputs.MOBILE_VERSION }}
persist-credentials: false
# Download the demo plugin once per workflow (or on cache miss) so
# provision can upload from a local fixture instead of install_from_url.
# Test runners rely on the server already being provisioned — they do not
# download this artifact.
- name: Cache demo plugin fixture
id: demo-plugin-cache
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: detox/e2e/support/fixtures/mattermost-plugin-demo-v0.11.1-linux-amd64.tar.gz
key: mattermost-plugin-demo-linux-amd64-v0.11.1
- name: Download demo plugin fixture
if: steps.demo-plugin-cache.outputs.cache-hit != 'true'
run: |
mkdir -p detox/e2e/support/fixtures
curl -fsSL -o detox/e2e/support/fixtures/mattermost-plugin-demo-v0.11.1-linux-amd64.tar.gz \
"https://github.com/mattermost/mattermost-plugin-demo/releases/download/v0.11.1/mattermost-plugin-demo-v0.11.1-linux-amd64.tar.gz"
ls -lh detox/e2e/support/fixtures/mattermost-plugin-demo-v0.11.1-linux-amd64.tar.gz
- name: Provision servers (license + plugins)
run: |
cd detox
npm ci --prefer-offline --no-audit --no-fund
# Quote every variable in the iteration. Without quotes, bash word-splits
# on whitespace and would treat e.g. "https://a https://b" as two URLs,
# bypassing the per-variable validation in the previous step (which
# validates the value as a single string). The validator above also
# rejects whitespace outright, so this is belt-and-suspenders.
declare -A provisioned=()
for url in "$ANDROID_SITE_1_URL" "$ANDROID_SITE_2_URL" "$IOS_SITE_1_URL" "$IOS_SITE_2_URL" "$SITE_3_URL"; do
if [ -n "$url" ] && [ -z "${provisioned[$url]+x}" ]; then
echo "--- Provisioning $url ---"
npm run provision -- "$url"
provisioned["$url"]=1
fi
done
env:
ANDROID_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.android-site-1-url }}
ANDROID_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.android-site-2-url }}
IOS_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.ios-site-1-url }}
IOS_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.ios-site-2-url }}
SITE_3_URL: ${{ needs.resolve-server-topology.outputs.site-3-url }}
ADMIN_USERNAME: ${{ secrets.MM_MOBILE_E2E_ADMIN_USERNAME }}
ADMIN_PASSWORD: ${{ secrets.MM_MOBILE_E2E_ADMIN_PASSWORD }}
# iOS and Android Detox jobs are separate so each platform starts as soon as its
# own build finishes — Android does not wait for build-ios-simulator.
run-detox-ios:
name: Detox iOS E2E
needs:
- resolve-e2e-policy
- calculate-tsio-identity
- build-ios-simulator
- provision-servers
- resolve-server-topology
permissions:
contents: read
statuses: write
actions: read
id-token: write
if: |
!cancelled() &&
needs.resolve-e2e-policy.outputs.e2e_override != 'true' &&
(inputs.PLATFORM == 'ios' || inputs.PLATFORM == 'both') &&
needs.provision-servers.result == 'success' &&
(needs.build-ios-simulator.result == 'success' || needs.build-ios-simulator.result == 'skipped')
uses: ./.github/workflows/e2e-detox.yml
with:
MOBILE_VERSION: ${{ inputs.MOBILE_VERSION }}
PLATFORM: ios
ANDROID_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.android-site-1-url }}
ANDROID_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.android-site-2-url }}
IOS_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.ios-site-1-url }}
IOS_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.ios-site-2-url }}
SITE_3_URL: ${{ needs.resolve-server-topology.outputs.site-3-url }}
run_type: ${{ inputs.run_type || 'PR' }}
artifact_run_id: ${{ github.run_id }}
tsio-job-configs: ${{ needs.calculate-tsio-identity.outputs.job-configs }}
secrets: inherit
run-detox-android:
name: Detox Android E2E
needs:
- resolve-e2e-policy
- calculate-tsio-identity
- build-android-apk
- provision-servers
- resolve-server-topology
permissions:
contents: read
statuses: write
actions: read
id-token: write
if: |
!cancelled() &&
needs.resolve-e2e-policy.outputs.e2e_override != 'true' &&
(inputs.PLATFORM == 'android' || inputs.PLATFORM == 'both') &&
needs.provision-servers.result == 'success' &&
(needs.build-android-apk.result == 'success' || needs.build-android-apk.result == 'skipped')
uses: ./.github/workflows/e2e-detox.yml
with:
MOBILE_VERSION: ${{ inputs.MOBILE_VERSION }}
PLATFORM: android
ANDROID_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.android-site-1-url }}
ANDROID_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.android-site-2-url }}
IOS_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.ios-site-1-url }}
IOS_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.ios-site-2-url }}
SITE_3_URL: ${{ needs.resolve-server-topology.outputs.site-3-url }}
run_type: ${{ inputs.run_type || 'PR' }}
artifact_run_id: ${{ github.run_id }}
tsio-job-configs: ${{ needs.calculate-tsio-identity.outputs.job-configs }}
secrets: inherit
validate-maestro-flow-headers:
name: Validate Maestro flow headers
needs: resolve-e2e-policy
if: >-
needs.resolve-e2e-policy.outputs.e2e_override != 'true'
runs-on: ubuntu-24.04
steps:
- name: Checkout Repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false
ref: ${{ inputs.MOBILE_VERSION }}
- name: Validate flow header contract
run: bash detox/maestro/scripts/validate-flow-headers.sh
# Maestro orchestration lives in e2e-maestro-pr.yml so Detox and Maestro CI
# can evolve independently. Maestro downloads ios-build-simulator-* and
# android-maestro-build-files-* (release APK with embedded bundle) from this
# workflow run via artifact_run_id.
# iOS and Android are separate jobs so each platform starts as soon as its
# own build finishes — Android does not wait for build-ios-simulator.
run-maestro-ios:
name: Maestro iOS E2E
needs:
- resolve-e2e-policy
- calculate-tsio-identity
- build-ios-simulator
- provision-servers
- validate-maestro-flow-headers
- resolve-server-topology
permissions:
contents: read
statuses: write
actions: read
id-token: write
if: |
!cancelled() &&
needs.resolve-e2e-policy.outputs.e2e_override != 'true' &&
(inputs.PLATFORM == 'ios' || inputs.PLATFORM == 'both') &&
needs.provision-servers.result == 'success' &&
needs.validate-maestro-flow-headers.result == 'success' &&
(needs.build-ios-simulator.result == 'success' || needs.build-ios-simulator.result == 'skipped')
uses: ./.github/workflows/e2e-maestro-pr.yml
with:
MOBILE_VERSION: ${{ inputs.MOBILE_VERSION }}
PLATFORM: ios
ANDROID_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.android-site-1-url }}
ANDROID_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.android-site-2-url }}
IOS_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.ios-site-1-url }}
IOS_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.ios-site-2-url }}
SITE_3_URL: ${{ needs.resolve-server-topology.outputs.site-3-url }}
run_type: ${{ inputs.run_type || 'PR' }}
artifact_run_id: ${{ github.run_id }}
record_tests_in_zephyr: ${{ inputs.run_type == 'RELEASE' || inputs.run_type == 'MAIN' || inputs.run_type == 'MASTER' }}
tsio-job-configs: ${{ needs.calculate-tsio-identity.outputs.job-configs }}
secrets: inherit
run-maestro-android:
name: Maestro Android E2E
needs:
- resolve-e2e-policy
- calculate-tsio-identity
- build-android-apk-maestro
- provision-servers
- validate-maestro-flow-headers
- resolve-server-topology
permissions:
contents: read
statuses: write
actions: read
id-token: write
if: |
!cancelled() &&
needs.resolve-e2e-policy.outputs.e2e_override != 'true' &&
(inputs.PLATFORM == 'android' || inputs.PLATFORM == 'both') &&
needs.provision-servers.result == 'success' &&
needs.validate-maestro-flow-headers.result == 'success' &&
(needs.build-android-apk-maestro.result == 'success' || needs.build-android-apk-maestro.result == 'skipped')
uses: ./.github/workflows/e2e-maestro-pr.yml
with:
MOBILE_VERSION: ${{ inputs.MOBILE_VERSION }}
PLATFORM: android
ANDROID_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.android-site-1-url }}
ANDROID_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.android-site-2-url }}
IOS_SITE_1_URL: ${{ needs.resolve-server-topology.outputs.ios-site-1-url }}
IOS_SITE_2_URL: ${{ needs.resolve-server-topology.outputs.ios-site-2-url }}
SITE_3_URL: ${{ needs.resolve-server-topology.outputs.site-3-url }}
run_type: ${{ inputs.run_type || 'PR' }}
artifact_run_id: ${{ github.run_id }}
record_tests_in_zephyr: ${{ inputs.run_type == 'RELEASE' || inputs.run_type == 'MAIN' || inputs.run_type == 'MASTER' }}
tsio-job-configs: ${{ needs.calculate-tsio-identity.outputs.job-configs }}
secrets: inherit
e2e-remove-matterwick-label:
name: Remove Matterwick E2E label from PR
runs-on: ubuntu-24.04
permissions:
contents: read
issues: write
pull-requests: write
needs:
- resolve-e2e-policy
- run-detox-ios
- run-detox-android
- run-maestro-ios
- run-maestro-android
# Strip E2E/Run* after tests finish unless Maestro was externally cancelled
# (leave the label so the suite can be re-triggered).
if: |
!cancelled() &&
needs.resolve-e2e-policy.outputs.e2e_override != 'true' &&
contains(fromJSON('["success","failure","skipped"]'), needs.run-detox-ios.result) &&
contains(fromJSON('["success","failure","skipped"]'), needs.run-detox-android.result) &&
contains(fromJSON('["success","failure","skipped"]'), needs.run-maestro-ios.result) &&
contains(fromJSON('["success","failure","skipped"]'), needs.run-maestro-android.result)
steps:
- name: e2e/remove-label-from-pr
continue-on-error: true
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
with:
github-token: ${{ secrets.MATTERMOST_BUILD_GH_TOKEN }}
script: |
const owner = context.repo.owner;
const repo = context.repo.repo;
const runLabels = ['E2E/Run', 'E2E/Run-iOS', 'E2E/Run-Android'];
let prNumber = parseInt(process.env.PR_NUMBER, 10);
if (!Number.isFinite(prNumber) && process.env.MOBILE_VERSION) {
const {data: prs} = await github.rest.repos.listPullRequestsAssociatedWithCommit({
owner,
repo,
commit_sha: process.env.MOBILE_VERSION,
});
const openPr = prs.find((pr) => pr.state === 'open');
if (openPr) {
prNumber = openPr.number;
console.log(`Resolved PR #${prNumber} from commit ${process.env.MOBILE_VERSION}`);
}
}
if (!Number.isFinite(prNumber)) {
const branch = process.env.BRANCH;
if (branch) {
const {data: prs} = await github.rest.pulls.list({
owner,
repo,
head: `${owner}:${branch}`,
state: 'open',
per_page: 1,
});
if (prs.length > 0) {
prNumber = prs[0].number;
}
}
}
if (!Number.isFinite(prNumber)) {
core.warning('No PR found — skipping label removal');
return;
}
const {data: workflows} = await github.rest.actions.listRepoWorkflows({owner, repo});
const e2eWorkflow = workflows.workflows.find((workflow) => workflow.name === 'E2E');
if (e2eWorkflow) {
// Cache PR lookups per head_sha to avoid quadratic API calls.
const prsForSha = new Map();
const lookupPRsForSha = async (sha) => {
if (!sha) return [];
if (prsForSha.has(sha)) return prsForSha.get(sha);
try {
const {data} = await github.rest.repos.listPullRequestsAssociatedWithCommit({
owner,
repo,
commit_sha: sha,
});
const numbers = (data || []).map((p) => p.number);
prsForSha.set(sha, numbers);
return numbers;
} catch (err) {
core.warning(`listPullRequestsAssociatedWithCommit failed for ${sha}: ${err.message}`);
prsForSha.set(sha, []);
return [];
}
};
for (const status of ['queued', 'in_progress', 'waiting']) {
const {data: activeRuns} = await github.rest.actions.listWorkflowRuns({
owner,
repo,
workflow_id: e2eWorkflow.id,
status,
branch: process.env.BRANCH,
});
for (const run of activeRuns.workflow_runs) {
if (run.id === context.runId) {
continue;
}
// Fall back to per-SHA PR lookup when run.pull_requests is empty (fork PRs / webhook timing).
let belongsToPR;
if (run.pull_requests?.length) {
belongsToPR = run.pull_requests.some((pr) => pr.number === prNumber);
} else {
const numbers = await lookupPRsForSha(run.head_sha);
belongsToPR = numbers.includes(prNumber);
}
if (belongsToPR) {
core.info(`PR #${prNumber} has another active E2E run — skipping label removal (run ${run.id}).`);
return;
}
}
}
}
console.log(`Removing E2E labels from PR #${prNumber} (workflow conclusion: ${process.env.WORKFLOW_CONCLUSION || 'unknown'})`);
for (const label of runLabels) {
try {
await github.rest.issues.removeLabel({
issue_number: prNumber,
owner,
repo,
name: label,
});
console.log(`Removed ${label}`);
} catch (err) {
if (err.status !== 404) {
throw err;
}
}
}
env:
PR_NUMBER: ${{ inputs.pr_number }}
MOBILE_VERSION: ${{ inputs.MOBILE_VERSION }}
BRANCH: ${{ github.ref_name }}
WORKFLOW_CONCLUSION: ${{ job.status }}
# Per-platform TSIO commit statuses are finalized inside each Detox/Maestro
# generate-report / maestro job after that job's upload (total_reports_expected=1).
# No combined e2e/mobile finalizer — avoids cross-job clobber and pending races.
# One Mattermost channel rollup (best-effort). Per-job finalize leaves channel
# notify off so N legs do not spam; this job posts a single summary.
tsio-channel-notify:
name: Post Mattermost E2E channel rollup
runs-on: ubuntu-24.04
if: >-
always() &&
needs.resolve-e2e-policy.outputs.e2e_override != 'true' &&
needs.calculate-tsio-identity.result == 'success' &&
(inputs.run_type == 'PR' || inputs.run_type == 'MAIN' || inputs.run_type == 'MASTER')
needs:
- resolve-e2e-policy
- calculate-tsio-identity
- run-detox-ios
- run-detox-android
- run-maestro-ios
- run-maestro-android
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
ref: ${{ inputs.MOBILE_VERSION }}
persist-credentials: false
sparse-checkout: |
detox/utils/tsio-channel-notify-rollup.js
detox/utils/tsio-report-status.js
detox/utils/cmt-channel-notify.js
detox/utils/build-tsio-job-config.js
detox/utils/cli-args.js
- name: Aggregate per-job TSIO groups and notify channel
env:
JOB_CONFIGS: ${{ needs.calculate-tsio-identity.outputs.job-configs }}
MATTERMOST_E2E_WEBHOOK_URL: ${{ secrets.MM_MOBILE_E2E_WEBHOOK_URL }}
MATTERMOST_MASTER_HEALTH_WEBHOOK_URL: ${{ secrets.MM_E2E_MASTER_HEALTH_WEBHOOK_URL }}
MATTERMOST_CMT_WEBHOOK_URL: ${{ secrets.MM_E2E_RELEASE_WEBHOOK_URL }}
run: |
UPSTREAM="true"
for r in "${{ needs.run-detox-ios.result }}" "${{ needs.run-detox-android.result }}" "${{ needs.run-maestro-ios.result }}" "${{ needs.run-maestro-android.result }}"; do
case "$r" in
success|skipped) ;;
*) UPSTREAM="false" ;;
esac
done
node detox/utils/tsio-channel-notify-rollup.js \
--job-configs="$JOB_CONFIGS" \
--upstream-succeeded="$UPSTREAM" \
--poll-attempts=6 || true