feat: let tests run on macos runner

fix: killall script naming

chore: debug path issues

chore: homebrew android installation in path

chore: set path in all steps

chore: try to fix path issues

chore: keep debugging android sdk install

chore: hopefully last sdk fix

chore: fix missing env vars

chore: return android sdk root to env

fix: actually allow 9 emulators

fix: try 6 emulators only

chore: 6 emulators for all 3 runs

fix: try to download arm64 playstore build

fix: correct number of workers for macos runner

chore: try to run without snapshots for reliability

fix: tests cannot run headless

Author: Miki-Session

.github/workflows/android-regression.yml

@@ -4,6 +4,14 @@ run-name: '${{ inputs.RISK }} regressions on ${{ github.head_ref || github.ref }
 on:
   workflow_dispatch:
     inputs:
+      RUNNER: 
+        description: 'Which runner to use'
+        required: true
+        type: choice 
+        options: 
+          - 'linux'
+          - 'mac'
+        default: 'linux'
       APK_URL:
         description: 'apk url to test (.tar.xz)'
         required: true
@@ -70,18 +78,17 @@ on:
 
 jobs:
   android-regression:
-    runs-on: [self-hosted, linux, X64, qa-android]
+    runs-on: ${{ github.event.inputs.RUNNER == 'mac' && fromJSON('["self-hosted", "macOS"]') || fromJSON('["self-hosted", "linux", "X64", "qa-android"]') }}
     env:
       PLATFORM: 'android'
+      EMULATOR_COUNT: ${{ github.event.inputs.RUNNER == 'mac' && '6' || '4' }}
       APK_URL: ${{ github.event.inputs.APK_URL }}
       BUILD_NUMBER: ${{ github.event.inputs.BUILD_NUMBER }}
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       CI: 1
       ALLURE_ENABLED: ${{ github.event.inputs.ALLURE_ENABLED}}
       IOS_APP_PATH_PREFIX: '<just_not_empty>'
       ANDROID_APK: './extracted/session-android.apk'
-      APPIUM_ADB_FULL_PATH: '/opt/android/platform-tools/adb'
-      ANDROID_SDK_ROOT: '/opt/android'
       PLAYWRIGHT_RETRIES_COUNT: ${{ github.event.inputs.PLAYWRIGHT_RETRIES_COUNT }}
       PRINT_FAILED_TEST_LOGS: ${{ github.event.inputs.PRINT_FAILED_TEST_LOGS }}
       PRINT_ONGOING_TEST_LOGS: ${{ github.event.inputs.PRINT_ONGOING_TEST_LOGS }}
@@ -121,7 +128,11 @@ jobs:
       - name: Download APK & extract it
         run: |
           pwd
-          wget -q -O session-android.apk.tar.xz ${{ github.event.inputs.APK_URL }}
+          if [[ "${{ runner.os }}" == "macOS" ]]; then
+            curl -L -o session-android.apk.tar.xz ${{ github.event.inputs.APK_URL }}
+          else
+            wget -q -O session-android.apk.tar.xz ${{ github.event.inputs.APK_URL }}
+          fi
           tar xf session-android.apk.tar.xz
           mv session-android-*universal extracted
 
@@ -144,14 +155,15 @@ jobs:
         continue-on-error: true # just so we don't fail if adb wasn't already running
         run: |
           source ./scripts/ci.sh
+          echo "ANDROID_SDK_ROOT=${ANDROID_SDK_ROOT}" >> $GITHUB_ENV
           adb kill-server;
           adb start-server;
 
       - name: Start emulators from snapshot
         shell: bash
         run: |
           source ./scripts/ci.sh
-          start_with_snapshots
+          start_for_snapshots
           wait_for_emulators
 
       - name: List tests part of this run
@@ -164,7 +176,7 @@ jobs:
         continue-on-error: true
         id: devices-1-test-run
         env:
-          PLAYWRIGHT_WORKERS_COUNT: 4
+          PLAYWRIGHT_WORKERS_COUNT: ${{ env.EMULATOR_COUNT }}  # 6 on mac, 4 on linux
           DEVICES_PER_TEST_COUNT: 1
         run: |
           pwd
@@ -180,7 +192,7 @@ jobs:
         continue-on-error: true
         id: devices-2-test-run
         env:
-          PLAYWRIGHT_WORKERS_COUNT: 2
+          PLAYWRIGHT_WORKERS_COUNT:  ${{ github.event.inputs.RUNNER == 'mac' && '3' || '2' }}
           DEVICES_PER_TEST_COUNT: 2
         run: |
           pwd
@@ -196,8 +208,8 @@ jobs:
         continue-on-error: true
         id: other-devices-test-run
         env:
