test: [SDK-4333] expand Appium E2E test coverage

appium/README.md

@@ -44,12 +44,17 @@ cp .env.example .env   # add your OneSignal credentials
 
 Tests are numbered to run in dependency order (user login happens before push/email/SMS tests that require a logged-in user):
 
-| File | Description |
-|---|---|
-| `1_user.spec.ts` | Login, logout, anonymous state |
-| `2_push.spec.ts` | Push subscription |
-| `3_iam.spec.ts` | In-app messaging |
-| `4_alias.spec.ts` | Alias operations |
-| `5_email.spec.ts` | Email subscription |
-| `6_sms.spec.ts` | SMS subscription |
-| `7_tag.spec.ts` | Tag operations |
+| File                  | Description                    |
+| --------------------- | ------------------------------ |
+| `01_user.spec.ts`     | Login, logout, anonymous state |
+| `02_push.spec.ts`     | Push subscription              |
+| `03_iam.spec.ts`      | In-app messaging               |
+| `04_alias.spec.ts`    | Alias operations               |
+| `05_email.spec.ts`    | Email subscription             |
+| `06_sms.spec.ts`      | SMS subscription               |
+| `07_tag.spec.ts`      | Tag operations                 |
+| `08_outcome.spec.ts`  | Outcome sending                |
+| `09_trigger.spec.ts`  | Trigger add/remove/clear       |
+| `10_event.spec.ts`    | Custom event tracking          |
+| `11_location.spec.ts` | Location prompting and sharing |
+| `12_activity.spec.ts` | iOS Live Activity lifecycle    |

appium/scripts/.env.example

@@ -8,14 +8,13 @@ ONESIGNAL_API_KEY=your-api-key
 # BUNDLE_ID=com.onesignal.example
 
 # ── Optional (defaults shown) ────────────────────────────────────────────────
-# DEVICE=iPhone 17            # iOS default; Android default: Google Pixel 8
-# OS_VERSION=26.2             # iOS default; Android default: 14
+# OS_VERSION=26.2             # iOS default; Android default: 16
 
 # iOS-only
-# IOS_SIMULATOR=iPhone 17     # Simulator name (defaults to DEVICE)
+# IOS_SIMULATOR=iPhone 17     # Simulator name (defaults to --device)
 # IOS_RUNTIME=iOS-26-2        # simctl runtime identifier
 
 # Android-only
-# AVD_NAME=Pixel_8            # AVD to boot
+# AVD_NAME=Samsung_Galaxy_S26  # Defaults to --device with spaces replaced by underscores
 
 # APPIUM_PORT=4723

appium/scripts/README.md

@@ -42,16 +42,16 @@ If `--platform` or `--sdk` are not provided, the script prompts interactively.
 
 ### Options
 
-| Flag | Description |
-|---|---|
-| `--platform=P` | `ios` or `android` |
-| `--sdk=S` | `flutter` or `react-native` |
-| `--spec=GLOB` | Spec file glob (default: `tests/specs/**/*.spec.ts`) |
-| `--skip` | Skip build, device launch, and app reset (rerun tests only) |
-| `--skip-build` | Skip app build (reuse existing `.app`/`.apk`) |
-| `--skip-device` | Skip simulator/emulator launch |
-| `--skip-reset` | Keep existing app data between runs |
-| `-h, --help` | Show help |
+| Flag            | Description                                                 |
+| --------------- | ----------------------------------------------------------- |
+| `--platform=P`  | `ios` or `android`                                          |
+| `--sdk=S`       | `flutter` or `react-native`                                 |
+| `--spec=GLOB`   | Spec file glob (default: `tests/specs/**/*.spec.ts`)        |
+| `--skip`        | Skip build, device launch, and app reset (rerun tests only) |
+| `--skip-build`  | Skip app build (reuse existing `.app`/`.apk`)               |
+| `--skip-device` | Skip simulator/emulator launch                              |
+| `--skip-reset`  | Keep existing app data between runs                         |
+| `-h, --help`    | Show help                                                   |
 
 ### Examples
 
