E2e env actions #85

jake-perkins · 2025-07-09T21:08:15Z

🚀 Introduce Reusable E2E Environment Setup GitHub Action

📂 What’s new

This PR introduces a reusable composite GitHub Action at .github/actions/setup-e2e-env designed to standardize and streamline the setup of E2E test environments across iOS and Android platforms.

✅ Features

🧰 Common Tooling Setup

Node.js (node-version input)
Yarn (yarn-version via Corepack)
Detox CLI
Foundry (via foundryup)
Caching support for:
- node_modules (Yarn)
- Ruby gems (vendor/bundle)
- CocoaPods (Pods/)

🍎 iOS Platform Support (`platform: ios`)

Ruby environment setup (ruby-version)
Bundler installation (bundler-version) and gem resolution via bundle install
Xcode version selection (xcode-version)
CocoaPods installation using bundle exec pod install
Optional simulator booting (setup-simulator)
- Simulator device name via ios-simulator-device
applesimutils installation via Homebrew

🤖 Android Platform Support (`platform: android`)

Java JDK setup (jdk-version and jdk-distribution)
Android SDK setup:
- platform-tools, build-tools, emulator, system images
- License acceptance and update
Android NDK installation (ndk-version)
Emulator dependencies installed via apt
PATH extended with:
- Android tools (platform-tools, emulator, cmdline-tools)
- NDK toolchains (LLVM)

🧪 Testing

Verified on:

macos-14 and macos-14-large runners
iOS simulator boot and CocoaPods integration
Android emulator and NDK setup

Example usage:

📥 Inputs

Name	Description
`platform`	Target platform: `ios` or `android` (required)
`node-version`	Node.js version (default: `20.18.0`)
`yarn-version`	Yarn version to activate with Corepack (default: `1.22.22`)
`setup-simulator`	Whether to boot a simulator/emulator (default: `false`)
`ios-device`	iOS simulator device name (default: `"iPhone 15"`)
`bundler-version`	Bundler version for iOS Ruby setup (default: `2.5.8`)
`cache-prefix`	Prefix for cache keys (default: `e2e`)
`ruby-version`	Ruby version to install (default: `3.1`)
`xcode-version`	Xcode version to select (default: `16.2`)
`jdk-version`	Java version for Android (default: `17`)
`jdk-distribution`	JDK distribution (default: `temurin`)
`ndk-version`	Android NDK version to install (default: `26.1.10909125`)
`foundry-version`	Foundry version to install (default: `v1.2.3`)
`android-device`	AVD device profile (default "pixel")
`android-api-level`	Android API level to use (default: `34`)
`android-abi`	System architecture ABI for the Android system image ( default: `x86_64`)

📌 Notes

iOS-only inputs are ignored when platform: android and vice versa.
Simulator booting logic is guarded with safety checks and state awareness.
NDK toolchains are added to PATH for CLI-based native tools like clang or ndk-build.
Memory usage for Node.js is increased via NODE_OPTIONS=--max-old-space-size=4096.

cursor

Bug: SDK Setup Redundancy and API Level Inconsistency

The Android SDK setup in the setup-e2e-env action contains redundant steps and an inconsistency. Android SDK packages (platform-tools, platforms, build-tools, emulator, system-images) and licenses are installed/accepted twice. Additionally, the first SDK package installation step hardcodes "android-34" for system images, ignoring the configurable android-api-level input, unlike the second installation step which correctly uses it. This duplication and inconsistency are inefficient and could lead to conflicts or incorrect configurations.

.github/actions/setup-e2e-env/action.yml#L236-L280

github-tools/.github/actions/setup-e2e-env/action.yml

