honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Unit tests static methods in IndeexLifecycleRunner

This commit is contained in:
Colin Goodheart-Smithe 2018-04-04 13:29:30 +01:00
parent 47dcc8fe9c
commit 9ef26dbe51
2 changed files with 237 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
x-pack/plugin/index-lifecycle/src/main/java/org/elasticsearch/xpack/indexlifecycle/IndexLifecycleRunner.java
View File

@ -10,6 +10,7 @@ import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.metadata.IndexMetaData; import org.elasticsearch.cluster.metadata.IndexMetaData;
import org.elasticsearch.cluster.metadata.MetaData; import org.elasticsearch.cluster.metadata.MetaData;
import org.elasticsearch.cluster.service.ClusterService; import org.elasticsearch.cluster.service.ClusterService;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.logging.ESLoggerFactory; import org.elasticsearch.common.logging.ESLoggerFactory;
import org.elasticsearch.common.settings.Settings; import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.settings.Settings.Builder; import org.elasticsearch.common.settings.Settings.Builder;
@ -94,17 +95,26 @@ public class IndexLifecycleRunner {
clusterService.submitStateUpdateTask("ILM", new ExecuteStepsUpdateTask(policy, index, step, stepRegistry)); clusterService.submitStateUpdateTask("ILM", new ExecuteStepsUpdateTask(policy, index, step, stepRegistry));
} }
/**
* Retrieves the current {@link StepKey} from the index settings. Note that
* it is illegal for the step to be set with the phase and/or action unset,
* or for the step to be unset with the phase and/or action set. All three
* settings must be either present or missing.
*
* @param indexSettings
* the index settings to extract the {@link StepKey} from.
*/
static StepKey getCurrentStepKey(Settings indexSettings) { static StepKey getCurrentStepKey(Settings indexSettings) {
String currentPhase = LifecycleSettings.LIFECYCLE_PHASE_SETTING.get(indexSettings); String currentPhase = LifecycleSettings.LIFECYCLE_PHASE_SETTING.get(indexSettings);
String currentAction = LifecycleSettings.LIFECYCLE_ACTION_SETTING.get(indexSettings); String currentAction = LifecycleSettings.LIFECYCLE_ACTION_SETTING.get(indexSettings);
String currentStep = LifecycleSettings.LIFECYCLE_STEP_SETTING.get(indexSettings); String currentStep = LifecycleSettings.LIFECYCLE_STEP_SETTING.get(indexSettings);
if (currentStep == null) { if (Strings.isNullOrEmpty(currentStep)) {
assert currentPhase == null : "Current phase is not null: " + currentPhase; assert Strings.isNullOrEmpty(currentPhase) : "Current phase is not empty: " + currentPhase;
assert currentAction == null : "Current action is not null: " + currentAction; assert Strings.isNullOrEmpty(currentAction) : "Current action is not empty: " + currentAction;
return null; return null;
} else { } else {
assert currentPhase != null; assert Strings.isNullOrEmpty(currentPhase) == false;
assert currentAction != null; assert Strings.isNullOrEmpty(currentAction) == false;
return new StepKey(currentPhase, currentAction, currentStep); return new StepKey(currentPhase, currentAction, currentStep);
} }
} }

224
x-pack/plugin/index-lifecycle/src/test/java/org/elasticsearch/xpack/indexlifecycle/IndexLifecycleRunnerTests.java
View File

