gson-comments/graal-native-image-test
Marcono1234 77b566ced0
Fix graal-native-image-test module causing failure for 'Check API compatibility' (#2467)
The 'Check API compatibility' workflow runs `mvn install` to install the
previous version to the local Maven repository to compare it afterwards.
However this fails for the graal-native-image-test module because it does
not produce a JAR.

Therefore skip execution of the maven-install-plugin for that module.
2023-08-13 13:40:47 -07:00
..
src/test Add integration test for GraalVM Native Image (#2466) 2023-08-13 08:44:00 -07:00
pom.xml Fix graal-native-image-test module causing failure for 'Check API compatibility' (#2467) 2023-08-13 13:40:47 -07:00
README.md Add integration test for GraalVM Native Image (#2466) 2023-08-13 08:44:00 -07:00

graal-native-image-test

This Maven module contains integration tests for using Gson in a GraalVM Native Image.

Execution requires using GraalVM as JDK, and can be quite resource intensive. Native Image tests are therefore not enabled by default and the tests are only executed as regular unit tests. To run Native Image tests, make sure your PATH and JAVA_HOME environment variables point to GraalVM and then run:

mvn clean test --activate-profiles native-image-test

Technically it would also be possible to directly configure Native Image test execution for the gson module instead of having this separate Maven module. However, maintaining the reflection metadata for the unit tests would be quite cumbersome and would hinder future changes to the gson unit tests because many of them just happen to use reflection, without all of them being relevant for Native Image testing.

Reflection metadata

Native Image creation requires configuring which class members are accessed using reflection, see the GraalVM documentation.

The file reflect-config.json contains this reflection metadata.

You can also run with -Dagent=true to let the Maven plugin automatically generate a metadata file, see the plugin documentation.