Converting randomized testing to create a separate unitTest task instead of replacing the builtin test task (#36311)

- Create a separate unitTest task instead of Gradle's built in 
- convert all configuration to use the new task 
- the  built in task is now disabled

Author: alpar-t

benchmarks/build.gradle

@@ -24,7 +24,7 @@ mainClassName = 'org.openjdk.jmh.Main'
 assemble.enabled = false
 archivesBaseName = 'elasticsearch-benchmarks'
 
-test.enabled = false
+unitTest.enabled = false
 
 dependencies {
     compile("org.elasticsearch:elasticsearch:${version}") {

buildSrc/build.gradle

@@ -179,9 +179,7 @@ if (project != rootProject) {
   jarHell.enabled = false
   thirdPartyAudit.enabled = false
 
-  test {
-    include "**/*Tests.class"
-    exclude "**/*IT.class"
+  unitTest {
     // The test task is configured to runtimeJava version, but build-tools doesn't support all of them, so test
     // with compiler instead on the ones that are too old.
     if (project.runtimeJavaVersion <= JavaVersion.VERSION_1_10) {

buildSrc/src/main/groovy/com/carrotsearch/gradle/junit4/RandomizedTestingPlugin.groovy

@@ -4,30 +4,14 @@ import com.carrotsearch.ant.tasks.junit4.JUnit4
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.Task
-import org.gradle.api.UnknownTaskException
-import org.gradle.api.plugins.JavaBasePlugin
 import org.gradle.api.tasks.TaskContainer
-import org.gradle.api.tasks.TaskProvider
-import org.gradle.api.tasks.testing.Test
 
 class RandomizedTestingPlugin implements Plugin<Project> {
 
     void apply(Project project) {
         setupSeed(project)
-        replaceTestTask(project.tasks)
+        createUnitTestTask(project.tasks)
         configureAnt(project.ant)
-        configureSanityCheck(project)
-    }
-
-    private static void configureSanityCheck(Project project) {
-        // Check the task graph to confirm tasks were indeed replaced
-        // https://github.com/elastic/elasticsearch/issues/31324
-        project.rootProject.getGradle().getTaskGraph().whenReady {
-            Task test = project.getTasks().findByName("test")
-            if (test != null && (test instanceof RandomizedTestingTask) == false) {
-                throw new IllegalStateException("Test task was not replaced in project ${project.path}. Found ${test.getClass()}")
-            }
-        }
     }
 
     /**
@@ -57,35 +41,15 @@ class RandomizedTestingPlugin implements Plugin<Project> {
         }
     }
 
-    static void replaceTestTask(TaskContainer tasks) {
-        // Gradle 4.8 introduced lazy tasks, thus we deal both with the `test` task as well as it's provider
-        // https://github.com/gradle/gradle/issues/5730#issuecomment-398822153
-        // since we can't be sure if the task was ever realized, we remove both the provider and the task
-        TaskProvider<Test> oldTestProvider
-        try {
-            oldTestProvider = tasks.named('test')
-        } catch (UnknownTaskException unused) {
-            // no test task, ok, user will use testing task on their own
-            return
+    static void createUnitTestTask(TaskContainer tasks) {
+        // only create a unitTest task if the `test` task exists as some project don't make use of it.
+        tasks.matching { it.name == "test" }.all {
+            // We don't want to run any tests with the Gradle test runner since we add our own randomized runner
+            it.enabled = false
+            RandomizedTestingTask unitTest = tasks.create('unitTest', RandomizedTestingTask)
+            unitTest.description = 'Runs unit tests with the randomized testing framework'
+            it.dependsOn unitTest
         }
-        Test oldTestTask = oldTestProvider.get()
-
-        // we still have to use replace here despite the remove above because the task container knows about the provider
-        // by the same name
-        RandomizedTestingTask newTestTask = tasks.replace('test', RandomizedTestingTask)
-        newTestTask.configure{
-            group =  JavaBasePlugin.VERIFICATION_GROUP
-            description = 'Runs unit tests with the randomized testing framework'
-            dependsOn oldTestTask.dependsOn, 'testClasses'
-            classpath = oldTestTask.classpath
-            testClassesDirs = oldTestTask.project.sourceSets.test.output.classesDirs
-        }
-
-        // hack so check task depends on custom test
-        Task checkTask = tasks.getByName('check')
-        checkTask.dependsOn.remove(oldTestProvider)
-        checkTask.dependsOn.remove(oldTestTask)
-        checkTask.dependsOn.add(newTestTask)
     }
 
     static void configureAnt(AntBuilder ant) {

buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy

@@ -40,6 +40,7 @@ import org.gradle.api.artifacts.ProjectDependency
 import org.gradle.api.artifacts.ResolvedArtifact
 import org.gradle.api.artifacts.dsl.RepositoryHandler
 import org.gradle.api.execution.TaskExecutionGraph
+import org.gradle.api.plugins.JavaBasePlugin
 import org.gradle.api.plugins.JavaPlugin
 import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.api.publish.maven.plugins.MavenPublishPlugin
@@ -888,15 +889,22 @@ class BuildPlugin implements Plugin<Project> {
             parallelism System.getProperty('tests.jvms', project.rootProject.ext.defaultParallel)
             onNonEmptyWorkDirectory 'wipe'
             leaveTemporary true
+            project.sourceSets.matching { it.name == "test" }.all { test ->
+                task.testClassesDirs = test.output.classesDirs
+                task.classpath = test.runtimeClasspath
+            }
+            group =  JavaBasePlugin.VERIFICATION_GROUP
+            dependsOn 'testClasses'
 
             // Make sure all test tasks are configured properly
             if (name != "test") {
                 project.tasks.matching { it.name == "test"}.all { testTask ->
-                    task.testClassesDirs = testTask.testClassesDirs
-                    task.classpath = testTask.classpath
                     task.shouldRunAfter testTask
                 }
             }
+            if (name == "unitTest") {
+                include("**/*Tests.class")
+            }
 
             // TODO: why are we not passing maxmemory to junit4?
             jvmArg '-Xmx' + System.getProperty('tests.heap.size', '512m')
@@ -986,8 +994,6 @@ class BuildPlugin implements Plugin<Project> {
 
             exclude '**/*$*.class'
 
-            dependsOn(project.tasks.testClasses)
-
             project.plugins.withType(ShadowPlugin).whenPluginAdded {
                 // Test against a shadow jar if we made one
                 classpath -= project.tasks.compileJava.outputs.files

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

@@ -55,8 +55,6 @@ public class RestIntegTestTask extends DefaultTask {
         super.dependsOn(runner)
         clusterInit = project.tasks.create(name: "${name}Cluster#init", dependsOn: project.testClasses)
         runner.dependsOn(clusterInit)
-        runner.classpath = project.sourceSets.test.runtimeClasspath
-        runner.testClassesDirs = project.sourceSets.test.output.classesDirs
         clusterConfig = project.extensions.create("${name}Cluster", ClusterConfiguration.class, project)
 
         // override/add more for rest tests

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

@@ -27,7 +27,7 @@ forbiddenApisTest.enabled = false
 // requires dependency on testing fw
 jarHell.enabled = false
 // we don't have tests for now
-test.enabled = false
+unitTest.enabled = false
 
 task hello {
     doFirst {

client/benchmark/build.gradle

@@ -29,7 +29,7 @@ archivesBaseName = 'client-benchmarks'
 mainClassName = 'org.elasticsearch.client.benchmark.BenchmarkMain'
 
 // never try to invoke tests on the benchmark project - there aren't any
-test.enabled = false
+unitTest.enabled = false
 
 dependencies {
   compile 'org.apache.commons:commons-math3:3.2'

client/client-benchmark-noop-api-plugin/build.gradle

@@ -36,5 +36,5 @@ dependenciesInfo.enabled = false
 compileJava.options.compilerArgs << "-Xlint:-cast,-deprecation,-rawtypes,-try,-unchecked"
 
 // no unit tests
-test.enabled = false
+unitTest.enabled = false
 integTest.enabled = false

client/test/build.gradle

@@ -55,4 +55,4 @@ namingConventions.enabled = false
 
 //we aren't releasing this jar
 thirdPartyAudit.enabled = false
-test.enabled = false
+unitTest.enabled = false

distribution/bwc/build.gradle

@@ -39,7 +39,6 @@ bwcVersions.forPreviousUnreleased { VersionCollection.UnreleasedVersionInfo unre
     apply plugin: 'distribution'
     // Not published so no need to assemble
     assemble.enabled = false
-    assemble.dependsOn.remove('buildBwcVersion')
 
     File checkoutDir = file("${buildDir}/bwc/checkout-${bwcBranch}")