rename the placeholders

Author: jaymode

docs/reference/setup/configuration.asciidoc

@@ -265,15 +265,15 @@ file which will resolve to an environment setting, for example:
 --------------------------------------------------
 
 Additionally, for settings that you do not wish to store in the configuration
-file, you can use the value `__prompt:text__` or `__prompt:secret__` and start
-Elasticsearch in the foreground. `__prompt:secret__` has echoing disabled so
-that the value entered will not be shown in your terminal; `__prompt:text__`
+file, you can use the value `${prompt::text}` or `${prompt::secret}` and start
+Elasticsearch in the foreground. `${prompt::secret}` has echoing disabled so
+that the value entered will not be shown in your terminal; `${prompt::text}`
 will allow you to see the value as you type it in. For example:
 
 [source,yaml]
 --------------------------------------------------
 node:
-  name: __prompt:text__
+  name: ${prompt::text}
 --------------------------------------------------
 
 On execution of the `elasticsearch` command, you will be prompted to enter
@@ -284,7 +284,7 @@ the actual value like so:
 Enter value for [node.name]:
 --------------------------------------------------
 
-NOTE: Elasticsearch will not start if `__prompt:text__` or `__prompt:secret__`
+NOTE: Elasticsearch will not start if `${prompt::text}` or `${prompt::secret}`
 is used in the settings and the process is run as a service or in the background.
 
 The location of the configuration file can be set externally using a

src/main/java/org/elasticsearch/common/settings/ImmutableSettings.java

