gson-comments/graal-native-image-test
Marcono1234 c7c645db2f
Formatting follow-up (#2540)
* Formatting follow-up

- Adds formatting commits to .git-blame-ignore-revs so that they don't
  distract during Git blame
- Restores hard line breaks in Troubleshooting.md using `\` instead of
  trailing spaces
- Changes formatting of some string literals and comments
- Fixes accidental Javadoc and comment issues introduced by manual changes
  of formatting commit
- Fixes license header in $Gson$Types.java erroneously being a Javadoc
  comment and being reformatted
- Slightly changes `JsonReader` `getPath` and `getPreviousPath` documentation
  to help Javadoc detect first sentence as summary

* Remove `spotless:off` markers

* Add empty line before comment

* Check format for .github YAML files
2023-11-14 15:09:54 -08:00
..
src/test Formatting follow-up (#2540) 2023-11-14 15:09:54 -08:00
pom.xml Bump org.junit.jupiter:junit-jupiter from 5.10.0 to 5.10.1 (#2528) 2023-11-06 07:24:00 -08: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.