@ -5,9 +5,25 @@
*/ */
package org.elasticsearch.xpack.indexlifecycle; package org.elasticsearch.xpack.indexlifecycle;
import org.elasticsearch.Version;
import org.elasticsearch.cluster.ClusterName;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.cluster.metadata.IndexMetaData;
import org.elasticsearch.cluster.metadata.MetaData;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.index.Index;
import org.elasticsearch.test.ESTestCase; import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.xpack.core.indexlifecycle.LifecyclePolicy;
import org.elasticsearch.xpack.core.indexlifecycle.LifecycleSettings;
import org.elasticsearch.xpack.core.indexlifecycle.MockStep;
import org.elasticsearch.xpack.core.indexlifecycle.Step;
import org.elasticsearch.xpack.core.indexlifecycle.Step.StepKey;
import org.junit.Before; import org.junit.Before;
import java.util.HashMap;
import java.util.Map;
import java.util.SortedMap;
public class IndexLifecycleRunnerTests extends ESTestCase { public class IndexLifecycleRunnerTests extends ESTestCase {
@ -15,7 +31,211 @@ public class IndexLifecycleRunnerTests extends ESTestCase {
public void prepareServices() { public void prepareServices() {
} }
public void test() { public void testGetCurrentStepKey() {
// TODO: stub Settings indexSettings = Settings.EMPTY;
StepKey stepKey = IndexLifecycleRunner.getCurrentStepKey(indexSettings);
assertNull(stepKey);
String phase = randomAlphaOfLength(20);
String action = randomAlphaOfLength(20);
String step = randomAlphaOfLength(20);
Settings indexSettings2 = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, phase)
.put(LifecycleSettings.LIFECYCLE_ACTION, action)
.put(LifecycleSettings.LIFECYCLE_STEP, step)
.build();
stepKey = IndexLifecycleRunner.getCurrentStepKey(indexSettings2);
assertNotNull(stepKey);
assertEquals(phase, stepKey.getPhase());
assertEquals(action, stepKey.getAction());
assertEquals(step, stepKey.getName());
phase = randomAlphaOfLength(20);
action = randomAlphaOfLength(20);
step = randomBoolean() ? null : "";
Settings indexSettings3 = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, phase)
.put(LifecycleSettings.LIFECYCLE_ACTION, action)
.put(LifecycleSettings.LIFECYCLE_STEP, step)
.build();
AssertionError error3 = expectThrows(AssertionError.class, () -> IndexLifecycleRunner.getCurrentStepKey(indexSettings3));
assertEquals("Current phase is not empty: " + phase, error3.getMessage());
phase = randomBoolean() ? null : "";
action = randomAlphaOfLength(20);
step = randomBoolean() ? null : "";
Settings indexSettings4 = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, phase)
.put(LifecycleSettings.LIFECYCLE_ACTION, action)
.put(LifecycleSettings.LIFECYCLE_STEP, step)
.build();
AssertionError error4 = expectThrows(AssertionError.class, () -> IndexLifecycleRunner.getCurrentStepKey(indexSettings4));
assertEquals("Current action is not empty: " + action, error4.getMessage());
phase = randomBoolean() ? null : "";
action = randomAlphaOfLength(20);
step = randomAlphaOfLength(20);
Settings indexSettings5 = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, phase)
.put(LifecycleSettings.LIFECYCLE_ACTION, action)
.put(LifecycleSettings.LIFECYCLE_STEP, step)
.build();
AssertionError error5 = expectThrows(AssertionError.class, () -> IndexLifecycleRunner.getCurrentStepKey(indexSettings5));
assertEquals(null, error5.getMessage());
phase = randomBoolean() ? null : "";
action = randomBoolean() ? null : "";
step = randomAlphaOfLength(20);
Settings indexSettings6 = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, phase)
.put(LifecycleSettings.LIFECYCLE_ACTION, action)
.put(LifecycleSettings.LIFECYCLE_STEP, step)
.build();
AssertionError error6 = expectThrows(AssertionError.class, () -> IndexLifecycleRunner.getCurrentStepKey(indexSettings6));
assertEquals(null, error6.getMessage());
}
public void testGetCurrentStep() {
SortedMap<String, LifecyclePolicy> lifecyclePolicyMap = null; // Not used in the methods tested here
String policyName = "policy_1";
String otherPolicyName = "other_policy";
StepKey firstStepKey = new StepKey("phase_1", "action_1", "step_1");
StepKey secondStepKey = new StepKey("phase_1", "action_1", "step_2");
StepKey thirdStepKey = new StepKey("phase_1", "action_2", "step_1");
StepKey fourthStepKey = new StepKey("phase_2", "action_1", "step_1");
StepKey otherPolicyFirstStepKey = new StepKey("phase_1", "action_1", "step_1");
StepKey otherPolicySecondStepKey = new StepKey("phase_1", "action_1", "step_2");
Step firstStep = new MockStep(firstStepKey, secondStepKey);
Step secondStep = new MockStep(secondStepKey, thirdStepKey);
Step thirdStep = new MockStep(thirdStepKey, fourthStepKey);
Step fourthStep = new MockStep(fourthStepKey, null);
Step otherPolicyFirstStep = new MockStep(firstStepKey, secondStepKey);
Step otherPolicySecondStep = new MockStep(secondStepKey, null);
Map<String, Step> firstStepMap = new HashMap<>();
firstStepMap.put(policyName, firstStep);
firstStepMap.put(otherPolicyName, otherPolicyFirstStep);
Map<String, Map<StepKey, Step>> stepMap = new HashMap<>();
Map<StepKey, Step> policySteps = new HashMap<>();
policySteps.put(firstStepKey, firstStep);
policySteps.put(secondStepKey, secondStep);
policySteps.put(thirdStepKey, thirdStep);
policySteps.put(fourthStepKey, fourthStep);
stepMap.put(policyName, policySteps);
Map<StepKey, Step> otherPolicySteps = new HashMap<>();
otherPolicySteps.put(otherPolicyFirstStepKey, otherPolicyFirstStep);
otherPolicySteps.put(otherPolicySecondStepKey, otherPolicySecondStep);
stepMap.put(otherPolicyName, otherPolicySteps);
PolicyStepsRegistry registry = new PolicyStepsRegistry(lifecyclePolicyMap, firstStepMap, stepMap);
Settings indexSettings = Settings.EMPTY;
Step actualStep = IndexLifecycleRunner.getCurrentStep(registry, policyName, indexSettings);
assertSame(firstStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_1")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_1")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, policyName, indexSettings);
assertSame(firstStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_1")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_2")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, policyName, indexSettings);
assertSame(secondStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_1")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_2")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_1")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, policyName, indexSettings);
assertSame(thirdStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_2")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_1")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, policyName, indexSettings);
assertSame(fourthStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_2")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_1")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, policyName, indexSettings);
assertSame(fourthStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_1")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_1")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, otherPolicyName, indexSettings);
assertSame(otherPolicyFirstStep, actualStep);
indexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_1")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_2")
.build();
actualStep = IndexLifecycleRunner.getCurrentStep(registry, otherPolicyName, indexSettings);
assertSame(otherPolicySecondStep, actualStep);
Settings invalidIndexSettings = Settings.builder()
.put(LifecycleSettings.LIFECYCLE_PHASE, "phase_1")
.put(LifecycleSettings.LIFECYCLE_ACTION, "action_1")
.put(LifecycleSettings.LIFECYCLE_STEP, "step_3")
.build();
IllegalStateException exception = expectThrows(IllegalStateException.class,
() -> IndexLifecycleRunner.getCurrentStep(registry, policyName, invalidIndexSettings));
assertEquals("step [[phase_1][action_1][step_3]] does not exist", exception.getMessage());
exception = expectThrows(IllegalStateException.class,
() -> IndexLifecycleRunner.getCurrentStep(registry, "policy_does_not_exist", invalidIndexSettings));
assertEquals("policy [policy_does_not_exist] does not exist", exception.getMessage());
}
public void testMoveClusterStateToNextStep() {
String indexName = "my_index";
StepKey nextStep = new StepKey("next_phase", "next_action", "next_step");
ClusterState clusterState = buildClusterState(indexName, Settings.builder());
Index index = clusterState.metaData().index(indexName).getIndex();
ClusterState newClusterState = IndexLifecycleRunner.moveClusterStateToNextStep(index, clusterState, nextStep);
assertClusterStateOnNextStep(clusterState, index, nextStep, newClusterState);
clusterState = buildClusterState(indexName, Settings.builder().put(LifecycleSettings.LIFECYCLE_PHASE, "current_phase")
.put(LifecycleSettings.LIFECYCLE_ACTION, "current_action").put(LifecycleSettings.LIFECYCLE_STEP, "current_step"));
index = clusterState.metaData().index(indexName).getIndex();
newClusterState = IndexLifecycleRunner.moveClusterStateToNextStep(index, clusterState, nextStep);
assertClusterStateOnNextStep(clusterState, index, nextStep, newClusterState);
}
private ClusterState buildClusterState(String indexName, Settings.Builder indexSettingsBuilder) {
Settings indexSettings = indexSettingsBuilder.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1)
.put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0).put(IndexMetaData.SETTING_VERSION_CREATED, Version.CURRENT).build();
IndexMetaData indexMetadata = IndexMetaData.builder(indexName).settings(indexSettings)
.build();
MetaData metadata = MetaData.builder().put(indexMetadata, true).build();
return ClusterState.builder(new ClusterName("my_cluster")).metaData(metadata).build();
}
private void assertClusterStateOnNextStep(ClusterState oldClusterState, Index index, StepKey nextStep, ClusterState newClusterState) {
assertNotSame(oldClusterState, newClusterState);
MetaData newMetadata = newClusterState.metaData();
assertNotSame(oldClusterState.metaData(), newMetadata);
IndexMetaData newIndexMetadata = newMetadata.getIndexSafe(index);
assertNotSame(oldClusterState.metaData().index(index), newIndexMetadata);
Settings newIndexSettings = newIndexMetadata.getSettings();
assertNotSame(oldClusterState.metaData().index(index).getSettings(), newIndexSettings);
assertEquals(nextStep.getPhase(), LifecycleSettings.LIFECYCLE_PHASE_SETTING.get(newIndexSettings));
assertEquals(nextStep.getAction(), LifecycleSettings.LIFECYCLE_ACTION_SETTING.get(newIndexSettings));
assertEquals(nextStep.getName(), LifecycleSettings.LIFECYCLE_STEP_SETTING.get(newIndexSettings));
} }
} }