Skip to content

Apache Lucene open-source search software

Improve build cache compatibility for test, ecjLint, and forbiddenApis tasks (#15875)

Gašper Kojek105537ea44cc
diff --git a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ApplyForbiddenApisPlugin.java b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ApplyForbiddenApisPlugin.java
index a7849f1d8b9..f08bf3d63e5 100644
--- a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ApplyForbiddenApisPlugin.java
+++ b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ApplyForbiddenApisPlugin.java
@@ -36,6 +36,7 @@ import org.gradle.api.artifacts.result.ResolvedDependencyResult;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.JavaPluginExtension;
import org.gradle.api.provider.Provider;
+import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SourceSetContainer;
import org.gradle.api.tasks.TaskCollection;
import org.gradle.api.tasks.TaskContainer;
@@ -205,7 +206,7 @@ public class ApplyForbiddenApisPlugin extends LuceneGradlePlugin {
var allSignatureFiles = project.files(signatureFiles);
var existingSignatureFiles = allSignatureFiles.filter(File::exists);
- task.getInputs().files(existingSignatureFiles);
+ task.getInputs().files(existingSignatureFiles).withPathSensitivity(PathSensitivity.RELATIVE);
task.setSignaturesFiles(task.getSignaturesFiles().plus(existingSignatureFiles));
addBuiltInSignatures(task, allDependenciesProvider);
diff --git a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/EcjLintPlugin.java b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/EcjLintPlugin.java
index 84879168dc7..3bb9392f069 100644
--- a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/EcjLintPlugin.java
+++ b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/EcjLintPlugin.java
@@ -35,6 +35,8 @@ import org.gradle.api.Task;
import org.gradle.api.file.FileCollection;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.tasks.ClasspathNormalizer;
+import org.gradle.api.tasks.PathSensitivity;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.process.CommandLineArgumentProvider;
@@ -120,7 +122,8 @@ public class EcjLintPlugin extends LuceneGradlePlugin {
args.add("-proc:none");
args.add("-nowarn");
args.add("-enableJavadoc");
- args.addAll(List.of("-properties", javadocPrefsPath.toAbsolutePath().toString()));
+ // Note: -properties path is added at execution time (in doFirst) to avoid
+ // absolute paths in the cache key. The file content is tracked separately.
// We depend on modular paths.
ModularPathsExtension modularPaths =
@@ -133,15 +136,20 @@ public class EcjLintPlugin extends LuceneGradlePlugin {
// Collect modular dependencies and their transitive dependencies to module path.
CommandLineArgumentProvider compilationArguments = modularPaths.getCompilationArguments();
// this isn't exactly right but the returned CommandLineArgumentProvider isn't serializable...
- task.getInputs().files(sourceSet.getCompileClasspath());
+ task.getInputs()
+ .files(sourceSet.getCompileClasspath())
+ .withNormalizer(ClasspathNormalizer.class);
// Collect classpath locations
FileCollection classpathArguments = modularPaths.getCompilationClasspath().filter(File::exists);
- task.getInputs().files(classpathArguments);
+ task.getInputs().files(classpathArguments).withNormalizer(ClasspathNormalizer.class);
// Input sources.
var inputSources = sourceSet.getJava().getAsFileTree();
- task.getInputs().files(inputSources);
+ task.getInputs().files(inputSources).withPathSensitivity(PathSensitivity.RELATIVE);
+
+ // Track the javadoc prefs file as an input with relative path sensitivity.
+ task.getInputs().file(javadocPrefsPath.toFile()).withPathSensitivity(PathSensitivity.RELATIVE);
// Add all arguments so far as inputs.
task.getInputs().property("args", args);
@@ -163,6 +171,7 @@ public class EcjLintPlugin extends LuceneGradlePlugin {
task.doFirst(
_ -> {
List<String> allArgs = new ArrayList<>(args);
+ allArgs.addAll(List.of("-properties", javadocPrefsPath.toAbsolutePath().toString()));
compilationArguments.asArguments().forEach(allArgs::add);
if (!classpathArguments.isEmpty()) {
diff --git a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ModularPathsPlugin.java b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ModularPathsPlugin.java
index da87e38e4e2..02680275420 100644
--- a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ModularPathsPlugin.java
+++ b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/ModularPathsPlugin.java
@@ -32,6 +32,7 @@ import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.JavaPluginExtension;
import org.gradle.api.provider.ListProperty;
import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.ClasspathNormalizer;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.SourceSetContainer;
import org.gradle.api.tasks.bundling.Jar;
@@ -101,7 +102,9 @@ public class ModularPathsPlugin extends LuceneGradlePlugin {
// on the task itself... but I don't know how to implement this on an
// existing class.
// this is a workaround but should work just fine though.
- task.getInputs().files(modularPaths.getCompileModulePathConfiguration());
+ task.getInputs()
+ .files(modularPaths.getCompileModulePathConfiguration())
+ .withNormalizer(ClasspathNormalizer.class);
// LUCENE-10327: don't allow gradle to emit an empty sourcepath as it would
// break
diff --git a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/TestsAndRandomizationPlugin.java b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/TestsAndRandomizationPlugin.java
index d87c45fd3c6..f6fd1753fed 100644
--- a/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/TestsAndRandomizationPlugin.java
+++ b/build-tools/build-infra/src/main/java/org/apache/lucene/gradle/plugins/java/TestsAndRandomizationPlugin.java
@@ -539,7 +539,9 @@ public class TestsAndRandomizationPlugin extends LuceneGradlePlugin {
}
// Set up cwd and temp locations.
- task.systemProperty("java.io.tmpdir", testsTmpDir);
+ // java.io.tmpdir is passed via the LoggingFileArgumentProvider (marked @Internal)
+ // instead of systemProperty to avoid absolute paths affecting the build cache key.
+ loggingFileProvider.getJavaTmpDir().set(workDirOption.get());
task.doFirst(
_ -> {
@@ -601,12 +603,19 @@ public class TestsAndRandomizationPlugin extends LuceneGradlePlugin {
@Internal
public abstract DirectoryProperty getTempDir();
+ /**
+ * java.io.tmpdir for forked test JVMs. Marked @Internal to avoid absolute paths in cache key.
+ */
+ @Internal
+ public abstract DirectoryProperty getJavaTmpDir();
+
@Override
public Iterable<String> asArguments() {
return List.of(
"-Djava.util.logging.config.file="
+ getLoggingConfigFile().getAsFile().get().getAbsolutePath(),
- "-DtempDir=" + getTempDir().get().getAsFile().getAbsolutePath());
+ "-DtempDir=" + getTempDir().get().getAsFile().getAbsolutePath(),
+ "-Djava.io.tmpdir=" + getJavaTmpDir().get().getAsFile().getAbsolutePath());
}
}
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index ecc5a66dd3f..ec4c4472b6d 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -181,6 +181,11 @@ Build
Install with `uv tool install prek; prek install`
For more see help/precommit.txt or `./gradlew helpPrecommit` (Robert Muir)
+* Improve build cache compatibility for test, ecjLint, and forbiddenApis tasks.
+ Use path-sensitive annotations and argument providers instead of embedding absolute
+ paths in cache keys, improving cache hit rates across different project locations.
+ (Gasper Kojek)
+
Other
---------------------