|
| 1 | +#!/usr/bin/env bash |
| 2 | +# Run AI-driven E2E tests on an iOS Simulator using simulator-llm-pilot. |
| 3 | +# |
| 4 | +# This script manages the full lifecycle: |
| 5 | +# 1. Check for "Testing" label on PR (Buildkite only, skips if missing) |
| 6 | +# 2. Download build artifacts and install app (Buildkite only) |
| 7 | +# 3. Install the simulator-llm-pilot gem from GitHub |
| 8 | +# 4. Run tests (gem handles simulator, WDA, agent loop, and results) |
| 9 | +# |
| 10 | +# The gem provides a sandboxed agent that drives the simulator through a |
| 11 | +# fixed set of tools (tap, swipe, type, REST API, etc.) — no arbitrary |
| 12 | +# code execution, no shell access. |
| 13 | +# |
| 14 | +# Required environment variables: |
| 15 | +# ANTHROPIC_API_KEY Claude API key |
| 16 | +# SIMULATOR_LLM_PILOT_SITE_URL WordPress test site URL |
| 17 | +# SIMULATOR_LLM_PILOT_USERNAME WordPress username |
| 18 | +# SIMULATOR_LLM_PILOT_APP_PASSWORD WordPress application password |
| 19 | +# |
| 20 | +# Optional environment variables: |
| 21 | +# APP wordpress | jetpack (default: jetpack) |
| 22 | +# SIMULATOR_NAME Simulator to boot if none running (default: iPhone 16) |
| 23 | +# TEST_DIR Test directory (default: Tests/AgentTests/ui-tests) |
| 24 | +# SIMULATOR_LLM_PILOT_REPO_URL Remote repo URL for simulator-llm-pilot |
| 25 | +# SIMULATOR_LLM_PILOT_SOURCE_PATH Local source checkout override for simulator-llm-pilot |
| 26 | + |
| 27 | +set -euo pipefail |
| 28 | + |
| 29 | +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" |
| 30 | +REPO_ROOT="$(cd "$SCRIPT_DIR/../.." && pwd)" |
| 31 | +cd "$REPO_ROOT" |
| 32 | + |
| 33 | +normalize_site_url() { |
| 34 | + local site_url="$1" |
| 35 | + if [[ "$site_url" == http://* || "$site_url" == https://* ]]; then |
| 36 | + printf '%s' "$site_url" |
| 37 | + else |
| 38 | + printf 'https://%s' "$site_url" |
| 39 | + fi |
| 40 | +} |
| 41 | + |
| 42 | +# ── Label gate (Buildkite only) ───────────────────────────────────── |
| 43 | +if [[ -n "${BUILDKITE_PULL_REQUEST_LABELS:-}" ]]; then |
| 44 | + echo "--- Checking for 'Testing' label" |
| 45 | + |
| 46 | + if ! echo ",${BUILDKITE_PULL_REQUEST_LABELS}," | grep -qF ",Testing,"; then |
| 47 | + echo "PR does not have the 'Testing' label. Skipping." |
| 48 | + echo "Add the label and re-run this step to trigger AI E2E tests." |
| 49 | + exit 0 |
| 50 | + fi |
| 51 | + echo "'Testing' label found." |
| 52 | +fi |
| 53 | + |
| 54 | +# ── Required env vars ──────────────────────────────────────────────── |
| 55 | +: "${ANTHROPIC_API_KEY:?Set ANTHROPIC_API_KEY}" |
| 56 | +: "${SIMULATOR_LLM_PILOT_SITE_URL:?Set SIMULATOR_LLM_PILOT_SITE_URL}" |
| 57 | +: "${SIMULATOR_LLM_PILOT_USERNAME:?Set SIMULATOR_LLM_PILOT_USERNAME}" |
| 58 | +: "${SIMULATOR_LLM_PILOT_APP_PASSWORD:?Set SIMULATOR_LLM_PILOT_APP_PASSWORD}" |
| 59 | +export SIMULATOR_LLM_PILOT_SITE_URL="$(normalize_site_url "$SIMULATOR_LLM_PILOT_SITE_URL")" |
| 60 | + |
| 61 | +# ── Defaults ───────────────────────────────────────────────────────── |
| 62 | +APP="${APP:-jetpack}" |
| 63 | +export SIMULATOR_NAME="${SIMULATOR_NAME:-iPhone 16}" |
| 64 | +TEST_DIR="${TEST_DIR:-Tests/AgentTests/ui-tests}" |
| 65 | +SIMULATOR_LLM_PILOT_REPO_URL="${SIMULATOR_LLM_PILOT_REPO_URL:-https://github.com/Automattic/simulator-llm-pilot.git}" |
| 66 | +SIMULATOR_LLM_PILOT_SOURCE_PATH="${SIMULATOR_LLM_PILOT_SOURCE_PATH:-}" |
| 67 | + |
| 68 | +case "$APP" in |
| 69 | + wordpress) APP_BUNDLE_ID="org.wordpress"; APP_DISPLAY_NAME="WordPress" ;; |
| 70 | + jetpack) APP_BUNDLE_ID="com.automattic.jetpack"; APP_DISPLAY_NAME="Jetpack" ;; |
| 71 | + *) echo "Error: APP must be 'wordpress' or 'jetpack', got '$APP'" >&2; exit 1 ;; |
| 72 | +esac |
| 73 | + |
| 74 | +APP_INSTRUCTIONS_FILE="${REPO_ROOT}/Tests/AgentTests/app-instructions.md" |
| 75 | + |
| 76 | +# ── Artifact download (Buildkite only) ─────────────────────────────── |
| 77 | +if [[ -n "${BUILDKITE:-}" ]]; then |
| 78 | + echo "--- Downloading Build Artifacts" |
| 79 | + download_artifact "build-products-${APP}.tar" |
| 80 | + tar -xf "build-products-${APP}.tar" |
| 81 | + |
| 82 | + echo "--- Setting up Gems" |
| 83 | + install_gems |
| 84 | +fi |
| 85 | + |
| 86 | +# ── Install simulator-llm-pilot ────────────────────────────────────── |
| 87 | +echo "--- Installing simulator-llm-pilot" |
| 88 | +bash Scripts/ci/install-simulator-llm-pilot.sh |
| 89 | +echo "simulator-llm-pilot $(simulator-llm-pilot version)" |
| 90 | + |
| 91 | +# ── Resolve simulator and install app (Buildkite only) ─────────────── |
| 92 | +echo "--- Setting up Simulator" |
| 93 | + |
| 94 | +UDID="$(ruby Scripts/ci/find-booted-simulator.rb "$SIMULATOR_NAME" 2>/dev/null || true)" |
| 95 | +if [[ -z "$UDID" ]]; then |
| 96 | + echo "No booted simulator named '$SIMULATOR_NAME' found. Booting..." |
| 97 | + xcrun simctl boot "$SIMULATOR_NAME" 2>/dev/null || true |
| 98 | + UDID="$(ruby Scripts/ci/find-booted-simulator.rb "$SIMULATOR_NAME" 30 1 2>/dev/null || true)" |
| 99 | +fi |
| 100 | + |
| 101 | +if [[ -z "$UDID" ]]; then |
| 102 | + echo "Error: could not find a booted simulator named '$SIMULATOR_NAME'" >&2 |
| 103 | + exit 1 |
| 104 | +fi |
| 105 | + |
| 106 | +export SIMULATOR_UDID="$UDID" |
| 107 | +echo "Simulator UDID: $UDID" |
| 108 | + |
| 109 | +if [[ -n "${BUILDKITE:-}" ]]; then |
| 110 | + APP_PATH=$(find DerivedData/Build/Products -name "${APP_DISPLAY_NAME}.app" -path "*Debug-iphonesimulator*" | head -1) |
| 111 | + if [[ -z "$APP_PATH" ]]; then |
| 112 | + echo "Error: ${APP_DISPLAY_NAME}.app not found in build products" >&2 |
| 113 | + exit 1 |
| 114 | + fi |
| 115 | + echo "Installing $APP_PATH on simulator..." |
| 116 | + xcrun simctl install "$UDID" "$APP_PATH" |
| 117 | +fi |
| 118 | + |
| 119 | +# ── Build WebDriverAgent (if not present) ──────────────────────────── |
| 120 | +echo "--- Building WebDriverAgent" |
| 121 | +"$(dirname "$0")/build-wda.sh" |
| 122 | + |
| 123 | +# ── Run tests ──────────────────────────────────────────────────────── |
| 124 | +echo "--- Running AI E2E Tests" |
| 125 | + |
| 126 | +TIMESTAMP="$(date +%Y-%m-%d-%H%M)" |
| 127 | +RESULTS_DIR="Tests/AgentTests/results/${TIMESTAMP}" |
| 128 | + |
| 129 | +EXIT_CODE=0 |
| 130 | +simulator-llm-pilot run "$TEST_DIR" \ |
| 131 | + --app-bundle-id "$APP_BUNDLE_ID" \ |
| 132 | + --app-name "$APP_DISPLAY_NAME" \ |
| 133 | + --app-instructions-file "$APP_INSTRUCTIONS_FILE" \ |
| 134 | + --simulator-udid "$UDID" \ |
| 135 | + --results-dir "$RESULTS_DIR" \ |
| 136 | + || EXIT_CODE=$? |
| 137 | + |
| 138 | +# ── Report results ─────────────────────────────────────────────────── |
| 139 | +echo "--- Results" |
| 140 | +RESULTS_FILE="${RESULTS_DIR}/results.md" |
| 141 | +if [[ -f "$RESULTS_FILE" ]]; then |
| 142 | + cat "$RESULTS_FILE" |
| 143 | +else |
| 144 | + echo "Warning: no results.md found at $RESULTS_FILE" |
| 145 | +fi |
| 146 | + |
| 147 | +exit "$EXIT_CODE" |
0 commit comments