Update tests for ElasticsearchNodeCommand #129240
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,23 +9,30 @@ | |
|
|
||
| package org.elasticsearch.cluster.coordination; | ||
|
|
||
| import org.elasticsearch.TransportVersion; | ||
| import org.elasticsearch.cluster.ClusterModule; | ||
| import org.elasticsearch.cluster.ClusterState; | ||
| import org.elasticsearch.cluster.metadata.IndexGraveyard; | ||
| import org.elasticsearch.cluster.metadata.IndexMetadata; | ||
| import org.elasticsearch.cluster.metadata.Metadata; | ||
| import org.elasticsearch.common.UUIDs; | ||
| import org.elasticsearch.common.settings.ClusterSettings; | ||
| import org.elasticsearch.common.settings.Settings; | ||
| import org.elasticsearch.core.Tuple; | ||
| import org.elasticsearch.env.Environment; | ||
| import org.elasticsearch.env.TestEnvironment; | ||
| import org.elasticsearch.gateway.PersistedClusterStateService; | ||
| import org.elasticsearch.index.Index; | ||
| import org.elasticsearch.indices.IndicesModule; | ||
| import org.elasticsearch.test.ESTestCase; | ||
| import org.elasticsearch.test.TestClusterCustomMetadata; | ||
| import org.elasticsearch.test.TestProjectCustomMetadata; | ||
| import org.elasticsearch.xcontent.NamedXContentRegistry; | ||
| import org.elasticsearch.xcontent.ParseField; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.file.Path; | ||
| import java.util.EnumSet; | ||
| import java.util.List; | ||
| import java.util.function.Function; | ||
| import java.util.stream.Stream; | ||
|
|
@@ -38,61 +45,101 @@ | |
|
|
||
| public class ElasticsearchNodeCommandTests extends ESTestCase { | ||
|
|
||
| public void testLoadStateWithoutMissingCustomsButPreserved() throws IOException { | ||
| runLoadStateTest(false); | ||
| } | ||
|
|
||
| public void testLoadStateWithMissingCustomsButPreserved() throws IOException { | ||
| runLoadStateTest(true); | ||
| } | ||
|
|
||
| @Override | ||
| public Settings buildEnvSettings(Settings settings) { | ||
| // we control the data path in the tests, so we don't need to set it here | ||
| return settings; | ||
| } | ||
|
|
||
|
Member
Author
There was a problem hiding this comment. This is no longer correct after MP changes because it serializes metadata without |
||
|
Comment on lines
-70
to
-73
Member
Author
There was a problem hiding this comment. This round-trip does not seem to directly test |
||
| private void runLoadStateTest(boolean hasMissingCustoms) throws IOException { | ||
| final var dataPath = createTempDir(); | ||
| final Settings settings = Settings.builder() | ||
| .putList(Environment.PATH_DATA_SETTING.getKey(), List.of(dataPath.toString())) | ||
| .put(Environment.PATH_HOME_SETTING.getKey(), createTempDir().toAbsolutePath()) | ||
| .build(); | ||
|
|
||
| try (var nodeEnvironment = newNodeEnvironment(settings)) { | ||
| final var persistedClusterStateServiceWithFullRegistry = new PersistedClusterStateService( | ||
| nodeEnvironment, | ||
| xContentRegistry(), | ||
| new ClusterSettings(Settings.EMPTY, ClusterSettings.BUILT_IN_CLUSTER_SETTINGS), | ||
| () -> 0L, | ||
| () -> false | ||
| ); | ||
|
|
||
| // 1. Simulating persisting cluster state by a running node | ||
| final long initialTerm = randomNonNegativeLong(); | ||
| final Metadata initialMetadata = randomMeta(hasMissingCustoms); | ||
| final ClusterState initialState = ClusterState.builder(ClusterState.EMPTY_STATE).metadata(initialMetadata).build(); | ||
| try (var writer = persistedClusterStateServiceWithFullRegistry.createWriter()) { | ||
| writer.writeFullStateAndCommit(initialTerm, initialState); | ||
| } | ||
|
|
||
| // 2. Simulating loading the persisted cluster state by the CLI | ||
| final var persistedClusterStateServiceForNodeCommand = ElasticsearchNodeCommand.createPersistedClusterStateService( | ||
| Settings.EMPTY, | ||
| new Path[] { dataPath } | ||
| ); | ||
| final Tuple<Long, ClusterState> loadedTermAndClusterState = ElasticsearchNodeCommand.loadTermAndClusterState( | ||
| persistedClusterStateServiceForNodeCommand, | ||
| TestEnvironment.newEnvironment(settings) | ||
| ); | ||
|
|
||
| assertThat(loadedTermAndClusterState.v1(), equalTo(initialTerm)); | ||
|
|
||
| final var loadedMetadata = loadedTermAndClusterState.v2().metadata(); | ||
| assertThat(loadedMetadata.clusterUUID(), not(equalTo("_na_"))); | ||
| assertThat(loadedMetadata.clusterUUID(), equalTo(initialMetadata.clusterUUID())); | ||
| assertThat(loadedMetadata.getProject().dataStreams(), equalTo(initialMetadata.getProject().dataStreams())); | ||
| assertNotNull(loadedMetadata.getProject().custom(IndexGraveyard.TYPE)); | ||
| assertThat( | ||
| loadedMetadata.getProject().custom(IndexGraveyard.TYPE), | ||
| instanceOf(ElasticsearchNodeCommand.UnknownProjectCustom.class) | ||
| ); | ||
| if (hasMissingCustoms) { | ||
| assertThat( | ||
| loadedMetadata.getProject().custom(TestMissingProjectCustomMetadata.TYPE), | ||
| instanceOf(ElasticsearchNodeCommand.UnknownProjectCustom.class) | ||
| ); | ||
| assertThat( | ||
| loadedMetadata.custom(TestMissingClusterCustomMetadata.TYPE), | ||
| instanceOf(ElasticsearchNodeCommand.UnknownClusterCustom.class) | ||
| ); | ||
| } else { | ||
| assertNull(loadedMetadata.getProject().custom(TestMissingProjectCustomMetadata.TYPE)); | ||
| assertNull(loadedMetadata.custom(TestMissingClusterCustomMetadata.TYPE)); | ||
| } | ||
|
|
||
| final long newTerm = initialTerm + 1; | ||
| try (var writer = persistedClusterStateServiceForNodeCommand.createWriter()) { | ||
| writer.writeFullStateAndCommit(newTerm, ClusterState.builder(ClusterState.EMPTY_STATE).metadata(loadedMetadata).build()); | ||
| } | ||
|
|
||
|
Comment on lines
-86
to
-89
Member
Author
There was a problem hiding this comment. The node CLI always perserve unknown customs as long as they are either |
||
| // 3. Simulate node restart after updating on-disk state with the CLI tool | ||
| final var bestOnDiskState = persistedClusterStateServiceWithFullRegistry.loadBestOnDiskState(); | ||
| assertThat(bestOnDiskState.currentTerm, equalTo(newTerm)); | ||
| final Metadata reloadedMetadata = bestOnDiskState.metadata; | ||
| assertThat(reloadedMetadata.getProject().indexGraveyard(), equalTo(initialMetadata.getProject().indexGraveyard())); | ||
| if (hasMissingCustoms) { | ||
| assertThat( | ||
| reloadedMetadata.getProject().custom(TestMissingProjectCustomMetadata.TYPE), | ||
| equalTo(initialMetadata.getProject().custom(TestMissingProjectCustomMetadata.TYPE)) | ||
| ); | ||
| } else { | ||
| assertNull(reloadedMetadata.getProject().custom(TestMissingProjectCustomMetadata.TYPE)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private Metadata randomMeta(boolean hasMissingCustoms) { | ||
| Metadata.Builder mdBuilder = Metadata.builder(); | ||
| mdBuilder.generateClusterUuidIfNeeded(); | ||
| int numDelIndices = randomIntBetween(0, 5); | ||
|
|
@@ -109,15 +156,86 @@ private Metadata randomMeta() { | |
| } | ||
| } | ||
| mdBuilder.indexGraveyard(graveyard.build()); | ||
| if (hasMissingCustoms) { | ||
| mdBuilder.putCustom( | ||
| TestMissingProjectCustomMetadata.TYPE, | ||
| new TestMissingProjectCustomMetadata("test missing project custom metadata") | ||
| ); | ||
| mdBuilder.putCustom( | ||
| TestMissingClusterCustomMetadata.TYPE, | ||
| new TestMissingClusterCustomMetadata("test missing cluster custom metadata") | ||
| ); | ||
| } | ||
| return mdBuilder.build(); | ||
| } | ||
|
|
||
| @Override | ||
| protected NamedXContentRegistry xContentRegistry() { | ||
| return new NamedXContentRegistry( | ||
| Stream.of( | ||
| ClusterModule.getNamedXWriteables().stream(), | ||
| IndicesModule.getNamedXContents().stream(), | ||
| Stream.of( | ||
| new NamedXContentRegistry.Entry( | ||
| Metadata.ProjectCustom.class, | ||
| new ParseField(TestMissingProjectCustomMetadata.TYPE), | ||
| parser -> TestMissingProjectCustomMetadata.fromXContent(TestMissingProjectCustomMetadata::new, parser) | ||
| ), | ||
| new NamedXContentRegistry.Entry( | ||
| Metadata.ClusterCustom.class, | ||
| new ParseField(TestMissingClusterCustomMetadata.TYPE), | ||
| parser -> TestMissingClusterCustomMetadata.fromXContent(TestMissingClusterCustomMetadata::new, parser) | ||
| ) | ||
| ) | ||
| ).flatMap(Function.identity()).toList() | ||
| ); | ||
| } | ||
|
|
||
| private static class TestMissingProjectCustomMetadata extends TestProjectCustomMetadata { | ||
|
Member
Author
There was a problem hiding this comment. Actually simulating unknown (unregistered) customs.
Contributor
There was a problem hiding this comment. deserves a comment in the code to that effect - the "missing" is a little confusing cos they're not missing, they're right here, the point is that they're not registered. Except they are registered in some registries, just not the one that the |
||
|
|
||
| static final String TYPE = "missing_project_custom_metadata"; | ||
|
|
||
| TestMissingProjectCustomMetadata(String data) { | ||
| super(data); | ||
| } | ||
|
|
||
| @Override | ||
| public String getWriteableName() { | ||
| return TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public TransportVersion getMinimalSupportedVersion() { | ||
| return TransportVersion.current(); | ||
| } | ||
|
|
||
| @Override | ||
| public EnumSet<Metadata.XContentContext> context() { | ||
| return EnumSet.of(Metadata.XContentContext.GATEWAY); | ||
| } | ||
| } | ||
|
|
||
| private static class TestMissingClusterCustomMetadata extends TestClusterCustomMetadata { | ||
|
|
||
| static final String TYPE = "missing_cluster_custom_metadata"; | ||
|
|
||
| TestMissingClusterCustomMetadata(String data) { | ||
| super(data); | ||
| } | ||
|
|
||
| @Override | ||
| public String getWriteableName() { | ||
| return TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public TransportVersion getMinimalSupportedVersion() { | ||
| return TransportVersion.current(); | ||
| } | ||
|
|
||
| @Override | ||
| public EnumSet<Metadata.XContentContext> context() { | ||
| return EnumSet.of(Metadata.XContentContext.GATEWAY); | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 tho unrelated to the test changes