Restructure CI workflow and improve JDK caching (#178)

Author: jbachorik

.github/actions/extract_versions/action.yml

@@ -1,15 +1,28 @@
 name: Extract Java and Gradle Versions
 description: Versions are reported in JAVA_VERSION and GRADLE_VERSION environment variables
+
 runs:
   using: "composite"
   steps:
     - name: Extract Versions
       id: extract_versions
       shell: bash
       run: |
+        set +e
+
         # Extract Java version
-        java_version="${{ matrix.java_version }}"
-        echo "JAVA_VERSION=${java_version%%+*}" >> $GITHUB_ENV
+        ${{ env.JAVA_TEST_HOME }}/bin/java -version
+        JAVA_VERSION=$(${{ env.JAVA_TEST_HOME }}/bin/java -version 2>&1 | awk -F '"' '/version/ {
+              split($2, v, "[._]");
+              if (v[1] == "1") {
+              # Java 8 or older: Include major, minor, and update
+              printf "%s.%s.%s\n", v[2], v[3], v[4]
+            } else {
+              # Java 9 or newer: Major, minor, and patch
+              printf "%s.%s.%s\n", v[1], v[2], v[3]
+            }
+          }')
+        echo "JAVA_VERSION=${JAVA_VERSION}" >> $GITHUB_ENV
 
         # Extract Gradle version from gradle-wrapper.properties
         gradle_version=$(grep 'distributionUrl' gradle/wrapper/gradle-wrapper.properties | cut -d'=' -f2)

.github/actions/setup_cached_java/action.yml

@@ -0,0 +1,74 @@
+name: "Setup test Java environment"
+description: "Setup Java environment for testing"
+
+inputs:
+  version:
+    description: "The test JDK version to install"
+    required: true
+    default: "11"
+  arch:
+    description: "The architecture"
+    required: true
+    default: "amd64"
+
+runs:
+    using: composite
+    steps:
+      - name: Infer Build JDK
+        shell: bash
+        id: infer_build_jdk
+        run: |
+          echo "Infering JDK 11 [${{ inputs.arch }}]"
+          if [[ ${{ inputs.arch }} =~ "-musl" ]]; then
+            echo "build_jdk=jdk11-librca" >> $GITHUB_OUTPUT
+          else
+            echo "build_jdk=jdk11" >> $GITHUB_OUTPUT
+          fi
+      - name: Cache Build JDK [${{ inputs.arch }}]
+        id: cache_build_jdk
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            jdks/${{ steps.infer_build_jdk.outputs.build_jdk }}
+          key: ${{ steps.infer_build_jdk.outputs.build_jdk }}-${{ inputs.arch }}--${{ hashFiles('.github/workflows/cache_java.yml', '.github/scripts/java_setup.sh') }}
+          restore-keys: |
+            ${{ steps.infer_build_jdk.outputs.build_jdk }}-${{ inputs.arch }}--
+      - name: Cache JDK ${{ inputs.version }} [${{ inputs.arch }}]
+        id: cache_jdk
+        uses: actions/cache/restore@v4
+        with:
+          path: |
+            jdks/jdk${{ inputs.version }}
+          key: jdk${{ inputs.version }}-${{ inputs.arch }}--${{ hashFiles('.github/workflows/cache_java.yml', '.github/scripts/java_setup.sh') }}
+          restore-keys: |
+            jdk${{ inputs.version }}-${{ inputs.arch }}--
+      - name: JDK cache miss
+        if: steps.cache_jdk.outputs.cache-hit != 'true' || steps.cache_build_jdk.outputs.cache-hit != 'true'
+        shell: bash
+        run: |
+          # well, the cache-hit is not alway set to 'true', even when cache is hit (but it is not freshly recreated, whatever that means)
+          if [ ! -d "jdks/jdk${{ inputs.version }}" ]; then
+            OWNER=${{ github.repository_owner }}
+            REPO=${{ github.event.repository.name }}
+            BRANCH=${{ github.ref_name }}
+            WORKFLOW="cache_java.yml"
+    
+            URL="https://github.com/$OWNER/$REPO/actions/workflows/$WORKFLOW"
+              
+            echo "### ⚠️ JDK Cache Miss Detected" >> $GITHUB_STEP_SUMMARY
+            echo "🛠️ [Click here and select ${BRANCH} branch to manually refresh the cache](<$URL>)" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+      - name: Setup Environment
+        shell: bash
+        run: |
+          chmod a+rx -R jdks
+          echo "Setting up JDK ${{ inputs.version }} [${{ inputs.arch }}]"
+          JAVA_HOME=$(pwd)/jdks/${{ steps.infer_build_jdk.outputs.build_jdk }}
+          JAVA_TEST_HOME=$(pwd)/jdks/jdk${{ inputs.version }}
+          PATH=$JAVA_HOME/bin:$PATH
+          echo "JAVA_HOME=$JAVA_HOME" >> $GITHUB_ENV
+          echo "JAVA_TEST_HOME=$JAVA_TEST_HOME" >> $GITHUB_ENV
+          echo "PATH=$JAVA_HOME/bin:$PATH" >> $GITHUB_ENV
+          
+          ldd $JAVA_HOME/bin/java

.github/scripts/java_setup.sh

@@ -1,14 +1,76 @@
 #!/usr/bin/env bash
 
 function prepareJdk() {
-  local jdk_distro=$1
-  local target_path=$2
+  local variant=$1
+  local arch=$2
+  local version=${variant%%-*}
+  local qualifier=${variant#*-}
 
-  if [ -e "$target_path/bin/java" ]; then
-    echo "JDK $jdk_distro already installed at $jdk_path"
+  local target_path="${GITHUB_WORKSPACE}/${JDKS_DIR}/jdk${variant}"
+
+  mkdir -p ${target_path}
+
+  if [[ ${qualifier} == "librca" ]] && [[ "${arch}" =~ "-musl" ]]; then
+    URL_VAR="JAVA_${version}_MUSL_URL"
+    URL="${!URL_VAR}"
+    if [[ -z "${URL}" ]]; then
+      echo "Musl/Liberica JDK URL not found for ${arch}/${variant}"
+      exit 1
+    fi
+    curl -L --fail "${URL}" | tar -xvzf - -C ${target_path} --strip-components 1
     return
   fi
 
-  echo 'n' | sdk install java ${jdk_distro}
-  ln -s ~/.sdkman/candidates/java/${jdk_distro} ${target_path}
-}
+  if [[ ${qualifier} == "orcl" ]]; then
+    if [[ ${version} == "8" ]]; then
+      mkdir -p "${target_path}"
+      curl -L --fail "${JAVA_8_ORACLE_URL}" | sudo tar -xvzf - -C ${target_path} --strip-components 1
+      return
+    else
+      echo "Oracle JDK 8 only!"
+      exit 1
+    fi
+  fi
+
+  if [[ ${qualifier} == "zing" ]]; then
+    URL_VAR="JAVA_${version}_ZING_URL"
+    if [[ "${arch}" == "aarch64" ]]; then
+      URL_VAR="JAVA_${version}_ZING_AARCH64_URL"
+    fi
+
+    URL="${!URL_VAR}"
+    if [[ -z "${URL}" ]]; then
+      echo "Zing JDK URL not found for ${variant}"
+      exit 1
+    fi
+    curl -L --fail "${URL}" | sudo tar -xvzf - -C ${target_path} --strip-components 1
+    if [[ "${arch}" != "aarch64" ]]; then
+      # rename the bundled libstdc++.so to avoid conflicts with the system one
+      sudo mv ${target_path}/etc/libc++/libstdc++.so.6 ${target_path}/etc/libc++/libstdc++.so.6.bak
+    fi
+    return
+  fi
+
+  # below the installation of the SDKMAN-managed JDK
+  source ~/.sdkman/bin/sdkman-init.sh
+
+  local suffix="tem"
+  local versionVar="JAVA_${version}_VERSION"
+  if [[ "${qualifier}" == "j9" ]]; then
+    suffix="sem"
+    versionVar="JAVA_${version}_J9_VERSION"
+  elif [[ "${qualifier}" == "graal" ]]; then
+    suffix="graal"
+    versionVar="JAVA_${version}_GRAAL_VERSION"
+  fi
+
+  local distro_base
+  distro_base="${!versionVar}"
+  local jdk_distro="${distro_base}-${suffix}"
+
+  echo 'n' | sdk install java ${jdk_distro} > /dev/null
+
+  rm -rf ${target_path}
+  mkdir -p "$(dirname ${target_path})"
+  mv ${SDKMAN_DIR}/candidates/java/${jdk_distro} ${target_path}
+}

.github/scripts/prepare_reports.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+mkdir -p reports
+cp /tmp/hs_err* reports/ || true
+cp ddprof-test/build/hs_err* reports/ || true
+cp -r ddprof-lib/build/tmp reports/native_build || true
+cp -r ddprof-test/build/reports/tests reports/tests || true
+cp -r /tmp/recordings reports/recordings || true
+find ddprof-lib/build -name 'libjavaProfiler.*' -exec cp {} reports/ \; || true