Skip to content

Explicitly disable FeatureFlag in MetadataCreateIndexServiceTests.testCreateIndexWithContextDisabled #17384

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 6 commits into from
Feb 19, 2025
Merged

Explicitly disable FeatureFlag in MetadataCreateIndexServiceTests.testCreateIndexWithContextDisabled #17384

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7b7d162
Segregate tests in MetadataCreateIndexServiceTests that rely on Featu…
cwperks Feb 18, 2025
43fa229
Remove duplicate methods
cwperks Feb 18, 2025
cab6a75
Remove unnecessary license
cwperks Feb 18, 2025
27e9738
Explicitly disable FF
cwperks Feb 18, 2025
484dc37
Remove multiple try blocks
cwperks Feb 18, 2025
9b622cd
Clean up FF in tearDown
cwperks Feb 18, 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
264 changes: 124 additions & 140 deletions server/src/test/java/org/opensearch/cluster/metadata/MetadataCreateIndexServiceTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,14 @@ public void setupCreateIndexRequestAndAliasValidator() {
);
}

@After
public void tearDown() throws Exception {
super.tearDown();
// clear any FeatureFlags needed for individual tests
FeatureFlags.initializeFeatureFlags(Settings.EMPTY);
clusterSettings = null;
}

private ClusterState createClusterState(String name, int numShards, int numReplicas, Settings settings) {
int numRoutingShards = settings.getAsInt(IndexMetadata.INDEX_NUMBER_OF_ROUTING_SHARDS_SETTING.getKey(), numShards);
Metadata.Builder metaBuilder = Metadata.builder();
Expand Down Expand Up @@ -2304,6 +2312,8 @@ public void testIndexCreationWithIndexStoreTypeRemoteStoreThrowsException() {
}

public void testCreateIndexWithContextDisabled() throws Exception {
// Explicitly disable the FF
FeatureFlags.initializeFeatureFlags(Settings.builder().put(FeatureFlags.APPLICATION_BASED_CONFIGURATION_TEMPLATES, false).build());
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(randomAlphaOfLength(5)));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Expand Down Expand Up @@ -2337,42 +2347,35 @@ public void testCreateIndexWithContextDisabled() throws Exception {

public void testCreateIndexWithContextAbsent() throws Exception {
FeatureFlags.initializeFeatureFlags(Settings.builder().put(FeatureFlags.APPLICATION_BASED_CONFIGURATION_TEMPLATES, true).build());
try {
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(randomAlphaOfLength(5)));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Settings.EMPTY,
clusterService,
indicesServices,
null,
null,
createTestShardLimitService(randomIntBetween(1, 1000), false, clusterService),
mock(Environment.class),
IndexScopedSettings.DEFAULT_SCOPED_SETTINGS,
threadPool,
null,
new SystemIndices(Collections.emptyMap()),
false,
new AwarenessReplicaBalance(Settings.EMPTY, clusterService.getClusterSettings()),
DefaultRemoteStoreSettings.INSTANCE,
repositoriesServiceSupplier
);
CountDownLatch counter = new CountDownLatch(1);
InvalidIndexContextException exception = expectThrows(
InvalidIndexContextException.class,
() -> checkerService.validateContext(request)
);
assertTrue(
"Invalid exception message." + exception.getMessage(),
exception.getMessage().contains("index specifies a context which is not loaded on the cluster.")
);
});
} finally {
// Disable so that other tests which are not dependent on this are not impacted.
FeatureFlags.initializeFeatureFlags(
Settings.builder().put(FeatureFlags.APPLICATION_BASED_CONFIGURATION_TEMPLATES, false).build()
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(randomAlphaOfLength(5)));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Settings.EMPTY,
clusterService,
indicesServices,
null,
null,
createTestShardLimitService(randomIntBetween(1, 1000), false, clusterService),
mock(Environment.class),
IndexScopedSettings.DEFAULT_SCOPED_SETTINGS,
threadPool,
null,
new SystemIndices(Collections.emptyMap()),
false,
new AwarenessReplicaBalance(Settings.EMPTY, clusterService.getClusterSettings()),
DefaultRemoteStoreSettings.INSTANCE,
repositoriesServiceSupplier
);
}
CountDownLatch counter = new CountDownLatch(1);
InvalidIndexContextException exception = expectThrows(
InvalidIndexContextException.class,
() -> checkerService.validateContext(request)
);
assertTrue(
"Invalid exception message." + exception.getMessage(),
exception.getMessage().contains("index specifies a context which is not loaded on the cluster.")
);
});
}

