-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deprecate setting 'cluster.no_master_block' and introduce the alterna…
…tive setting 'cluster.no_cluster_manager_block' (#2453) * Add a new setting `cluster.no_cluster_manager_block`, aims to replace the existing `cluster.no_master_block` * Set the value of the old setting `cluster.no_master_block` as the fallback to the new setting * Deprecate the existing `setting cluster.no_master_block` * Add unit tests Signed-off-by: Tianli Feng <[email protected]>
- Loading branch information
Tianli Feng
authored
Mar 18, 2022
1 parent
ec47a93
commit 1193ec1
Showing
8 changed files
with
119 additions
and
21 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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
87 changes: 87 additions & 0 deletions
87
...est/java/org/opensearch/cluster/coordination/NoMasterBlockServiceRenamedSettingTests.java
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.cluster.coordination; | ||
|
|
||
| import org.opensearch.common.settings.ClusterSettings; | ||
| import org.opensearch.common.settings.Setting; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.test.OpenSearchTestCase; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * A unit test to validate the former name of the setting 'cluster.no_cluster_manager_block' still take effect, | ||
| * after it is deprecated, so that the backwards compatibility is maintained. | ||
| * The test can be removed along with removing support of the deprecated setting. | ||
| */ | ||
| public class NoMasterBlockServiceRenamedSettingTests extends OpenSearchTestCase { | ||
|
|
||
| /** | ||
| * Validate the both settings are known and supported. | ||
| */ | ||
| public void testReindexSettingsExist() { | ||
| Set<Setting<?>> settings = ClusterSettings.BUILT_IN_CLUSTER_SETTINGS; | ||
| assertTrue( | ||
| "Both 'cluster.no_cluster_manager_block' and its predecessor should be supported built-in settings.", | ||
| settings.containsAll( | ||
| Arrays.asList(NoMasterBlockService.NO_MASTER_BLOCK_SETTING, NoMasterBlockService.NO_CLUSTER_MANAGER_BLOCK_SETTING) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Validate the default value of the both settings is the same. | ||
| */ | ||
| public void testSettingFallback() { | ||
| assertEquals( | ||
| NoMasterBlockService.NO_MASTER_BLOCK_SETTING.get(Settings.EMPTY), | ||
| NoMasterBlockService.NO_CLUSTER_MANAGER_BLOCK_SETTING.get(Settings.EMPTY) | ||
|
|
||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Validate the new setting can be configured correctly, and it doesn't impact the old setting. | ||
| */ | ||
| public void testSettingGetValue() { | ||
| Settings settings = Settings.builder().put("cluster.no_cluster_manager_block", "all").build(); | ||
| assertEquals(NoMasterBlockService.NO_MASTER_BLOCK_ALL, NoMasterBlockService.NO_CLUSTER_MANAGER_BLOCK_SETTING.get(settings)); | ||
| assertEquals( | ||
| NoMasterBlockService.NO_MASTER_BLOCK_SETTING.getDefault(Settings.EMPTY), | ||
| NoMasterBlockService.NO_MASTER_BLOCK_SETTING.get(settings) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Validate the value of the old setting will be applied to the new setting, if the new setting is not configured. | ||
| */ | ||
| public void testSettingGetValueWithFallback() { | ||
| Settings settings = Settings.builder().put("cluster.no_master_block", "metadata_write").build(); | ||
| assertEquals( | ||
| NoMasterBlockService.NO_MASTER_BLOCK_METADATA_WRITES, | ||
| NoMasterBlockService.NO_CLUSTER_MANAGER_BLOCK_SETTING.get(settings) | ||
| ); | ||
| assertSettingDeprecationsAndWarnings(new Setting<?>[] { NoMasterBlockService.NO_MASTER_BLOCK_SETTING }); | ||
| } | ||
|
|
||
| /** | ||
| * Validate the value of the old setting will be ignored, if the new setting is configured. | ||
| */ | ||
| public void testSettingGetValueWhenBothAreConfigured() { | ||
| Settings settings = Settings.builder() | ||
| .put("cluster.no_cluster_manager_block", "all") | ||
| .put("cluster.no_master_block", "metadata_write") | ||
| .build(); | ||
| assertEquals(NoMasterBlockService.NO_MASTER_BLOCK_ALL, NoMasterBlockService.NO_CLUSTER_MANAGER_BLOCK_SETTING.get(settings)); | ||
| assertEquals(NoMasterBlockService.NO_MASTER_BLOCK_METADATA_WRITES, NoMasterBlockService.NO_MASTER_BLOCK_SETTING.get(settings)); | ||
| assertSettingDeprecationsAndWarnings(new Setting<?>[] { NoMasterBlockService.NO_MASTER_BLOCK_SETTING }); | ||
| } | ||
|
|
||
| } |
This file contains 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 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