E2e env actions #85
E2e env actions #85
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Not Platform-Agnostic
The NDK toolchain path in the Add NDK related toolchains to PATH step is hardcoded to linux-x86_64. This prevents the action from correctly locating the NDK toolchain on non-Linux x86_64 runners, such as macOS (which requires darwin-x86_64) or ARM-based Linux systems.
Locations (1)
| setup-simulator: | ||
| description: 'Whether to setup simulator/emulator' | ||
| required: false | ||
| default: 'false' |
There was a problem hiding this comment.
Bug: Simulator Setup Incomplete, YAML Parsing Issues
The setup-simulator input is defined but its functionality to boot simulators/emulators is not implemented; the action only prepares the environment (creates Android AVD, lists iOS devices) without starting them. Additionally, several description fields in the inputs section lack YAML quotes, potentially causing parsing errors.
Locations (1)
| required: true | ||
| secret-name: | ||
| description: 'The name of the secret in AWS Secrets Manager' | ||
| required: true |
There was a problem hiding this comment.
Bug: Required Input Ignored in Action
The secret-name input is declared as required but is entirely ignored by the action. Instead, the AWS secret name is determined by hardcoded logic based on the environment input, leading to user confusion and a misleading required input.
Locations (1)
For self hosted nodes we can decoupling some steps.
| aws-role-to-assume: ${{ inputs.keystore-role-to-assume }} | ||
| aws-region: 'us-east-2' | ||
| platform: 'ios' | ||
| environment: ${{ inputs.environment }} |
There was a problem hiding this comment.
Bug: Keystore Configuration Ignores Required Secret Name
The configure-keystore action's secret-name input is marked as required but is not provided by its caller (setup-e2e-env), leading to a workflow failure. Additionally, the configure-keystore action ignores this input, dynamically determining the secret name from the environment input instead.
Additional Locations (1)
| ## IOS Setup ## | ||
| - name: Configure iOS Signing Certificates | ||
| if: ${{ inputs.platform == 'ios' && inputs.configure-keystores == 'true' }} | ||
| uses: MetaMask/github-tools/.github/actions/configure-keystore@e2e-env-actions |
There was a problem hiding this comment.
Bug: Local Action Reference Error
The setup-e2e-env action incorrectly references an external MetaMask/github-tools/.github/actions/configure-keystore@e2e-env-actions (lines 144, 233). This change introduces a local configure-keystore action, which should be used instead, as the external reference is likely invalid.
Additional Locations (1)
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Issue Across Platforms
The Android NDK toolchain path is hardcoded to linux-x86_64, making the setup incompatible with non-Linux runners, such as macOS, where the path should be darwin-x86_64.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Not Platform-Agnostic
The NDK toolchain path in the 'Add NDK related toolchains to PATH' step is hardcoded to linux-x86_64. This prevents the action from correctly setting up the NDK on non-Linux runners (e.g., macOS, Windows), as the prebuilt directory varies by host platform (e.g., darwin-x86_64 for macOS, windows-x86_64 for Windows). The path should dynamically adapt to the runner.os.
| 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" |
There was a problem hiding this comment.
Bug: NDK Path and SDK Environment Mismatch
The NDK toolchain path hardcodes linux-x86_64, which will cause Android builds to fail on macOS runners where darwin-x86_64 is required. The path should dynamically determine the correct operating system and architecture. Additionally, there is inconsistent use of ANDROID_SDK_ROOT and ANDROID_HOME throughout the Android setup, which can lead to path resolution issues.
| required: true | ||
| secret-name: | ||
| description: 'The name of the secret in AWS Secrets Manager' | ||
| required: true |
There was a problem hiding this comment.
Bug: Unused Required Input Causes Misleading Configuration
The secret-name input is defined as required but is never used by the action. Instead, the secret name is dynamically determined from the environment input via a hardcoded mapping. This makes the secret-name input misleading and forces callers to provide an unnecessary value.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Path Issue on macOS Builds
The NDK toolchain path is hardcoded to linux-x86_64, which causes Android builds to fail on non-Linux platforms like macOS, where the path should dynamically resolve to darwin-x86_64.
| SECRET_NAME="metamask-mobile-main-signing-certificates" | ||
| ;; | ||
| *) | ||
| echo "❌ Unknown environment: ${{ inputs.environment }}" |
There was a problem hiding this comment.
Bug: Incorrect Error Message for Unknown Targets
The error message for unknown targets incorrectly references inputs.environment instead of the defined inputs.target, resulting in an empty value being displayed in the error output.
| ## IOS Setup ## | ||
| - name: Configure iOS Signing Certificates | ||
| if: ${{ inputs.platform == 'ios' && inputs.configure-keystores == 'true' }} | ||
| uses: MetaMask/github-tools/.github/actions/configure-keystore@e2e-env-actions |
There was a problem hiding this comment.
Bug: Action References External Path Incorrectly
The setup-e2e-env action incorrectly references the configure-keystore action using an external path (MetaMask/github-tools/.github/actions/configure-keystore@e2e-env-actions). Since configure-keystore is defined locally within this repository, it should be referenced via a relative path (e.g., ../configure-keystore). This issue occurs in multiple instances.
Additional Locations (1)
| ## Launch AVD | ||
|
|
||
| - name: Set ANDROID_AVD_HOME for downstream steps | ||
| if: ${{ inputs.platform == 'android'}} |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Issue on macOS
The NDK toolchain path is hardcoded to linux-x86_64, preventing the action from working on macOS runners where darwin-x86_64 is required. Additionally, there is inconsistent spacing in if conditions, specifically missing a space before the closing braces }} for Android-related steps.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Hardcoded for Linux
The NDK toolchain path is hardcoded to linux-x86_64, which causes failures on other operating systems and architectures, such as macOS (where it should be darwin-x86_64) or ARM64 systems.
| SECRET_NAME="metamask-mobile-main-signing-certificates" | ||
| ;; | ||
| *) | ||
| echo "❌ Unknown environment: ${{ inputs.environment }}" |
There was a problem hiding this comment.
Bug: Incorrect Error Message Variable Reference
The Determine signing secret name step's error message incorrectly references ${{ inputs.environment }} instead of ${{ inputs.target }}. This causes the error message to display an empty value when an unknown target is provided, rather than the actual invalid input.
| SECRET_NAME="metamask-mobile-main-signing-certificates" | ||
| ;; | ||
| *) | ||
| echo "❌ Unknown environment: ${{ inputs.environment }}" |
There was a problem hiding this comment.
Bug: Invalid Target Error Message Bug
The error message for unknown targets incorrectly references inputs.environment instead of inputs.target. This causes an empty value to be displayed in the error message when an invalid target is provided.
| - name: Select Xcode version | ||
| if: ${{ inputs.platform == 'ios' }} | ||
| run: sudo xcode-select -s /Applications/Xcode_${{ inputs.xcode-version }}.app/Contents/Developer | ||
| shell: bash |
There was a problem hiding this comment.
Bug: Redundant Xcode Version Selection in CI
The setup-e2e-env action contains duplicate Xcode version selection steps for iOS. The first step (line 144) uses an incomplete path and lacks the shell: bash directive, while the second step (line 196) uses the correct path and includes the shell directive. The second step overrides the first, rendering the initial selection redundant.
| 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Incorrect on Non-Linux Runners
The NDK toolchain path is hardcoded to linux-x86_64 in the Android setup step. This causes an incorrect path to be added to GITHUB_PATH on non-Linux x86_64 runners (e.g., macOS, where darwin-x86_64 is expected, or ARM64 runners), leading to NDK toolchain setup failures.
| "platforms;android-${{ inputs.android-api-level }}" \ | ||
| "build-tools;34.0.0" \ | ||
| "emulator" \ | ||
| "system-images;android-${{ inputs.android-api-level }};google_apis;${{ inputs.android-abi }}" \ |
There was a problem hiding this comment.
Bug: Shell Syntax Error with Trailing Backslash
A trailing backslash after the system-images package in the sdkmanager --install command causes a shell syntax error. The backslash indicates line continuation, but no content follows on the next line.
| SECRET_NAME="metamask-mobile-main-signing-certificates" | ||
| ;; | ||
| *) | ||
| echo "❌ Unknown environment: ${{ inputs.environment }}" |
There was a problem hiding this comment.
Bug: Incorrect Target Reference in Error Message
The error message for an unknown target in the Determine signing secret name step incorrectly references inputs.environment instead of the defined inputs.target. This causes the error message to display an empty value.
| # 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 }}- |
There was a problem hiding this comment.
Bug: Redundant Xcode Selection Steps
The setup-e2e-env action contains two "Select Xcode version" steps for iOS. The first step (lines 142-145) uses an incorrect path (/Applications/Xcode_X.X.app), which is immediately overridden by the second step (lines 195-198) that uses the correct path (/Applications/Xcode_X.X.app/Contents/Developer), making the first step redundant. Additionally, there is commented-out code for Xcode selection and CocoaPods cache restoration, indicating leftover development/debugging code.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Not Arch-Independent
The NDK toolchain path is hardcoded to linux-x86_64. This prevents Android E2E setup from finding the NDK toolchain on macOS runners, where the path should dynamically resolve to darwin-x86_64 or darwin-arm64 based on the runner's architecture.
| 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 |
There was a problem hiding this comment.
Bug: NDK Path Hardcoded for Linux Only
The NDK toolchain path is hardcoded to linux-x86_64 (line 321), which is incorrect for non-Linux runners (e.g., macOS requires darwin-x86_64). This step lacks a runner.os == 'Linux' guard, causing NDK tools to not be found on other platforms.
| - name: Select Xcode version | ||
| if: ${{ inputs.platform == 'ios' }} | ||
| run: sudo xcode-select -s /Applications/Xcode_${{ inputs.xcode-version }}.app/Contents/Developer | ||
| shell: bash |
There was a problem hiding this comment.
Bug: iOS Xcode Selection Fails on GitHub Runners
The setup-e2e-env action includes duplicate Xcode version selection steps for iOS. A step conditional for self-hosted runners and another unconditional step for all iOS platforms lead to self-hosted runners executing xcode-select twice. Additionally, the unconditional step attempts to select Xcode using a path that may not exist on GitHub-hosted runners, potentially causing build failures. This indicates an incorrect implementation of intended distinct Xcode paths for self-hosted versus GitHub-hosted environments.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Incorrect on macOS
The NDK toolchain path is hardcoded to linux-x86_64 in the Add NDK related toolchains to PATH step. This causes Android setup to fail on macOS runners, as the correct path for macOS is darwin-x86_64. The path should be determined dynamically based on runner.os.
| # 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 }}- |
There was a problem hiding this comment.
Bug: Action File Cleanup Needed
The action.yml contains stray commented-out debug/development code for Xcode version selection and CocoaPods cache restoration. Additionally, the if conditional expression if: ${{ inputs.platform == 'ios'}} is missing a space before the closing }}.
| 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" |
There was a problem hiding this comment.
Bug: NDK Path Issues Across Platforms
The Android NDK toolchain path is hardcoded to linux-x86_64, which is incorrect for macOS runners where darwin-x86_64 is required. This path also inconsistently uses $ANDROID_SDK_ROOT instead of $ANDROID_HOME, which is used by other Android setup steps, potentially leading to incorrect NDK paths.
| - 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" |
There was a problem hiding this comment.
Bug: NDK Toolchain Path Incorrect on macOS
The NDK toolchain path is hardcoded to linux-x86_64. This is incorrect for macOS runners, where the path should be darwin-x86_64, causing the NDK toolchain to not be found in PATH.
🚀 Introduce Reusable E2E Environment Setup GitHub Action
📂 What’s new
This PR introduces a reusable composite GitHub Action at
.github/actions/setup-e2e-envdesigned to standardize and streamline the setup of E2E test environments across iOS and Android platforms.✅ Features
🧰 Common Tooling Setup
node-versioninput)yarn-versionvia Corepack)foundryup)node_modules(Yarn)vendor/bundle)Pods/)🍎 iOS Platform Support (
platform: ios)ruby-version)bundler-version) and gem resolution viabundle installxcode-version)bundle exec pod installsetup-simulator)ios-simulator-device🤖 Android Platform Support (
platform: android)jdk-versionandjdk-distribution)platform-tools,build-tools, emulator, system imagesndk-version)aptplatform-tools,emulator,cmdline-tools)🧪 Testing
Verified on:
macos-14andmacos-14-largerunnersExample usage:
📥 Inputs
platformiosorandroid(required)node-version20.18.0)yarn-version1.22.22)setup-simulatorfalse)ios-device"iPhone 15")bundler-version2.5.8)cache-prefixe2e)ruby-version3.1)xcode-version16.2)jdk-version17)jdk-distributiontemurin)ndk-version26.1.10909125)foundry-versionv1.2.3)android-deviceandroid-api-level34)android-abix86_64)📌 Notes
platform: androidand vice versa.PATHfor CLI-based native tools likeclangorndk-build.NODE_OPTIONS=--max-old-space-size=4096.