Rollup: Consolidate rollup cleanup for http tests

client/rest-high-level/src/test/java/org/elasticsearch/client/RollupIT.java

@@ -208,8 +208,7 @@ public void testPutAndGetRollupJob() throws Exception {
             }
         });
 
-        // TODO when we move cleaning rollup into ESTestCase we can randomly choose the _all version of this request
-        GetRollupJobRequest getRollupJobRequest = new GetRollupJobRequest(id);
+        GetRollupJobRequest getRollupJobRequest = randomBoolean() ? new GetRollupJobRequest() : new GetRollupJobRequest(id);
         GetRollupJobResponse getResponse = execute(getRollupJobRequest, rollupClient::getRollupJob, rollupClient::getRollupJobAsync);
         assertThat(getResponse.getJobs(), hasSize(1));
         JobWrapper job = getResponse.getJobs().get(0);

client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/RollupDocumentationIT.java

@@ -27,9 +27,7 @@
 import org.elasticsearch.action.index.IndexRequest;
 import org.elasticsearch.action.support.WriteRequest;
 import org.elasticsearch.client.ESRestHighLevelClientTestCase;
-import org.elasticsearch.client.Request;
 import org.elasticsearch.client.RequestOptions;
-import org.elasticsearch.client.Response;
 import org.elasticsearch.client.RestHighLevelClient;
 import org.elasticsearch.client.rollup.GetRollupJobRequest;
 import org.elasticsearch.client.rollup.GetRollupJobResponse;
@@ -47,21 +45,15 @@
 import org.elasticsearch.client.rollup.job.config.RollupJobConfig;
 import org.elasticsearch.client.rollup.job.config.TermsGroupConfig;
 import org.elasticsearch.common.unit.TimeValue;
-import org.elasticsearch.common.xcontent.support.XContentMapValues;
 import org.elasticsearch.rest.RestStatus;
 import org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval;
-import org.junit.After;
 import org.junit.Before;
 
-import java.io.BufferedReader;
 import java.io.IOException;
-import java.io.InputStreamReader;
-import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
-import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
@@ -227,62 +219,6 @@ public void onFailure(Exception e) {
         assertTrue(latch.await(30L, TimeUnit.SECONDS));
     }
 
