Adding two missing entries to the deprecation info api (#80290) (#80307)

masseyke · web-flow · commit 8b5b762171ff · 2021-11-03T15:38:16.000-04:00
Adding indices.lifecycle.step.master_timeout and xpack.eql.enabled to the deprecation info API. These two checks were also added to the 7.16 line in #80233.
diff --git a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/LifecycleSettings.java b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/LifecycleSettings.java
@@ -76,7 +76,7 @@ public class LifecycleSettings {
         TimeValue.timeValueSeconds(30),
         Setting.Property.Dynamic,
         Setting.Property.NodeScope,
-        Setting.Property.Deprecated
+        Setting.Property.DeprecatedWarning
     );
     // This setting configures how much time since step_time should ILM wait for a condition to be met. After the threshold wait time has
     // elapsed ILM will likely stop waiting and go to the next step.
diff --git a/x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/DeprecationChecks.java b/x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/DeprecationChecks.java
@@ -82,7 +82,9 @@ private DeprecationChecks() {}
         NodeDeprecationChecks::checkScriptContextCompilationsRateLimitSetting,
         NodeDeprecationChecks::checkScriptContextCacheSizeSetting,
         NodeDeprecationChecks::checkScriptContextCacheExpirationSetting,
-        NodeDeprecationChecks::checkEnforceDefaultTierPreferenceSetting
+        NodeDeprecationChecks::checkEnforceDefaultTierPreferenceSetting,
+        NodeDeprecationChecks::checkLifecyleStepMasterTimeoutSetting,
+        NodeDeprecationChecks::checkEqlEnabledSetting
     );
 
     static List<Function<IndexMetadata, DeprecationIssue>> INDEX_SETTINGS_CHECKS = List.of(
diff --git a/x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecks.java b/x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecks.java
@@ -13,9 +13,11 @@
 import org.elasticsearch.common.settings.SecureSetting;
 import org.elasticsearch.common.settings.Setting;
 import org.elasticsearch.common.settings.Settings;
+import org.elasticsearch.core.TimeValue;
 import org.elasticsearch.env.Environment;
 import org.elasticsearch.script.ScriptService;
 import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
+import org.elasticsearch.xpack.core.ilm.LifecycleSettings;
 import org.elasticsearch.xpack.core.monitoring.MonitoringDeprecatedSettings;
 import org.elasticsearch.xpack.core.security.authc.RealmConfig;
 import org.elasticsearch.xpack.core.security.authc.RealmSettings;
@@ -59,23 +61,32 @@ static DeprecationIssue checkDeprecatedSetting(
     }
 
     static DeprecationIssue checkRemovedSetting(final Settings settings, final Setting<?> removedSetting, final String url) {
+        return checkRemovedSetting(settings, removedSetting, url, null, DeprecationIssue.Level.CRITICAL);
+    }
+
+    static DeprecationIssue checkRemovedSetting(
+        final Settings settings,
+        final Setting<?> removedSetting,
+        final String url,
+        String additionalDetailMessage,
+        DeprecationIssue.Level deprecationLevel
+    ) {
         if (removedSetting.exists(settings) == false) {
             return null;
         }
         final String removedSettingKey = removedSetting.getKey();
-        final String value = removedSetting.get(settings).toString();
-        final String message = String.format(
-            Locale.ROOT,
-            "setting [%s] is deprecated and will be removed in the next major version",
-            removedSettingKey
-        );
-        final String details = String.format(
-            Locale.ROOT,
-            "the setting [%s] is currently set to [%s], remove this setting",
-            removedSettingKey,
-            value
-        );
-        return new DeprecationIssue(DeprecationIssue.Level.CRITICAL, message, url, details, false, null);
+        Object removedSettingValue = removedSetting.get(settings);
+        String value;
+        if (removedSettingValue instanceof TimeValue) {
+            value = ((TimeValue) removedSettingValue).getStringRep();
+        } else {
+            value = removedSettingValue.toString();
+        }
+        final String message = String.format(Locale.ROOT, "Setting [%s] is deprecated", removedSettingKey);
+        final String details = additionalDetailMessage == null
+            ? String.format(Locale.ROOT, "Remove the [%s] setting.", removedSettingKey)
+            : String.format(Locale.ROOT, "Remove the [%s] setting. %s", removedSettingKey, additionalDetailMessage);
+        return new DeprecationIssue(deprecationLevel, message, url, details, false, null);
     }
 
     static DeprecationIssue checkSharedDataPathSetting(final Settings settings, final PluginsAndModules pluginsAndModules) {
@@ -565,4 +576,33 @@ static DeprecationIssue checkEnforceDefaultTierPreferenceSetting(final Settings
         return null;
     }
 
+    static DeprecationIssue checkLifecyleStepMasterTimeoutSetting(final Settings settings, final PluginsAndModules pluginsAndModules) {
+        Setting<TimeValue> deprecatedSetting = LifecycleSettings.LIFECYCLE_STEP_MASTER_TIMEOUT_SETTING;
+        String url = "https://ela.st/es-deprecation-8-lifecycle-master-timeout-setting";
+        return checkRemovedSetting(
+            settings,
+            deprecatedSetting,
+            url,
+            "As of 7.16 the timeout is always infinite.",
+            DeprecationIssue.Level.WARNING
+        );
+    }
+
+    static DeprecationIssue checkEqlEnabledSetting(final Settings settings, final PluginsAndModules pluginsAndModules) {
+        Setting<Boolean> deprecatedSetting = Setting.boolSetting(
+            "xpack.eql.enabled",
+            true,
+            Setting.Property.NodeScope,
+            Setting.Property.DeprecatedWarning
+        );
+        String url = "https://ela.st/es-deprecation-8-eql-enabled-setting";
+        return checkRemovedSetting(
+            settings,
+            deprecatedSetting,
+            url,
+            "As of 7.9.2 basic license level features are always enabled.",
+            DeprecationIssue.Level.WARNING
+        );
+    }
+
 }
diff --git a/x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java b/x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java
@@ -7,6 +7,8 @@
 
 package org.elasticsearch.xpack.deprecation;
 
+import org.apache.logging.log4j.Level;
+import org.elasticsearch.action.admin.cluster.node.info.PluginsAndModules;
 import org.elasticsearch.cluster.routing.allocation.DataTier;
 import org.elasticsearch.cluster.routing.allocation.decider.DiskThresholdDecider;
 import org.elasticsearch.common.Strings;
@@ -18,8 +20,10 @@
 import org.elasticsearch.script.ScriptService;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;
+import org.elasticsearch.xpack.core.ilm.LifecycleSettings;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -53,11 +57,8 @@ public void testRemovedSetting() {
         );
         assertThat(issue, not(nullValue()));
         assertThat(issue.getLevel(), equalTo(DeprecationIssue.Level.CRITICAL));
-        assertThat(
-            issue.getMessage(),
-            equalTo("setting [node.removed_setting] is deprecated and will be removed in the next major version")
-        );
-        assertThat(issue.getDetails(), equalTo("the setting [node.removed_setting] is currently set to [value], remove this setting"));
+        assertThat(issue.getMessage(), equalTo("Setting [node.removed_setting] is deprecated"));
+        assertThat(issue.getDetails(), equalTo("Remove the [node.removed_setting] setting."));
         assertThat(issue.getUrl(), equalTo("https://removed-setting.example.com"));
     }
 