@@ -64,7 +64,13 @@ Run all tests (full build + fresh install):
 Run a single spec file:
 
 ```bash
-./run-local.sh --platform=ios --sdk=flutter --spec="tests/specs/1_user.spec.ts"
+./run-local.sh --platform=ios --sdk=flutter --spec="tests/specs/01_user.spec.ts"
+```
+
+Run multiple spec files:
+
+```bash
+./run-local.sh --platform=ios --sdk=flutter --spec="tests/specs/{01_user,08_outcome}.spec.ts"
 ```
 
 Re-run tests without rebuilding or relaunching the simulator:
@@ -83,19 +89,19 @@ Skip only the build (simulator + reset still happen):
 
 All env vars can be set in `.env` or exported in your shell. See [`.env.example`](.env.example) for the full list.
 
-| Variable | Default | Description |
-|---|---|---|
-| `ONESIGNAL_APP_ID` | -- | OneSignal app ID (written to demo app `.env`) |
-| `ONESIGNAL_API_KEY` | -- | OneSignal REST API key |
-| `FLUTTER_DIR` | `../../OneSignal-Flutter-SDK` | Path to the Flutter SDK repo |
-| `APP_PATH` | auto-detected from build | Path to `.app` or `.apk` |
-| `BUNDLE_ID` | `com.onesignal.example` | App bundle/package ID |
-| `DEVICE` | `iPhone 17` / `Google Pixel 8` | Device name for WebdriverIO |
-| `OS_VERSION` | `26.2` / `14` | Platform version |
-| `IOS_SIMULATOR` | same as `DEVICE` | Simulator name for `simctl` |
-| `IOS_RUNTIME` | `iOS-26-2` | simctl runtime identifier |
-| `AVD_NAME` | `Pixel_8` | Android AVD name |
-| `APPIUM_PORT` | `4723` | Appium server port |
+| Variable            | Default                            | Description                                   |
+| ------------------- | ---------------------------------- | --------------------------------------------- |
+| `ONESIGNAL_APP_ID`  | --                                 | OneSignal app ID (written to demo app `.env`) |
+| `ONESIGNAL_API_KEY` | --                                 | OneSignal REST API key                        |
+| `FLUTTER_DIR`       | `../../OneSignal-Flutter-SDK`      | Path to the Flutter SDK repo                  |
+| `APP_PATH`          | auto-detected from build           | Path to `.app` or `.apk`                      |
+| `BUNDLE_ID`         | `com.onesignal.example`            | App bundle/package ID                         |
+| `DEVICE`            | `iPhone 17` / `Samsung Galaxy S26` | Device name for WebdriverIO                   |
+| `OS_VERSION`        | `26.2` / `16`                      | Platform version                              |
+| `IOS_SIMULATOR`     | same as `DEVICE`                   | Simulator name for `simctl`                   |
+| `IOS_RUNTIME`       | `iOS-26-2`                         | simctl runtime identifier                     |
+| `AVD_NAME`          | `Samsung_Galaxy_S26`               | Android AVD name                              |
+| `APPIUM_PORT`       | `4723`                             | Appium server port                            |
 
 ## Troubleshooting
 

appium/scripts/run-local.sh

@@ -34,6 +34,7 @@ for arg in "$@"; do
   case "$arg" in
     --platform=*)  PLATFORM="${arg#--platform=}" ;;
     --sdk=*)       SDK_TYPE="${arg#--sdk=}" ;;
+    --device=*)    DEVICE="${arg#--device=}" ;;
     --skip)        SKIP_BUILD=true; SKIP_DEVICE=true; SKIP_RESET=true ;;
     --skip-build)  SKIP_BUILD=true ;;
     --skip-device) SKIP_DEVICE=true ;;
