ci: Debug

Author: madadam

.github/workflows/ci.yml

@@ -278,26 +278,9 @@ jobs:
           name: ${{ matrix.name }}
           path: releases/release_*/${{ matrix.artifact-files }}
 
-  integration_test_android_prebuild:
-    name: "Prebuild the test binary for integration tests on android"
-    runs-on: self-hosted
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Prebuild
-        run: |
-          ./docker/linux.sh \
-            --container ouisync-integration-test-android-prebuild-$GITHUB_RUN_ID \
-            --srcdir . \
-            --cache \
-            integration-test --platform android --prebuild
-
   integration_test_android:
     name: "run integration tests on android ${{ matrix.api-level }}"
     runs-on: self-hosted
-    needs: ["integration_test_android_prebuild"]
     strategy:
       fail-fast: false
       matrix:
@@ -342,7 +325,6 @@ jobs:
       #   # Upload only when the tests fail
       #   if: failure() || cancelled()
 
-
   # TODO: Integration tests on both linux and windows currently fail or hang. Commenting them out until they are fixed.
   # integration_test_desktop:
   #   name: run integration tests on ${{ matrix.name }}

android/settings.gradle

@@ -46,4 +46,3 @@ includeBuild('../ouisync/bindings/kotlin') {
         substitute module('ie.equalit.ouinet:ouisync-service-debug') using project(':ouisync-service')
     }
 }
-

docker/linux.sh

@@ -30,9 +30,6 @@ container_name=$default_container_name
 # Is cache enabled (see `$cache_paths` to see what's cached)?
 cache=
 
-# Is gradle cache enabled? Needed only for android integration test and build
-cache_gradle=
-
 # Name of the docker volume to put the cache on
 cache_volume="$base_name-cache"
 
