Update to Gradle 9.1.0 (#19329)

andrross · web-flow · commit df3b3ae0a1d1 · 2025-09-24T11:37:51.000-05:00
Signed-off-by: Andrew Ross &lt;andrross@amazon.com&gt;
diff --git a/.github/workflows/detect-breaking-change.yml b/.github/workflows/detect-breaking-change.yml
@@ -15,7 +15,7 @@ jobs:
       with:
         cache-disabled: true
         arguments: japicmp
-        gradle-version: 8.14.3
+        gradle-version: 9.1.0
         build-root-directory: server
     - if: failure()
       run: cat server/build/reports/java-compatibility/report.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -65,6 +65,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [Flaky Test] Fix flaky test IngestFromKinesisIT.testAllActiveIngestion ([#19380](https://github.com/opensearch-project/OpenSearch/pull/19380))
 
 ### Dependencies
+- Update to Gradle 9.1.0 ([#19329](https://github.com/opensearch-project/OpenSearch/pull/19329))
 - Bump `com.netflix.nebula.ospackage-base` from 12.0.0 to 12.1.0 ([#19019](https://github.com/opensearch-project/OpenSearch/pull/19019))
 - Bump `actions/checkout` from 4 to 5 ([#19023](https://github.com/opensearch-project/OpenSearch/pull/19023))
 - Bump `commons-cli:commons-cli` from 1.9.0 to 1.10.0 ([#19021](https://github.com/opensearch-project/OpenSearch/pull/19021))
diff --git a/build.gradle b/build.gradle
@@ -47,6 +47,7 @@ import org.gradle.plugins.ide.eclipse.model.SourceFolder
 import org.gradle.api.Project;
 import org.gradle.process.ExecResult;
 import org.opensearch.gradle.CheckCompatibilityTask
+import groovy.xml.XmlParser;
 
 import static org.opensearch.gradle.util.GradleUtils.maybeConfigure
 
diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
@@ -130,7 +130,7 @@ dependencies {
   testFixturesApi gradleTestKit()
   testImplementation 'org.wiremock:wiremock-standalone:3.6.0'
   testImplementation "org.mockito:mockito-core:${props.getProperty('mockito')}"
-  integTestImplementation('org.spockframework:spock-core:2.3-groovy-3.0') {
+  integTestImplementation('org.spockframework:spock-core:2.4-M6-groovy-4.0') {
     exclude module: "groovy"
   }
 }
@@ -218,6 +218,7 @@ if (project != rootProject) {
   // Track reaper jar as a test input using runtime classpath normalization strategy
   tasks.withType(Test).configureEach {
     inputs.files(configurations.reaper).withNormalizer(ClasspathNormalizer)
+    jvmArgs += ["--add-opens", "java.base/java.lang=ALL-UNNAMED"]
   }
 
   normalization {
diff --git a/buildSrc/src/main/groovy/org/opensearch/gradle/AntTask.groovy b/buildSrc/src/main/groovy/org/opensearch/gradle/AntTask.groovy
@@ -29,6 +29,7 @@
 
 package org.opensearch.gradle
 
+import groovy.ant.AntBuilder
 import org.apache.tools.ant.BuildListener
 import org.apache.tools.ant.BuildLogger
 import org.apache.tools.ant.DefaultLogger
diff --git a/buildSrc/src/main/groovy/org/opensearch/gradle/plugin/PluginBuildPlugin.groovy b/buildSrc/src/main/groovy/org/opensearch/gradle/plugin/PluginBuildPlugin.groovy
@@ -174,7 +174,7 @@ class PluginBuildPlugin implements Plugin<Project> {
 
     private static void configureDependencies(Project project) {
         project.dependencies {
-            if (BuildParams.internal) {
+            if (BuildParams.isInternal) {
                 compileOnly project.project(':server')
                 testImplementation project.project(':test:framework')
             } else {
diff --git a/buildSrc/src/main/groovy/org/opensearch/gradle/precommit/LicenseHeadersTask.groovy b/buildSrc/src/main/groovy/org/opensearch/gradle/precommit/LicenseHeadersTask.groovy
@@ -41,6 +41,7 @@ import org.gradle.api.tasks.OutputFile
 import org.gradle.api.tasks.PathSensitive
 import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.SkipWhenEmpty
+import groovy.ant.AntBuilder
 
 import javax.inject.Inject
 
diff --git a/buildSrc/src/main/groovy/org/opensearch/gradle/test/AntFixture.groovy b/buildSrc/src/main/groovy/org/opensearch/gradle/test/AntFixture.groovy
@@ -29,6 +29,7 @@
 
 package org.opensearch.gradle.test
 
+import groovy.ant.AntBuilder
 import org.apache.tools.ant.taskdefs.condition.Os
 import org.gradle.api.Project
 import org.gradle.api.GradleException
diff --git a/buildSrc/src/main/groovy/org/opensearch/gradle/test/ClusterConfiguration.groovy b/buildSrc/src/main/groovy/org/opensearch/gradle/test/ClusterConfiguration.groovy
@@ -28,6 +28,7 @@
  */
 package org.opensearch.gradle.test
 
+import groovy.ant.AntBuilder
 import org.opensearch.gradle.Version
 import org.gradle.api.GradleException
 import org.gradle.api.Project
diff --git a/buildSrc/src/main/groovy/org/opensearch/gradle/test/TestWithSslPlugin.java b/buildSrc/src/main/groovy/org/opensearch/gradle/test/TestWithSslPlugin.java
@@ -50,7 +50,7 @@ public class TestWithSslPlugin implements Plugin<Project> {
 
     @Override
     public void apply(Project project) {
-        File keyStoreDir = new File(project.getBuildDir(), "keystore");
+        File keyStoreDir = new File(project.getLayout().getBuildDirectory().getAsFile().get(), "keystore");
         TaskProvider<ExportOpenSearchBuildResourcesTask> exportKeyStore = project.getTasks()
             .register("copyTestCertificates", ExportOpenSearchBuildResourcesTask.class, (t) -> {
                 t.copy("test/ssl/test-client.crt");
@@ -74,7 +74,7 @@ public void apply(Project project) {
         });
 
         project.getPlugins().withType(TestClustersPlugin.class).configureEach(clustersPlugin -> {
-            File keystoreDir = new File(project.getBuildDir(), "keystore/test/ssl");
+            File keystoreDir = new File(project.getLayout().getBuildDirectory().getAsFile().get(), "keystore/test/ssl");
             File nodeKeystore = new File(keystoreDir, "test-node.jks");
             File clientKeyStore = new File(keystoreDir, "test-client.jks");
             @SuppressWarnings("unchecked")
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/LoggedExec.java b/buildSrc/src/main/java/org/opensearch/gradle/LoggedExec.java
@@ -65,7 +65,7 @@
 /**
  * A wrapper around gradle's Exec task to capture output and log on error.
  */
-public class LoggedExec extends Exec implements FileSystemOperationsAware {
+public abstract class LoggedExec extends Exec implements FileSystemOperationsAware {
 
     private static final Logger LOGGER = Logging.getLogger(LoggedExec.class);
     private Consumer<Logger> outputLogger;
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/precommit/DependencyLicensesPrecommitPlugin.java b/buildSrc/src/main/java/org/opensearch/gradle/precommit/DependencyLicensesPrecommitPlugin.java
@@ -37,10 +37,12 @@
 import org.gradle.api.Project;
 import org.gradle.api.Task;
 import org.gradle.api.artifacts.Configuration;
-import org.gradle.api.artifacts.ProjectDependency;
+import org.gradle.api.artifacts.component.ComponentIdentifier;
+import org.gradle.api.artifacts.component.ProjectComponentIdentifier;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.provider.Provider;
+import org.gradle.api.specs.Spec;
 import org.gradle.api.tasks.TaskProvider;
 
 public class DependencyLicensesPrecommitPlugin extends PrecommitPlugin {
@@ -54,9 +56,9 @@ public TaskProvider<? extends Task> createTask(Project project) {
         final Configuration runtimeClasspath = project.getConfigurations().getByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME);
         final Configuration compileOnly = project.getConfigurations()
             .getByName(CompileOnlyResolvePlugin.RESOLVEABLE_COMPILE_ONLY_CONFIGURATION_NAME);
+        Spec<ComponentIdentifier> spec = ci -> ci instanceof ProjectComponentIdentifier == false;
         final Provider<FileCollection> provider = project.provider(
-            () -> GradleUtils.getFiles(project, runtimeClasspath, dependency -> dependency instanceof ProjectDependency == false)
-                .minus(compileOnly)
+            () -> GradleUtils.getFirstLevelModuleDependencyFiles(project, runtimeClasspath, spec).minus(compileOnly)
         );
 
         // only require dependency licenses for non-opensearch deps
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/precommit/ThirdPartyAuditTask.java b/buildSrc/src/main/java/org/opensearch/gradle/precommit/ThirdPartyAuditTask.java
@@ -42,7 +42,8 @@
 import org.gradle.api.JavaVersion;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.Configuration;
-import org.gradle.api.artifacts.Dependency;
+import org.gradle.api.artifacts.component.ComponentIdentifier;
+import org.gradle.api.artifacts.component.ModuleComponentIdentifier;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.file.FileTree;
 import org.gradle.api.provider.Property;
@@ -220,19 +221,21 @@ public Set<File> getJarsToScan() {
         // These are SelfResolvingDependency, and some of them backed by file collections, like the Gradle API files,
         // or dependencies added as `files(...)`, we can't be sure if those are third party or not.
         // err on the side of scanning these to make sure we don't miss anything
-        Spec<Dependency> reallyThirdParty = dep -> dep.getGroup() != null && dep.getGroup().startsWith("org.opensearch") == false;
+        Spec<ComponentIdentifier> reallyThirdParty = ci -> {
+            if (ci instanceof ModuleComponentIdentifier) {
+                return ((ModuleComponentIdentifier) ci).getGroup().startsWith("org.opensearch") == false;
+            }
+            return false;
+        };
 
-        Set<File> jars = GradleUtils.getFiles(project, getRuntimeConfiguration(), reallyThirdParty).getFiles();
-        Set<File> compileOnlyConfiguration = GradleUtils.getFiles(
+        final FileCollection runtime = GradleUtils.getFirstLevelModuleDependencyFiles(project, getRuntimeConfiguration(), reallyThirdParty);
+        // don't scan provided dependencies that we already scanned, e.x. don't scan cores dependencies for every plugin
+        final FileCollection compileOnly = GradleUtils.getFirstLevelModuleDependencyFiles(
             project,
             project.getConfigurations().getByName(CompileOnlyResolvePlugin.RESOLVEABLE_COMPILE_ONLY_CONFIGURATION_NAME),
             reallyThirdParty
-        ).getFiles();
-        // don't scan provided dependencies that we already scanned, e.x. don't scan cores dependencies for every plugin
-        if (compileOnlyConfiguration != null) {
-            jars.removeAll(compileOnlyConfiguration);
-        }
-        return jars;
+        );
+        return runtime.minus(compileOnly).getFiles();
     }
 
     @TaskAction
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/tar/SymbolicLinkPreservingTar.java b/buildSrc/src/main/java/org/opensearch/gradle/tar/SymbolicLinkPreservingTar.java
@@ -64,7 +64,7 @@
  * <p>
  * This task is necessary because the built-in task {@link org.gradle.api.tasks.bundling.Tar} does not preserve symbolic links.
  */
-public class SymbolicLinkPreservingTar extends Tar {
+public abstract class SymbolicLinkPreservingTar extends Tar {
     private long lastModifiedTimestamp = 0;
 
     public void setLastModifiedTimestamp(long lastModifiedTimestamp) {
@@ -231,5 +231,4 @@ private long getModTime(final FileCopyDetails details) {
         }
 
     }
-
 }
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/util/GradleUtils.java b/buildSrc/src/main/java/org/opensearch/gradle/util/GradleUtils.java
@@ -39,10 +39,8 @@
 import org.gradle.api.UnknownTaskException;
 import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.artifacts.Dependency;
-import org.gradle.api.artifacts.LenientConfiguration;
+import org.gradle.api.artifacts.component.ComponentIdentifier;
 import org.gradle.api.file.FileCollection;
-import org.gradle.api.internal.artifacts.ivyservice.ResolvedFilesCollectingVisitor;
-import org.gradle.api.internal.artifacts.ivyservice.resolveengine.artifact.SelectedArtifactSet;
 import org.gradle.api.plugins.JavaBasePlugin;
 import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.provider.Provider;
@@ -58,16 +56,15 @@
 import org.gradle.plugins.ide.eclipse.model.EclipseModel;
 import org.gradle.plugins.ide.idea.model.IdeaModel;
 
-import java.lang.invoke.MethodHandle;
-import java.lang.invoke.MethodHandles;
-import java.lang.invoke.MethodType;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.function.Function;
+import java.util.stream.Collectors;
 
 public abstract class GradleUtils {
 
@@ -254,21 +251,20 @@ public static String getProjectPathFromTask(String taskPath) {
         return lastDelimiterIndex == 0 ? ":" : taskPath.substring(0, lastDelimiterIndex);
     }
 
-    public static FileCollection getFiles(Project project, Configuration cfg, Spec<Dependency> spec) {
-        final LenientConfiguration configuration = cfg.getResolvedConfiguration().getLenientConfiguration();
-        try {
-            // Using reflection here to cover the pre 8.7 releases (since those have no such APIs), the
-            // ResolverResults.LegacyResolverResults.LegacyVisitedArtifactSet::select(...) is not available
-            // on older versions.
-            final MethodHandle mh = MethodHandles.lookup()
-                .findVirtual(configuration.getClass(), "select", MethodType.methodType(SelectedArtifactSet.class, Spec.class))
-                .bindTo(configuration);
-
-            final ResolvedFilesCollectingVisitor visitor = new ResolvedFilesCollectingVisitor();
-            ((SelectedArtifactSet) mh.invoke(spec)).visitArtifacts(visitor, false);
-            return project.files(visitor.getFiles());
-        } catch (Throwable ex) {
-            return project.files(configuration.getFiles(spec));
-        }
+    public static FileCollection getFirstLevelModuleDependencyFiles(
+        Project project,
+        Configuration cfg,
+        Spec<? super ComponentIdentifier> spec
+    ) {
+        final FileCollection files = cfg.getIncoming().artifactView(viewConfiguration -> {
+            final Set<ComponentIdentifier> directDependencies = cfg.getResolvedConfiguration()
+                .getFirstLevelModuleDependencies()
+                .stream()
+                .flatMap(dep -> dep.getModuleArtifacts().stream().map(artifact -> artifact.getId().getComponentIdentifier()))
+                .collect(Collectors.toSet());
+            viewConfiguration.setLenient(true);
+            viewConfiguration.componentFilter(ci -> spec.isSatisfiedBy(ci) && directDependencies.contains(ci));
+        }).getFiles();
+        return project.files(files);
     }
 }
diff --git a/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantBasePlugin.java b/buildSrc/src/main/java/org/opensearch/gradle/vagrant/VagrantBasePlugin.java
@@ -40,6 +40,9 @@
 import org.gradle.api.execution.TaskActionListener;
 import org.gradle.api.execution.TaskExecutionListener;
 import org.gradle.api.tasks.TaskState;
+import org.gradle.process.ExecOperations;
+
+import javax.inject.Inject;
 
 import java.io.ByteArrayOutputStream;
 import java.nio.charset.StandardCharsets;
@@ -81,6 +84,13 @@ static class VagrantSetupCheckerPlugin implements Plugin<Project> {
         private static final Pattern VAGRANT_VERSION = Pattern.compile("Vagrant (\\d+\\.\\d+\\.\\d+)");
         private static final Pattern VIRTUAL_BOX_VERSION = Pattern.compile("(\\d+\\.\\d+)");
 
+        private final ExecOperations execOperations;
+
+        @Inject
+        public VagrantSetupCheckerPlugin(ExecOperations execOperations) {
+            this.execOperations = execOperations;
+        }
+
         @Override
         public void apply(Project project) {
             if (project != project.getRootProject()) {
@@ -98,7 +108,7 @@ public void apply(Project project) {
 
         void checkVersion(Project project, String tool, Pattern versionRegex, int... minVersion) {
             ByteArrayOutputStream pipe = new ByteArrayOutputStream();
-            project.exec(spec -> {
+            execOperations.exec(spec -> {
                 spec.setCommandLine(tool, "--version");
                 spec.setStandardOutput(pipe);
             });
diff --git a/buildSrc/src/test/java/org/opensearch/gradle/precommit/DependencyLicensesTaskTests.java b/buildSrc/src/test/java/org/opensearch/gradle/precommit/DependencyLicensesTaskTests.java
@@ -35,7 +35,6 @@
 import org.gradle.api.Action;
 import org.gradle.api.GradleException;
 import org.gradle.api.Project;
-import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.artifacts.Dependency;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.plugins.JavaPlugin;
@@ -298,10 +297,10 @@ private Project createProject() {
         Project project = ProjectBuilder.builder().build();
         project.getPlugins().apply(JavaPlugin.class);
 
-        Configuration compileClasspath = project.getConfigurations().getByName("compileClasspath");
-        Configuration someCompileConfiguration = project.getConfigurations().create("someCompileConfiguration");
         // Declare a configuration that is going to resolve the compile classpath of the application
-        project.getConfigurations().add(compileClasspath.extendsFrom(someCompileConfiguration));
+        project.getConfigurations()
+            .getByName("compileClasspath")
+            .extendsFrom(project.getConfigurations().create("someCompileConfiguration"));
 
         return project;
     }
diff --git a/buildSrc/src/test/java/org/opensearch/gradle/precommit/UpdateShasTaskTests.java b/buildSrc/src/test/java/org/opensearch/gradle/precommit/UpdateShasTaskTests.java
@@ -36,7 +36,6 @@
 import org.gradle.api.Action;
 import org.gradle.api.GradleException;
 import org.gradle.api.Project;
-import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.artifacts.Dependency;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.plugins.JavaPlugin;
@@ -123,10 +122,10 @@ private Project createProject() {
         Project project = ProjectBuilder.builder().build();
         project.getPlugins().apply(JavaPlugin.class);
 
-        Configuration compileClasspath = project.getConfigurations().getByName("compileClasspath");
-        Configuration someCompileConfiguration = project.getConfigurations().create("someCompileConfiguration");
         // Declare a configuration that is going to resolve the compile classpath of the application
-        project.getConfigurations().add(compileClasspath.extendsFrom(someCompileConfiguration));
+        project.getConfigurations()
+            .getByName("compileClasspath")
+            .extendsFrom(project.getConfigurations().create("someCompileConfiguration"));
 
         return project;
     }
diff --git a/gradle.properties b/gradle.properties
@@ -26,7 +26,10 @@ options.forkOptions.memoryMaximumSize=3g
 systemProp.org.gradle.dependency.duplicate.project.detection=false
 
 # Enforce the build to fail on deprecated gradle api usage
-systemProp.org.gradle.warning.mode=fail
+# TODO: Waiting for https://github.com/google/protobuf-gradle-plugin/commit/894f2d25e2b511bc11661f4d23e47ee0671e82ad
+# to be released in the Protobuf gradle plugin, at which this point can be changed
+# back to `fail`
+systemProp.org.gradle.warning.mode=all
 
 systemProp.jdk.tls.client.protocols=TLSv1.2,TLSv1.3
 
diff --git a/gradle/ide.gradle b/gradle/ide.gradle
@@ -12,6 +12,8 @@
 import org.opensearch.gradle.info.BuildParams
 import org.jetbrains.gradle.ext.Remote
 import org.jetbrains.gradle.ext.JUnit
+import groovy.xml.XmlNodePrinter
+import groovy.xml.XmlParser
 
 buildscript {
   repositories {
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,8 +1,8 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionSha256Sum=ed1a8d686605fd7c23bdf62c7fc7add1c5b23b2bbc3721e661934ef4a4911d7c
+distributionSha256Sum=b84e04fa845fecba48551f425957641074fcc00a88a84d2aae5808743b35fc85
diff --git a/plugins/analysis-phonenumber/build.gradle b/plugins/analysis-phonenumber/build.gradle
@@ -17,5 +17,5 @@ opensearchplugin {
 }
 
 dependencies {
-  implementation group: 'com.googlecode.libphonenumber', name: 'libphonenumber', version: '8.13.45'
+  implementation "com.googlecode.libphonenumber:libphonenumber:8.13.45"
 }
diff --git a/plugins/arrow-flight-rpc/build.gradle b/plugins/arrow-flight-rpc/build.gradle
@@ -57,7 +57,7 @@ dependencies {
 
   compileOnly "com.google.errorprone:error_prone_annotations:${versions.error_prone_annotations}"
 
-  runtimeOnly group: 'com.google.code.findbugs', name: 'jsr305', version: '3.0.2'
+  runtimeOnly "com.google.code.findbugs:jsr305:3.0.2"
   annotationProcessor 'org.immutables:value:2.10.1'
 
   runtimeOnly 'io.perfmark:perfmark-api:0.27.0'
diff --git a/server/build.gradle b/server/build.gradle
@@ -29,6 +29,7 @@
  */
 
 import org.opensearch.gradle.info.BuildParams
+import groovy.xml.XmlParser
 
 plugins {
   id('com.google.protobuf') version 'latest.release'

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ dependencies {`
`130`	`130`	`testFixturesApi gradleTestKit()`
`131`	`131`	`testImplementation 'org.wiremock:wiremock-standalone:3.6.0'`
`132`	`132`	`testImplementation "org.mockito:mockito-core:${props.getProperty('mockito')}"`
`133`		`- integTestImplementation('org.spockframework:spock-core:2.3-groovy-3.0') {`
	`133`	`+ integTestImplementation('org.spockframework:spock-core:2.4-M6-groovy-4.0') {`
`134`	`134`	`exclude module: "groovy"`
`135`	`135`	`}`
`136`	`136`	`}`
`@@ -218,6 +218,7 @@ if (project != rootProject) {`
`218`	`218`	`// Track reaper jar as a test input using runtime classpath normalization strategy`
`219`	`219`	`tasks.withType(Test).configureEach {`
`220`	`220`	`inputs.files(configurations.reaper).withNormalizer(ClasspathNormalizer)`
	`221`	`+ jvmArgs += ["--add-opens", "java.base/java.lang=ALL-UNNAMED"]`
`221`	`222`	`}`
`222`	`223`
`223`	`224`	`normalization {`