[8.19] Migrate ILM REST tests to new test framework. (#136744) (#137091)

* Migrate ILM REST tests to new test framework. (#136744)

I'll follow up consolidating the projects in another PR. This felt
easier to review if migrating in place.

Relates to ES-11813

(cherry picked from commit 440faee)

# Conflicts:
#	x-pack/plugin/ilm/qa/multi-cluster/build.gradle
#	x-pack/plugin/ilm/qa/multi-cluster/src/javaRestTest/java/org/elasticsearch/xpack/ilm/CCRIndexLifecycleIT.java
#	x-pack/plugin/ilm/qa/multi-node/build.gradle
#	x-pack/plugin/ilm/qa/multi-node/src/javaRestTest/java/org/elasticsearch/xpack/ilm/actions/SearchableSnapshotActionIT.java
#	x-pack/plugin/ilm/qa/rest/build.gradle
#	x-pack/plugin/ilm/qa/with-security/build.gradle

* [CI] Auto commit changes from spotless

* fix

---------

Co-authored-by: elasticsearchmachine <[email protected]>

Author: mosche

build-tools-internal/src/main/java/org/elasticsearch/gradle/internal/RestrictedBuildApiService.java

@@ -61,9 +61,6 @@ private static ListMultimap<Class<?>, String> createLegacyRestTestBasePluginUsag
         map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:eql:qa:correctness");
         map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:eql:qa:mixed-node");
         map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:identity-provider:qa:idp-rest-tests");
-        map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:ilm:qa:multi-cluster");
-        map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:ilm:qa:multi-node");
-        map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:ilm:qa:rest");
         map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:ml:qa:basic-multi-node");
         map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:ml:qa:disabled");
         map.put(LegacyRestTestBasePlugin.class, ":x-pack:plugin:ml:qa:ml-with-security");

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

@@ -2552,6 +2552,7 @@ public static Optional<Version> parseLegacyVersion(String version) {
     protected static void waitForActiveLicense(final RestClient restClient) throws Exception {
         assertBusy(() -> {
             final Request request = new Request(HttpGet.METHOD_NAME, "/_xpack");
+            request.addParameter("categories", "license");
             request.setOptions(RequestOptions.DEFAULT.toBuilder());
 
             final Response response = restClient.performRequest(request);

x-pack/plugin/ilm/qa/multi-cluster/build.gradle

@@ -1,62 +1,24 @@
-import org.elasticsearch.gradle.internal.test.RestIntegTestTask
-import org.elasticsearch.gradle.internal.info.BuildParams
-import static org.elasticsearch.gradle.PropertyNormalization.IGNORE_VALUE
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
 
-apply plugin: 'elasticsearch.internal-testclusters'
-apply plugin: 'elasticsearch.standalone-rest-test'
+apply plugin: 'elasticsearch.internal-java-rest-test'
 
 dependencies {
-  testImplementation project(':x-pack:plugin:core')
-  testImplementation project(':x-pack:plugin:ilm')
+  javaRestTestImplementation(testArtifact(project(xpackModule('core'))))
+  javaRestTestImplementation(testArtifact(project(xpackModule('ccr')), 'javaRestTest'))
+  javaRestTestImplementation project(xpackModule('ilm'))
+
+  clusterModules project(xpackModule('ilm'))
+  clusterModules project(xpackModule('ccr'))
+  clusterModules project(xpackModule('searchable-snapshots'))
+  clusterModules project(':modules:data-streams')
 }
 
-File repoDir = file("$buildDir/testclusters/repo")
-
-tasks.register('leader-cluster', RestIntegTestTask) {
-  mustRunAfter("precommit")
-    systemProperty 'tests.target_cluster', 'leader'
-    /* To support taking index snapshots, we have to set path.repo setting */
-    nonInputProperties.systemProperty 'tests.path.repo', repoDir.absolutePath
-}
-
-testClusters.matching { it.name == 'leader-cluster' }.configureEach {
-  testDistribution = 'DEFAULT'
-  setting 'path.repo', repoDir.absolutePath, IGNORE_VALUE
-  setting 'xpack.ccr.enabled', 'true'
-  setting 'xpack.security.enabled', 'false'
-  setting 'xpack.watcher.enabled', 'false'
-  setting 'xpack.ml.enabled', 'false'
-  setting 'xpack.license.self_generated.type', 'trial'
-  setting 'indices.lifecycle.poll_interval', '1000ms'
-}
-
-tasks.register('follow-cluster', RestIntegTestTask) {
-  dependsOn tasks.findByName('leader-cluster')
-  useCluster testClusters.named('leader-cluster')
-  systemProperty 'tests.target_cluster', 'follow'
-  nonInputProperties.systemProperty 'tests.leader_host',
-    "${-> testClusters."leader-cluster".getAllHttpSocketURI().get(0)}"
-  nonInputProperties.systemProperty 'tests.leader_remote_cluster_seed',
-    "${-> testClusters.'leader-cluster'.getAllTransportPortURI().get(0)}"
-  /* To support taking index snapshots, we have to set path.repo setting */
-  nonInputProperties.systemProperty 'tests.path.repo', repoDir.absolutePath
-}
-
-testClusters.matching{ it.name == 'follow-cluster' }.configureEach {
-  testDistribution = 'DEFAULT'
-  setting 'path.repo', repoDir.absolutePath, IGNORE_VALUE
-  setting 'xpack.ccr.enabled', 'true'
-  setting 'xpack.security.enabled', 'false'
-  setting 'xpack.watcher.enabled', 'false'
-  setting 'xpack.ml.enabled', 'false'
-  setting 'xpack.license.self_generated.type', 'trial'
-  setting 'indices.lifecycle.poll_interval', '1000ms'
-  setting 'cluster.remote.leader_cluster.seeds',
-    { "\"${testClusters.'leader-cluster'.getAllTransportPortURI().get(0)}\"" }, IGNORE_VALUE
-}
-
-tasks.named("check").configure { dependsOn 'follow-cluster' }
-// Security is explicitly disabled for follow-cluster and leader-cluster, do not run these in FIPS mode
-tasks.withType(Test).configureEach {
-  enabled = buildParams.inFipsJvm == false
+tasks.named("javaRestTest") {
+  // Security is explicitly disabled for follow-cluster and leader-cluster, do not run these in FIPS mode
+  buildParams.withFipsEnabledOnly(it)
 }

x-pack/plugin/ilm/qa/multi-cluster/src/test/java/org/elasticsearch/xpack/ilm/CCRIndexLifecycleIT.java renamed to x-pack/plugin/ilm/qa/multi-cluster/src/javaRestTest/java/org/elasticsearch/xpack/ilm/CCRIndexLifecycleIT.java

@@ -6,6 +6,9 @@
  */
 package org.elasticsearch.xpack.ilm;
 
+import com.carrotsearch.randomizedtesting.annotations.Name;
+import com.carrotsearch.randomizedtesting.annotations.ParametersFactory;
+
 import org.apache.http.entity.ContentType;
 import org.apache.http.entity.StringEntity;
 import org.apache.http.util.EntityUtils;
@@ -22,15 +25,20 @@
 import org.elasticsearch.common.xcontent.XContentHelper;
 import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.rest.RestStatus;
+import org.elasticsearch.test.cluster.ElasticsearchCluster;
 import org.elasticsearch.xcontent.ObjectPath;
 import org.elasticsearch.xcontent.XContentBuilder;
 import org.elasticsearch.xcontent.XContentType;
 import org.elasticsearch.xcontent.json.JsonXContent;
+import org.elasticsearch.xpack.ccr.AbstractCCRRestTestCase;
 import org.elasticsearch.xpack.core.ilm.LifecycleAction;
 import org.elasticsearch.xpack.core.ilm.LifecyclePolicy;
 import org.elasticsearch.xpack.core.ilm.Phase;
 import org.elasticsearch.xpack.core.ilm.UnfollowAction;
 import org.elasticsearch.xpack.core.ilm.WaitUntilTimeSeriesEndTimePassesStep;
+import org.junit.ClassRule;
+import org.junit.rules.RuleChain;
+import org.junit.rules.TemporaryFolder;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -50,7 +58,7 @@
 import static org.hamcrest.Matchers.notNullValue;
 import static org.hamcrest.Matchers.nullValue;
 
-public class CCRIndexLifecycleIT extends ESCCRRestTestCase {
+public class CCRIndexLifecycleIT extends AbstractCCRRestTestCase {
 
     private static final Logger LOGGER = LogManager.getLogger(CCRIndexLifecycleIT.class);
     private static final String TSDB_INDEX_TEMPLATE = """
@@ -85,18 +93,69 @@ public class CCRIndexLifecycleIT extends ESCCRRestTestCase {
             }
         }""";
 
+    public static TemporaryFolder repoDir = new TemporaryFolder();
+
+    public static ElasticsearchCluster leaderCluster = ElasticsearchCluster.local()
+        .name("leader")
+        .module("x-pack-ilm")
+        .module("x-pack-ccr")
+        .module("searchable-snapshots")
+        .module("data-streams")
+        .setting("path.repo", () -> repoDir.getRoot().getAbsolutePath())
+        .setting("xpack.ccr.enabled", "true")
+        .setting("xpack.security.enabled", "false")
+        .setting("xpack.license.self_generated.type", "trial")
+        .setting("indices.lifecycle.poll_interval", "1000ms")
+        .build();
+
+    public static ElasticsearchCluster followerCluster = ElasticsearchCluster.local()
+        .name("follower")
+        .module("x-pack-ilm")
+        .module("x-pack-ccr")
+        .module("searchable-snapshots")
+        .module("data-streams")
+        .setting("path.repo", () -> repoDir.getRoot().getAbsolutePath())
+        .setting("xpack.ccr.enabled", "true")
+        .setting("xpack.security.enabled", "false")
+        .setting("xpack.license.self_generated.type", "trial")
+        .setting("indices.lifecycle.poll_interval", "1000ms")
+        .setting("cluster.remote.leader_cluster.seeds", () -> "\"" + leaderCluster.getTransportEndpoints() + "\"")
+        .build();
+
+    @ClassRule
+    public static RuleChain ruleChain = RuleChain.outerRule(repoDir).around(leaderCluster).around(followerCluster);
+
+    public CCRIndexLifecycleIT(@Name("targetCluster") TargetCluster targetCluster) {
+        super(targetCluster);
+    }
+
+    @ParametersFactory
+    public static Iterable<Object[]> parameters() throws Exception {
+        return leaderFollower();
+    }
+
+    @Override
+    protected ElasticsearchCluster getFollowerCluster() {
+        return followerCluster;
+    }
+
+    @Override
+    protected ElasticsearchCluster getLeaderCluster() {
+        return leaderCluster;
+    }
+
     public void testBasicCCRAndILMIntegration() throws Exception {
         String indexName = "logs-1";
 
         String policyName = "basic-test";
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             putILMPolicy(policyName, "50GB", null, TimeValue.timeValueHours(7 * 24));
             Settings indexSettings = indexSettings(1, 0).put("index.lifecycle.name", policyName)
                 .put("index.lifecycle.rollover_alias", "logs")
                 .build();
             createIndex(indexName, indexSettings, "", "\"logs\": { }");
             ensureGreen(indexName);
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             // Policy with the same name must exist in follower cluster too:
             putILMPolicy(policyName, "50GB", null, TimeValue.timeValueHours(7 * 24));
             followIndex(indexName, indexName);
@@ -133,7 +192,7 @@ public void testBasicCCRAndILMIntegration() throws Exception {
                     // ILM should have unfollowed the follower index, so the following_index setting should have been removed:
                     // (this controls whether the follow engine is used)
                     assertThat(getIndexSetting(client(), indexName, "index.xpack.ccr.following_index"), nullValue());
-                });
+                }, 30, TimeUnit.SECONDS);
             }
         } else {
             fail("unexpected target cluster [" + targetCluster + "]");
@@ -142,10 +201,10 @@ public void testBasicCCRAndILMIntegration() throws Exception {
 
     public void testCCRUnfollowDuringSnapshot() throws Exception {
         String indexName = "unfollow-test-index";
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             createIndex(adminClient(), indexName, indexSettings(2, 0).build());
             ensureGreen(indexName);
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             createNewSingletonPolicy("unfollow-only", "hot", UnfollowAction.INSTANCE, TimeValue.ZERO);
             followIndex(indexName, indexName);
             ensureGreen(indexName);
@@ -159,7 +218,7 @@ public void testCCRUnfollowDuringSnapshot() throws Exception {
                         .field("type", "fs")
                         .startObject("settings")
                         .field("compress", randomBoolean())
-                        .field("location", System.getProperty("tests.path.repo"))
+                        .field("location", repoDir.getRoot().getAbsolutePath())
                         .field("max_snapshot_bytes_per_sec", "256b")
                         .endObject()
                         .endObject()
@@ -212,7 +271,7 @@ public void testCcrAndIlmWithRollover() throws Exception {
         String nextIndexName = "mymetrics-000002";
         String policyName = "rollover-test";
 
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             // Create a policy on the leader
             putILMPolicy(policyName, null, 1, null);
             Request templateRequest = new Request("PUT", "/_index_template/my_template");
@@ -223,7 +282,7 @@ public void testCcrAndIlmWithRollover() throws Exception {
                 "{\"index_patterns\":  [\"mymetrics-*\"], \"template\":{\"settings\":  " + Strings.toString(indexSettings) + "}}"
             );
             assertOK(client().performRequest(templateRequest));
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             // Policy with the same name must exist in follower cluster too:
             putILMPolicy(policyName, null, 1, null);
 
@@ -327,7 +386,7 @@ public void testAliasReplicatedOnShrink() throws Exception {
         final String policyName = "shrink-test-policy";
         final int numberOfAliases = randomIntBetween(0, 4);
 
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             // this policy won't exist on the leader, that's fine
             Settings indexSettings = indexSettings(3, 0).put("index.lifecycle.name", policyName).build();
             final StringBuilder aliases = new StringBuilder();
@@ -346,7 +405,7 @@ public void testAliasReplicatedOnShrink() throws Exception {
             }
             createIndex(indexName, indexSettings, "", aliases.toString());
             ensureGreen(indexName);
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             // Create a policy with just a Shrink action on the follower
             putShrinkOnlyPolicy(client(), policyName);
 
@@ -388,12 +447,12 @@ public void testUnfollowInjectedBeforeShrink() throws Exception {
         final String indexName = "shrink-test";
         final String policyName = "shrink-test-policy";
 
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             // this policy won't exist on the leader, that's fine
             Settings indexSettings = indexSettings(3, 0).put("index.lifecycle.name", policyName).build();
             createIndex(indexName, indexSettings, "", "");
             ensureGreen(indexName);
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             // Create a policy with just a Shrink action on the follower
             putShrinkOnlyPolicy(client(), policyName);
 
@@ -430,14 +489,14 @@ public void testUnfollowInjectedBeforeShrink() throws Exception {
     public void testCannotShrinkLeaderIndex() throws Exception {
         String indexName = "shrink-leader-test";
         String policyName = "shrink-leader-test-policy";
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             // Set up the policy and index, but don't attach the policy yet,
             // otherwise it'll proceed through shrink before we can set up the
             // follower
             putShrinkOnlyPolicy(client(), policyName);
             createIndex(indexName, indexSettings(2, 0).build(), "", "");
             ensureGreen(indexName);
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
 
             try (RestClient leaderClient = buildLeaderClient()) {
                 // Policy with the same name must exist in follower cluster too:
@@ -502,16 +561,15 @@ public void testILMUnfollowFailsToRemoveRetentionLeases() throws Exception {
         final String followerIndex = "follower";
         final String policyName = "unfollow_only_policy";
 
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             Settings indexSettings = indexSettings(1, 0).put("index.lifecycle.name", policyName) // this policy won't exist on the leader,
                                                                                                  // that's fine
                 .build();
             createIndex(leaderIndex, indexSettings, "", "");
             ensureGreen(leaderIndex);
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             try (RestClient leaderClient = buildLeaderClient()) {
-                String leaderRemoteClusterSeed = System.getProperty("tests.leader_remote_cluster_seed");
-                configureRemoteClusters("other_remote", leaderRemoteClusterSeed);
+                configureRemoteClusters("other_remote", leaderCluster.getTransportEndpoints());
                 assertBusy(() -> {
                     Map<?, ?> localConnection = (Map<?, ?>) toMap(client().performRequest(new Request("GET", "/_remote/info"))).get(
                         "other_remote"
@@ -576,12 +634,12 @@ public void testTsdbLeaderIndexRolloverAndSyncAfterWaitUntilEndTime() throws Exc
         String dataStream = "tsdb-index-cpu";
         String policyName = "tsdb-policy";
 
-        if ("leader".equals(targetCluster)) {
+        if (targetCluster == TargetCluster.LEADER) {
             putILMPolicy(policyName, null, 1, null);
             Request templateRequest = new Request("PUT", "/_index_template/tsdb_template");
             templateRequest.setJsonEntity(Strings.format(TSDB_INDEX_TEMPLATE, indexPattern, policyName));
             assertOK(client().performRequest(templateRequest));
-        } else if ("follow".equals(targetCluster)) {
+        } else if (targetCluster == TargetCluster.FOLLOWER) {
             // Use unfollow-only policy for follower cluster instead of regular ILM policy
             // Follower clusters should not have their own rollover actions as they are meant
             // to follow the rollover behavior of the leader index, not initiate their own rollovers