Test against GraalVM native-image

Added an example of a native application that uses the driver and is built using GraalVM. The application runs the existing tour applications for the sync, legacy and reactive driver APIs.

JAVA-3580

Author: stIncMale

graalvm-native-image-app/build.gradle

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+plugins {
+    id 'application'
+    id 'org.graalvm.buildtools.native' version '0.9.23'
+}
+
+application {
+    mainClass = 'com.mongodb.internal.graalvm.NativeImageApp'
+}
+
+// see https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html
+graalvmNative {
+    metadataRepository {
+        enabled = true
+        version = '0.3.6'
+    }
+    agent {
+        // Executing the `run` Gradle task with the tracing agent
+        // https://www.graalvm.org/latest/reference-manual/native-image/metadata/AutomaticMetadataCollection/
+        // requires running Gradle with GraalVM despite the toolchain for the task already being GraalVM.
+        // The same is true about executing the `metadataCopy` Gradle task.
+        // This may be a manifestation of an issue with the `org.graalvm.buildtools.native` plugin.
+        enabled = false
+        defaultMode = 'standard'
+        metadataCopy {
+            inputTaskNames.add('run')
+            outputDirectories.add('src/main/resources/META-INF/native-image')
+            mergeWithExisting = false
+        }
+    }
+    binaries {
+        configureEach {
+            buildArgs.add('--strict-image-heap')
+            // see class initialization report is generated at `graalvm/build/native/nativeCompile/reports`,
+            // informing us on the kind of initialization for each Java class
+            buildArgs.add('-H:+PrintClassInitialization')
+            // see the "registerResource" entries in the `native-image` built-time output,
+            // informing us on the resources included in the native image being built
+            buildArgs.add('-H:Log=registerResource:5')
+        }
+        main {
+            sharedLibrary = false
+            def mainClassName = application.mainClass.get()
+            imageName = mainClassName.substring(mainClassName.lastIndexOf('.') + 1, mainClassName.length())
+            quickBuild = true
+            // See the "Apply" entries in the `native-image` built-time output, informing us on
+            // the build configuration files (https://www.graalvm.org/latest/reference-manual/native-image/overview/BuildConfiguration/)
+            // and the reachability metadata files (https://www.graalvm.org/latest/reference-manual/native-image/metadata/)
+            // which are applied at build time.
+            verbose = true
+        }
+    }
+}
+
+dependencies {
+    // we intentionally depend here on the driver artifacts instead of depending on compiled classes
+    implementation project(path:':bson', configuration:'archives')
+    implementation project(path:':driver-core', configuration:'archives')
+    implementation project(path:':driver-sync', configuration:'archives')
+    implementation project(path:':driver-reactive-streams', configuration:'archives')
+    implementation project(path:':driver-legacy', configuration:'archives')
+    // note that as a result of these `sourceSets` dependencies, `driver-sync/src/test/resources/logback-test.xml` is used
+    implementation project(':driver-sync').sourceSets.test.output
+    implementation project(':driver-legacy').sourceSets.test.output
+    implementation project(':driver-reactive-streams').sourceSets.test.output
+    implementation "org.mongodb:mongodb-crypt:$mongoCryptVersion"
+    implementation 'org.slf4j:slf4j-api:2.0.12'
+    implementation 'ch.qos.logback:logback-classic:1.5.3'
+    implementation platform("io.projectreactor:reactor-bom:$projectReactorVersion")
+    implementation 'io.projectreactor:reactor-core'
+}

graalvm-native-image-app/readme.md