@@ -52,6 +53,7 @@ via flags or env vars.
 Options:
   --platform=P     ios | android
   --sdk=S          flutter | react-native
+  --device=NAME    Device/simulator/AVD name (default: iPhone 17 / Samsung Galaxy S26)
   --skip           Skip build, device launch, and app reset (rerun tests only)
   --skip-build     Skip app build (reuse existing)
   --skip-device    Skip simulator/emulator launch
@@ -64,9 +66,7 @@ Env vars (set in .env or export):
   BUNDLE_ID          Bundle/package id (default: com.onesignal.example)
   ONESIGNAL_APP_ID   OneSignal app ID (written to demo app .env)
   ONESIGNAL_API_KEY  OneSignal REST API key (written to demo app .env)
-  DEVICE             Device name for wdio (default: iPhone 17 / Google Pixel 8)
-  OS_VERSION         Platform version (default: 26.2 / 14)
-  AVD_NAME           Android AVD to boot (default: Pixel_8)
+  OS_VERSION         Platform version (default: 26.2 / 16)
   IOS_SIMULATOR      iOS simulator name (default: iPhone 17)
   IOS_RUNTIME        simctl runtime id (default: iOS-26-2)
   APPIUM_PORT        Appium port (default: 4723)
@@ -114,7 +114,6 @@ case "$PLATFORM" in
   *) error "PLATFORM must be 'ios' or 'android', got '$PLATFORM'" ;;
 esac
 
-[[ "$PLATFORM" == "android" ]] && error "Android is not supported yet. Only iOS is available for now."
 [[ "$SDK_TYPE" != "flutter" ]] && error "Only flutter is supported for now. Got '$SDK_TYPE'."
 
 BUNDLE_ID="${BUNDLE_ID:-com.onesignal.example}"
@@ -123,7 +122,11 @@ if [[ "$SDK_TYPE" == "flutter" ]]; then
   FLUTTER_DIR="${FLUTTER_DIR:-$SDK_ROOT/OneSignal-Flutter-SDK}"
   [[ -d "$FLUTTER_DIR" ]] || error "Flutter SDK not found at $FLUTTER_DIR — set FLUTTER_DIR in .env"
   DEMO_DIR="$FLUTTER_DIR/examples/demo"
-  APP_PATH="${APP_PATH:-$DEMO_DIR/build/ios/iphonesimulator/Runner.app}"
+  if [[ "$PLATFORM" == "ios" ]]; then
+    APP_PATH="${APP_PATH:-$DEMO_DIR/build/ios/iphonesimulator/Runner.app}"
+  else
+    APP_PATH="${APP_PATH:-$DEMO_DIR/build/app/outputs/flutter-apk/app-debug.apk}"
+  fi
 fi
 
 # ── Platform defaults ────────────────────────────────────────────────────────
@@ -133,9 +136,9 @@ if [[ "$PLATFORM" == "ios" ]]; then
   IOS_SIMULATOR="${IOS_SIMULATOR:-$DEVICE}"
   IOS_RUNTIME="${IOS_RUNTIME:-iOS-26-2}"
 else
-  DEVICE="${DEVICE:-Google Pixel 8}"
-  OS_VERSION="${OS_VERSION:-14}"
-  AVD_NAME="${AVD_NAME:-Pixel_8}"
+  DEVICE="${DEVICE:-Samsung Galaxy S26}"
+  OS_VERSION="${OS_VERSION:-16}"
+  AVD_NAME="${AVD_NAME:-${DEVICE// /_}}"
 fi
 
 # ── 1. Build app ─────────────────────────────────────────────────────────────
@@ -164,6 +167,28 @@ EOF
   info "App built: $APP_PATH"
 }
 
