Run unit tests in Android CI pipeline

.azure/azure-pipelines-alpine.yml

@@ -11,6 +11,7 @@ trigger:
       - '.azure/azure-pipelines-win.yml'
       - '.circleci/config.yml'
       - '.github/workflows/*'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 resources:

.azure/azure-pipelines-android.yml

@@ -150,7 +150,6 @@ jobs:
 
     - script: |
         set -ex
-
         sudo apt remove --purge --auto-remove cmake
         wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | sudo tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null
         sudo apt-add-repository 'deb https://apt.kitware.com/ubuntu/ focal main'
@@ -232,7 +231,7 @@ jobs:
     - template: cmake-android.yml
       parameters:
         sourceDir: 'oboe-$(OBOE_VERSION)'
-        installCommand: 'cp liboboe.* ${PREFIX}/lib/ && cp -ur ../include/oboe ${PREFIX}/include'
+        installCommand: 'cp liboboe.* ${PREFIX}/lib/ && cp -R ../include/oboe ${PREFIX}/include'
 
     - script: |
         set -ex
@@ -265,20 +264,84 @@ jobs:
         cmakeArgs: '-Denable-opensles=1 -Denable-floats=1 -Denable-oboe=1 -Denable-dbus=0 -Denable-oss=0 -Denable-openmp=0'
         installCommand: ''
 
-    - script: |
-        set -x
-        export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:$(PREFIX)/lib:$(NDK_TOOLCHAIN)/sysroot/usr/lib/$(ARCH)-linux-android$(ANDROID_TARGET_ABI)/$(ANDROID_API)
-        pushd build
-        make -j$((`nproc`+1)) check
-        ldd test/test_sample_cache
+    # Build individual Android test executables
+    - bash: |
+        set -ex
+        pushd build_$(ANDROID_ABI_CMAKE)
+        make check
         popd
-      displayName: 'Execute fluidsynth unit test'
-      condition: and(succeeded(), in(variables['ARCH'], 'x86_64', 'i686'))
-      enabled: 'false'
+        # List built test executables for verification
+        find build_$(ANDROID_ABI_CMAKE) -name "*" -type f | head -10
+      displayName: 'Build Android Test Executables'
 
-    - script: |
+    - bash: |
+        set -ex
+        # Grant the current CI user access to /dev/kvm so the emulator can use hardware acceleration.
+        # Without this, x86/x86_64 system images refuse to boot at all ("x86 emulation currently
+        # requires hardware acceleration!") because the KVM device is only group-readable/writable.
+        if [ -e /dev/kvm ]; then
+          sudo groupadd -f kvm
+          sudo usermod -aG kvm "$USER"
+          sudo chown root:kvm /dev/kvm
+          sudo chmod 660 /dev/kvm
+          # Apply the new group membership to this shell without needing to re-login.
+          sudo setfacl -m u:"$USER":rw /dev/kvm || true
+        else
+          echo "##[warning]/dev/kvm does not exist; hardware acceleration will not be available."
+        fi
+
+        ls $ANDROID_HOME/cmdline-tools/ || true
+        cd $ANDROID_HOME/cmdline-tools/latest/bin
+        yes | ./sdkmanager --licenses > /dev/null 2>&1
+        ./sdkmanager --list | grep system-images
+        ./sdkmanager 'system-images;android-$(ANDROID_API);default;$(ANDROID_ABI_CMAKE)' > /dev/null
+        ./sdkmanager --channel=3 emulator
+        echo "no" | ./avdmanager create avd -n android_emulator -k 'system-images;android-$(ANDROID_API);default;$(ANDROID_ABI_CMAKE)' --force
+        echo "Emulator created successfully $($ANDROID_HOME/emulator/emulator -list-avds), launching it"
+
+        # NOTE: -gpu guest can stall on headless CI runners without a display/GPU. swiftshader_indirect
+        # is the software renderer explicitly recommended for headless emulator use.
+        # Emulator output is logged to a file (instead of discarded) so we can diagnose boot failures below.
+        nohup $ANDROID_HOME/emulator/emulator -avd android_emulator -no-window -no-snapshot -no-audio -no-boot-anim -accel auto -gpu swiftshader_indirect > $(Build.ArtifactStagingDirectory)/emulator.log 2>&1 &
+        emulatorPid=$!
+
+        # adb wait-for-device only waits for the emulator's ADB transport to attach, which normally
+        # happens within seconds of a healthy boot. It never times out on its own, so if the emulator
+        # process fails/crashes/hangs during boot (e.g. no hardware acceleration available for this ABI),
+        # this would otherwise block for the entire job timeout. Bound it explicitly and fail fast with logs.
+        if ! timeout 300 $ANDROID_HOME/platform-tools/adb wait-for-device; then
+          echo "##[error]Timed out waiting for the emulator to attach via adb."
+          echo "--- emulator.log ---"
+          cat $(Build.ArtifactStagingDirectory)/emulator.log || true
+          echo "--- adb devices ---"
+          $ANDROID_HOME/platform-tools/adb devices -l || true
+          kill -9 $emulatorPid 2>/dev/null || true
+          exit 1
+        fi
+
+        # Set up environment and run individual test executables
+        # run-android-tests.sh calls plain "adb" (not the full path), so platform-tools must be on PATH.
+        export PATH="$PATH:$ANDROID_HOME/platform-tools"
+        export ANDROID_ABI_CMAKE="$(ANDROID_ABI_CMAKE)"
+        # BUILD_DIR must be absolute: run-android-tests.sh resolves it relative to its own cwd
+        # (test/), not the repo root, so a relative "build_x86_64" would never be found.
+        export BUILD_DIR="$(Build.SourcesDirectory)/build_$(ANDROID_ABI_CMAKE)"
+        export PREFIX="${PREFIX}"
+
+        cd $(Build.SourcesDirectory)/test
+        ./run-android-tests.sh
+
+        kill -9 $emulatorPid
+      displayName: 'Start emulator and execute individual test executables'
+      # armeabi-v7a and arm64-v8a system images cannot be hardware-accelerated on the x86_64 hosted
+      # agent (KVM only accelerates same-architecture guests; ARM-on-x86 always falls back to slow
+      # TCG software emulation), so booting them is impractically slow/unreliable in CI and is what
+      # caused this step to hang. Only run the emulator for the x86/x86_64 legs, which can use KVM.
+      condition: and(succeeded(), in(variables['ANDROID_ABI_CMAKE'], 'x86', 'x86_64'))
+
+    - bash: |
         set -ex
