build(isthmus-cli): use official graal plugin (#512)

Replace the deprecated com.palantir.graal plugin, which was last
released in June 2022 and is no longer maintained.

Signed-off-by: Mark S. Lewis <[email protected]>

Author: bestbeforetoday

.github/workflows/pr.yml

@@ -105,37 +105,33 @@ jobs:
     - uses: actions/checkout@v5
       with:
         submodules: recursive
-    - uses: graalvm/setup-graalvm@v1
+    - uses: actions/setup-java@v5
       with:
-        java-version: '17'
-        distribution: 'graalvm'
-        # helps avoid rate-limiting issues
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+        java-version: 21
+        distribution: graalvm
     - name: Setup Gradle
       uses: gradle/actions/setup-gradle@v4
     - name: Report Java Version
       run: java -version
-    - name: Install GraalVM native image
-      run: gu install native-image
     - name: Build with Gradle
       run: |
         # fetch submodule tags since actions/checkout@v5 does not
         git submodule foreach 'git fetch --unshallow || true'
 
-        ./gradlew nativeImage
+        ./gradlew nativeCompile
     - name: Smoke Test
       run: |
         ./isthmus-cli/src/test/script/smoke.sh
         ./isthmus-cli/src/test/script/tpch_smoke.sh
     - name: Rename the artifact to OS-unique name
       shell: bash
       run: |
-        value=`mv isthmus-cli/build/graal/isthmus isthmus-cli/build/graal/isthmus-${{ matrix.os }}`
+        value=`mv isthmus-cli/build/native/nativeCompile/isthmus isthmus-cli/build/native/nativeCompile/isthmus-${{ matrix.os }}`
     - name: Publish artifact
       uses: actions/upload-artifact@v4
       with:
         name: isthmus-${{ matrix.os }}
-        path: isthmus-cli/build/graal/isthmus-${{ matrix.os }}
+        path: isthmus-cli/build/native/nativeCompile/isthmus-${{ matrix.os }}
   dry-run-release:
     name: Dry-run release
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -22,37 +22,33 @@ jobs:
       - uses: actions/checkout@v5
         with:
           submodules: recursive
-      - uses: graalvm/setup-graalvm@v1
+      - uses: actions/setup-java@v5
         with:
-          java-version: "17"
-          distribution: "graalvm"
-          # helps avoid rate-limiting issues
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+          java-version: 21
+          distribution: graalvm
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
       - name: Report Java Version
         run: java -version
-      - name: Install GraalVM native image
-        run: gu install native-image
       - name: Build with Gradle
         run: |
           # fetch submodule tags since actions/checkout@v5 does not
           git submodule foreach 'git fetch --unshallow || true'
 
-          ./gradlew nativeImage
+          ./gradlew nativeCompile
       - name: Smoke Test
         run: |
           ./isthmus-cli/src/test/script/smoke.sh
           ./isthmus-cli/src/test/script/tpch_smoke.sh
       - name: Rename the artifact to OS-unique name
         shell: bash
         run: |
-          value=`mv isthmus-cli/build/graal/isthmus isthmus-cli/build/graal/isthmus-${{ matrix.os }}`
+          value=`mv isthmus-cli/build/native/nativeCompile/isthmus isthmus-cli/build/native/nativeCompile/isthmus-${{ matrix.os }}`
       - name: Publish artifact
         uses: actions/upload-artifact@v4
         with:
           name: isthmus-${{ matrix.os }}
-          path: isthmus-cli/build/graal/isthmus-${{ matrix.os }}
+          path: isthmus-cli/build/native/nativeCompile/isthmus-${{ matrix.os }}
   semantic-release:
     if: github.repository == 'substrait-io/substrait-java'
     runs-on: ubuntu-latest

gradle/libs.versions.toml

@@ -3,7 +3,7 @@ antlr = "4.13.2"
 calcite = "1.40.0"
 commons-lang3 = "[3.18.0,)"
 graal = "22.1.0"
-graal-plugin = "0.12.0"
+graal-plugin = "0.11.0"
 gradle-extensions = "2.0.0"
 guava = "33.4.8-jre"
 httpclient5 = "5.5"
@@ -71,7 +71,7 @@ spark-sql = { module = "org.apache.spark:spark-sql_2.12", version.ref = "spark"
 jackson = [ "jackson-databind", "jackson-annotations", "jackson-datatype-jdk8", "jackson-dataformat-yaml" ]
 
 [plugins]
-graal = { id = "com.palantir.graal", version.ref = "graal-plugin" }
+graal = { id = "org.graalvm.buildtools.native", version.ref = "graal-plugin" }
 gradle-extensions = { id = "com.github.vlsi.gradle-extensions", version.ref = "gradle-extensions" }
 jreleaser = { id = "org.jreleaser", version.ref = "jreleaser" }
 protobuf = { id = "com.google.protobuf", version.ref = "protobuf-plugin" }

isthmus-cli/README.md

@@ -6,26 +6,26 @@ Isthmus-CLI provides a native command-line interface to drive the [Isthmus](../i
 
 ## Build
 
-Isthmus can be built as a native executable via Graal
+Isthmus can be built as a native executable via Graal. This requires a GraalVM JDK to be installed, and its install location set in the `GRAALVM_HOME` environment variable.
 
 ```
-./gradlew nativeImage
+./gradlew nativeCompile
 ```
 
 ## Usage
 
 ### Version
 
 ```
-$ ./isthmus-cli/build/graal/isthmus --version
+$ ./isthmus-cli/build/native/nativeCompile/isthmus --version
 
 isthmus 0.1
 ```
 
 ### Help
 
 ```
-$ ./isthmus-cli/build/graal/isthmus --help
+$ ./isthmus-cli/build/native/nativeCompile/isthmus --help
 
 Usage: isthmus [-hV] [--outputformat=<outputFormat>]
                [--unquotedcasing=<unquotedCasing>] [-c=<createStatements>]...
@@ -52,7 +52,7 @@ Convert SQL Queries and SQL Expressions to Substrait
 ### SQL to Substrait Plan
 
 ```
-> $ ./isthmus-cli/build/graal/isthmus \
+> $ ./isthmus-cli/build/native/nativeCompile/isthmus \
   -c "CREATE TABLE Persons ( firstName VARCHAR, lastName VARCHAR, zip INT )" \
      "SELECT lastName, firstName FROM Persons WHERE zip = 90210"
 
@@ -183,7 +183,7 @@ Convert SQL Queries and SQL Expressions to Substrait
 #### Projection
 
 ```
-$ ./isthmus-cli/build/graal/isthmus -c "CREATE TABLE NATION (N_NATIONKEY BIGINT NOT NULL, N_NAME CHAR(25), N_REGIONKEY BIGINT NOT NULL, N_COMMENT VARCHAR(152))" \
+$ ./isthmus-cli/build/native/nativeCompile/isthmus -c "CREATE TABLE NATION (N_NATIONKEY BIGINT NOT NULL, N_NAME CHAR(25), N_REGIONKEY BIGINT NOT NULL, N_COMMENT VARCHAR(152))" \
     -e  "N_REGIONKEY + 10"
 
 {
@@ -283,7 +283,7 @@ $ ./isthmus-cli/build/graal/isthmus -c "CREATE TABLE NATION (N_NATIONKEY BIGINT
 #### Filter
 
 ```
-$ ./isthmus-cli/build/graal/isthmus -c "CREATE TABLE NATION (N_NATIONKEY BIGINT NOT NULL, N_NAME CHAR(25), N_REGIONKEY BIGINT NOT NULL, N_COMMENT VARCHAR(152))" \
+$ ./isthmus-cli/build/native/nativeCompile/isthmus -c "CREATE TABLE NATION (N_NATIONKEY BIGINT NOT NULL, N_NAME CHAR(25), N_REGIONKEY BIGINT NOT NULL, N_COMMENT VARCHAR(152))" \
     -e  "N_REGIONKEY > 10"
 
 {

isthmus-cli/build.gradle.kts

@@ -1,8 +1,8 @@
 import java.nio.charset.StandardCharsets
 
 plugins {
-  id("java")
   id("idea")
+  id("application")
   alias(libs.plugins.graal)
   alias(libs.plugins.spotless)
   id("substrait.java-conventions")
@@ -24,7 +24,7 @@ dependencies {
   testRuntimeOnly(libs.junit.platform.launcher)
   implementation(libs.reflections)
   implementation(libs.guava)
-  implementation(libs.graal.sdk)
+  compileOnly(libs.graal.sdk)
   implementation(libs.picocli)
   annotationProcessor(libs.picocli.codegen)
   implementation(libs.protobuf.java.util) {
@@ -68,6 +68,7 @@ val initializeAtBuildTime =
       "io.substrait.isthmus.metadata.LambdaMetadataSupplier",
       "io.substrait.isthmus.metadata.LegacyToLambdaGenerator",
       "org.apache.calcite.config.CalciteSystemProperty",
+      "org.apache.calcite.linq4j.tree.Primitive",
       "org.apache.calcite.rel.metadata.BuiltInMetadata\$AllPredicates",
       "org.apache.calcite.rel.metadata.BuiltInMetadata\$Collation",
       "org.apache.calcite.rel.metadata.BuiltInMetadata\$ColumnOrigin",
@@ -114,6 +115,8 @@ val initializeAtBuildTime =
       "org.apache.calcite.rel.metadata.RelMdSize",
       "org.apache.calcite.rel.metadata.RelMdTableReferences",
       "org.apache.calcite.rel.metadata.RelMdUniqueKeys",
+      "org.apache.calcite.sql.SqlKind",
+      "org.apache.calcite.util.BuiltInMethod",
       "org.apache.calcite.util.Pair",
       "org.apache.calcite.util.ReflectUtil",
       "org.apache.calcite.util.Util",
@@ -124,19 +127,26 @@ val initializeAtBuildTime =
     )
     .joinToString(",")
 
-graal {
-  mainClass("io.substrait.isthmus.cli.IsthmusEntryPoint")
-  outputName("isthmus")
-  graalVersion("22.1.0")
-  javaVersion("17")
-  option("--no-fallback")
-  option("--initialize-at-build-time=${initializeAtBuildTime}")
-  option("-H:IncludeResources=.*yaml")
-  option("--report-unsupported-elements-at-runtime")
-  option("-H:+ReportExceptionStackTraces")
-  option("-H:DynamicProxyConfigurationFiles=${project.file("proxies.json")}")
-  option("--features=io.substrait.isthmus.cli.RegisterAtRuntime")
-  option("-J--enable-preview")
+application { mainClass.set("io.substrait.isthmus.cli.IsthmusEntryPoint") }
+
+graalvmNative {
+  binaries {
+    toolchainDetection.set(false)
+
+    all { verbose.set(true) }
+
+    named("main") {
+      imageName.set("isthmus")
+      fallback.set(false)
+      buildArgs.add("--initialize-at-build-time=${initializeAtBuildTime}")
+      buildArgs.add("-H:IncludeResources=.*yaml")
+      buildArgs.add("--report-unsupported-elements-at-runtime")
+      buildArgs.add("-H:+ReportExceptionStackTraces")
+      buildArgs.add("-H:DynamicProxyConfigurationFiles=${project.file("proxies.json")}")
+      buildArgs.add("--features=io.substrait.isthmus.cli.RegisterAtRuntime")
+      buildArgs.add("-J--enable-preview")
+    }
+  }
 }
 
 tasks.register("writeIsthmusVersion") {

isthmus-cli/src/test/script/smoke.sh

@@ -4,7 +4,7 @@ set -eu -o pipefail
 
 parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
 cd "${parent_path}"
-CMD=../../../build/graal/isthmus
+CMD=../../../build/native/nativeCompile/isthmus
 LINEITEM="CREATE TABLE LINEITEM (L_ORDERKEY BIGINT NOT NULL, L_PARTKEY BIGINT NOT NULL, L_SUPPKEY BIGINT NOT NULL, L_LINENUMBER INTEGER, L_QUANTITY DECIMAL, L_EXTENDEDPRICE DECIMAL, L_DISCOUNT DECIMAL, L_TAX DECIMAL, L_RETURNFLAG CHAR(1), L_LINESTATUS CHAR(1), L_SHIPDATE DATE, L_COMMITDATE DATE, L_RECEIPTDATE DATE, L_SHIPINSTRUCT CHAR(25), L_SHIPMODE CHAR(10), L_COMMENT VARCHAR(44))"
 echo "${LINEITEM}"
 #set -x

isthmus-cli/src/test/script/tpch_smoke.sh

@@ -4,7 +4,7 @@ set -eu -o pipefail
 
 parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
 cd "${parent_path}"
-CMD=../../../build/graal/isthmus
+CMD=../../../build/native/nativeCompile/isthmus
 
 TPCH="../../../../isthmus/src/test/resources/tpch"
 

readme.md

@@ -11,9 +11,9 @@ After you've cloned the project through git, Substrait Java is built with a tool
 ./gradlew build
 ```
 
-To build the Isthmus executable that enables Substrait plans to be generated for a SQL statement, execute the following:
+To build the Isthmus executable that enables Substrait plans to be generated for a SQL statement, first ensure that you have GraalVM JDK installed and its install location set in the `GRAALVM_HOME` environment variable, then execute the following:
 ```
-./gradlew nativeImage
+./gradlew nativeCompile
 ```
 
 ## Getting Started