-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename settings from OpenDistro and OpenSearch, with backwards compat…
…ibility, using fallback (#20)
- Loading branch information
Showing
6 changed files
with
218 additions
and
22 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
62 changes: 62 additions & 0 deletions
62
.../amazon/opendistroforelasticsearch/jobscheduler/LegacyOpenDistroJobSchedulerSettings.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,62 @@ | ||
| /* | ||
| * 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. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package com.amazon.opendistroforelasticsearch.jobscheduler; | ||
|
|
||
| import org.opensearch.common.settings.Setting; | ||
| import org.opensearch.common.unit.TimeValue; | ||
|
|
||
| public class LegacyOpenDistroJobSchedulerSettings { | ||
| public static final Setting<TimeValue> REQUEST_TIMEOUT = Setting.positiveTimeSetting( | ||
| "opendistro.jobscheduler.request_timeout", | ||
| TimeValue.timeValueSeconds(10), | ||
| Setting.Property.NodeScope, Setting.Property.Dynamic, Setting.Property.Deprecated); | ||
|
|
||
| public static final Setting<TimeValue> SWEEP_BACKOFF_MILLIS = Setting.positiveTimeSetting( | ||
| "opendistro.jobscheduler.sweeper.backoff_millis", | ||
| TimeValue.timeValueMillis(50), | ||
| Setting.Property.NodeScope, Setting.Property.Dynamic, Setting.Property.Deprecated); | ||
|
|
||
| public static final Setting<Integer> SWEEP_BACKOFF_RETRY_COUNT = Setting.intSetting( | ||
| "opendistro.jobscheduler.retry_count", | ||
| 3, | ||
| Setting.Property.NodeScope, Setting.Property.Dynamic, Setting.Property.Deprecated); | ||
|
|
||
| public static final Setting<TimeValue> SWEEP_PERIOD = Setting.positiveTimeSetting( | ||
| "opendistro.jobscheduler.sweeper.period", | ||
| TimeValue.timeValueMinutes(5), | ||
| Setting.Property.NodeScope, Setting.Property.Dynamic, Setting.Property.Deprecated); | ||
|
|
||
| public static final Setting<Integer> SWEEP_PAGE_SIZE = Setting.intSetting( | ||
| "opendistro.jobscheduler.sweeper.page_size", | ||
| 100, | ||
| Setting.Property.NodeScope, Setting.Property.Dynamic, Setting.Property.Deprecated); | ||
|
|
||
| public static final Setting<Double> JITTER_LIMIT = Setting.doubleSetting( | ||
| "opendistro.jobscheduler.jitter_limit", | ||
| 0.60, 0, 0.95, | ||
| Setting.Property.NodeScope, Setting.Property.Dynamic, Setting.Property.Deprecated); | ||
| } |
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
119 changes: 119 additions & 0 deletions
119
...st/java/com/amazon/opendistroforelasticsearch/jobscheduler/JobSchedulerSettingsTests.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,119 @@ | ||
| /* | ||
| * 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. | ||
| * | ||
| * Modifications Copyright OpenSearch Contributors. See | ||
| * GitHub history for details. | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"). | ||
| * You may not use this file except in compliance with the License. | ||
| * A copy of the License is located at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * or in the "license" file accompanying this file. This file is distributed | ||
| * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either | ||
| * express or implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package com.amazon.opendistroforelasticsearch.jobscheduler; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.List; | ||
|
|
||
| import org.junit.Before; | ||
| import org.opensearch.common.settings.Setting; | ||
| import org.opensearch.common.settings.Settings; | ||
| import org.opensearch.common.unit.TimeValue; | ||
| import org.opensearch.test.OpenSearchTestCase; | ||
|
|
||
| @SuppressWarnings({"rawtypes"}) | ||
| public class JobSchedulerSettingsTests extends OpenSearchTestCase { | ||
|
|
||
| JobSchedulerPlugin plugin; | ||
|
|
||
| @Before | ||
| public void setup() { | ||
| this.plugin = new JobSchedulerPlugin(); | ||
| } | ||
|
|
||
| public void testAllLegacyOpenDistroSettingsReturned() { | ||
| List<Setting<?>> settings = plugin.getSettings(); | ||
| assertTrue("legacy setting must be returned from settings", | ||
| settings.containsAll( | ||
| Arrays.asList( | ||
| LegacyOpenDistroJobSchedulerSettings.JITTER_LIMIT, | ||
| LegacyOpenDistroJobSchedulerSettings.REQUEST_TIMEOUT, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_BACKOFF_MILLIS, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_BACKOFF_RETRY_COUNT, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_PAGE_SIZE, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_PERIOD | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| public void testAllOpenSearchSettingsReturned() { | ||
| List<Setting<?>> settings = plugin.getSettings(); | ||
| assertTrue("legacy setting must be returned from settings", | ||
| settings.containsAll( | ||
| Arrays.asList( | ||
| JobSchedulerSettings.JITTER_LIMIT, | ||
| JobSchedulerSettings.REQUEST_TIMEOUT, | ||
| JobSchedulerSettings.SWEEP_BACKOFF_MILLIS, | ||
| JobSchedulerSettings.SWEEP_BACKOFF_RETRY_COUNT, | ||
| JobSchedulerSettings.SWEEP_PAGE_SIZE, | ||
| JobSchedulerSettings.SWEEP_PERIOD | ||
| ) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| public void testLegacyOpenDistroSettingsFallback() { | ||
| assertEquals( | ||
| JobSchedulerSettings.REQUEST_TIMEOUT.get(Settings.EMPTY), | ||
| LegacyOpenDistroJobSchedulerSettings.REQUEST_TIMEOUT.get(Settings.EMPTY) | ||
| ); | ||
| } | ||
|
|
||
| public void testSettingsGetValue() { | ||
| Settings settings = Settings.builder().put("opensearch.jobscheduler.request_timeout", "42s").build(); | ||
| assertEquals(JobSchedulerSettings.REQUEST_TIMEOUT.get(settings), TimeValue.timeValueSeconds(42)); | ||
| assertEquals(LegacyOpenDistroJobSchedulerSettings.REQUEST_TIMEOUT.get(settings), TimeValue.timeValueSeconds(10)); | ||
| } | ||
|
|
||
| public void testSettingsGetValueWithLegacyFallback() { | ||
| Settings settings = Settings.builder() | ||
| .put("opendistro.jobscheduler.request_timeout", "1s") | ||
| .put("opendistro.jobscheduler.sweeper.backoff_millis", "2ms") | ||
| .put("opendistro.jobscheduler.retry_count", 3) | ||
| .put("opendistro.jobscheduler.sweeper.period", "4s") | ||
| .put("opendistro.jobscheduler.sweeper.page_size", 5) | ||
| .put("opendistro.jobscheduler.jitter_limit", 6) | ||
| .build(); | ||
|
|
||
| assertEquals(JobSchedulerSettings.REQUEST_TIMEOUT.get(settings), TimeValue.timeValueSeconds(1)); | ||
| assertEquals(JobSchedulerSettings.SWEEP_BACKOFF_MILLIS.get(settings), TimeValue.timeValueMillis(2)); | ||
| assertEquals(JobSchedulerSettings.SWEEP_BACKOFF_RETRY_COUNT.get(settings), Integer.valueOf(3)); | ||
| assertEquals(JobSchedulerSettings.SWEEP_PERIOD.get(settings), TimeValue.timeValueSeconds(4)); | ||
| assertEquals(JobSchedulerSettings.SWEEP_PAGE_SIZE.get(settings), Integer.valueOf(5)); | ||
| assertEquals(JobSchedulerSettings.JITTER_LIMIT.get(settings), Double.valueOf(6.0)); | ||
|
|
||
| assertSettingDeprecationsAndWarnings(new Setting[]{ | ||
| LegacyOpenDistroJobSchedulerSettings.REQUEST_TIMEOUT, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_BACKOFF_MILLIS, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_BACKOFF_RETRY_COUNT, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_PERIOD, | ||
| LegacyOpenDistroJobSchedulerSettings.SWEEP_PAGE_SIZE, | ||
| LegacyOpenDistroJobSchedulerSettings.JITTER_LIMIT | ||
| }); | ||
| } | ||
| } |