Support file-based reachability metadata repositories

See gh-32408

Author: wilkinsona

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/main/java/org/springframework/boot/gradle/plugin/NativeImagePluginAction.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.gradle.plugin;
 
 import java.io.File;
+import java.net.URI;
 import java.nio.file.Path;
 
 import org.graalvm.buildtools.gradle.NativeImagePlugin;
@@ -31,6 +32,7 @@
 import org.gradle.api.plugins.ExtensionAware;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.provider.Property;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.SourceSetContainer;
 
@@ -87,17 +89,24 @@ private void configureGraalVmReachabilityExtension(GraalVMExtension graalVmExten
 	private void copyReachabilityMetadataToBootJar(Project project, GraalVMExtension graalVmExtension) {
 		Path repositoryCacheDir = new File(project.getGradle().getGradleUserHomeDir(),
 				"native-build-tools/repositories").toPath();
+
 		project.getTasks().named(SpringBootPlugin.BOOT_JAR_TASK_NAME, BootJar.class).configure((bootJar) -> {
 			NativeImageOptions options = graalVmExtension.getBinaries().named(NativeImagePlugin.NATIVE_MAIN_EXTENSION)
 					.get();
+			GraalVMReachabilityMetadataRepositoryExtension metadataRepositoryExtension = ((ExtensionAware) graalVmExtension)
+					.getExtensions().getByType(GraalVMReachabilityMetadataRepositoryExtension.class);
+			Property<URI> metadataRepositoryUri = metadataRepositoryExtension.getUri();
 			bootJar.from(options.getConfigurationFileDirectories())
-					.eachFile((file) -> normalizePathIfNecessary(repositoryCacheDir, file));
+					.eachFile((file) -> normalizePathIfNecessary(repositoryCacheDir, metadataRepositoryUri, file));
 		});
 	}
 
-	private void normalizePathIfNecessary(Path repositoryCacheDir, FileCopyDetails configurationFile) {
+	private void normalizePathIfNecessary(Path repositoryCacheDir, Property<URI> metadataRepositoryUri,
+			FileCopyDetails configurationFile) {
 		Path configurationFilePath = configurationFile.getFile().toPath();
-		if (configurationFilePath.startsWith(repositoryCacheDir)) {
+		Path repositoryMetadataRoot = ("file".equals(metadataRepositoryUri.get().getScheme()))
+				? Path.of(metadataRepositoryUri.get()) : repositoryCacheDir;
+		if (configurationFilePath.startsWith(repositoryMetadataRoot)) {
 			Path versionDir = configurationFilePath.getParent();
 			Path artifactDir = versionDir.getParent();
 			Path groupDir = artifactDir.getParent();

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/java/org/springframework/boot/gradle/plugin/NativeImagePluginActionIntegrationTests.java

@@ -32,6 +32,7 @@
 
 import org.springframework.boot.gradle.junit.GradleCompatibility;
 import org.springframework.boot.testsupport.gradle.testkit.GradleBuild;
+import org.springframework.util.FileSystemUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -68,6 +69,24 @@ void reachabilityMetadataConfigurationFilesAreCopiedToJar() throws IOException {
 				"META-INF/native-image/org.jline/jline/3.21.0/resource-config.json");
 	}
 
+	@TestTemplate
+	void reachabilityMetadataConfigurationFilesFromFileRepositoryAreCopiedToJar() throws IOException {
+		writeDummyAotProcessorMainClass();
+		FileSystemUtils.copyRecursively(new File("src/test/resources/reachability-metadata-repository"),
+				new File(this.gradleBuild.getProjectDir(), "reachability-metadata-repository"));
+		BuildResult result = this.gradleBuild.build("bootJar");
+		assertThat(result.task(":bootJar").getOutcome()).isEqualTo(TaskOutcome.SUCCESS);
+		File buildLibs = new File(this.gradleBuild.getProjectDir(), "build/libs");
+		File jarFile = new File(buildLibs, this.gradleBuild.getProjectDir().getName() + ".jar");
+		assertThat(buildLibs.listFiles()).contains(jarFile);
+		assertThat(getEntryNames(jarFile)).contains(
+				"META-INF/native-image/ch.qos.logback/logback-classic/1.2.11/reflect-config.json",
+				"META-INF/native-image/org.jline/jline/3.21.0/jni-config.json",
+				"META-INF/native-image/org.jline/jline/3.21.0/proxy-config.json",
+				"META-INF/native-image/org.jline/jline/3.21.0/reflect-config.json",
+				"META-INF/native-image/org.jline/jline/3.21.0/resource-config.json");
+	}
+
 	private void writeDummyAotProcessorMainClass() {
 		File examplePackage = new File(this.gradleBuild.getProjectDir(), "src/main/java/org/springframework/boot");
 		examplePackage.mkdirs();

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/org/springframework/boot/gradle/plugin/NativeImagePluginActionIntegrationTests-reachabilityMetadataConfigurationFilesFromFileRepositoryAreCopiedToJar.gradle

@@ -0,0 +1,26 @@
+plugins {
+	id 'java'
+	id 'org.springframework.boot'
+	id 'org.springframework.boot.aot'
+}
+
+apply plugin: 'org.graalvm.buildtools.native'
+
+repositories {
+	mavenCentral()
+}
+
+dependencies {
+	implementation "ch.qos.logback:logback-classic:1.2.11"
+	implementation "org.jline:jline:3.21.0"
+}
+
+graalvmNative {
+	metadataRepository {
+		uri(file("reachability-metadata-repository"))
+	}
+	// see https://github.com/graalvm/native-build-tools/issues/302
+	agent {
+		tasksToInstrumentPredicate = { t -> false } as java.util.function.Predicate<Test>
+	}
+}

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/test/resources/reachability-metadata-repository/ch.qos.logback/logback-classic/1.2.11/index.json

@@ -0,0 +1,3 @@
+[
+  "reflect-config.json"
+]