dmurat / gradle-source-repack-groovy

Introduction

This little tool aims to ease the debugging of Gradle internals inside IDEA.

We can include runtimeOnly gradleApi() dependency in a build script to get a hold on Gradle's internal classes. However, we cannot easily attach sources to them.

The main problem is that Gradle sources are archived in a distribution zip in multiple source roots, which IDEA can not understand. The solution is to repack Gradle sources under a single root in an archive and provide that archive to IDEA via the "Attach sources" command.

gradle-source-repack utility can prepare such an archive.

Running command via JVM

All commands should be executed from project root.

cd gradle-source-repack-groovy
./gradlew clean assemble
java -jar ./build/libs/gradle-source-repack-groovy-0.1.0-all.jar --root-log-level=INFO --log-level=DEBUG --cleanup=true 6.7.1

GraalVM native image compilation

• Gradle task executed from root project directory for creating GraalVM native image in build/native-image directory.

./gradlew kwrkNativeImage

• native command executed from root project directory for creating GraalVM native image in build/native-image directory.
  • It is assumed that GraalVM 20.3.0.r11-grl and corresponding native-image tool are installed.

mkdir -p build/native-image && \
native-image --verbose \
--class-path build/libs/gradle-source-repack-groovy-0.1.0-all.jar:build/native-image-dependencies/classgraph-4.8.90.jar \
--allow-incomplete-classpath \
--report-unsupported-elements-at-runtime \
--initialize-at-build-time \
--initialize-at-run-time=org.codehaus.groovy.control.XStreamUtils,groovy.grape.GrapeIvy \
--no-fallback \
--no-server \
-H:ConfigurationFileDirectories=src/main/graal/ \
-H:+ReportExceptionStackTraces \
-H:Path=build/native-image \
org.klokwrk.tools.gradle.source.repack.GradleSourceRepackCommand \
gradle-source-repack-groovy

• Command executed from root project directory for generating GraalVM native-image metadata in build/native-image-configuration directory.
  • Generated metadata are for information purposes only, when some more insight in GraalVM behavior is needed.
  • Only if needed, parts of generated metadata can be copied from build/native-image-configuration/reflect-config.json into src/main/graal/reflect-config.json.
  • In general, src/main/graal/reflect-config.json should remain empty.

java -agentlib:native-image-agent=config-output-dir=build/native-image-configuration/ -jar \
./build/libs/gradle-source-repack-groovy-0.1.0-all.jar -h

Running command as native image

./build/native-image/gradle-source-repack-groovy --root-log-level=INFO --log-level=DEBUG --cleanup=true 6.7.1