public void testApplyContext() throws IOException {
Expand Down Expand Up @@ -2420,63 +2423,56 @@ public void testApplyContext() throws IOException {
}

String contextName = randomAlphaOfLength(5);
try {
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(contextName));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Settings.EMPTY,
clusterService,
indicesServices,
null,
null,
createTestShardLimitService(randomIntBetween(1, 1000), false, clusterService),
mock(Environment.class),
IndexScopedSettings.DEFAULT_SCOPED_SETTINGS,
threadPool,
null,
new SystemIndices(Collections.emptyMap()),
false,
new AwarenessReplicaBalance(Settings.EMPTY, clusterService.getClusterSettings()),
DefaultRemoteStoreSettings.INSTANCE,
repositoriesServiceSupplier
);
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(contextName));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Settings.EMPTY,
clusterService,
indicesServices,
null,
null,
createTestShardLimitService(randomIntBetween(1, 1000), false, clusterService),
mock(Environment.class),
IndexScopedSettings.DEFAULT_SCOPED_SETTINGS,
threadPool,
null,
new SystemIndices(Collections.emptyMap()),
false,
new AwarenessReplicaBalance(Settings.EMPTY, clusterService.getClusterSettings()),
DefaultRemoteStoreSettings.INSTANCE,
repositoriesServiceSupplier
);

ClusterState mockState = mock(ClusterState.class);
Metadata metadata = mock(Metadata.class);

when(mockState.metadata()).thenReturn(metadata);
when(metadata.systemTemplatesLookup()).thenReturn(Map.of(contextName, new TreeMap<>() {
{
put(1L, contextName);
}
}));
when(metadata.componentTemplates()).thenReturn(Map.of(contextName, componentTemplate.get()));

try {
Template template = checkerService.applyContext(request, mockState, allMappings, settingsBuilder);
assertEquals(componentTemplate.get().template(), template);

assertEquals(2, allMappings.size());
assertEquals(mappings, allMappings.get(0));
assertEquals(
MapperService.parseMapping(NamedXContentRegistry.EMPTY, componentTemplate.get().template().mappings().toString()),
allMappings.get(1)
);

assertEquals("60s", settingsBuilder.get(INDEX_REFRESH_INTERVAL_SETTING.getKey()));
assertEquals("log_byte_size", settingsBuilder.get(INDEX_MERGE_POLICY.getKey()));
assertEquals("best_compression", settingsBuilder.get(EngineConfig.INDEX_CODEC_SETTING.getKey()));
assertEquals("false", settingsBuilder.get(INDEX_SOFT_DELETES_SETTING.getKey()));
} catch (IOException ex) {
throw new AssertionError(ex);
ClusterState mockState = mock(ClusterState.class);
Metadata metadata = mock(Metadata.class);

when(mockState.metadata()).thenReturn(metadata);
when(metadata.systemTemplatesLookup()).thenReturn(Map.of(contextName, new TreeMap<>() {
{
put(1L, contextName);
}
});
} finally {
// Disable so that other tests which are not dependent on this are not impacted.
FeatureFlags.initializeFeatureFlags(
Settings.builder().put(FeatureFlags.APPLICATION_BASED_CONFIGURATION_TEMPLATES, false).build()
);
}
}));
when(metadata.componentTemplates()).thenReturn(Map.of(contextName, componentTemplate.get()));

try {
Template template = checkerService.applyContext(request, mockState, allMappings, settingsBuilder);
assertEquals(componentTemplate.get().template(), template);

assertEquals(2, allMappings.size());
assertEquals(mappings, allMappings.get(0));
assertEquals(
MapperService.parseMapping(NamedXContentRegistry.EMPTY, componentTemplate.get().template().mappings().toString()),
allMappings.get(1)
);

assertEquals("60s", settingsBuilder.get(INDEX_REFRESH_INTERVAL_SETTING.getKey()));
assertEquals("log_byte_size", settingsBuilder.get(INDEX_MERGE_POLICY.getKey()));
assertEquals("best_compression", settingsBuilder.get(EngineConfig.INDEX_CODEC_SETTING.getKey()));
assertEquals("false", settingsBuilder.get(INDEX_SOFT_DELETES_SETTING.getKey()));
} catch (IOException ex) {
throw new AssertionError(ex);
}
});
}

