Introduce javaRestTest source set/task and convert modules (elastic#5…

…9939)

Introduce a javaRestTest source set and task to compliment the yamlRestTest.
javaRestTest differs such that the code is sourced from Java and may have
different dependencies and setup requirements for the test clusters. This also
allows the tests to run in parallel in different cluster instances to prevent any
cross test contamination between the two types of tests.

Included in this PR is all :modules no longer use the integTest task. The tests
are now driven by test, yamlRestTest, javaRestTest, and internalClusterTest.
Since only :modules (and :rest-api-spec) have been converted to yamlRestTest
we can now disable the integTest task if either yamlRestTest or javaRestTest have
been applied. Once all projects are converted, we can delete the integTest task.

related: elastic#56841
related: elastic#59444

buildSrc/src/main/groovy/org/elasticsearch/gradle/plugin/PluginBuildPlugin.groovy

@@ -120,6 +120,14 @@ class PluginBuildPlugin implements Plugin<Project> {
             }
         }
 
+        //disable integTest task if project has been converted to use yaml or java rest test plugin
+        project.pluginManager.withPlugin("elasticsearch.yaml-rest-test") {
+            project.tasks.integTest.enabled = false
+        }
+        project.pluginManager.withPlugin("elasticsearch.java-rest-test") {
+            project.tasks.integTest.enabled = false
+        }
+
         project.tasks.named('testingConventions').configure {
             naming.clear()
             naming {

buildSrc/src/main/java/org/elasticsearch/gradle/test/rest/JavaRestTestPlugin.java

@@ -0,0 +1,68 @@
+/*
+ * Licensed to Elasticsearch under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.elasticsearch.gradle.test.rest;
+
+import org.elasticsearch.gradle.ElasticsearchJavaPlugin;
+import org.elasticsearch.gradle.test.RestIntegTestTask;
+import org.elasticsearch.gradle.testclusters.TestClustersPlugin;
+import org.elasticsearch.gradle.util.GradleUtils;
+import org.gradle.api.Plugin;
+import org.gradle.api.Project;
+import org.gradle.api.plugins.JavaBasePlugin;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
+
+import static org.elasticsearch.gradle.test.rest.RestTestUtil.setupDependencies;
+import static org.elasticsearch.gradle.test.rest.RestTestUtil.setupRunnerTask;
+import static org.elasticsearch.gradle.test.rest.RestTestUtil.setupTask;
+
+/**
+ * Apply this plugin to run the Java based REST tests.
+ */
+public class JavaRestTestPlugin implements Plugin<Project> {
+
+    public static final String SOURCE_SET_NAME = "javaRestTest";
+
+    @Override
+    public void apply(Project project) {
+
+        project.getPluginManager().apply(ElasticsearchJavaPlugin.class);
+        project.getPluginManager().apply(TestClustersPlugin.class);
+
+        // create source set
+        SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
+        SourceSet javaTestSourceSet = sourceSets.create(SOURCE_SET_NAME);
+
+        // setup the javaRestTest task
+        RestIntegTestTask javaRestTestTask = setupTask(project, SOURCE_SET_NAME);
+
+        // setup the runner task
+        setupRunnerTask(project, javaRestTestTask, javaTestSourceSet);
+
+        // setup dependencies
+        setupDependencies(project, javaTestSourceSet);
+
+        // setup IDE
+        GradleUtils.setupIdeForTestSourceSet(project, javaTestSourceSet);
+
+        // wire this task into check
+        project.getTasks().named(JavaBasePlugin.CHECK_TASK_NAME).configure(check -> check.dependsOn(javaRestTestTask));
+    }
+}

buildSrc/src/main/java/org/elasticsearch/gradle/test/rest/RestTestUtil.java

@@ -0,0 +1,105 @@
+/*
+ * Licensed to Elasticsearch under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.elasticsearch.gradle.test.rest;
+
+import org.elasticsearch.gradle.VersionProperties;
+import org.elasticsearch.gradle.info.BuildParams;
+import org.elasticsearch.gradle.plugin.PluginPropertiesExtension;
+import org.elasticsearch.gradle.test.RestIntegTestTask;
+import org.elasticsearch.gradle.testclusters.RestTestRunnerTask;
+import org.gradle.api.Project;
+import org.gradle.api.plugins.JavaBasePlugin;
+import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.bundling.Zip;
+
+/**
+ * Utility class to configure the necessary tasks and dependencies.
+ */
+public class RestTestUtil {
+
+    private RestTestUtil() {}
+
+    /**
+     * Creates a task with the source set name of type {@link RestIntegTestTask}
+     */
+    static RestIntegTestTask setupTask(Project project, String sourceSetName) {
+        // create task - note can not use .register due to the work in RestIntegTestTask's constructor :(
+        // see: https://github.com/elastic/elasticsearch/issues/47804
+        RestIntegTestTask testTask = project.getTasks().create(sourceSetName, RestIntegTestTask.class);
+        testTask.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
+        testTask.setDescription("Runs the REST tests against an external cluster");
+        // make the new test run after unit tests
+        testTask.mustRunAfter(project.getTasks().named("test"));
+        return testTask;
+    }
+
+    /**
+     * Creates the runner task and configures the test clusters
+     */
+    static RestTestRunnerTask setupRunnerTask(Project project, RestIntegTestTask testTask, SourceSet sourceSet) {
+        RestTestRunnerTask runner = testTask.getRunner();
+        runner.setTestClassesDirs(sourceSet.getOutput().getClassesDirs());
+        runner.setClasspath(sourceSet.getRuntimeClasspath());
+
+        // if this a module or plugin, it may have an associated zip file with it's contents, add that to the test cluster
+        project.getPluginManager().withPlugin("elasticsearch.esplugin", plugin -> {
+            Zip bundle = (Zip) project.getTasks().getByName("bundlePlugin");
+            testTask.dependsOn(bundle);
+            if (project.getPath().startsWith(":modules:")) {
+                runner.getClusters().forEach(c -> c.module(bundle.getArchiveFile()));
+            } else {
+                runner.getClusters().forEach(c -> c.plugin(project.getObjects().fileProperty().value(bundle.getArchiveFile())));
+            }
+        });
+
+        // es-plugins may declare dependencies on additional modules, add those to the test cluster too.
+        project.afterEvaluate(p -> {
+            PluginPropertiesExtension pluginPropertiesExtension = project.getExtensions().findByType(PluginPropertiesExtension.class);
+            if (pluginPropertiesExtension != null) { // not all projects are defined as plugins
+                pluginPropertiesExtension.getExtendedPlugins().forEach(pluginName -> {
+                    Project extensionProject = project.getProject().findProject(":modules:" + pluginName);
+                    if (extensionProject != null) { // extension plugin may be defined, but not required to be a module
+                        Zip extensionBundle = (Zip) extensionProject.getTasks().getByName("bundlePlugin");
+                        testTask.dependsOn(extensionBundle);
+                        runner.getClusters().forEach(c -> c.module(extensionBundle.getArchiveFile()));
+                    }
+                });
+            }
+        });
+        return runner;
+    }
+
+    /**
+     * Setup the dependencies needed for the REST tests.
+     */
+    static void setupDependencies(Project project, SourceSet sourceSet) {
+        if (BuildParams.isInternal()) {
+            project.getDependencies().add(sourceSet.getImplementationConfigurationName(), project.project(":test:framework"));
+        } else {
+            project.getDependencies()
+                .add(
+                    sourceSet.getImplementationConfigurationName(),
+                    "org.elasticsearch.test:framework:" + VersionProperties.getElasticsearch()
+                );
+        }
+
+    }
+
+}

buildSrc/src/main/java/org/elasticsearch/gradle/test/rest/YamlRestTestPlugin.java

@@ -20,19 +20,18 @@
 package org.elasticsearch.gradle.test.rest;
 
 import org.elasticsearch.gradle.ElasticsearchJavaPlugin;
-import org.elasticsearch.gradle.VersionProperties;
-import org.elasticsearch.gradle.info.BuildParams;
-import org.elasticsearch.gradle.plugin.PluginPropertiesExtension;
 import org.elasticsearch.gradle.test.RestIntegTestTask;
-import org.elasticsearch.gradle.testclusters.RestTestRunnerTask;
 import org.elasticsearch.gradle.testclusters.TestClustersPlugin;
 import org.elasticsearch.gradle.util.GradleUtils;
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.plugins.JavaBasePlugin;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.SourceSetContainer;
-import org.gradle.api.tasks.bundling.Zip;
+
+import static org.elasticsearch.gradle.test.rest.RestTestUtil.setupDependencies;
+import static org.elasticsearch.gradle.test.rest.RestTestUtil.setupRunnerTask;
+import static org.elasticsearch.gradle.test.rest.RestTestUtil.setupTask;
 
 /**
  * Apply this plugin to run the YAML based REST tests.
@@ -44,37 +43,22 @@ public class YamlRestTestPlugin implements Plugin<Project> {
     @Override
     public void apply(Project project) {
 
-        // yaml Rest tests require a Java test runner
         project.getPluginManager().apply(ElasticsearchJavaPlugin.class);
-        // to spin up the external cluster
         project.getPluginManager().apply(TestClustersPlugin.class);
-        // to copy around the yaml tests and json spec
         project.getPluginManager().apply(RestResourcesPlugin.class);
 
-        // note - source sets are not created via org.elasticsearch.gradle.util.GradleUtils.addTestSourceSet since unlike normal tests
-        // we only want the yamlRestTestSourceSet on the classpath by default. The yaml tests should be pure black box testing over HTTP and
-        // such it should not need the main class on the class path. Also, there are some special setup steps unique to YAML REST tests.
-
         // create source set
         SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
         SourceSet yamlTestSourceSet = sourceSets.create(SOURCE_SET_NAME);
 
-        // create task - note can not use .register due to the work in RestIntegTestTask's constructor :(
-        // see: https://github.com/elastic/elasticsearch/issues/47804
-        RestIntegTestTask yamlRestTestTask = project.getTasks().create(SOURCE_SET_NAME, RestIntegTestTask.class);
-        yamlRestTestTask.setGroup(JavaBasePlugin.VERIFICATION_GROUP);
-        yamlRestTestTask.setDescription("Runs the YAML based REST tests against an external cluster");
+        // setup the yamlRestTest task
+        RestIntegTestTask yamlRestTestTask = setupTask(project, SOURCE_SET_NAME);
+
+        // setup the runner task
+        setupRunnerTask(project, yamlRestTestTask, yamlTestSourceSet);
 
-        // setup task dependency
-        if (BuildParams.isInternal()) {
-            project.getDependencies().add(yamlTestSourceSet.getImplementationConfigurationName(), project.project(":test:framework"));
-        } else {
-            project.getDependencies()
-                .add(
-                    yamlTestSourceSet.getImplementationConfigurationName(),
-                    "org.elasticsearch.test:framework:" + VersionProperties.getElasticsearch()
-                );
-        }
+        // setup the dependencies
+        setupDependencies(project, yamlTestSourceSet);
 
         // setup the copy for the rest resources
         project.getTasks().withType(CopyRestApiTask.class, copyRestApiTask -> {
@@ -83,40 +67,6 @@ public void apply(Project project) {
         });
         project.getTasks().withType(CopyRestTestsTask.class, copyRestTestTask -> { copyRestTestTask.sourceSetName = SOURCE_SET_NAME; });
 
-        // make the new test run after unit tests
-        yamlRestTestTask.mustRunAfter(project.getTasks().named("test"));
-
-        // setup the runner
-        RestTestRunnerTask runner = yamlRestTestTask.getRunner();
-        runner.setTestClassesDirs(yamlTestSourceSet.getOutput().getClassesDirs());
-        runner.setClasspath(yamlTestSourceSet.getRuntimeClasspath());
-
-        // if this a module or plugin, it may have an associated zip file with it's contents, add that to the test cluster
-        project.getPluginManager().withPlugin("elasticsearch.esplugin", plugin -> {
-            Zip bundle = (Zip) project.getTasks().getByName("bundlePlugin");
-            yamlRestTestTask.dependsOn(bundle);
-            if (project.getPath().startsWith(":modules:")) {
-                runner.getClusters().forEach(c -> c.module(bundle.getArchiveFile()));
-            } else {
-                runner.getClusters().forEach(c -> c.plugin(project.getObjects().fileProperty().value(bundle.getArchiveFile())));
-            }
-        });
-
-        // es-plugins may declare dependencies on additional modules, add those to the test cluster too.
-        project.afterEvaluate(p -> {
-            PluginPropertiesExtension pluginPropertiesExtension = project.getExtensions().findByType(PluginPropertiesExtension.class);
-            if (pluginPropertiesExtension != null) { // not all projects are defined as plugins
-                pluginPropertiesExtension.getExtendedPlugins().forEach(pluginName -> {
-                    Project extensionProject = project.getProject().findProject(":modules:" + pluginName);
-                    if (extensionProject != null) { // extension plugin may be defined, but not required to be a module
-                        Zip extensionBundle = (Zip) extensionProject.getTasks().getByName("bundlePlugin");
-                        yamlRestTestTask.dependsOn(extensionBundle);
-                        runner.getClusters().forEach(c -> c.module(extensionBundle.getArchiveFile()));
-                    }
-                });
-            }
-        });
-
         // setup IDE
         GradleUtils.setupIdeForTestSourceSet(project, yamlTestSourceSet);
 

buildSrc/src/main/resources/META-INF/gradle-plugins/elasticsearch.java-rest-test.properties

@@ -0,0 +1,20 @@
+#
+# Licensed to Elasticsearch under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+implementation-class=org.elasticsearch.gradle.test.rest.JavaRestTestPlugin

modules/aggs-matrix-stats/build.gradle

@@ -29,5 +29,3 @@ restResources {
     includeCore '_common', 'indices', 'cluster', 'index', 'search', 'nodes'
   }
 }
-
-integTest.enabled = false

modules/analysis-common/build.gradle

@@ -17,6 +17,7 @@
  * under the License.
  */
 apply plugin: 'elasticsearch.yaml-rest-test'
+apply plugin: 'elasticsearch.internal-cluster-test'
 
 esplugin {
   description 'Adds "built in" analyzers to Elasticsearch.'

modules/geo/build.gradle

@@ -31,6 +31,4 @@ restResources {
 artifacts {
   restTests(project.file('src/yamlRestTest/resources/rest-api-spec/test'))
 }
-
-integTest.enabled = false
 test.enabled = false

modules/ingest-common/build.gradle

@@ -17,6 +17,7 @@
  * under the License.
  */
 apply plugin: 'elasticsearch.yaml-rest-test'
+apply plugin: 'elasticsearch.internal-cluster-test'
 
 esplugin {
   description 'Module for ingest processors that do not require additional security permissions or have large dependencies and resources'

modules/ingest-geoip/build.gradle

@@ -43,8 +43,6 @@ restResources {
   }
 }
 
-integTest.enabled = false
-
 task copyDefaultGeoIp2DatabaseFiles(type: Copy) {
   from { zipTree(configurations.testCompileClasspath.files.find { it.name.contains('geolite2-databases') }) }
   into "${project.buildDir}/ingest-geoip"

modules/ingest-user-agent/build.gradle

@@ -33,4 +33,3 @@ testClusters.all {
   extraConfigFile 'ingest-user-agent/test-regexes.yml', file('src/test/test-regexes.yml')
 }
 
-integTest.enabled = false

modules/kibana/build.gradle

@@ -16,6 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+apply plugin: 'elasticsearch.java-rest-test'
 
 esplugin {
   description 'Plugin exposing APIs for Kibana system indices'
@@ -26,6 +27,7 @@ dependencies {
   api project(path: ':modules:reindex')
 }
 
-testClusters.integTest {
+testClusters.all {
   module file(project(':modules:reindex').tasks.bundlePlugin.archiveFile)
 }
+

modules/lang-mustache/build.gradle

@@ -17,6 +17,8 @@
  * under the License.
  */
 apply plugin: 'elasticsearch.yaml-rest-test'
+apply plugin: 'elasticsearch.java-rest-test'
+apply plugin: 'elasticsearch.internal-cluster-test'
 
 esplugin {
   description 'Mustache scripting integration for Elasticsearch'

modules/mapper-extras/build.gradle

@@ -17,6 +17,7 @@
  * under the License.
  */
 apply plugin: 'elasticsearch.yaml-rest-test'
+apply plugin: 'elasticsearch.java-rest-test'
 
 esplugin {
   description 'Adds advanced field mappers'