-        pushd build
+        pushd build_$(ANDROID_ABI_CMAKE)
         make install
         popd
       displayName: 'Install fluidsynth'
@@ -302,7 +365,7 @@ jobs:
         cd $(Build.ArtifactStagingDirectory)/lib/$(ANDROID_ABI_CMAKE)
         cp -LR $(PREFIX)/lib/* .
         ls -Rg .
-        rm -rf *.dll *.alias gettext/ libtextstyle.* *.a *.la
+        rm -Rf *.dll *.alias gettext/ libtextstyle.* *.a *.la
         rm -f *.so.*
         mkdir -p $(Build.ArtifactStagingDirectory)/include
         cd $(Build.ArtifactStagingDirectory)/include
@@ -340,7 +403,7 @@ jobs:
     - script: |
         set -ex
         # as very last step before creating the pipeline cache, remove fluidsynth
-        pushd build
+        pushd build_$(ANDROID_ABI_CMAKE)
         make uninstall
         popd
       displayName: 'Uninstall fluidsynth'

.azure/azure-pipelines-mac.yml

@@ -12,6 +12,7 @@ trigger:
       - '.azure/Dockerfile.azure-alpine'
       - '.circleci/config.yml'
       - '.github/workflows/*'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 parameters:

.azure/cmake-android.yml

@@ -21,8 +21,8 @@ steps:
     set -ex
 
     pushd ${{ parameters.sourceDir }}
-    mkdir -p build
-    pushd build
+    mkdir -p build_${ANDROID_ABI_CMAKE}
+    pushd build_${ANDROID_ABI_CMAKE}
 
     # Invoke cmake in the most correctest way I've could find while try and erroring:
     #

.github/workflows/api_doc_build.yml

@@ -12,6 +12,7 @@ on:
       - '.github/workflows/os2.yml'
       - '.github/workflows/sonarcloud.yml'
       - '.github/workflows/windows.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
   workflow_dispatch:
 

.github/workflows/freebsd.yml

@@ -16,6 +16,7 @@ on:
       - '.github/workflows/sonarcloud.yml'
       - '.github/workflows/solaris.yml'
       - '.github/workflows/windows.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 env:

.github/workflows/ios.yml

@@ -16,6 +16,7 @@ on:
       - '.github/workflows/windows.yml'
       - '.github/workflows/sonarcloud.yml'
       - '.github/workflows/rendering-regression.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
     tags:
       - 'v*'

.github/workflows/linux.yml

@@ -16,6 +16,7 @@ on:
       - '.github/workflows/ios.yml'
       - '.github/workflows/os2.yml'
       - '.github/workflows/rendering-regression.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 env:

.github/workflows/os2.yml

@@ -16,6 +16,7 @@ on:
       - '.github/workflows/ios.yml'
       - '.github/workflows/linux.yml'
       - '.github/workflows/rendering-regression.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 env:

.github/workflows/rendering-regression.yml

@@ -22,6 +22,7 @@ on:
       - '.github/workflows/os2.yml'
       - '.github/workflows/sonarcloud.yml'
       - '.github/workflows/windows.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 permissions:

.github/workflows/solaris.yml

@@ -16,6 +16,7 @@ on:
       - '.github/workflows/rendering-regression.yml'
       - '.github/workflows/sonarcloud.yml'
       - '.github/workflows/windows.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
 
 env:

.github/workflows/sonarcloud.yml

@@ -16,6 +16,7 @@ on:
       - '.github/workflows/ios.yml'
       - '.github/workflows/os2.yml'
       - '.github/workflows/rendering-regression.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
   pull_request:
       types: [opened, synchronize, reopened]

.github/workflows/windows.yml

@@ -17,6 +17,7 @@ on:
       - '.github/workflows/ios.yml'
       - '.github/workflows/os2.yml'
       - '.github/workflows/rendering-regression.yml'
+      - 'test/run-android-tests.sh'
       - 'README.md'
     tags:
       - 'v*'

CMakeLists.txt

@@ -804,13 +804,46 @@ if ( enable-signalsmith )
 endif ( enable-signalsmith )
 
 # manipulate some variables to setup a proper test env
-set(TEST_SOUNDFONT "${FluidSynth_SOURCE_DIR}/sf2/VintageDreamsWaves-v2.sf2")
-set(TEST_DLS "${FluidSynth_SOURCE_DIR}/sf2/VintageDreamsWaves-v2.dls")
-set(TEST_SOUNDFONT_UTF8_1 "${FluidSynth_SOURCE_DIR}/sf2/\\xE2\\x96\\xA0VintageDreamsWaves-v2\\xE2\\x96\\xA0.sf2")
-set(TEST_SOUNDFONT_UTF8_2 "${FluidSynth_SOURCE_DIR}/sf2/VìntàgèDrèàmsWàvès-v2.sf2")
-set(TEST_SOUNDFONT_SF3 "${FluidSynth_SOURCE_DIR}/sf2/VintageDreamsWaves-v2.sf3")
-set(TEST_MIDI_UTF8 "${FluidSynth_SOURCE_DIR}/test/ⓉⒺⓈⓉ.mid")
-set(TEST_WAV_UTF8 "${FluidSynth_BINARY_DIR}/test/ⓉⒺⓈⓉ.wav")
+#
+# The unit tests resolve their test data relative to the current working
+# directory (the test build dir on the host via ctest, the adb-pushed
+# ${TEST_DIR} in the Android emulator), therefore TEST_* are plain relative
+# paths. The actual files are staged into ${TEST_DATA_STAGE} mirroring their
+# location relative to the source root (see TEST_DATA_FILES below), and on
+# the Android emulator test/run-android-tests.sh pushes that staged tree to
+# the device.
+set(TEST_DATA_STAGE "${CMAKE_BINARY_DIR}/test")
+set(TEST_DATA_FILES
+    "${FluidSynth_SOURCE_DIR}/sf2/VintageDreamsWaves-v2.sf2"
+    "${FluidSynth_SOURCE_DIR}/sf2/VintageDreamsWaves-v2.dls"
+    "${FluidSynth_SOURCE_DIR}/sf2/■VintageDreamsWaves-v2■.sf2"
+    "${FluidSynth_SOURCE_DIR}/sf2/VìntàgèDrèàmsWàvès-v2.sf2"
+    "${FluidSynth_SOURCE_DIR}/sf2/VintageDreamsWaves-v2.sf3"
+    "${FluidSynth_SOURCE_DIR}/test/ⓉⒺⓈⓉ.mid"
+)
+set(TEST_DATA_OUTPUTS "")
+foreach(src IN LISTS TEST_DATA_FILES)
+    file(RELATIVE_PATH rel "${FluidSynth_SOURCE_DIR}" "${src}")
+    set(dst "${TEST_DATA_STAGE}/${rel}")
+    get_filename_component(dst_dir "${dst}" DIRECTORY)
+    add_custom_command(
+        OUTPUT "${dst}"
+        COMMAND "${CMAKE_COMMAND}" -E make_directory "${dst_dir}"
+        COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${src}" "${dst}"
+        DEPENDS "${src}"
+        VERBATIM
+    )
+    list(APPEND TEST_DATA_OUTPUTS "${dst}")
+endforeach()
+add_custom_target(test_data DEPENDS ${TEST_DATA_OUTPUTS})
+
+set(TEST_SOUNDFONT "sf2/VintageDreamsWaves-v2.sf2")
+set(TEST_DLS "sf2/VintageDreamsWaves-v2.dls")
+set(TEST_SOUNDFONT_UTF8_1 "sf2/\\xE2\\x96\\xA0VintageDreamsWaves-v2\\xE2\\x96\\xA0.sf2")
+set(TEST_SOUNDFONT_UTF8_2 "sf2/VìntàgèDrèàmsWàvès-v2.sf2")
+set(TEST_SOUNDFONT_SF3 "sf2/VintageDreamsWaves-v2.sf3")
+set(TEST_MIDI_UTF8 "test/ⓉⒺⓈⓉ.mid")
+set(TEST_WAV_UTF8 "test/ⓉⒺⓈⓉ.wav")
 
 # Make sure to link against libm before checking for math functions below
 set ( CMAKE_REQUIRED_LIBRARIES "${LIBFLUID_LIBS};${WINDOWS_LIBS}" )

cmake_admin/FluidUnitTest.cmake

@@ -26,7 +26,9 @@ macro ( ADD_FLUID_TEST _test )
     )
 
     # add the test to ctest
-    ADD_TEST(NAME ${_test} COMMAND ${_test})
+    if( NOT ANDROID )
+        ADD_TEST(NAME ${_test} COMMAND ${_test})
+    endif()
 
     # append the current unit test to check-target as dependency
     add_dependencies(check ${_test})