+build_flutter_android() {
+  if [[ -n "${ONESIGNAL_APP_ID:-}" && -n "${ONESIGNAL_API_KEY:-}" ]]; then
+    info "Writing .env for demo app..."
+    cat > "$DEMO_DIR/.env" <<EOF
+ONESIGNAL_APP_ID=$ONESIGNAL_APP_ID
+ONESIGNAL_API_KEY=$ONESIGNAL_API_KEY
+E2E_MODE=true
+EOF
+  else
+    warn "ONESIGNAL_APP_ID / ONESIGNAL_API_KEY not set — skipping demo .env"
+  fi
+
+  info "Installing Flutter dependencies..."
+  (cd "$FLUTTER_DIR" && flutter pub get)
+
+  info "Building debug APK (this may take a few minutes)..."
+  (cd "$DEMO_DIR" && flutter build apk --debug)
+
+  [[ -f "$APP_PATH" ]] || error ".apk not found after build at $APP_PATH"
+  info "App built: $APP_PATH"
+}
+
 build_app() {
   if [[ "$SKIP_BUILD" == true ]]; then
     if [[ "$PLATFORM" == "ios" && ! -d "$APP_PATH" ]] || [[ "$PLATFORM" == "android" && ! -f "$APP_PATH" ]]; then
@@ -173,7 +198,11 @@ build_app() {
     return
   fi
 
-  build_flutter_ios
+  if [[ "$PLATFORM" == "ios" ]]; then
+    build_flutter_ios
+  else
+    build_flutter_android
+  fi
 }
 
 # ── 2. Start device ──────────────────────────────────────────────────────────

appium/tests/helpers/app.ts

@@ -40,7 +40,7 @@ async function swipeMainContent(
   direction: 'up' | 'down',
   distance: 'small' | 'normal' | 'large' = 'normal',
 ) {
-  const distances = { small: 0.3, normal: 0.5, large: 1.0 };
+  const distances = { small: 0.2, normal: 0.5, large: 1.0 };
   const mainScroll = await byTestId('main_scroll_view');
   const platform = getPlatform();
   const invertedDirection = direction === 'up' ? 'down' : 'up';
@@ -88,25 +88,53 @@ export async function scrollToEl(
     if (await el.isDisplayed()) {
       return el;
     }
-    await swipeMainContent(direction, 'normal');
+    await swipeMainContent(direction, 'small');
   }
   throw new Error(`Element "${identifier}" not found after ${maxScrolls} scrolls`);
 }
 
+/**
+ * Wait for a native system alert to appear and return its text.
+ * Returns null if no alert appears within the timeout.
+ */
+export async function waitForAlert(timeoutMs = 10_000): Promise<string | null> {
+  try {
+    await driver.waitUntil(
+      async () => {
+        try {
+          const buttons = await driver.execute('mobile: alert', { action: 'getButtons' });
+          return Array.isArray(buttons) && buttons.length > 0;
+        } catch {
+          return false;
+        }
+      },
+      { timeout: timeoutMs, interval: 250 },
+    );
+    return await driver.getAlertText();
+  } catch {
+    return null;
+  }
+}
+
 /**
  * Wait for the app to fully launch and the home screen to be visible.
- * Uses the log view container as the sentinel element since it's present
- * on the home screen of all demo apps.
  */
 export async function waitForAppReady(opts: { skipLogin?: boolean } = {}) {
   const { skipLogin = false } = opts;
-  const logView = await byTestId('log_view_container');
-  await logView.waitForDisplayed({ timeout: 5_000 });
+  const mainScroll = await byTestId('main_scroll_view');
+  await mainScroll.waitForDisplayed({ timeout: 5_000 });
 
-  const testUserId = getTestExternalId();
+  const alertHandled = await browser.sharedStore.get('alertHandled');
+  if (!alertHandled) {
+    const alert = await waitForAlert();
+    if (alert) await driver.acceptAlert();
+    await browser.sharedStore.set('alertHandled', true);
+  }
 
   if (skipLogin) return;
 
+  // want to login user so we can't clean up/delete user data for the next rerun
+  const testUserId = getTestExternalId();
   const loggedIn = await browser.sharedStore.get('loggedIn');
   if (!loggedIn) {
     const userIdEl = await scrollToEl('user_external_id_value', { direction: 'up' });
@@ -156,14 +184,14 @@ export async function addTag(key: string, value: string) {
   const addButton = await byTestId('add_tag_button');
   await addButton.click();
 
-  const keyInput = await byTestId('multi_pair_key_0');
+  const keyInput = await byTestId('tag_key_input');
   await keyInput.waitForDisplayed({ timeout: 5_000 });
   await keyInput.setValue(key);
 
-  const valueInput = await byTestId('multi_pair_value_0');
+  const valueInput = await byTestId('tag_value_input');
   await valueInput.setValue(value);
 
-  const confirmButton = await byTestId('multi_pair_confirm_button');
+  const confirmButton = await byTestId('tag_confirm_button');
   await confirmButton.click();
 }
 
@@ -185,11 +213,26 @@ export async function expectPairInSection(sectionId: string, key: string, value:
 }
 
 /**
- * Clear the log view.
+ * Lock the iOS screen and wake it to reveal the lock screen (with notifications).
  */
-export async function clearLogs() {
-  const clearButton = await byTestId('log_view_clear_button');
-  await clearButton.click();
+export async function lockScreen() {
+  await driver.updateSettings({ defaultActiveApplication: 'com.apple.springboard' });
+  await driver.lock();
+  await driver.pause(500);
+
+  await driver.execute('mobile: pressButton', { name: 'home' });
+  await driver.pause(500);
+}
+
+/**
+ * Return to the app from SpringBoard / lock screen.
+ */
+export async function returnToApp() {
+  const caps = driver.capabilities as Record<string, unknown>;
+  const bundleId = (caps['bundleId'] ?? caps['appium:bundleId']) as string;
+  await driver.updateSettings({ defaultActiveApplication: bundleId });
+  await driver.execute('mobile: activateApp', { bundleId });
+  await driver.pause(1_000);
 }
 
 /**
@@ -212,9 +255,8 @@ export async function clearAllNotifications() {
  * Android: opens the notification shade, verifies the title (and optionally
  * body) are visible, then closes the shade.
  *
- * iOS: goes to the home screen, switches to the SpringBoard context, then
- * uses W3C touch actions (viewport origin) to swipe down and open the
- * notification center. After verifying the notification, it returns to the app.
+ * iOS: swipes down from the top-left to open the notification center,
+ * verifies the notification, then returns to the app.
  */
 export async function waitForNotification(opts: {
   title: string;
@@ -274,19 +316,13 @@ export async function waitForNotification(opts: {
     return;
   }
 
-  // iOS: swipe down from the top-left of the screen to open notification center
+  // iOS: swipe down from the top-left to open notification center
   // (top-right opens Control Center on iOS 16+)
-  const caps = driver.capabilities as Record<string, unknown>;
-  const bundleId = (caps['bundleId'] ?? caps['appium:bundleId']) as string;
+  await driver.updateSettings({ defaultActiveApplication: 'com.apple.springboard' });
 
   await driver.execute('mobile: pressButton', { name: 'home' });
   await driver.pause(1_000);
 
-  await driver.updateSettings({
-    defaultActiveApplication: 'com.apple.springboard',
-  });
-  await driver.pause(500);
-
   const { width, height } = await driver.getWindowSize();
   await driver.performActions([
     {
@@ -349,11 +385,7 @@ export async function waitForNotification(opts: {
     await image.waitForDisplayed({ timeout: 5_000 });
   }
 
-  await driver.execute('mobile: pressButton', { name: 'home' });
-  await driver.pause(500);
-
-  await driver.updateSettings({ defaultActiveApplication: bundleId });
-  await driver.execute('mobile: activateApp', { bundleId });
+  await returnToApp();
 }
 
 export async function checkNotification(opts: {