-          PLAYWRIGHT_WORKERS_COUNT: 1
-          DEVICES_PER_TEST_COUNT: 4
+          PLAYWRIGHT_WORKERS_COUNT: ${{ github.event.inputs.RUNNER == 'mac' && '2' || '1' }}
+          DEVICES_PER_TEST_COUNT: 3
         run: |
           pwd
           _TESTING=${{ github.event.inputs.HIDE_WEBDRIVER_LOGS }} npx playwright test --grep "(?=.*@${PLATFORM})(?=.*@${{ github.event.inputs.RISK }})" --grep-invert "@1-devices|@2-devices" #Note: this has to be double quotes

run/test/specs/utils/binaries.ts

@@ -1,12 +1,21 @@
-import { existsSync, lstatSync } from 'fs';
+import { existsSync, lstatSync} from 'fs';
 import { toNumber } from 'lodash';
+import * as path from 'path';
 
 function existsAndFileOrThrow(path: string, id: string) {
   if (!existsSync(path) || !lstatSync(path).isFile()) {
     throw new Error(`"${id}" does not exist at: ${path} or not a path`);
   }
 }
 
+const getAndroidSdkRoot = () => {
+  const sdkRoot = process.env.ANDROID_SDK_ROOT;
+  if (!sdkRoot) {
+    throw new Error('env variable `ANDROID_SDK_ROOT` needs to be set');
+  }
+  return sdkRoot;
+};
+
 export function getAndroidApk() {
   const fromEnv = process.env.ANDROID_APK;
   if (!fromEnv) {
@@ -17,48 +26,53 @@ export function getAndroidApk() {
 }
 
 export const getAdbFullPath = () => {
-  const fromEnv = process.env.APPIUM_ADB_FULL_PATH;
-  if (!fromEnv) {
-    throw new Error('env variable `APPIUM_ADB_FULL_PATH` needs to be set');
-  }
-
-  existsAndFileOrThrow(fromEnv, 'adb');
-
-  return fromEnv;
+  const sdkRoot = getAndroidSdkRoot();
+  const adbPath = path.join(sdkRoot, 'platform-tools', 'adb');
+  existsAndFileOrThrow(adbPath, 'adb');
+  return adbPath;
 };
 
 export const getEmulatorFullPath = () => {
-  const fromEnv = process.env.EMULATOR_FULL_PATH;
-
-  if (!fromEnv) {
-    throw new Error('env variable `EMULATOR_FULL_PATH` needs to be set');
-  }
-  existsAndFileOrThrow(fromEnv, 'EMULATOR_FULL_PATH');
-
-  return fromEnv;
+  const sdkRoot = getAndroidSdkRoot();
+  const emulatorPath = path.join(sdkRoot, 'emulator', 'emulator');
+  existsAndFileOrThrow(emulatorPath, 'emulator');
+  return emulatorPath;
 };
 
 export const getAvdManagerFullPath = () => {
-  const fromEnv = process.env.AVD_MANAGER_FULL_PATH;
-
-  if (!fromEnv) {
-    throw new Error('env variable `AVD_MANAGER_FULL_PATH` needs to be set');
+  const sdkRoot = getAndroidSdkRoot();
+  // Try multiple possible locations
+  const possiblePaths = [
+    path.join(sdkRoot, 'cmdline-tools', 'latest', 'bin', 'avdmanager'),
+    path.join(sdkRoot, 'cmdline-tools', 'tools', 'bin', 'avdmanager'),
+    path.join(sdkRoot, 'tools', 'bin', 'avdmanager')
+  ];
+  
+  for (const path of possiblePaths) {
+    if (existsSync(path) && lstatSync(path).isFile()) {
+      return path;
+    }
   }
-  existsAndFileOrThrow(fromEnv, 'AVD_MANAGER_FULL_PATH');
-
-  return fromEnv;
+  
+  throw new Error(`avdmanager not found in any expected location under ${sdkRoot}`);
 };
 
 export const getSdkManagerFullPath = () => {
-  const fromEnv = process.env.SDK_MANAGER_FULL_PATH;
-
-  if (!fromEnv) {
-    throw new Error('env variable `SDK_MANAGER_FULL_PATH` needs to be set');
+  const sdkRoot = getAndroidSdkRoot();
+  // Try multiple possible locations
+  const possiblePaths = [
+    path.join(sdkRoot, 'cmdline-tools', 'latest', 'bin', 'sdkmanager'),
+    path.join(sdkRoot, 'cmdline-tools', 'tools', 'bin', 'sdkmanager'),
+    path.join(sdkRoot, 'tools', 'bin', 'sdkmanager')
+  ];
+  
+  for (const path of possiblePaths) {
+    if (existsSync(path) && lstatSync(path).isFile()) {
+      return path;
+    }
   }
-
-  existsAndFileOrThrow(fromEnv, 'SDK_MANAGER_FULL_PATH');
-
-  return fromEnv;
+  
+  throw new Error(`sdkmanager not found in any expected location under ${sdkRoot}`);
 };
 
 export const getAndroidSystemImageToUse = () => {

run/test/specs/utils/capabilities_android.ts

@@ -35,6 +35,7 @@ const emulator5Udid = 'emulator-5562';
 const emulator6Udid = 'emulator-5564';
 const emulator7Udid = 'emulator-5566';
 const emulator8Udid = 'emulator-5568';
+const emulator9Udid = 'emulator-5570';
 
 const udids = [
   emulator1Udid,
@@ -45,6 +46,7 @@ const udids = [
   emulator6Udid,
   emulator7Udid,
   emulator8Udid,
+  emulator9Udid,
 ];
 
 const emulatorCapabilities: AppiumCapabilities[] = udids.map(udid => ({
@@ -61,6 +63,7 @@ const emulatorCapabilities5 = emulatorCapabilities[4];
 const emulatorCapabilities6 = emulatorCapabilities[5];
 const emulatorCapabilities7 = emulatorCapabilities[6];
 const emulatorCapabilities8 = emulatorCapabilities[7];
+const emulatorCapabilities9 = emulatorCapabilities[8];
 
 export const androidCapabilities = {
   sharedCapabilities,
@@ -77,6 +80,7 @@ function getAllCaps() {
     emulatorCapabilities6,
     emulatorCapabilities7,
     emulatorCapabilities8,
+    emulatorCapabilities9,
   ];
   return emulatorCaps;
 }

scripts/ci.sh

@@ -6,11 +6,12 @@ set -x
 if [[ "$OSTYPE" == "darwin"* ]]; then
     # Mac settings
     ARCH="arm64-v8a"
-    EMULATOR_COUNT=9
+    EMULATOR_COUNT=6
     API_LEVEL="35"
     ANDROID_CMD="commandlinetools-mac-13114758_latest.zip"
     EMULATOR_BIN="emulator"
-    TARGET="google_apis"  # Mac ARM doesn't have playstore variant
+    TARGET="google_apis_playstore"  # Mac ARM doesn't have playstore variant
+    ANDROID_SDK_ROOT=${ANDROID_SDK_ROOT:-"$HOME/Android/sdk"}
 else
     # Linux settings
     ARCH="x86_64"
@@ -19,6 +20,7 @@ else
     ANDROID_CMD="commandlinetools-linux-13114758_latest.zip"
     EMULATOR_BIN="emulator"
     TARGET="google_apis_playstore"  # Linux can use playstore
+    ANDROID_SDK_ROOT=${ANDROID_SDK_ROOT:-"/opt/android"}
 fi
 
 
@@ -31,7 +33,7 @@ EMULATOR_PACKAGE="system-images;${ANDROID_API_LEVEL};${ANDROID_APIS}"
 PLATFORM_VERSION="platforms;${ANDROID_API_LEVEL}"
 BUILD_TOOL="build-tools;${BUILD_TOOLS}"
 export ANDROID_SDK_PACKAGES="${EMULATOR_PACKAGE} ${PLATFORM_VERSION} ${BUILD_TOOL} platform-tools"
-export ANDROID_SDK_ROOT=/opt/android
+export ANDROID_SDK_ROOT
 
 export PATH="$PATH:$ANDROID_SDK_ROOT/cmdline-tools/tools:$ANDROID_SDK_ROOT/cmdline-tools/tools/bin:$ANDROID_SDK_ROOT/emulator:$ANDROID_SDK_ROOT/tools/bin:$ANDROID_SDK_ROOT/platform-tools:$ANDROID_SDK_ROOT/build-tools/${BUILD_TOOLS}:$ANDROID_SDK_ROOT/platform-tools/"
 export EMULATOR_DEVICE="pixel_6" # all emulators are created with the pixel 6 spec for now
@@ -107,8 +109,8 @@ function start_for_snapshots() {
     for i in $(seq 1 $EMULATOR_COUNT)
     do
         if [[ "$OSTYPE" == "darwin"* ]]; then
-            # Mac: Headless
-            $EMULATOR_BIN @emulator$i -no-window -no-snapshot-load &
+            # Mac: Not headless
+            $EMULATOR_BIN @emulator$i -no-snapshot-load &
         else
             # Linux: Keep as-is with display
             DISPLAY=:0 $EMULATOR_BIN @emulator$i -gpu host -accel on -no-snapshot-load &
@@ -130,7 +132,7 @@ function force_save_snapshots() {
 
 function killall_emulators() {
     if [[ "$OSTYPE" == "darwin"* ]]; then
-        killall qemu-system-aarch64 2>/dev/null || true
+        killall qemu-system-aarch64-headless 2>/dev/null || true
     else
         killall qemu-system-x86_64 2>/dev/null || true
     fi