@@ -47,6 +44,10 @@ cache_paths=(
     # Cargo per project
     /opt/ouisync-app/ouisync/target
 
+    # Gradle
+    /root/.gradle/caches
+    /root/.gradle/wrapper
+
     # Dart
     /root/.pub-cache
 
@@ -84,7 +85,6 @@ function print_help() {
             echo "Options:"
             echo "    --platform <linux|android>    Platform for which to run the tests"
             echo "    --api <API>                   Android API level to run in"
-            echo "    --prebuild                    Only build the test binary, don't run the tests. Useful for seeding the cache."
             ;;
         "analyze")
             echo "Analyze the dart source code"
@@ -136,8 +136,8 @@ function print_help() {
     esac
 }
 
-function build_container() {
-    log_group_begin "Building image $image_name"
+function build_image() {
+    log_group_begin "Build image $image_name"
 
     ndk_version=$(cat ndk-version.txt)
     dock build -t $image_name --build-arg NDK_VERSION=$ndk_version - < docker/Dockerfile.linux
@@ -155,48 +155,11 @@ function create_cache_volume() {
     log_group_end
 }
 
-# Gradle cache doesn't work well when accessed from multiple containers concurrently. This is
-# because the Gradle daemons need to communicate with each other over localhost TCP sockets in
-# order to coordinate locking and this doesn't work when each daemon runs in a separate container
-# (due to network separation). One way around this is to run the containers with `--network host`
-# but that comes with its own issues and is generally not worth it. To solve this, we copy
-# (using rsync) the Gradle cache files from the cache volume to the container at the beginning of
-# the run and the copy them back at the end of it. We use file locks to synchronize the copies.
-gradle_cache_root=/root/.gradle
-gradle_cache_dirs=(caches wrapper)
-
-function gradle_cache_rsync() {
-    local lock_mode=$1
-    local src=$2
-    local dst=$3
-
-    exe mkdir -p "${gradle_cache_dirs[@]/#/$src/}"
-    exe flock $lock_mode /mnt/cache/gradle.lock                             \
-            rsync                                                           \
-                -a                                                          \
-                --exclude='*.lock'                                          \
-                ${gradle_cache_dirs[@]/*/--include=/&/ --include=/&/***}    \
-                --exclude='*'                                               \
-                "$src/" "$dst"
-}
-
-function restore_gradle_cache() {
-    log_group_begin "Restore gradle cache"
-    gradle_cache_rsync --shared /mnt/cache$gradle_cache_root $gradle_cache_root
-    log_group_end
-}
-
-function save_gradle_cache() {
-    log_group_begin "Save gradle cache"
-    gradle_cache_rsync --exclusive $gradle_cache_root /mnt/cache$gradle_cache_root
-    log_group_end
-}
-
 function start_container() {
     if [ -z "$commit" -a -z "$srcdir" ]; then error "Missing one of --commit or --srcdir"; fi
     if [ -n "$commit" -a -n "$srcdir" ]; then error "--commit and --src are mutually exclusive"; fi
 
-    build_container
+    build_image
 
     if [ "$cache" = 1 ]; then
         create_cache_volume
@@ -256,10 +219,6 @@ function start_container() {
     fi
     log_group_end
 
-    if [ "$cache" = 1 -a "$cache_gradle" = 1 ]; then
-        restore_gradle_cache
-    fi
-
     # Generate bindings (TODO: This should be done automatically)
     log_group_begin "Generate bindings"
     exe -w /opt/ouisync-app/ouisync/bindings/dart -t dart pub get
@@ -270,19 +229,15 @@ function start_container() {
     exe -w /opt/ouisync-app -t dart pub get
     log_group_end
 
-    # Run cargo sweep to delete all cargo artifacts older than 30 days (prevents unbounded cache grow)
     if [ "$cache" = 1 ]; then
+        # Run cargo sweep to delete all cargo artifacts older than 30 days (prevents unbounded cache grow)
         log_group_begin "Prune cached cargo artifacts"
         exe -w /opt/ouisync-app/ouisync -t cargo sweep --recursive --time 30
         log_group_end
     fi
 }
 
 function stop_container() {
-    if [ "$cache" = 1 -a "$cache_gradle" ]; then
-        save_gradle_cache
-    fi
-
     echo "Stop container $container_name"
     dock container stop $container_name
 }
@@ -335,7 +290,7 @@ function manage_container() {
             stop_container
             ;;
         build)
-            build_container
+            build_image
             ;;
     esac
 }
@@ -349,7 +304,6 @@ function init() {
 # Build the release artifacts for linux and android
 function build() {
     rsync_include_git=1
-    cache_gradle=1
 
     local dst_dir="./releases/$container_name"
     local flavor=
@@ -434,6 +388,27 @@ function unit_test() {
 
 ####################################################################################################
 
+# emulator_serial=
+
+# # Find serial number of the emulator running the given avd
+# function emulator_find_serial() {
+#     local expected_avd=$1
+
+#     # Find the serial number
+#     while true; do
+#         for serial in $(adb devices | grep emulator | cut -f1); do
+#             local actual_avd=$(adb -s $serial emu avd name | head -n1 | sed 's/[^[:alnum:]-]//g')
+
+#             if [ "$expected_avd" = "$actual_avd" ]; then
+#                 emulator_serial=$serial
+#                 return
+#             fi
+#         done
+
+#         sleep 1
+#     done
+# }
+
 # Wait for the emulator to boot
 function emulator_wait_boot() {
     while true; do
@@ -511,44 +486,46 @@ function emulator_stop() {
 }
 
 function integration_test_android() {
-    cache_gradle=1
+    # Share also the build directoty between the integration test jobs, to speed them up
+    cache_paths+=("/opt/ouisync-app/build")
+
     init
 
     local api=
-    local prebuild=
 
     while true; do
         case ${1-} in
             --api)
                 api="${2-}"
                 shift 2
                 ;;
-            --prebuild)
-                prebuild=1
-                shift
-                ;;
             *)
                 break
                 ;;
         esac
     done
 
-    if [ "$prebuild" = 1 ]; then
-        log_group_begin "Pre-build the test binary"
-        exe -w /opt/ouisync-app -t flutter build apk --debug --flavor itest --target-platform android-x64
-        log_group_end
-        return
-    fi
-
     if [ -z "$api" ]; then
         error "Missing --api"
     fi
 
     emulator_start --api $api
 
     log_group_begin "Run tests"
-    exe -w /opt/ouisync-app -t flutter \
-        test integration_test --flavor itest --ignore-timeouts $@
+
+    # Note: While multiple gradle daemons can safely access the gradle home directory
+    # (~/.gradle) concurrently when running on the same machine, the same is not true when they run
+    # on different containers while the gradle home is shared between them. This is because the
+    # daemons need to coordinate locking and they use localhost TCP sockets to do that which
+    # doesn't work in containers due to network isolation. To work around that, we put a big fat
+    # lock around this whole command so that only one container can run it at a time.
+    #
+    # TODO: This is not optimal. Try to find a way to split the test building and running into two
+    # steps and put the lock only around the build step (which needs to happen only once anyway).
+    exe -w /opt/ouisync-app -t \
+        flock /mnt/cache/gradle.lock \
+            flutter test integration_test --flavor itest --ignore-timeouts $@
+
     log_group_end
 
     emulator_stop