Merge branch 'ci-fix-asan-detection' into 'dev'

Fix run with ASAN script

See merge request objectbox/objectbox-java!123

Author: greenrobot-team

.gitlab-ci.yml

@@ -1,4 +1,5 @@
 # Default image for linux builds
+# Using core instead of base to get access to ASAN from clang.
 image: objectboxio/buildenv-core:2023-07-28
 
 # Assumes these environment variables are configured in GitLab CI/CD Settings:
@@ -44,7 +45,7 @@ test:
     # "|| true" for an OK exit code if no file is found
     - rm **/hs_err_pid*.log || true
   script:
-    - ./ci/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean build
+    - ./scripts/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean build
   artifacts:
     when: always
     paths:
@@ -89,7 +90,7 @@ test-macos:
     LC_ALL: "C.UTF-8"
   script:
     # Note: do not run check task as it includes SpotBugs.
-    - ./ci/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean :tests:objectbox-java-test:test
+    - ./scripts/test-with-asan.sh $GITLAB_REPO_ARGS $VERSION_ARGS clean :tests:objectbox-java-test:test
 
 # Test oldest supported and a recent JDK.
 # Note: can not run these in parallel using a matrix configuration as Gradle would step over itself.

Jenkinsfile

@@ -56,7 +56,7 @@ pipeline {
 
         stage('build-java') {
             steps {
-                sh "./ci/test-with-asan.sh $gradleArgs $signingArgs $gitlabRepoArgs clean build"
+                sh "./scripts/test-with-asan.sh $gradleArgs $signingArgs $gitlabRepoArgs clean build"
             }
             post {
                 always {
@@ -78,7 +78,7 @@ pipeline {
                 // "|| true" for an OK exit code if no file is found
                 sh 'rm tests/objectbox-java-test/hs_err_pid*.log || true'
                 // Note: do not run check task as it includes SpotBugs.
-                sh "./ci/test-with-asan.sh $gradleArgs $gitlabRepoArgs clean :tests:objectbox-java-test:test"
+                sh "./scripts/test-with-asan.sh $gradleArgs $gitlabRepoArgs clean :tests:objectbox-java-test:test"
             }
             post {
                 always {
@@ -95,7 +95,7 @@ pipeline {
                 // "|| true" for an OK exit code if no file is found
                 sh 'rm tests/objectbox-java-test/hs_err_pid*.log || true'
                 // Note: do not run check task as it includes SpotBugs.
-                sh "./ci/test-with-asan.sh $gradleArgs $gitlabRepoArgs clean :tests:objectbox-java-test:test"
+                sh "./scripts/test-with-asan.sh $gradleArgs $gitlabRepoArgs clean :tests:objectbox-java-test:test"
             }
             post {
                 always {

ci/test-with-asan.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+set -e
+
+# Runs Gradle with address sanitizer enabled. Arguments are passed directly to Gradle.
+# If no arguments are specified runs the test task.
+# The ASAN detection is known to work with the buildenv-core image or Ubuntu 22.04 with a clang setup.
+
+# ASAN shared library (gcc or clang setup)
+if [ -z "$ASAN_LIB_SO" ]; then  # If not supplied (e.g. by CI script), try to locate the lib:
+    ASAN_ARCH=$(uname -m) # x86_64 or aarch64
+    echo "No ASAN_LIB_SO defined, trying to locate dynamically..."
+    # Approach via https://stackoverflow.com/a/54386573/551269
+    ASAN_LIB_SO_GCC=$(gcc -print-file-name=libasan.so || true)
+    ASAN_LIB_SO_CLANG=$(clang -print-file-name=libclang_rt.asan-${ASAN_ARCH}.so || true)
+    # Find in the typical llvm directory (using `tail` for latest version; `head` would be oldest")
+    ASAN_LIB_SO_CLANG_LATEST=$(find /usr/lib/llvm-*/ -name libclang_rt.asan-${ASAN_ARCH}.so | tail -1)
+    echo "         gcc asan lib: ${ASAN_LIB_SO_GCC}"
+    echo "       clang asan lib: ${ASAN_LIB_SO_CLANG}"
+    echo "clang latest asan lib: ${ASAN_LIB_SO_CLANG_LATEST}"
+    if [ -f "${ASAN_LIB_SO_CLANG_LATEST}" ]; then # prefer this so version matches with llvm-symbolizer below
+        export ASAN_LIB_SO="${ASAN_LIB_SO_CLANG_LATEST}"
+    elif [ -f "${ASAN_LIB_SO_CLANG}" ]; then
+        export ASAN_LIB_SO="${ASAN_LIB_SO_CLANG}"
+    elif [ -f "${ASAN_LIB_SO_GCC}" ]; then
+        export ASAN_LIB_SO="${ASAN_LIB_SO_GCC}"
+    else
+        echo "No asan lib found; please specify via ASAN_LIB_SO"
+        exit 1
+    fi
+fi
+
+# llvm-symbolizer (clang setup only)
+# Rocky Linux 8 (buildenv-core)
+if [ -z "$ASAN_SYMBOLIZER_PATH" ]; then
+    export ASAN_SYMBOLIZER_PATH="$(find /usr/local/bin/ -name llvm-symbolizer | tail -1 )"
+fi
+# Ubuntu 22.04
+if [ -z "$ASAN_SYMBOLIZER_PATH" ]; then
+    export ASAN_SYMBOLIZER_PATH="$(find /usr/lib/llvm-*/ -name llvm-symbolizer | tail -1)"
+fi
+
+if [ -z "$ASAN_OPTIONS" ]; then
+    export ASAN_OPTIONS="detect_leaks=0"
+fi
+
+echo "ASAN_LIB_SO: $ASAN_LIB_SO"
+echo "ASAN_SYMBOLIZER_PATH: $ASAN_SYMBOLIZER_PATH"
+echo "ASAN_OPTIONS: $ASAN_OPTIONS"
+ls -l $ASAN_LIB_SO
+ls -l $ASAN_SYMBOLIZER_PATH
+
+if [[ $# -eq 0 ]] ; then
+    args=test
+else
+    args=$@
+fi
+echo "Starting Gradle for target(s) \"$args\"..."
+pwd
+
+LD_PRELOAD=${ASAN_LIB_SO} ./gradlew ${args}