Lines 236 to 280 in 860e85f

    
               - name: Install Android SDK packages 
        
                 if: ${{ inputs.platform == 'android' }} 
        
                 run: | 
        
                   echo "Accepting SDK licenses..." 
        
                   printf 'y\n%.0s' {1..10} | "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses 
        
                   echo "Installing Android SDK components..." 
        
                   "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install \ 
        
                     "platform-tools" \ 
        
                     "platforms;android-${{ inputs.android-api-level }}" \ 
        
                     "build-tools;34.0.0" \ 
        
                     "emulator" \ 
        
                     "system-images;android-34;google_apis;${{ inputs.android-abi }}" \ 
        
                   echo "Updating SDK packages..." 
        
                   "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --update 
        
                 shell: bash 
        
               ## NDK Setup 
        
               - name: Debug Android SDK Paths 
        
                 if: ${{ inputs.platform == 'android' }} 
        
                 run: | 
        
                   echo "ANDROID_HOME: $ANDROID_HOME" 
        
                   echo "ANDROID_SDK_ROOT: $ANDROID_SDK_ROOT" 
        
                 shell: bash 
        
               - name: Accept Android SDK licenses 
        
                 if: ${{ inputs.platform == 'android' }} 
        
                 run: | 
        
                   echo "Accepting Android SDK licenses..." 
        
                   bash -c 'yes | "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses' || true 
        
                 shell: bash 
        
               - name: Install Android SDK Packages 
        
                 if: ${{ inputs.platform == 'android' }} 
        
                 run: | 
        
                   "$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" --install \ 
        
                     "platform-tools" \ 
        
                     "platforms;android-${{ inputs.android-api-level }}" \ 
        
                     "build-tools;34.0.0" \ 
        
                     "emulator" \ 
        
                     "system-images;android-${{ inputs.android-api-level }};google_apis;${{ inputs.android-abi }}" 
        
                 shell: bash


	- name: Install Android SDK packages
	if: ${{ inputs.platform == 'android' }}
	run: \|
	echo "Accepting SDK licenses..."
	printf 'y\n%.0s' {1..10} \| "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses

	echo "Installing Android SDK components..."
	"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install \
	"platform-tools" \
	"platforms;android-${{ inputs.android-api-level }}" \
	"build-tools;34.0.0" \
	"emulator" \
	"system-images;android-34;google_apis;${{ inputs.android-abi }}" \

	echo "Updating SDK packages..."
	"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --update
	shell: bash

	## NDK Setup

	- name: Debug Android SDK Paths
	if: ${{ inputs.platform == 'android' }}
	run: \|
	echo "ANDROID_HOME: $ANDROID_HOME"
	echo "ANDROID_SDK_ROOT: $ANDROID_SDK_ROOT"
	shell: bash

	- name: Accept Android SDK licenses
	if: ${{ inputs.platform == 'android' }}
	run: \|
	echo "Accepting Android SDK licenses..."
	bash -c 'yes \| "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses' \|\| true
	shell: bash

	- name: Install Android SDK Packages
	if: ${{ inputs.platform == 'android' }}
	run: \|
	"$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" --install \
	"platform-tools" \
	"platforms;android-${{ inputs.android-api-level }}" \
	"build-tools;34.0.0" \
	"emulator" \
	"system-images;android-${{ inputs.android-api-level }};google_apis;${{ inputs.android-abi }}"
	shell: bash

	# Launch Android Emulator
	- name: Launch Android Emulator
	if: ${{ inputs.platform == 'android' && inputs.setup-simulator == 'true' }}
	run: \|
	"$ANDROID_HOME/emulator/emulator" -avd "${{ inputs.android-avd-name }}" -no-audio -no-boot-anim -no-window -verbose
	shell: bash


	- name: Install Android system image
	if: ${{ inputs.platform == 'android' && inputs.setup-simulator == 'true' }}
	run: \|
	IMAGE="system-images;android-${{ inputs.android-api-level }};google_apis;${{ inputs.android-abi }}"
	echo "Installing system image: $IMAGE"
	"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install "$IMAGE"
	shell: bash

	run: \|
	NDK_TOOLCHAIN="$ANDROID_SDK_ROOT/ndk/${{ inputs.ndk-version }}/toolchains/llvm/prebuilt/linux-x86_64/bin"
	echo "$NDK_TOOLCHAIN" >> "$GITHUB_PATH"
	echo "$ANDROID_SDK_ROOT/ndk/${{ inputs.ndk-version }}" >> "$GITHUB_PATH"

	# Restore CocoaPods cache
	- name: Restore CocoaPods cache
	if: ${{ inputs.platform == 'ios' && inputs.setup-simulator == 'true' }}
	uses: actions/cache@v4
	with:
	path: ios/Pods
	key: ${{ inputs.cache-prefix }}-pods-${{ inputs.platform }}-${{ runner.os }}-${{ hashFiles('ios/Podfile.lock') }}
	restore-keys: \|
	${{ inputs.cache-prefix }}-pods-${{ inputs.platform }}-${{ runner.os }}-

	# Install CocoaPods w/ cached bundler environment
	- name: Install CocoaPods via bundler
	if: ${{ inputs.platform == 'ios' && inputs.setup-simulator == 'true' }}
	run: bundle exec pod install
	working-directory: ios
	shell: bash


	# - name: Install required emulator dependencies
	# if: ${{ inputs.platform == 'android' }}
	# run: \|
	# sudo apt-get update
	# sudo apt-get install -y libpulse0 libglu1-mesa
	# shell: bash

	- name: Install Android SDK packages
	if: ${{ inputs.platform == 'android' }}
	run: \|
	echo "Accepting SDK licenses..."
	printf 'y\n%.0s' {1..10} \| "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses

	echo "Installing Android SDK components..."
	"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install \
	"platform-tools" \
	"platforms;android-${{ inputs.android-api-level }}" \
	"build-tools;34.0.0" \
	"emulator" \
	"system-images;android-34;google_apis;${{ inputs.android-abi }}" \

	echo "Updating SDK packages..."
	"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --update
	shell: bash

	## NDK Setup

	- name: Debug Android SDK Paths
	if: ${{ inputs.platform == 'android' }}
	run: \|
	echo "ANDROID_HOME: $ANDROID_HOME"
	echo "ANDROID_SDK_ROOT: $ANDROID_SDK_ROOT"
	shell: bash

	- name: Accept Android SDK licenses
	if: ${{ inputs.platform == 'android' }}
	run: \|
	echo "Accepting Android SDK licenses..."
	bash -c 'yes \| "${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --licenses' \|\| true
	shell: bash

	- name: Install Android SDK Packages
	if: ${{ inputs.platform == 'android' }}
	run: \|
	"$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" --install \
	"platform-tools" \
	"platforms;android-${{ inputs.android-api-level }}" \
	"build-tools;34.0.0" \
	"emulator" \
	"system-images;android-${{ inputs.android-api-level }};google_apis;${{ inputs.android-abi }}"
	shell: bash


	## Launch AVD

	- name: Install Android system image
	if: ${{ inputs.platform == 'android' && inputs.setup-simulator == 'true' }}
	run: \|
	IMAGE="system-images;android-${{ inputs.android-api-level }};google_apis;${{ inputs.android-abi }}"
	echo "Installing system image: $IMAGE"
	"${ANDROID_HOME}/cmdline-tools/latest/bin/sdkmanager" --install "$IMAGE"
	shell: bash


	- name: Add NDK related toolchains to PATH
	if: ${{ inputs.platform == 'android' }}
	run: \|
	NDK_TOOLCHAIN="$ANDROID_SDK_ROOT/ndk/${{ inputs.ndk-version }}/toolchains/llvm/prebuilt/linux-x86_64/bin"
	echo "$NDK_TOOLCHAIN" >> "$GITHUB_PATH"
	echo "$ANDROID_SDK_ROOT/ndk/${{ inputs.ndk-version }}" >> "$GITHUB_PATH"
	shell: bash

	required: true
	secret-name:
	description: 'The name of the secret in AWS Secrets Manager'
	required: true

	if: ${{ inputs.platform == 'ios' && inputs.configure-keystores == 'true' }}
	uses: MetaMask/github-tools/.github/actions/configure-keystore@e2e-env-actions
	with:
	aws-role-to-assume: 'arn:aws:iam::722264665990:role/metamask-mobile-build-signing-certificate-manager'
	aws-region: 'us-east-2'
	platform: 'ios'
	environment: ${{ inputs.environment }}

