[Gradle] Update shadow plugin (#116826)

- The shadow plugin has changed ownership and plugin id. - Make some formatting of poms more reproducible
elastic · Nov 15, 2024 · def490e · def490e
1 parent 9489726
commit def490e
Show file tree

Hide file tree

Showing 22 changed files with 135 additions and 69 deletions.
diff --git a/build-conventions/build.gradle b/build-conventions/build.gradle
@@ -12,9 +12,6 @@ import org.gradle.plugins.ide.eclipse.model.SourceFolder
 
 buildscript {
   repositories {
-    maven {
-      url 'https://jitpack.io'
-    }
     mavenCentral()
   }
 }
@@ -70,10 +67,6 @@ gradlePlugin {
 }
 
 repositories {
-    maven {
-      url 'https://jitpack.io'
-    }
-
     mavenCentral()
     gradlePluginPortal()
 }

diff --git a/...onventions/src/main/java/org/elasticsearch/gradle/internal/conventions/PublishPlugin.java b/...onventions/src/main/java/org/elasticsearch/gradle/internal/conventions/PublishPlugin.java
@@ -9,15 +9,19 @@
 
 package org.elasticsearch.gradle.internal.conventions;
 
-import org.elasticsearch.gradle.internal.conventions.precommit.PomValidationPrecommitPlugin;
+import groovy.util.Node;
+
 import com.github.jengelman.gradle.plugins.shadow.ShadowExtension;
 import com.github.jengelman.gradle.plugins.shadow.ShadowPlugin;
-import groovy.util.Node;
-import org.elasticsearch.gradle.internal.conventions.util.Util;
+
 import org.elasticsearch.gradle.internal.conventions.info.GitInfo;
+import org.elasticsearch.gradle.internal.conventions.precommit.PomValidationPrecommitPlugin;
+import org.elasticsearch.gradle.internal.conventions.util.Util;
+import org.gradle.api.Action;
 import org.gradle.api.NamedDomainObjectSet;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
+import org.gradle.api.Task;
 import org.gradle.api.XmlProvider;
 import org.gradle.api.file.ProjectLayout;
 import org.gradle.api.plugins.BasePlugin;
@@ -35,11 +39,12 @@
 import org.gradle.api.tasks.bundling.Jar;
 import org.gradle.initialization.layout.BuildLayout;
 import org.gradle.language.base.plugins.LifecycleBasePlugin;
+import org.w3c.dom.Element;
 
-import javax.inject.Inject;
 import java.io.File;
 import java.util.Map;
 import java.util.concurrent.Callable;
+import javax.inject.Inject;
 
 public class PublishPlugin implements Plugin<Project> {
 
@@ -113,19 +118,22 @@ private void configurePomGeneration(Project project) {
         var archivesBaseName = providerFactory.provider(() -> getArchivesBaseName(extensions));
         var projectVersion = providerFactory.provider(() -> project.getVersion());
         var generateMavenPoms = project.getTasks().withType(GenerateMavenPom.class);
-        generateMavenPoms.configureEach(
-            pomTask -> pomTask.setDestination(
+        generateMavenPoms.configureEach(pomTask -> {
+            pomTask.setDestination(
                 (Callable<String>) () -> String.format(
                     "%s/distributions/%s-%s.pom",
                     projectLayout.getBuildDirectory().get().getAsFile().getPath(),
                     archivesBaseName.get(),
                     projectVersion.get()
                 )
-            )
-        );
+            );
+            pomTask.doFirst(t -> pomTask.getPom().withXml(xml -> formatDependencies(xml)));
+        });
+
         var publishing = extensions.getByType(PublishingExtension.class);
         final var mavenPublications = publishing.getPublications().withType(MavenPublication.class);
-        addNameAndDescriptiontoPom(project, mavenPublications);
+
+        addNameAndDescriptionToPom(project, mavenPublications);
         mavenPublications.configureEach(publication -> {
             // Add git origin info to generated POM files for internal builds
             publication.getPom().withXml(xml -> addScmInfo(xml, gitInfo.get()));
@@ -135,11 +143,26 @@ private void configurePomGeneration(Project project) {
         });
     }
 
-    private void addNameAndDescriptiontoPom(Project project, NamedDomainObjectSet<MavenPublication> mavenPublications) {
+    /**
+     * just ensure we put dependencies to the end. more a cosmetic thing than anything else
+     * */
+    private void formatDependencies(XmlProvider xml) {
+        Element rootElement = xml.asElement();
+        var dependencies = rootElement.getElementsByTagName("dependencies");
+        if (dependencies.getLength() == 1 && dependencies.item(0) != null) {
+            org.w3c.dom.Node item = dependencies.item(0);
+            rootElement.removeChild(item);
+            rootElement.appendChild(item);
+        }
+    }
+
+    private void addNameAndDescriptionToPom(Project project, NamedDomainObjectSet<MavenPublication> mavenPublications) {
         var name = project.getName();
         var description = providerFactory.provider(() -> project.getDescription() != null ? project.getDescription() : "");
         mavenPublications.configureEach(p -> p.getPom().withXml(xml -> {
             var root = xml.asNode();
+            // Node versionNode = root.get("version");
+            // versionNode.plus(1, "name", name);
             root.appendNode("name", name);
             root.appendNode("description", description.get());
         }));

diff --git a/build-tools-internal/build.gradle b/build-tools-internal/build.gradle
@@ -258,9 +258,6 @@ tasks.named('licenseHeaders').configure {
  *****************************************************************************/
 
 repositories {
-  maven {
-    url 'https://jitpack.io'
-  }
   mavenCentral()
   gradlePluginPortal()
 }

diff --git a/build-tools-internal/settings.gradle b/build-tools-internal/settings.gradle
@@ -1,8 +1,5 @@
 pluginManagement {
   repositories {
-    maven {
-      url 'https://jitpack.io'
-    }
     mavenCentral()
     gradlePluginPortal()
   }

diff --git a/...egTest/groovy/org/elasticsearch/gradle/internal/ElasticsearchJavadocPluginFuncTest.groovy b/...egTest/groovy/org/elasticsearch/gradle/internal/ElasticsearchJavadocPluginFuncTest.groovy
@@ -73,7 +73,7 @@ class ElasticsearchJavadocPluginFuncTest extends AbstractGradleFuncTest {
             buildFile << """
                 plugins {
                     id 'elasticsearch.java-doc'
-                    id 'com.github.johnrengelman.shadow' version '7.1.2'
+                    id 'com.gradleup.shadow'
                     id 'java'
                 }
                 group = 'org.acme.depending'

diff --git a/...ernal/src/integTest/groovy/org/elasticsearch/gradle/internal/PublishPluginFuncTest.groovy b/...ernal/src/integTest/groovy/org/elasticsearch/gradle/internal/PublishPluginFuncTest.groovy
@@ -96,7 +96,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
             plugins {
                 id 'elasticsearch.java'
                 id 'elasticsearch.publish'
-                id 'com.github.johnrengelman.shadow'
+                id 'com.gradleup.shadow'
             }
 
             repositories {
@@ -117,7 +117,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
             }
             version = "1.0"
             group = 'org.acme'
-            description = 'some description'
+            description = 'shadowed project'
         """
 
         when:
@@ -137,7 +137,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
               <artifactId>hello-world</artifactId>
               <version>1.0</version>
               <name>hello-world</name>
-              <description>some description</description>
+              <description>shadowed project</description>
               <url>unknown</url>
               <scm>
                 <url>unknown</url>
@@ -186,7 +186,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
             plugins {
                 id 'elasticsearch.java'
                 id 'elasticsearch.publish'
-                id 'com.github.johnrengelman.shadow'
+                id 'com.gradleup.shadow'
             }
 
             dependencies {
@@ -206,7 +206,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
                 group = 'org.acme'
             }
 
-            description = 'some description'
+            description = 'with shadowed dependencies'
         """
 
         when:
@@ -226,7 +226,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
               <artifactId>hello-world</artifactId>
               <version>1.0</version>
               <name>hello-world</name>
-              <description>some description</description>
+              <description>with shadowed dependencies</description>
               <url>unknown</url>
               <scm>
                 <url>unknown</url>
@@ -277,13 +277,13 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
             plugins {
                 id 'elasticsearch.internal-es-plugin'
                 id 'elasticsearch.publish'
-                id 'com.github.johnrengelman.shadow'
+                id 'com.gradleup.shadow'
             }
 
             esplugin {
                 name = 'hello-world-plugin'
                 classname 'org.acme.HelloWorldPlugin'
-                description = "custom project description"
+                description = "shadowed es plugin"
             }
 
             publishing {
@@ -324,7 +324,7 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
               <artifactId>hello-world-plugin</artifactId>
               <version>1.0</version>
               <name>hello-world</name>
-              <description>custom project description</description>
+              <description>shadowed es plugin</description>
               <url>unknown</url>
               <scm>
                 <url>unknown</url>
@@ -353,7 +353,6 @@ class PublishPluginFuncTest extends AbstractGradleFuncTest {
                   <url>https://www.elastic.co</url>
                 </developer>
               </developers>
-              <dependencies/>
             </project>"""
         )
     }

diff --git a/...ols-internal/src/main/java/org/elasticsearch/gradle/internal/ElasticsearchJavaPlugin.java b/...ols-internal/src/main/java/org/elasticsearch/gradle/internal/ElasticsearchJavaPlugin.java
@@ -87,7 +87,7 @@ public void execute(Task task) {
                 }
             });
         });
-        project.getPluginManager().withPlugin("com.github.johnrengelman.shadow", p -> {
+        project.getPluginManager().withPlugin("com.gradleup.shadow", p -> {
             project.getTasks().withType(ShadowJar.class).configureEach(shadowJar -> {
                 /*
                  * Replace the default "-all" classifier with null

diff --git a/...internal/src/main/java/org/elasticsearch/gradle/internal/ElasticsearchTestBasePlugin.java b/...internal/src/main/java/org/elasticsearch/gradle/internal/ElasticsearchTestBasePlugin.java
@@ -198,7 +198,7 @@ public void execute(Task t) {
              *  If this project builds a shadow JAR than any unit tests should test against that artifact instead of
              *  compiled class output and dependency jars. This better emulates the runtime environment of consumers.
              */
-            project.getPluginManager().withPlugin("com.github.johnrengelman.shadow", p -> {
+            project.getPluginManager().withPlugin("com.gradleup.shadow", p -> {
                 if (test.getName().equals(JavaPlugin.TEST_TASK_NAME)) {
                     // Remove output class files and any other dependencies from the test classpath, since the shadow JAR includes these
                     SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);

diff --git a/build-tools/build.gradle b/build-tools/build.gradle
@@ -9,9 +9,6 @@
 
 buildscript {
   repositories {
-    maven {
-      url 'https://jitpack.io'
-    }
     mavenCentral()
   }
 }
@@ -117,9 +114,6 @@ configurations {
 }
 
 repositories {
-    maven {
-      url 'https://jitpack.io'
-    }
     mavenCentral()
     gradlePluginPortal()
 }

diff --git a/build-tools/src/main/java/org/elasticsearch/gradle/plugin/BasePluginBuildPlugin.java b/build-tools/src/main/java/org/elasticsearch/gradle/plugin/BasePluginBuildPlugin.java
@@ -167,7 +167,7 @@ private static CopySpec createBundleSpec(
             copySpec.exclude("plugin-security.codebases");
         });
         bundleSpec.from(
-            (Callable<TaskProvider<Task>>) () -> project.getPluginManager().hasPlugin("com.github.johnrengelman.shadow")
+            (Callable<TaskProvider<Task>>) () -> project.getPluginManager().hasPlugin("com.gradleup.shadow")
                 ? project.getTasks().named("shadowJar")
                 : project.getTasks().named("jar")
         );

diff --git a/build.gradle b/build.gradle
@@ -27,10 +27,6 @@ import static org.elasticsearch.gradle.util.GradleUtils.maybeConfigure
 
 buildscript {
   repositories {
-    maven {
-      url 'https://jitpack.io'
-    }
-
     mavenCentral()
   }
 }

diff --git a/gradle/build.versions.toml b/gradle/build.versions.toml
@@ -39,7 +39,7 @@ maven-model = "org.apache.maven:maven-model:3.6.2"
 mockito-core = "org.mockito:mockito-core:1.9.5"
 nebula-info = "com.netflix.nebula:gradle-info-plugin:11.3.3"
 reflections = "org.reflections:reflections:0.9.12"
-shadow-plugin = "com.github.breskeby:shadow:3b035f2"
+shadow-plugin = "com.gradleup.shadow:shadow-gradle-plugin:8.3.5"
 snakeyaml = { group = "org.yaml", name = "snakeyaml", version = { strictly = "2.0" } }
 spock-core = { group = "org.spockframework", name="spock-core", version.ref="spock" }
 spock-junit4 = { group = "org.spockframework", name="spock-junit4", version.ref="spock" }