public void testApplyContextWithSettingsOverlap() throws IOException {
Expand Down Expand Up @@ -2508,55 +2504,48 @@ public void testApplyContextWithSettingsOverlap() throws IOException {
}

String contextName = randomAlphaOfLength(5);
try {
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(contextName));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Settings.EMPTY,
clusterService,
indicesServices,
null,
null,
createTestShardLimitService(randomIntBetween(1, 1000), false, clusterService),
mock(Environment.class),
IndexScopedSettings.DEFAULT_SCOPED_SETTINGS,
threadPool,
null,
new SystemIndices(Collections.emptyMap()),
false,
new AwarenessReplicaBalance(Settings.EMPTY, clusterService.getClusterSettings()),
DefaultRemoteStoreSettings.INSTANCE,
repositoriesServiceSupplier
);
request = new CreateIndexClusterStateUpdateRequest("create index", "test", "test").context(new Context(contextName));
withTemporaryClusterService((clusterService, threadPool) -> {
MetadataCreateIndexService checkerService = new MetadataCreateIndexService(
Settings.EMPTY,
clusterService,
indicesServices,
null,
null,
createTestShardLimitService(randomIntBetween(1, 1000), false, clusterService),
mock(Environment.class),
IndexScopedSettings.DEFAULT_SCOPED_SETTINGS,
threadPool,
null,
new SystemIndices(Collections.emptyMap()),
false,
new AwarenessReplicaBalance(Settings.EMPTY, clusterService.getClusterSettings()),
DefaultRemoteStoreSettings.INSTANCE,
repositoriesServiceSupplier
);

ClusterState mockState = mock(ClusterState.class);
Metadata metadata = mock(Metadata.class);
ClusterState mockState = mock(ClusterState.class);
Metadata metadata = mock(Metadata.class);

when(mockState.metadata()).thenReturn(metadata);
when(metadata.systemTemplatesLookup()).thenReturn(Map.of(contextName, new TreeMap<>() {
{
put(1L, contextName);
}
}));
when(metadata.componentTemplates()).thenReturn(Map.of(contextName, componentTemplate.get()));
when(mockState.metadata()).thenReturn(metadata);
when(metadata.systemTemplatesLookup()).thenReturn(Map.of(contextName, new TreeMap<>() {
{
put(1L, contextName);
}
}));
when(metadata.componentTemplates()).thenReturn(Map.of(contextName, componentTemplate.get()));

ValidationException validationException = expectThrows(
ValidationException.class,
() -> checkerService.applyContext(request, mockState, List.of(), settingsBuilder)
);
assertEquals(1, validationException.validationErrors().size());
assertTrue(
"Invalid exception message: " + validationException.getMessage(),
validationException.getMessage()
.contains("Cannot apply context template as user provide settings have overlap with the included context template")
);
});
} finally {
// Disable so that other tests which are not dependent on this are not impacted.
FeatureFlags.initializeFeatureFlags(
Settings.builder().put(FeatureFlags.APPLICATION_BASED_CONFIGURATION_TEMPLATES, false).build()
ValidationException validationException = expectThrows(
ValidationException.class,
() -> checkerService.applyContext(request, mockState, List.of(), settingsBuilder)
);
}
assertEquals(1, validationException.validationErrors().size());
assertTrue(
"Invalid exception message: " + validationException.getMessage(),
validationException.getMessage()
.contains("Cannot apply context template as user provide settings have overlap with the included context template")
);
});
}

private IndexTemplateMetadata addMatchingTemplate(Consumer<IndexTemplateMetadata.Builder> configurator) {
Expand Down Expand Up @@ -2632,9 +2621,4 @@ private DiscoveryNode getRemoteNode() {
);
}

@After
public void shutdown() throws Exception {
clusterSettings = null;
}

}
Loading