Add enable_android_sdk_checks option for Android emulator testing #215
+174
−25
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| #!/bin/bash | ||
| ##===----------------------------------------------------------------------===## | ||
| ## | ||
| ## This source file is part of the Swift.org open source project | ||
| ## | ||
| ## Copyright (c) 2025 Apple Inc. and the Swift project authors | ||
| ## Licensed under Apache License v2.0 with Runtime Library Exception | ||
| ## | ||
| ## See https://swift.org/LICENSE.txt for license information | ||
| ## See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
| ## | ||
| ##===----------------------------------------------------------------------===## | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| log() { printf -- "** %s\n" "$*" >&2; } | ||
| error() { printf -- "** ERROR: %s\n" "$*" >&2; } | ||
| fatal() { error "$@"; exit 1; } | ||
|
|
||
| ANDROID_PROFILE="Nexus 10" | ||
| ANDROID_EMULATOR_TIMEOUT=300 | ||
|
|
||
| SWIFTPM_HOME="${XDG_CONFIG_HOME}"/swiftpm | ||
| # e.g., "${SWIFTPM_HOME}"/swift-sdks/swift-DEVELOPMENT-SNAPSHOT-2025-12-11-a_android.artifactbundle/ | ||
| SWIFT_ANDROID_SDK_HOME=$(find "${SWIFTPM_HOME}"/swift-sdks -maxdepth 1 -name 'swift-*android.artifactbundle' | tail -n 1) | ||
|
|
||
| ANDROID_SDK_TRIPLE="x86_64-unknown-linux-android28" | ||
|
|
||
| while [[ $# -gt 0 ]]; do | ||
| case $1 in | ||
| --android-sdk-triple=*) | ||
| ANDROID_SDK_TRIPLE="${1#*=}" | ||
| shift | ||
| ;; | ||
| --android-profile=*) | ||
| ANDROID_PROFILE="${1#*=}" | ||
| shift | ||
| ;; | ||
| --android-emulator-timeout=*) | ||
| ANDROID_EMULATOR_TIMEOUT="${1#*=}" | ||
| shift | ||
| ;; | ||
| -*) | ||
| fatal "Unknown option: $1" | ||
| ;; | ||
| *) | ||
| if [[ -z "$SWIFT_VERSION_INPUT" ]]; then | ||
| SWIFT_VERSION_INPUT="$1" | ||
| else | ||
| fatal "Multiple Swift versions specified: $SWIFT_VERSION_INPUT and $1" | ||
| fi | ||
| shift | ||
| ;; | ||
| esac | ||
| done | ||
|
|
||
| # extract the API level from the end of the triple | ||
| ANDROID_API="${ANDROID_SDK_TRIPLE/*-unknown-linux-android/}" | ||
|
|
||
| # extract the build arch from the beginning of the triple | ||
| ANDROID_EMULATOR_ARCH="${ANDROID_SDK_TRIPLE/-unknown-linux-android*/}" | ||
|
Member
There was a problem hiding this comment. If multiple triples are passed in, what does this do, just grab the arch of the first one? If we only support x86_64 right now, may be better to just hard-code this until we support testing on other arches, or it may fail if it attempts those.
Contributor
Author
There was a problem hiding this comment. It will actually grab the arch of the last one that is passed in (just because of how the parameter is iterated; the last one "wins"). So it happens to work with the default triples that we build against: github-workflows/.github/workflows/swift_package_test.yml Lines 150 to 153 in 20b826e I had considered just hardwiring "x86_64", but it is possible that aarch64 will work someday once they release a Linux ARM64 emulator (and it currently does work on macOS, which leaves open the possibility of running this on a self-hosted runner). In the (unlikely, methinks) event of someone overriding the build triples to not include x86_64, then this workflow won't currently work at all, since we expect that the package tests will already have been built by install-and-build-with-sdk.sh. If we want to make this less magic, we could add another parameter to android_sdk_checks_emulator_image:
type: string
description: "The emulator system image for testing package with the Swift SDK for Android"
default: "system-images;android-28;default;x86_64" That would allow complete fine-grained control over the exact emulator image that is being used.
Member
There was a problem hiding this comment. Your choice: either add that image setting and add some logic to make sure it matches one of the SDK triples, or simply document in the description that the testing will always be done with the parameters from the last SDK triple specified, so that those who do override the SDK triples won't be surprised by the resulting CI failures. |
||
|
|
||
| # x86_64=x86_64, armv7=arm | ||
| ANDROID_EMULATOR_ARCH_TRIPLE="${ANDROID_EMULATOR_ARCH}" | ||
|
|
||
marcprux marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| EMULATOR_SPEC="system-images;android-${ANDROID_API};default;${ANDROID_EMULATOR_ARCH}" | ||
|
|
||
| log "SWIFT_ANDROID_SDK_HOME=${SWIFT_ANDROID_SDK_HOME}" | ||
|
|
||
| # install and start an Android emulator | ||
| log "Listing installed Android SDKs" | ||
| export PATH="${PATH}:$ANDROID_HOME/emulator:$ANDROID_HOME/tools:$ANDROID_HOME/build-tools/latest:$ANDROID_HOME/platform-tools:$ANDROID_HOME/cmdline-tools/latest/bin" | ||
| sdkmanager --list_installed | ||
|
|
||
| log "Updating Android SDK licenses" | ||
| yes | sdkmanager --licenses > /dev/null || true | ||
|
|
||
| log "Installing Android emulator" | ||
| sdkmanager --install "emulator" "platform-tools" "platforms;android-${ANDROID_API}" "${EMULATOR_SPEC}" | ||
|
|
||
| log "Creating Android emulator" | ||
| export ANDROID_AVD_HOME=${XDG_CONFIG_HOME:-$HOME}/.android/avd | ||
| ANDROID_EMULATOR_NAME="swiftemu" | ||
| avdmanager create avd --force -n "${ANDROID_EMULATOR_NAME}" --package "${EMULATOR_SPEC}" --device "${ANDROID_PROFILE}" | ||
|
|
||
| log "Configuring Android emulators" | ||
| emulator -list-avds | ||
|
|
||
| log "Check Hardware Acceleration (KVM)" | ||
| emulator -accel-check | ||
|
|
||
| log "Starting Android emulator" | ||
| # launch the emulator in the background | ||
| nohup emulator -no-metrics -partition-size 1024 -memory 4096 -wipe-data -no-window -no-snapshot -noaudio -no-boot-anim -avd "${ANDROID_EMULATOR_NAME}" & | ||
|
|
||
| log "Waiting for Android emulator startup" | ||
| timeout "${ANDROID_EMULATOR_TIMEOUT}" adb wait-for-any-device | ||
|
|
||
| log "Prepare Swift test package" | ||
| # create a staging folder where we copy the test executable | ||
| # and all the dependent libraries to copy over to the emulator | ||
| STAGING_DIR="swift-android-test" | ||
| rm -rf "${STAGING_DIR}" | ||
| mkdir "${STAGING_DIR}" | ||
|
|
||
| BUILD_DIR=.build/"${ANDROID_SDK_TRIPLE}"/debug | ||
|
|
||
| find "${BUILD_DIR}" -name '*.xctest' -exec cp -av {} "${STAGING_DIR}" \; | ||
| find "${BUILD_DIR}" -name '*.resources' -exec cp -av {} "${STAGING_DIR}" \; | ||
|
|
||
| # copy over the required library dependencies | ||
| cp -av "${SWIFT_ANDROID_SDK_HOME}"/swift-android/swift-resources/usr/lib/swift-"${ANDROID_EMULATOR_ARCH_TRIPLE}"/android/*.so "${STAGING_DIR}" | ||
| cp -av "${SWIFT_ANDROID_SDK_HOME}"/swift-android/ndk-sysroot/usr/lib/"${ANDROID_EMULATOR_ARCH_TRIPLE}"-linux-android/libc++_shared.so "${STAGING_DIR}" | ||
|
|
||
| # for the common case of tests referencing | ||
| # their own files as hardwired paths instead of resources | ||
| if [[ -d Tests ]]; then | ||
| cp -a Tests "${STAGING_DIR}" | ||
| fi | ||
|
|
||
| log "Copy Swift test package to emulator" | ||
|
|
||
| ANDROID_TMP_FOLDER="/data/local/tmp/${STAGING_DIR}" | ||
| adb push "${STAGING_DIR}" "${ANDROID_TMP_FOLDER}" | ||
|
|
||
| TEST_CMD="./*.xctest" | ||
| TEST_SHELL="cd ${ANDROID_TMP_FOLDER}" | ||
| TEST_SHELL="${TEST_SHELL} && ${TEST_CMD} --testing-library xctest" | ||
|
|
||
| # Run test cases a second time with the Swift Testing library | ||
| # We additionally need to handle the special exit code | ||
| # EXIT_NO_TESTS_FOUND (69 on Android), which can happen | ||
| # when the tests link to Testing, but no tests are executed | ||
| # see: https://github.com/swiftlang/swift-package-manager/blob/main/Sources/Commands/SwiftTestCommand.swift#L1571 | ||
| TEST_SHELL="${TEST_SHELL} && ${TEST_CMD} --testing-library swift-testing && [ \$? -eq 0 ] || [ \$? -eq 69 ]" | ||
marcprux marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| log "Run Swift package tests" | ||
|
|
||
| # run the test executable | ||
| adb shell "${TEST_SHELL}" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If multiple triples are passed in, what does this do, just grab the API level of the first one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The last one, actually.