Uh oh!

E2e env actions #85

Are you sure you want to change the base?

E2e env actions #85

Conversation

jake-perkins commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Introduce Reusable E2E Environment Setup GitHub Action

📂 What’s new

✅ Features

🧰 Common Tooling Setup

🍎 iOS Platform Support (platform: ios)

🤖 Android Platform Support (platform: android)

🧪 Testing

📥 Inputs

📌 Notes

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: SDK Setup Redundancy and API Level Inconsistency

Bug: Emulator Command Hangs GitHub Actions

Bug: Redundant Android System Image Installation

Bug: Android Setup Fails on Non-x86_64 Linux

Bug: CocoaPods Required for iOS Builds

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Android SDK Setup Issues

Bug: Emulator Launch Blocks Workflow

Bug: NDK Path and OS Architecture Issues

Bug: CocoaPods Installation Fails Without Simulator Setup

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: E2E Setup: Redundant SDK Installations, Hardcoded API Levels

Bug: NDK Toolchain Path Issue on macOS

Bug: Redundant Android System Image Installations

Bug: CocoaPods Cache Issues in iOS Builds

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: SDK Setup Redundancy Causes API Level Inconsistency

Bug: Android Setup Path Issues

Bug: CocoaPods Installation Fails Without Simulator Setup

Bug: Android SDK Installs System Image Multiple Times

Bug: Redundant SDK License Acceptance

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Redundant Android SDK Setup Causes Inconsistency

Bug: NDK Toolchain Path Incorrect on macOS

Bug: CocoaPods Setup Ignored When Simulator Not Set Up

Uh oh!

jake-perkins commented Jul 9, 2025 •

edited

Loading

🍎 iOS Platform Support (`platform: ios`)

🤖 Android Platform Support (`platform: android`)