@@ -591,4 +592,60 @@ public void testEnforceDefaultTierPreferenceSetting() {
         );
     }
 
+    private List<DeprecationIssue> getDeprecationIssues(Settings settings, PluginsAndModules pluginsAndModules) {
+        final List<DeprecationIssue> issues = DeprecationChecks.filterChecks(
+            DeprecationChecks.NODE_SETTINGS_CHECKS,
+            c -> c.apply(settings, pluginsAndModules)
+        );
+
+        return issues;
+    }
+
+    public void testLifecyleStepMasterTimeoutSetting() {
+        Settings settings = Settings.builder()
+            .put(LifecycleSettings.LIFECYCLE_STEP_MASTER_TIMEOUT_SETTING.getKey(), randomTimeValue())
+            .build();
+        final PluginsAndModules pluginsAndModules = new PluginsAndModules(Collections.emptyList(), Collections.emptyList());
+        final List<DeprecationIssue> issues = getDeprecationIssues(settings, pluginsAndModules);
+        final DeprecationIssue expected = new DeprecationIssue(
+            DeprecationIssue.Level.WARNING,
+            "Setting [indices.lifecycle.step.master_timeout] is deprecated",
+            "https://ela.st/es-deprecation-8-lifecycle-master-timeout-setting",
+            "Remove the [indices.lifecycle.step.master_timeout] setting. As of 7.16 the timeout is always infinite.",
+            false,
+            null
+        );
+        assertThat(issues, hasItem(expected));
+        assertWarnings(
+            true,
+            new DeprecationWarning(
+                Level.WARN,
+                "[indices.lifecycle.step.master_timeout] setting was deprecated in Elasticsearch and will be removed in a future release!"
+                    + " See the breaking changes documentation for the next major version."
+            )
+        );
+    }
+
+    public void testEqlEnabledSetting() {
+        Settings settings = Settings.builder().put("xpack.eql.enabled", randomBoolean()).build();
+        final PluginsAndModules pluginsAndModules = new PluginsAndModules(Collections.emptyList(), Collections.emptyList());
+        final List<DeprecationIssue> issues = getDeprecationIssues(settings, pluginsAndModules);
+        final DeprecationIssue expected = new DeprecationIssue(
+            DeprecationIssue.Level.WARNING,
+            "Setting [xpack.eql.enabled] is deprecated",
+            "https://ela.st/es-deprecation-8-eql-enabled-setting",
+            "Remove the [xpack.eql.enabled] setting. As of 7.9.2 basic license level features are always enabled.",
+            false,
+            null
+        );
+        assertThat(issues, hasItem(expected));
+        assertWarnings(
+            true,
+            new DeprecationWarning(
+                Level.WARN,
+                "[xpack.eql.enabled] setting was deprecated in Elasticsearch and will be removed in a future release!"
+                    + " See the breaking changes documentation for the next major version."
+            )
+        );
+    }
 }
