Skip to content

Migrate ILM REST tests to new test framework. #136744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 23, 2025
Merged

Migrate ILM REST tests to new test framework. #136744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
470feb8
Migrate ILM REST tests to new test framework.
mosche Oct 17, 2025
29b4993
fix missed ones
mosche Oct 17, 2025
ae98bce
fix test issues
mosche Oct 20, 2025
d655712
Merge branch 'main' into tests/migrate_ilm
mosche Oct 20, 2025
5978313
Merge branch 'main' into tests/migrate_ilm
mosche Oct 20, 2025
9dc3207
feedback
mosche Oct 23, 2025
e6a2550
Merge branch 'main' into tests/migrate_ilm
mosche Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions ...s-internal/src/main/java/org/elasticsearch/gradle/internal/RestrictedBuildApiService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down
1 change: 1 addition & 0 deletions test/framework/src/main/java/org/elasticsearch/test/rest/ESRestTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2594,6 +2594,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);
Expand Down
68 changes: 12 additions & 56 deletions x-pack/plugin/ilm/qa/multi-cluster/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,64 +5,20 @@
* 2.0.
*/

import org.elasticsearch.gradle.internal.test.RestIntegTestTask
import static org.elasticsearch.gradle.PropertyNormalization.IGNORE_VALUE

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')
}

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
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')
}

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)
}
100 changes: 79 additions & 21 deletions ...search/xpack/ilm/CCRIndexLifecycleIT.java → ...search/xpack/ilm/CCRIndexLifecycleIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -23,16 +26,21 @@
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.elasticsearch.xpack.ilm.action.RestPutLifecycleAction;
import org.junit.ClassRule;
import org.junit.rules.RuleChain;
import org.junit.rules.TemporaryFolder;

import java.io.IOException;
import java.io.InputStream;
Expand All @@ -52,7 +60,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 TEST_PHASE = "hot";
Expand Down Expand Up @@ -88,18 +96,69 @@ public class CCRIndexLifecycleIT extends ESCCRRestTestCase {
}
}""";

public static TemporaryFolder repoDir = new TemporaryFolder();

public static ElasticsearchCluster leaderCluster = ElasticsearchCluster.local()
.name("leader")
.module("x-pack-ilm")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For multi-cluster tests it's generally good practice to give them unique names. The default is "test-cluster" but you can use name() to customize this. This can be helpful when analyzing the logs, since the node nodes use the cluster name as a prefix. That way you can see leader-1 and follower-1 in the test output vs just test-cluster-n and have to figure out which cluster it is.

.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);
Expand Down Expand Up @@ -136,7 +195,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 + "]");
Expand All @@ -145,10 +204,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);
Expand All @@ -162,7 +221,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()
Expand Down Expand Up @@ -215,7 +274,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");
Expand All @@ -226,7 +285,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);

Expand Down Expand Up @@ -330,7 +389,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();
Expand All @@ -349,7 +408,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);

Expand Down Expand Up @@ -391,12 +450,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);

Expand Down Expand Up @@ -433,14 +492,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:
Expand Down Expand Up @@ -505,16 +564,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"
Expand Down Expand Up @@ -579,12 +637,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
Expand Down
Loading