Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 1 | # Copyright 2018 The Android Open Source Project |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | |
| 15 | ################################################ |
| 16 | # Script to build and run the Oboe tests on an attached Android device or emulator |
| 17 | # |
| 18 | # Prerequisites: |
Don Turner | f9d2605 | 2019-03-27 16:05:50 +0000 | [diff] [blame] | 19 | # - CMake on PATH. This is usually found in $ANDROID_HOME/cmake/<version>/bin. |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 20 | # - ANDROID_NDK environment variable is set to your Android NDK location |
Don Turner | d8854b7 | 2019-03-26 18:00:14 +0000 | [diff] [blame] | 21 | # e.g. $HOME/Library/Android/sdk/ndk-bundle |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 22 | # - Android device or emulator attached and accessible via adb |
| 23 | # |
Don Turner | d5a82b7 | 2018-07-12 18:09:15 +0100 | [diff] [blame] | 24 | # Instructions: |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 25 | # - Run this script |
| 26 | # - Check the test results on your target device |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 27 | # |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 28 | # What does the script do? |
| 29 | # - Builds a test binary for the target architecture |
| 30 | # - Copies the test binary into the UnitTestRunner app |
| 31 | # - Builds, installs and runs the app on the target device |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 32 | # |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 33 | # The initial run may take some time as GTest is built, subsequent runs should be much faster. |
| 34 | # |
| 35 | # If you want to perform a clean build just delete the 'build' folder and re-run this script. You will need to do |
| 36 | # this if you change target architectures (e.g. when changing between real device and emulator) |
| 37 | # |
| 38 | # Why is running the tests so convoluted? |
| 39 | # The tests require the RECORDING permission and on many devices (e.g Samsung) the adb user does not have this |
| 40 | # permission (and `run-as` is broken). This means that the test binary must be executed by an app which has this |
| 41 | # permission, hence the need for the UnitTestRunner app. |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 42 | # |
| 43 | ################################################ |
| 44 | |
| 45 | #!/bin/bash |
| 46 | |
| 47 | # Directories, paths and filenames |
| 48 | BUILD_DIR=build |
| 49 | CMAKE=cmake |
| 50 | TEST_BINARY_FILENAME=testOboe |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 51 | TEST_RUNNER_DIR=UnitTestRunner |
| 52 | TEST_RUNNER_PACKAGE_NAME=com.google.oboe.tests.unittestrunner |
| 53 | TEST_RUNNER_ASSET_DIR=${TEST_RUNNER_DIR}/app/src/main/assets |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 54 | |
| 55 | # Check prerequisites |
| 56 | if [ -z "$ANDROID_NDK" ]; then |
| 57 | echo "Please set ANDROID_NDK to the Android NDK folder" |
| 58 | exit 1 |
| 59 | fi |
| 60 | |
| 61 | if [ ! $(type -P ${CMAKE}) ]; then |
Don Turner | f9d2605 | 2019-03-27 16:05:50 +0000 | [diff] [blame] | 62 | echo "${CMAKE} was not found on your path. You can install it using Android Studio using Tools->Android->SDK Manager->SDK Tools." |
| 63 | echo "Once done you will need to add ${HOME}/Library/Android/sdk/cmake/<current_version>/bin to your path." |
| 64 | exit 1 |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 65 | fi |
| 66 | |
| 67 | # Get the device ABI |
| 68 | ABI=$(adb shell getprop ro.product.cpu.abi | tr -d '\n\r') |
| 69 | |
| 70 | if [ -z "$ABI" ]; then |
| 71 | echo "No device ABI was set. Please ensure a device or emulator is running" |
| 72 | exit 1 |
| 73 | fi |
| 74 | |
| 75 | echo "Device/emulator architecture is $ABI" |
| 76 | |
| 77 | if [ ${ABI} == "arm64-v8a" ] || [ ${ABI} == "x86_64" ]; then |
| 78 | PLATFORM=android-21 |
| 79 | elif [ ${ABI} == "armeabi-v7a" ] || [ ${ABI} == "x86" ]; then |
| 80 | PLATFORM=android-16 |
| 81 | else |
| 82 | echo "Unrecognised ABI: ${ABI}. Supported ABIs are: arm64-v8a, armeabi-v7a, x86_64, x86. If you feel ${ABI} should be supported please file an issue on github.com/google/oboe" |
| 83 | exit 1 |
| 84 | fi |
| 85 | |
| 86 | # Configure the build |
| 87 | echo "Building tests for ${ABI} using ${PLATFORM}" |
| 88 | |
| 89 | CMAKE_ARGS="-H. \ |
| 90 | -B${BUILD_DIR} \ |
| 91 | -DANDROID_ABI=${ABI} \ |
| 92 | -DANDROID_PLATFORM=${PLATFORM} \ |
| 93 | -DCMAKE_BUILD_TYPE=RelWithDebInfo \ |
| 94 | -DCMAKE_CXX_FLAGS=-std=c++11 \ |
| 95 | -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK}/build/cmake/android.toolchain.cmake \ |
| 96 | -DCMAKE_VERBOSE_MAKEFILE=1" |
| 97 | |
| 98 | mkdir -p ${BUILD_DIR} |
| 99 | |
| 100 | cmake ${CMAKE_ARGS} |
| 101 | |
| 102 | # Perform the build |
| 103 | pushd ${BUILD_DIR} |
| 104 | make -j5 |
| 105 | |
| 106 | if [ $? -eq 0 ]; then |
| 107 | echo "Tests built successfully" |
| 108 | else |
| 109 | echo "Building tests FAILED" |
| 110 | exit 1 |
| 111 | fi |
| 112 | |
| 113 | popd |
| 114 | |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 115 | # Copy the binary into the unit test runner app |
| 116 | mkdir ${TEST_RUNNER_ASSET_DIR}/${ABI} |
| 117 | DESTINATION_DIR=${TEST_RUNNER_ASSET_DIR}/${ABI}/${TEST_BINARY_FILENAME} |
| 118 | echo "Copying binary to ${DESTINATION_DIR}" |
| 119 | cp ${BUILD_DIR}/${TEST_BINARY_FILENAME} ${DESTINATION_DIR} |
Don Turner | fda6701 | 2018-01-19 18:10:25 +0000 | [diff] [blame] | 120 | |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 121 | # Build and install the unit test runner app |
| 122 | pushd ${TEST_RUNNER_DIR} |
| 123 | echo "Building test runner app" |
| 124 | ./gradlew assembleDebug |
| 125 | echo "Installing to device" |
| 126 | ./gradlew installDebug |
| 127 | popd |
Don Turner | ff649d0 | 2018-07-04 18:35:02 +0100 | [diff] [blame] | 128 | |
Don Turner | ae0a477 | 2018-09-20 18:46:44 +0100 | [diff] [blame] | 129 | echo "Starting app - Check your device for test results" |
Don Turner | 6dd6439 | 2018-09-20 19:14:13 +0100 | [diff] [blame] | 130 | adb shell am start ${TEST_RUNNER_PACKAGE_NAME}/.MainActivity |
| 131 | |
| 132 | sleep 1 |
| 133 | adb logcat --pid=`adb shell pidof -s ${TEST_RUNNER_PACKAGE_NAME}` |