@@ -0,0 +1,38 @@
+# graalvm-native-image-app
+
+## About
+This is an example of a native application that uses the driver and is built using
+[GraalVM native image](https://www.graalvm.org/latest/reference-manual/native-image/).
+
+## Contributor Guide
+
+This guide assumes you are using a shell capable of running [Bash](https://www.gnu.org/software/bash/) scripts.
+
+### Prepare the development environment
+
+#### Install GraalVM
+
+[GraalVM for JDK 21 Community](https://github.com/graalvm/graalvm-ce-builds/releases/tag/jdk-21.0.2) is required
+in addition to the JDK you are using for running [Gradle](https://gradle.org/) when building the driver.
+Note that GraalVM for JDK 21 Community is [available](https://sdkman.io/jdks#graalce) via [SDKMAN!](https://sdkman.io/).
+
+#### Configure environment variables pointing to JDKs.
+
+Assuming that the JDK you are using for running Gradle is for Java SE 17, export the following variables
+(your values may differ):
+
+```bash
+export JDK17="/Users/valentin.kovalenko/.sdkman/candidates/java/17.0.10-librca/"
+export JDK21_GRAALVM="/Users/valentin.kovalenko/.sdkman/candidates/java/21.0.2-graalce/"
+```
+
+### Build-related commands
+
+Run from the driver project root directory:
+
+| # | Command                                                                                                                                                                                                                                                  | Description                                                                                                                               |
+|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| 1      | `env JAVA_HOME=${JDK17} ./gradlew -PjavaVersion=21 :graalvm-native-image-app:nativeCompile`                                                                                                                                                              | Build the application relying on the reachability metadata stored in `graalvm-native-image-app/src/main/resources/META-INF/native-image`. |
+| 2      | `env JAVA_HOME=${JDK17} ./gradlew :graalvm-native-image-app:clean && env JAVA_HOME=${JDK21_GRAALVM} ./gradlew -PjavaVersion=21 -Pagent :graalvm-native-image-app:run && env JAVA_HOME=${JDK21_GRAALVM} ./gradlew :graalvm-native-image-app:metadataCopy` | Collect the reachability metadata and update the files storing it. Do this only if building/running the application fails otherwise.      |
+| 3      | `./graalvm-native-image-app/build/native/nativeCompile/NativeImageApp`                                                                                                                                                                                   | Run the application that has been built.                                                                                                  |
+| 4      | `env JAVA_HOME=${JDK17} ./gradlew -PjavaVersion=21 :graalvm-native-image-app:nativeRun`                                                                                                                                                                  | Run the application using Gradle, build it if necessary relying on the stored reachability metadata.                                      |

graalvm-native-image-app/src/main/com/mongodb/internal/graalvm/NativeImageApp.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.mongodb.internal.graalvm;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Stream;
+
+final class NativeImageApp {
+    private static final Logger LOGGER = LoggerFactory.getLogger(NativeImageApp.class);
+
+    public static void main(final String[] args) {
+        LOGGER.info("java.vendor={}, java.vm.name={}, java.version={}",
+                System.getProperty("java.vendor"), System.getProperty("java.vm.name"), System.getProperty("java.version"));
+        List<Throwable> errors = Stream.<ThrowingRunnable>of(
+                () -> gridfs.GridFSTour.main(args),
+                () -> documentation.CausalConsistencyExamples.main(args),
+                () -> documentation.ChangeStreamSamples.main(args),
+                () -> tour.ClientSideEncryptionAutoEncryptionSettingsTour.main(args),
+                () -> tour.ClientSideEncryptionExplicitEncryptionAndDecryptionTour.main(args),
+                () -> tour.ClientSideEncryptionExplicitEncryptionOnlyTour.main(args),
+                () -> tour.ClientSideEncryptionQueryableEncryptionTour.main(args),
+                () -> tour.ClientSideEncryptionSimpleTour.main(args),
+                () -> tour.Decimal128QuickTour.main(args),
+                () -> tour.PojoQuickTour.main(args),
+                () -> tour.QuickTour.main(args),
+                () -> tour.Decimal128LegacyAPIQuickTour.main(args),
+                () -> reactivestreams.gridfs.GridFSTour.main(args),
+                // This tour is broken and hangs even when run by a JVM.
+                // See https://jira.mongodb.org/browse/JAVA-5364.
+                // () -> reactivestreams.tour.ClientSideEncryptionAutoEncryptionSettingsTour.main(args),
+                () -> reactivestreams.tour.ClientSideEncryptionExplicitEncryptionAndDecryptionTour.main(args),
+                () -> reactivestreams.tour.ClientSideEncryptionExplicitEncryptionOnlyTour.main(args),
+                () -> reactivestreams.tour.ClientSideEncryptionQueryableEncryptionTour.main(args),
+                () -> reactivestreams.tour.ClientSideEncryptionSimpleTour.main(args),
+                () -> reactivestreams.tour.PojoQuickTour.main(args),
+                () -> reactivestreams.tour.QuickTour.main(args)
+                ).map(ThrowingRunnable::runAndCatch)
+                .filter(Objects::nonNull)
+                .toList();
+        if (!errors.isEmpty()) {
+            AssertionError error = new AssertionError(String.format("%d %s failed",
+                    errors.size(), errors.size() == 1 ? "application" : "applications"));
+            errors.forEach(error::addSuppressed);
+            throw error;
+        }
+    }
+
+    private NativeImageApp() {
+    }
+
+    private interface ThrowingRunnable {
+        void run() throws Exception;
+
+        @Nullable
+        default Throwable runAndCatch() {
+            try {
+                run();
+            } catch (Exception | AssertionError e) {
+                return e;
+            }
+            return null;
+        }
+    }
+}

graalvm-native-image-app/src/main/resources/META-INF/native-image/jni-config.json

@@ -0,0 +1,184 @@
+[
+{
+  "name":"com.mongodb.crypt.capi.CAPI$mongocrypt_crypto_fn",
+  "methods":[{"name":"crypt","parameterTypes":["com.sun.jna.Pointer","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.sun.jna.Pointer","com.mongodb.crypt.capi.CAPI$mongocrypt_status_t"] }]
+},
+{
+  "name":"com.mongodb.crypt.capi.CAPI$mongocrypt_hash_fn",
+  "methods":[{"name":"hash","parameterTypes":["com.sun.jna.Pointer","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_status_t"] }]
+},
+{
+  "name":"com.mongodb.crypt.capi.CAPI$mongocrypt_hmac_fn",
+  "methods":[{"name":"hmac","parameterTypes":["com.sun.jna.Pointer","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","com.mongodb.crypt.capi.CAPI$mongocrypt_status_t"] }]
+},
+{
+  "name":"com.mongodb.crypt.capi.CAPI$mongocrypt_log_fn_t",
+  "methods":[{"name":"log","parameterTypes":["int","com.mongodb.crypt.capi.CAPI$cstring","int","com.sun.jna.Pointer"] }]
+},
+{
+  "name":"com.mongodb.crypt.capi.CAPI$mongocrypt_random_fn",
+  "methods":[{"name":"random","parameterTypes":["com.sun.jna.Pointer","com.mongodb.crypt.capi.CAPI$mongocrypt_binary_t","int","com.mongodb.crypt.capi.CAPI$mongocrypt_status_t"] }]
+},
+{
+  "name":"com.mongodb.internal.graalvm.NativeImageApp",
+  "methods":[{"name":"main","parameterTypes":["java.lang.String[]"] }]
+},
+{
+  "name":"com.sun.jna.Callback"
+},
+{
+  "name":"com.sun.jna.CallbackReference",
+  "methods":[{"name":"getCallback","parameterTypes":["java.lang.Class","com.sun.jna.Pointer","boolean"] }, {"name":"getFunctionPointer","parameterTypes":["com.sun.jna.Callback","boolean"] }, {"name":"getNativeString","parameterTypes":["java.lang.Object","boolean"] }, {"name":"initializeThread","parameterTypes":["com.sun.jna.Callback","com.sun.jna.CallbackReference$AttachOptions"] }]
+},
+{
+  "name":"com.sun.jna.CallbackReference$AttachOptions"
+},
+{
+  "name":"com.sun.jna.FromNativeConverter",
+  "methods":[{"name":"nativeType","parameterTypes":[] }]
+},
+{
+  "name":"com.sun.jna.IntegerType",
+  "fields":[{"name":"value"}]
+},
+{
+  "name":"com.sun.jna.JNIEnv"
+},
+{
+  "name":"com.sun.jna.Native",
+  "methods":[{"name":"dispose","parameterTypes":[] }, {"name":"fromNative","parameterTypes":["com.sun.jna.FromNativeConverter","java.lang.Object","java.lang.reflect.Method"] }, {"name":"fromNative","parameterTypes":["java.lang.Class","java.lang.Object"] }, {"name":"fromNative","parameterTypes":["java.lang.reflect.Method","java.lang.Object"] }, {"name":"nativeType","parameterTypes":["java.lang.Class"] }, {"name":"toNative","parameterTypes":["com.sun.jna.ToNativeConverter","java.lang.Object"] }]
+},
+{
+  "name":"com.sun.jna.Native$ffi_callback",
+  "methods":[{"name":"invoke","parameterTypes":["long","long","long"] }]
+},
+{
+  "name":"com.sun.jna.NativeMapped",
+  "methods":[{"name":"toNative","parameterTypes":[] }]
+},
+{
+  "name":"com.sun.jna.Pointer",
+  "fields":[{"name":"peer"}],
+  "methods":[{"name":"<init>","parameterTypes":["long"] }]
+},
+{
+  "name":"com.sun.jna.PointerType",
+  "fields":[{"name":"pointer"}]
+},
+{
+  "name":"com.sun.jna.Structure",
+  "fields":[{"name":"memory"}, {"name":"typeInfo"}],
+  "methods":[{"name":"autoRead","parameterTypes":[] }, {"name":"autoWrite","parameterTypes":[] }, {"name":"getTypeInfo","parameterTypes":[] }, {"name":"newInstance","parameterTypes":["java.lang.Class","long"] }]
+},
+{
+  "name":"com.sun.jna.Structure$ByValue"
+},
+{
+  "name":"com.sun.jna.Structure$FFIType$FFITypes",
+  "fields":[{"name":"ffi_type_double"}, {"name":"ffi_type_float"}, {"name":"ffi_type_longdouble"}, {"name":"ffi_type_pointer"}, {"name":"ffi_type_sint16"}, {"name":"ffi_type_sint32"}, {"name":"ffi_type_sint64"}, {"name":"ffi_type_sint8"}, {"name":"ffi_type_uint16"}, {"name":"ffi_type_uint32"}, {"name":"ffi_type_uint64"}, {"name":"ffi_type_uint8"}, {"name":"ffi_type_void"}]
+},
+{
+  "name":"com.sun.jna.WString",
+  "methods":[{"name":"<init>","parameterTypes":["java.lang.String"] }]
+},
+{
+  "name":"java.lang.Boolean",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["boolean"] }, {"name":"getBoolean","parameterTypes":["java.lang.String"] }]
+},
+{
+  "name":"java.lang.Byte",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["byte"] }]
+},
+{
+  "name":"java.lang.Character",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["char"] }]
+},
+{
+  "name":"java.lang.Class",
+  "methods":[{"name":"getComponentType","parameterTypes":[] }]
+},
+{
+  "name":"java.lang.Double",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["double"] }]
+},
+{
+  "name":"java.lang.Float",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["float"] }]
+},
+{
+  "name":"java.lang.Integer",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["int"] }]
+},
+{
+  "name":"java.lang.Long",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["long"] }]
+},
+{
+  "name":"java.lang.Object",
+  "methods":[{"name":"toString","parameterTypes":[] }]
+},
+{
+  "name":"java.lang.Short",
+  "fields":[{"name":"TYPE"}, {"name":"value"}],
+  "methods":[{"name":"<init>","parameterTypes":["short"] }]
+},
+{
+  "name":"java.lang.String",
+  "methods":[{"name":"<init>","parameterTypes":["byte[]"] }, {"name":"<init>","parameterTypes":["byte[]","java.lang.String"] }, {"name":"getBytes","parameterTypes":[] }, {"name":"getBytes","parameterTypes":["java.lang.String"] }, {"name":"lastIndexOf","parameterTypes":["int"] }, {"name":"substring","parameterTypes":["int"] }, {"name":"toCharArray","parameterTypes":[] }]
+},
+{
+  "name":"java.lang.System",
+  "methods":[{"name":"getProperty","parameterTypes":["java.lang.String"] }, {"name":"setProperty","parameterTypes":["java.lang.String","java.lang.String"] }]
+},
+{
+  "name":"java.lang.UnsatisfiedLinkError",
+  "methods":[{"name":"<init>","parameterTypes":["java.lang.String"] }]
+},
+{
+  "name":"java.lang.Void",
+  "fields":[{"name":"TYPE"}]
+},
+{
+  "name":"java.lang.reflect.Method",
+  "methods":[{"name":"getParameterTypes","parameterTypes":[] }, {"name":"getReturnType","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.Buffer",
+  "methods":[{"name":"position","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.ByteBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.CharBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.DoubleBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.FloatBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.IntBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.LongBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+},
+{
+  "name":"java.nio.ShortBuffer",
+  "methods":[{"name":"array","parameterTypes":[] }, {"name":"arrayOffset","parameterTypes":[] }]
+}
+]