@@ -1057,7 +1057,7 @@ public Builder putProperties(String prefix, Properties properties, String[] igno
          * tries and resolve it against an environment variable ({@link System#getenv(String)}), and last, tries
          * and replace it with another setting already set on this builder.
          */
-        public Builder replacePropertyPlaceholders() {
+        public Builder replacePropertyPlaceholders(String... ignoredValues) {
             PropertyPlaceholder propertyPlaceholder = new PropertyPlaceholder("${", "}", false);
             PropertyPlaceholder.PlaceholderResolver placeholderResolver = new PropertyPlaceholder.PlaceholderResolver() {
                 @Override
@@ -1087,7 +1087,19 @@ public boolean shouldIgnoreMissing(String placeholderName) {
                 }
             };
             for (Map.Entry<String, String> entry : Maps.newHashMap(map).entrySet()) {
-                String value = propertyPlaceholder.replacePlaceholders(entry.getValue(), placeholderResolver);
+                String possiblePlaceholder = entry.getValue();
+                boolean ignored = false;
+                for (String ignoredValue : ignoredValues) {
+                    if (ignoredValue.equals(possiblePlaceholder)) {
+                        ignored = true;
+                        break;
+                    }
+                }
+                if (ignored) {
+                    continue;
+                }
+
+                String value = propertyPlaceholder.replacePlaceholders(possiblePlaceholder, placeholderResolver);
                 // if the values exists and has length, we should maintain it  in the map
                 // otherwise, the replace process resolved into removing it
                 if (Strings.hasLength(value)) {

src/main/java/org/elasticsearch/node/internal/InternalSettingsPreparer.java

@@ -40,8 +40,8 @@
  */
 public class InternalSettingsPreparer {
 
-    public static final String SECRET_PROMPT_VALUE = "__prompt:secret__";
-    public static final String TEXT_PROMPT_VALUE = "__prompt:text__";
+    public static final String SECRET_PROMPT_VALUE = "${prompt::secret}";
+    public static final String TEXT_PROMPT_VALUE = "${prompt::text}";
     public static final String IGNORE_SYSTEM_PROPERTIES_SETTING = "config.ignore_system_properties";
 
     /**
@@ -68,6 +68,9 @@ public static Tuple<Settings, Environment> prepareSettings(Settings pSettings, b
     public static Tuple<Settings, Environment> prepareSettings(Settings pSettings, boolean loadConfigSettings, Terminal terminal) {
         // ignore this prefixes when getting properties from es. and elasticsearch.
         String[] ignorePrefixes = new String[]{"es.default.", "elasticsearch.default."};
+        // ignore the special prompt placeholders since they have the same format as property placeholders and will be resolved
+        // as having a default value because of the ':' in the format
+        String[] ignoredPlaceholders = new String[] { SECRET_PROMPT_VALUE, TEXT_PROMPT_VALUE };
         boolean useSystemProperties = !pSettings.getAsBoolean(IGNORE_SYSTEM_PROPERTIES_SETTING, false);
         // just create enough settings to build the environment
         ImmutableSettings.Builder settingsBuilder = settingsBuilder().put(pSettings);
@@ -77,7 +80,7 @@ public static Tuple<Settings, Environment> prepareSettings(Settings pSettings, b
                     .putProperties("elasticsearch.", System.getProperties(), ignorePrefixes)
                     .putProperties("es.", System.getProperties(), ignorePrefixes);
         }
-        settingsBuilder.replacePropertyPlaceholders();
+        settingsBuilder.replacePropertyPlaceholders(ignoredPlaceholders);
 
         Environment environment = new Environment(settingsBuilder.build());
 
@@ -125,7 +128,7 @@ public static Tuple<Settings, Environment> prepareSettings(Settings pSettings, b
             settingsBuilder.putProperties("elasticsearch.", System.getProperties(), ignorePrefixes)
                     .putProperties("es.", System.getProperties(), ignorePrefixes);
         }
-        settingsBuilder.replacePropertyPlaceholders();
+        settingsBuilder.replacePropertyPlaceholders(ignoredPlaceholders);
 
         // allow to force set properties based on configuration of the settings provided
         for (Map.Entry<String, String> entry : pSettings.getAsMap().entrySet()) {
@@ -135,7 +138,7 @@ public static Tuple<Settings, Environment> prepareSettings(Settings pSettings, b
                 settingsBuilder.put(setting.substring("force.".length()), entry.getValue());
             }
         }
-        settingsBuilder.replacePropertyPlaceholders();
+        settingsBuilder.replacePropertyPlaceholders(ignoredPlaceholders);
 
         // generate the name
         if (settingsBuilder.get("name") == null) {

src/test/java/org/elasticsearch/common/settings/ImmutableSettingsTests.java

@@ -137,6 +137,17 @@ public void testReplacePropertiesPlaceholderIgnoreEnvUnset() {
         assertThat(settings.get("setting1"), is(nullValue()));
     }
 
+    @Test
+    public void testReplacePropertiesPlaceholderIgnores() {
+        Settings settings = settingsBuilder()
+                .put("setting1", "${foo.bar}")
+                .put("setting2", "${foo.bar1}")
+                .replacePropertyPlaceholders("${foo.bar}", "${foo.bar1}")
+                .build();
+        assertThat(settings.get("setting1"), is("${foo.bar}"));
+        assertThat(settings.get("setting2"), is("${foo.bar1}"));
+    }
+
     @Test
     public void testUnFlattenedSettings() {
         Settings settings = settingsBuilder()

src/test/java/org/elasticsearch/node/internal/InternalSettingsPreparerTests.java

@@ -40,6 +40,7 @@
 import static org.hamcrest.Matchers.is;
 
 public class InternalSettingsPreparerTests extends ElasticsearchTestCase {
+
     @Before
     public void setupSystemProperties() {
         System.setProperty("es.node.zone", "foo");
@@ -124,7 +125,7 @@ public void testReplaceSecretPromptPlaceholderWithNullTerminal() {
             InternalSettingsPreparer.replacePromptPlaceholders(builder.build(), null);
             fail("an exception should have been thrown since no terminal was provided!");
         } catch (UnsupportedOperationException e) {
-            assertThat(e.getMessage(), containsString("with value [__prompt:secret__]"));
+            assertThat(e.getMessage(), containsString("with value [" + InternalSettingsPreparer.SECRET_PROMPT_VALUE + "]"));
         }
     }
 
@@ -136,7 +137,7 @@ public void testReplaceTextPromptPlaceholderWithNullTerminal() {
             InternalSettingsPreparer.replacePromptPlaceholders(builder.build(), null);
             fail("an exception should have been thrown since no terminal was provided!");
         } catch (UnsupportedOperationException e) {
-            assertThat(e.getMessage(), containsString("with value [__prompt:text__]"));
+            assertThat(e.getMessage(), containsString("with value [" + InternalSettingsPreparer.TEXT_PROMPT_VALUE + "]"));
         }
     }
 }