-    @After
-    public void wipeRollup() throws Exception {
-        // TODO move this to ESRestTestCase
-        deleteRollupJobs();
-        waitForPendingRollupTasks();
-    }
-
-    private void deleteRollupJobs() throws Exception {
-        Response response = adminClient().performRequest(new Request("GET", "/_xpack/rollup/job/_all"));
-        Map<String, Object> jobs = entityAsMap(response);
-        @SuppressWarnings("unchecked")
-        List<Map<String, Object>> jobConfigs =
-                (List<Map<String, Object>>) XContentMapValues.extractValue("jobs", jobs);
-
-        if (jobConfigs == null) {
-            return;
-        }
-
-        for (Map<String, Object> jobConfig : jobConfigs) {
-            @SuppressWarnings("unchecked")
-            String jobId = (String) ((Map<String, Object>) jobConfig.get("config")).get("id");
-            Request request = new Request("DELETE", "/_xpack/rollup/job/" + jobId);
-            request.addParameter("ignore", "404"); // Ignore 404s because they imply someone was racing us to delete this
-            adminClient().performRequest(request);
-        }
-    }
-
-    private void waitForPendingRollupTasks() throws Exception {
-        assertBusy(() -> {
-            try {
-                Request request = new Request("GET", "/_cat/tasks");
-                request.addParameter("detailed", "true");
-                Response response = adminClient().performRequest(request);
-
-                try (BufferedReader responseReader = new BufferedReader(
-                        new InputStreamReader(response.getEntity().getContent(), StandardCharsets.UTF_8))) {
-                    int activeTasks = 0;
-                    String line;
-                    StringBuilder tasksListString = new StringBuilder();
-                    while ((line = responseReader.readLine()) != null) {
-
-                        // We only care about Rollup jobs, otherwise this fails too easily due to unrelated tasks
-                        if (line.startsWith("xpack/rollup/job") == true) {
-                            activeTasks++;
-                            tasksListString.append(line).append('\n');
-                        }
-                    }
-                    assertEquals(activeTasks + " active tasks found:\n" + tasksListString, 0, activeTasks);
-                }
-            } catch (IOException e) {
-                // Throw an assertion error so we retry
-                throw new AssertionError("Error getting active tasks list", e);
-            }
-        });
-    }
-
     public void testDeleteRollupJob() throws Exception {
         RestHighLevelClient client = highLevelClient();
 
@@ -303,8 +239,6 @@ public void testDeleteRollupJob() throws Exception {
             // Swallow any exception, this test does not test actually cancelling.
         }
 
-
-
         // tag::rollup-delete-job-execute-listener
         ActionListener<DeleteRollupJobResponse> listener = new ActionListener<DeleteRollupJobResponse>() {
             @Override
@@ -328,7 +262,5 @@ public void onFailure(Exception e) {
         // end::rollup-delete-job-execute-async
 
         assertTrue(latch.await(30L, TimeUnit.SECONDS));
-
     }
-
 }

test/framework/src/main/java/org/elasticsearch/test/rest/ESRestTestCase.java

@@ -52,8 +52,11 @@
 import org.junit.Before;
 
 import javax.net.ssl.SSLContext;
+import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.security.KeyManagementException;
@@ -206,8 +209,8 @@ protected static RestClient adminClient() {
 
     /**
      * Returns whether to preserve the state of the cluster upon completion of this test. Defaults to false. If true, overrides the value of
-     * {@link #preserveIndicesUponCompletion()}, {@link #preserveTemplatesUponCompletion()}, {@link #preserveReposUponCompletion()}, and
-     * {@link #preserveSnapshotsUponCompletion()}.
+     * {@link #preserveIndicesUponCompletion()}, {@link #preserveTemplatesUponCompletion()}, {@link #preserveReposUponCompletion()},
+     * {@link #preserveSnapshotsUponCompletion()}, and {@link #preserveRollupJobsUponCompletion()}.
      *
      * @return true if the state of the cluster should be preserved
      */
@@ -263,7 +266,18 @@ protected boolean preserveSnapshotsUponCompletion() {
         return false;
     }
 
-    private void wipeCluster() throws IOException {
+    /**
+     * Returns whether to preserve the rollup jobs of this test. Defaults to
+     * not preserving them. Only runs at all if xpack is installed on the
+     * cluster being tested.
+     */
+    protected boolean preserveRollupJobsUponCompletion() {
+        return false;
+    }
+
+    private void wipeCluster() throws Exception {
+        boolean hasXPack = hasXPack();
+
         if (preserveIndicesUponCompletion() == false) {
             // wipe indices
             try {
@@ -278,7 +292,7 @@ private void wipeCluster() throws IOException {
 
         // wipe index templates
         if (preserveTemplatesUponCompletion() == false) {
-            if (hasXPack()) {
+            if (hasXPack) {
                 /*
                  * Delete only templates that xpack doesn't automatically
                  * recreate. Deleting them doesn't hurt anything, but it
@@ -310,6 +324,11 @@ private void wipeCluster() throws IOException {
         if (preserveClusterSettings() == false) {
             wipeClusterSettings();
         }
+
+        if (hasXPack && false == preserveRollupJobsUponCompletion()) {
+            wipeRollupJobs();
+            waitForPendingRollupTasks();
+        }
     }
 
     /**
@@ -372,6 +391,56 @@ private void wipeClusterSettings() throws IOException {
         }
     }
 
+    private void wipeRollupJobs() throws IOException {
+        Response response = adminClient().performRequest(new Request("GET", "/_xpack/rollup/job/_all"));
+        Map<String, Object> jobs = entityAsMap(response);
+        @SuppressWarnings("unchecked")
+        List<Map<String, Object>> jobConfigs =
+                (List<Map<String, Object>>) XContentMapValues.extractValue("jobs", jobs);
+
+        if (jobConfigs == null) {
+            return;
+        }
+
+        for (Map<String, Object> jobConfig : jobConfigs) {
+            @SuppressWarnings("unchecked")
+            String jobId = (String) ((Map<String, Object>) jobConfig.get("config")).get("id");
+            Request request = new Request("DELETE", "/_xpack/rollup/job/" + jobId);
+            request.addParameter("ignore", "404"); // Ignore 404s because they imply someone was racing us to delete this
+            logger.debug("deleting rollup job [{}]", jobId);
+            adminClient().performRequest(request);
+        }
+    }
+
+    private void waitForPendingRollupTasks() throws Exception {
+        assertBusy(() -> {
+            try {
+                Request request = new Request("GET", "/_cat/tasks");
+                request.addParameter("detailed", "true");
+                Response response = adminClient().performRequest(request);
+
+                try (BufferedReader responseReader = new BufferedReader(
+                        new InputStreamReader(response.getEntity().getContent(), StandardCharsets.UTF_8))) {
+                    int activeTasks = 0;
+                    String line;
+                    StringBuilder tasksListString = new StringBuilder();
+                    while ((line = responseReader.readLine()) != null) {
+
+                        // We only care about Rollup jobs, otherwise this fails too easily due to unrelated tasks
+                        if (line.startsWith("xpack/rollup/job") == true) {
+                            activeTasks++;
+                            tasksListString.append(line).append('\n');
+                        }
+                    }
+                    assertEquals(activeTasks + " active tasks found:\n" + tasksListString, 0, activeTasks);
+                }
+            } catch (IOException e) {
+                // Throw an assertion error so we retry
+                throw new AssertionError("Error getting active tasks list", e);
+            }
+        });
+    }
+
     /**
      * Logs a message if there are still running tasks. The reasoning is that any tasks still running are state the is trying to bleed into
      * other tests.

test/framework/src/main/java/org/elasticsearch/upgrades/AbstractFullClusterRestartTestCase.java

@@ -62,4 +62,8 @@ protected boolean preserveClusterSettings() {
         return true;
     }
 
+    @Override
+    protected boolean preserveRollupJobsUponCompletion() {
+        return true;
+    }
 }

x-pack/docs/src/test/java/org/elasticsearch/smoketest/XDocsClientYamlTestSuiteIT.java

@@ -120,12 +120,6 @@ protected boolean isMachineLearningTest() {
         return testName != null && (testName.contains("ml/") || testName.contains("ml\\"));
     }
 
-    @Override
-    protected boolean isRollupTest() {
-        String testName = getTestName();
-        return testName != null && (testName.contains("rollup/") || testName.contains("rollup\\"));
-    }
-
     /**
      * Deletes users after every test just in case any test adds any.
      */