Improvement usage of gradle task avoidance api (#56627)

Use gradle task avoidance api wherever it is possible as a drop in replacement in the es build

Author: breskeby

build.gradle

@@ -108,7 +108,7 @@ subprojects {
   }
 }
 
-task updateCIBwcVersions() {
+tasks.register("updateCIBwcVersions") {
   doLast {
     File yml = file(".ci/bwcVersions")
     yml.text = ""
@@ -142,7 +142,7 @@ allprojects {
   }
 }
 
-task verifyVersions {
+tasks.register("verifyVersions") {
   doLast {
     if (gradle.startParameter.isOffline()) {
       throw new GradleException("Must run in online mode to verify versions")
@@ -194,18 +194,18 @@ subprojects {
   ext.bwc_tests_enabled = bwc_tests_enabled
 }
 
-task verifyBwcTestsEnabled {
+tasks.register("verifyBwcTestsEnabled") {
   doLast {
     if (bwc_tests_enabled == false) {
       throw new GradleException('Bwc tests are disabled. They must be re-enabled after completing backcompat behavior backporting.')
     }
   }
 }
 
-task branchConsistency {
+tasks.register("branchConsistency") {
   description 'Ensures this branch is internally consistent. For example, that versions constants match released versions.'
   group 'Verification'
-  dependsOn verifyVersions, verifyBwcTestsEnabled
+  dependsOn ":verifyVersions", ":verifyBwcTestsEnabled"
 }
 
 allprojects {
@@ -406,7 +406,7 @@ class Run extends DefaultTask {
   }
 }
 
-task run(type: Run) {
+tasks.register("run", Run) {
   dependsOn ':distribution:run'
   description = 'Runs elasticsearch in the foreground'
   group = 'Verification'
@@ -485,7 +485,7 @@ allprojects {
     if (realTask == null) {
       return
     }
-    project.tasks.create(taskName) {
+    project.tasks.register(taskName) {
       doLast {
         println("${realTask.path} dependencies:")
         for (Task dep : realTask.getTaskDependencies().getDependencies(realTask)) {

buildSrc/build.gradle

@@ -48,7 +48,7 @@ if (project == rootProject) {
 Properties props = VersionPropertiesLoader.loadBuildSrcVersion(project.file('version.properties'))
 version = props.getProperty("elasticsearch")
 
-task generateVersionProperties(type: WriteProperties) {
+def generateVersionProperties = tasks.register("generateVersionProperties", WriteProperties) {
   outputFile = "${buildDir}/version.properties"
   comment = 'Generated version properties'
   properties(props)
@@ -234,13 +234,13 @@ if (project != rootProject) {
     }
   }
 
-  task integTest(type: Test) {
+  tasks.register("integTest", Test) {
     inputs.dir(file("src/testKit")).withPropertyName("testkit dir").withPathSensitivity(PathSensitivity.RELATIVE)
     systemProperty 'test.version_under_test', version
     onlyIf { org.elasticsearch.gradle.info.BuildParams.inFipsJvm == false }
     maxParallelForks = System.getProperty('tests.jvms', org.elasticsearch.gradle.info.BuildParams.defaultParallel.toString()) as Integer
   }
-  check.dependsOn(integTest)
+  check.dependsOn("integTest")
 
   // for now we hardcode the tests for our build to use the gradle jvm.
   tasks.withType(Test).configureEach {

buildSrc/reaper/build.gradle

@@ -1,5 +1,5 @@
 jar {
-  archiveName = "${project.name}.jar"
+  archiveFileName = "${project.name}.jar"
   manifest {
     attributes 'Main-Class': 'org.elasticsearch.gradle.reaper.Reaper'
   }

buildSrc/src/main/groovy/org/elasticsearch/gradle/test/AntFixture.groovy

@@ -26,6 +26,8 @@ import org.gradle.api.GradleException
 import org.gradle.api.Task
 import org.gradle.api.tasks.Exec
 import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.TaskProvider
+
 /**
  * A fixture for integration tests which runs in a separate process launched by Ant.
  */
@@ -79,7 +81,7 @@ class AntFixture extends AntTask implements Fixture {
         return tmpFile.exists()
     }
 
-    private final Task stopTask
+    private final TaskProvider stopTask
 
     AntFixture() {
         stopTask = createStopTask()
@@ -88,7 +90,7 @@ class AntFixture extends AntTask implements Fixture {
 
     @Override
     @Internal
-    Task getStopTask() {
+    TaskProvider getStopTask() {
         return stopTask
     }
 
@@ -222,24 +224,29 @@ class AntFixture extends AntTask implements Fixture {
     }
 
     /** Adds a task to kill an elasticsearch node with the given pidfile */
-    private Task createStopTask() {
+    private TaskProvider createStopTask() {
         final AntFixture fixture = this
         final Object pid = "${ -> fixture.pid }"
-        Exec stop = project.tasks.create(name: "${name}#stop", type: LoggedExec)
-        stop.onlyIf { fixture.pidFile.exists() }
-        stop.doFirst {
-            logger.info("Shutting down ${fixture.name} with pid ${pid}")
-        }
-        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
-            stop.executable = 'Taskkill'
-            stop.args('/PID', pid, '/F')
-        } else {
-            stop.executable = 'kill'
-            stop.args('-9', pid)
-        }
-        stop.doLast {
-            project.delete(fixture.pidFile)
+        TaskProvider<Exec> stop = project.tasks.register("${name}#stop", LoggedExec)
+        stop.configure {
+            onlyIf { fixture.pidFile.exists() }
+            doFirst {
+                logger.info("Shutting down ${fixture.name} with pid ${pid}")
+            }
+
+            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+                executable = 'Taskkill'
+                args('/PID', pid, '/F')
+            } else {
+                executable = 'kill'
+                args('-9', pid)
+            }
+            doLast {
+                project.delete(fixture.pidFile)
+            }
+
         }
+
         return stop
     }
 

buildSrc/src/main/groovy/org/elasticsearch/gradle/test/TestWithDependenciesPlugin.groovy

@@ -58,10 +58,12 @@ class TestWithDependenciesPlugin implements Plugin<Project> {
         String outputDir = "${project.buildDir}/generated-resources/${pluginProject.name}"
         String camelName = pluginProject.name.replaceAll(/-(\w)/) { _, c -> c.toUpperCase(Locale.ROOT) }
         String taskName = "copy" + camelName[0].toUpperCase(Locale.ROOT) + camelName.substring(1) + "Metadata"
-        Copy copyPluginMetadata = project.tasks.create(taskName, Copy.class)
-        copyPluginMetadata.into(outputDir)
-        copyPluginMetadata.from(pluginProject.tasks.pluginProperties)
-        copyPluginMetadata.from(pluginProject.file('src/main/plugin-metadata'))
+        project.tasks.register(taskName, Copy.class) {
+            into(outputDir)
+            from(pluginProject.tasks.pluginProperties)
+            from(pluginProject.file('src/main/plugin-metadata'))
+        }
+
         project.sourceSets.test.output.dir(outputDir, builtBy: taskName)
     }
 }

buildSrc/src/test/java/org/elasticsearch/gradle/ExportElasticsearchBuildResourcesTaskIT.java

@@ -32,12 +32,16 @@ public void testUpToDateWithSourcesConfigured() {
         BuildResult result = getGradleRunner(PROJECT_NAME).withArguments("buildResources", "-s", "-i").build();
         assertTaskSuccessful(result, ":buildResources");
         assertBuildFileExists(result, PROJECT_NAME, "build-tools-exported/checkstyle.xml");
-        assertBuildFileExists(result, PROJECT_NAME, "build-tools-exported/checkstyle_suppressions.xml");
+
+        // using task avoidance api means the task configuration of the sample task is never triggered
+        assertBuildFileDoesNotExists(result, PROJECT_NAME, "build-tools-exported/checkstyle_suppressions.xml");
 
         result = getGradleRunner(PROJECT_NAME).withArguments("buildResources", "-s", "-i").build();
         assertTaskUpToDate(result, ":buildResources");
         assertBuildFileExists(result, PROJECT_NAME, "build-tools-exported/checkstyle.xml");
-        assertBuildFileExists(result, PROJECT_NAME, "build-tools-exported/checkstyle_suppressions.xml");
+
+        // using task avoidance api means the task configuration of the sample task is never triggered
+        assertBuildFileDoesNotExists(result, PROJECT_NAME, "build-tools-exported/checkstyle_suppressions.xml");
     }
 
     public void testImplicitTaskDependencyCopy() {
@@ -46,8 +50,10 @@ public void testImplicitTaskDependencyCopy() {
         assertTaskSuccessful(result, ":buildResources");
         assertTaskSuccessful(result, ":sampleCopyAll");
         assertBuildFileExists(result, PROJECT_NAME, "sampleCopyAll/checkstyle.xml");
-        // This is a side effect of compile time reference
-        assertBuildFileExists(result, PROJECT_NAME, "sampleCopyAll/checkstyle_suppressions.xml");
+
+        // using task avoidance api means the task configuration of the sample task is never triggered
+        // which means buildResource is not configured to copy this file
+        assertBuildFileDoesNotExists(result, PROJECT_NAME, "sampleCopyAll/checkstyle_suppressions.xml");
     }
 
     public void testImplicitTaskDependencyInputFileOfOther() {

buildSrc/src/test/java/org/elasticsearch/gradle/precommit/ThirdPartyAuditTaskIT.java

@@ -27,13 +27,13 @@ public class ThirdPartyAuditTaskIT extends GradleIntegrationTestCase {
     @Before
     public void setUp() throws Exception {
         // Build the sample jars
-        getGradleRunner("thirdPartyAudit").withArguments("build", "-s").build();
+        getGradleRunner("thirdPartyAudit").withArguments(":sample_jars:build", "-s").build();
     }
 
     public void testElasticsearchIgnored() {
         BuildResult result = getGradleRunner("thirdPartyAudit").withArguments(
-            "clean",
-            "empty",
+            ":clean",
+            ":empty",
             "-s",
             "-PcompileOnlyGroup=elasticsearch.gradle:broken-log4j",
             "-PcompileOnlyVersion=0.0.1",
@@ -44,9 +44,9 @@ public void testElasticsearchIgnored() {
     }
 
     public void testWithEmptyRules() {
-        BuildResult result = getGradleRunner("thirdPartyAudit").withArguments(
-            "clean",
-            "empty",
+        getGradleRunner("thirdPartyAudit").withArguments(
+            ":clean",
+            ":empty",
             "-s",
             "-PcompileOnlyGroup=other.gradle:broken-log4j",
             "-PcompileOnlyVersion=0.0.1",
@@ -57,8 +57,8 @@ public void testWithEmptyRules() {
 
     public void testViolationFoundAndCompileOnlyIgnored() {
         BuildResult result = getGradleRunner("thirdPartyAudit").withArguments(
-            "clean",
-            "absurd",
+            ":clean",
+            ":absurd",
             "-s",
             "-PcompileOnlyGroup=other.gradle:broken-log4j",
             "-PcompileOnlyVersion=0.0.1",
@@ -73,8 +73,8 @@ public void testViolationFoundAndCompileOnlyIgnored() {
 
     public void testClassNotFoundAndCompileOnlyIgnored() {
         BuildResult result = getGradleRunner("thirdPartyAudit").withArguments(
-            "clean",
-            "absurd",
+            ":clean",
+            ":absurd",
             "-s",
             "-PcompileGroup=other.gradle:broken-log4j",
             "-PcompileVersion=0.0.1",
@@ -94,8 +94,8 @@ public void testClassNotFoundAndCompileOnlyIgnored() {
 
     public void testJarHellWithJDK() {
         BuildResult result = getGradleRunner("thirdPartyAudit").withArguments(
-            "clean",
-            "absurd",
+            ":clean",
+            ":absurd",
             "-s",
             "-PcompileGroup=other.gradle:jarhellJdk",
             "-PcompileVersion=0.0.1",
@@ -115,8 +115,8 @@ public void testJarHellWithJDK() {
 
     public void testElasticsearchIgnoredWithViolations() {
         BuildResult result = getGradleRunner("thirdPartyAudit").withArguments(
-            "clean",
-            "absurd",
+            ":clean",
+            ":absurd",
             "-s",
             "-PcompileOnlyGroup=elasticsearch.gradle:broken-log4j",
             "-PcompileOnlyVersion=0.0.1",

buildSrc/src/testKit/distribution-download/distribution/build.gradle

@@ -3,10 +3,10 @@ if (distroConfig != null) {
   // setup the test distribution as an artifact of this project
   String distroType = System.getProperty('tests.distro.type')
 
-  Task buildDistro
+  def buildDistro
   File buildFile
   if (['rpm', 'deb'].contains(distroType)) {
-    buildDistro = project.tasks.create("build" + distroType.capitalize(), Copy) {
+    buildDistro = project.tasks.register("build" + distroType.capitalize(), Copy) {
       from 'files'
       into 'build/files'
       include 'fake_elasticsearch.tar.gz'
@@ -21,7 +21,7 @@ if (distroConfig != null) {
       extension = "zip"
     }
     // copy file as is
-    buildDistro = project.tasks.create("buildArchive", Copy) {
+    buildDistro = project.tasks.register("buildArchive", Copy) {
       from 'files'
       include "fake_elasticsearch.${extension}"
       into 'build/files'

buildSrc/src/testKit/distribution-download/subproj/build.gradle

@@ -36,7 +36,7 @@ elasticsearch_distributions {
   }
 }
 
-task assertDistroFile {
+tasks.register("assertDistroFile") {
   dependsOn elasticsearch_distributions.test_distro
   doLast {
     File distroFile = new File(elasticsearch_distributions.test_distro.toString())
@@ -50,7 +50,7 @@ task assertDistroFile {
 }
 
 if (['rpm', 'deb'].contains(distroType) == false) {
-  task assertDistroExtracted {
+  tasks.register("assertDistroExtracted") {
     dependsOn elasticsearch_distributions.test_distro.extracted, assertDistroFile
     doLast {
       File distroExtracted = new File(elasticsearch_distributions.test_distro.extracted.toString())

buildSrc/src/testKit/elasticsearch-build-resources/build.gradle

@@ -9,13 +9,13 @@ buildResources {
   copy 'checkstyle.xml'
 }
 
-task sampleCopyAll(type: Sync) {
+tasks.register("sampleCopyAll", Sync) {
   /** Note: no explicit dependency. This works with tasks that use the Provider API a.k.a "Lazy Configuration" **/
   from buildResources
   into "$buildDir/sampleCopyAll"
 }
 
-task sample {
+tasks.register("sample") {
   // This does not work, task dependencies can't be providers
   // dependsOn buildResources.resource('minimumRuntimeVersion')
   // Nor does this, despite https://github.com/gradle/gradle/issues/3811
@@ -29,7 +29,7 @@ task sample {
   }
 }
 
-task noConfigAfterExecution {
+tasks.register("noConfigAfterExecution") {
   dependsOn buildResources
   doLast {
     println "This should cause an error because we are refferencing " +

buildSrc/src/testKit/elasticsearch.build/build.gradle

@@ -29,7 +29,7 @@ loggerUsageCheck.enabled = false
 // TODO: shouldn't be part of BuildPlugin, should be tested separately
 validateNebulaPom.enabled = false
 
-task hello {
+tasks.register("hello") {
   doFirst {
     println "build plugin can be applied"
   }

buildSrc/src/testKit/jdk-download/build.gradle

@@ -9,7 +9,7 @@ project.gradle.projectsEvaluated {
   repository.setUrl(fakeJdkRepo)
 }
 
-task numConfigurations {
+tasks.register("numConfigurations") {
   doLast {
     println "NUM CONFIGS: ${project.configurations.size()}"
   }

buildSrc/src/testKit/jdk-download/subproj/build.gradle

@@ -26,21 +26,21 @@ jdks {
   }
 }
 
-task getLinuxJdk {
+tasks.register("getLinuxJdk") {
   dependsOn jdks.linux
   doLast {
     println "JDK HOME: " + jdks.linux
   }
 }
 
-task getDarwinJdk {
+tasks.register("getDarwinJdk") {
   dependsOn jdks.darwin
   doLast {
     println "JDK HOME: " + jdks.darwin
   }
 }
 
-task getWindowsJdk {
+tasks.register("getWindowsJdk") {
   dependsOn jdks.windows
   doLast {
     println "JDK HOME: " + jdks.windows