Merge pull request #17915 from htztomic

* pr/17915:
  Polish "Added support for devtools YAML configuration"
  Added support for devtools YAML configuration

Closes gh-17915

spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/env/DevToolsHomePropertiesPostProcessor.java

@@ -18,13 +18,17 @@ package org.springframework.boot.devtools.env;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Properties;
+import java.util.function.Function;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.devtools.DevToolsEnablementDeducer;
 import org.springframework.boot.env.EnvironmentPostProcessor;
 import org.springframework.core.env.ConfigurableEnvironment;
 import org.springframework.core.env.PropertiesPropertySource;
+import org.springframework.core.env.PropertySource;
 import org.springframework.core.io.FileSystemResource;
 import org.springframework.core.io.support.PropertiesLoaderUtils;
 import org.springframework.util.StringUtils;
@@ -35,28 +39,52 @@ import org.springframework.util.StringUtils;
  *
  * @author Phillip Webb
  * @author Andy Wilkinson
+ * @author HaiTao Zhang
+ * @author Madhura Bhave
  * @since 1.3.0
  */
 public class DevToolsHomePropertiesPostProcessor implements EnvironmentPostProcessor {
 
-	private static final String FILE_NAME = ".spring-boot-devtools.properties";
+	private static final String LEGACY_FILE_NAME = ".spring-boot-devtools.properties";
+
+	private static final String[] FILE_NAMES = new String[] { ".spring-boot-devtools.yml", ".spring-boot-devtools.yaml",
+			".spring-boot-devtools.properties" };
+
+	private static final String CONFIG_PATH = "/.config/spring-boot/";
 
 	@Override
 	public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
 		if (DevToolsEnablementDeducer.shouldEnable(Thread.currentThread())) {
+			List<PropertySource> propertySources = getPropertySources();
+			if (propertySources.isEmpty()) {
+				addPropertySource(LEGACY_FILE_NAME, (file) -> "devtools-local", propertySources);
+			}
+			propertySources.forEach((source) -> environment.getPropertySources().addFirst(source));
+		}
+	}
+
+	private List<PropertySource> getPropertySources() {
+		List<PropertySource> propertySources = new ArrayList<>();
+		for (String fileName : FILE_NAMES) {
+			addPropertySource(CONFIG_PATH + fileName, (file) -> "devtools-local: [" + file.toURI() + "]",
+					propertySources);
+		}
+		return propertySources;
+	}
+
+	private void addPropertySource(String fileName, Function<File, String> propertySourceName,
+			List<PropertySource> propertySources) {
+		Properties properties;
 		File home = getHomeFolder();
-			File propertyFile = (home != null) ? new File(home, FILE_NAME) : null;
+		File propertyFile = (home != null) ? new File(home, fileName) : null;
 		if (propertyFile != null && propertyFile.exists() && propertyFile.isFile()) {
 			FileSystemResource resource = new FileSystemResource(propertyFile);
-				Properties properties;
 			try {
 				properties = PropertiesLoaderUtils.loadProperties(resource);
-					environment.getPropertySources()
+				propertySources.add(new PropertiesPropertySource(propertySourceName.apply(propertyFile), properties));
-							.addFirst(new PropertiesPropertySource("devtools-local", properties));
 			}
 			catch (IOException ex) {
-					throw new IllegalStateException("Unable to load " + FILE_NAME, ex);
+				throw new IllegalStateException("Unable to load " + fileName, ex);
-				}
 			}
 		}
 	}

spring-boot-project/spring-boot-devtools/src/test/java/org/springframework/boot/devtools/env/DevToolsHomePropertiesPostProcessorTests.java

@@ -36,35 +36,135 @@ import static org.assertj.core.api.Assertions.assertThat;
  *
  * @author Phillip Webb
  * @author Andy Wilkinson
+ * @author HaiTao Zhang
+ * @author Madhura Bhave
  */
 class DevToolsHomePropertiesPostProcessorTests {
 
+	private String configDir;
+
 	private File home;
 
 	@BeforeEach
-	void setup(@TempDir File tempDir) throws IOException {
+	void setup(@TempDir File tempDir) {
 		this.home = tempDir;
+		this.configDir = this.home + "/.config/spring-boot/";
+		new File(this.configDir).mkdirs();
+	}
+
+	@Test
+	void loadsPropertiesFromHomeFolderUsingProperties() throws Exception {
+		Properties properties = new Properties();
+		properties.put("abc", "def");
+		writeFile(properties, ".spring-boot-devtools.properties");
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
+		assertThat(environment.getProperty("abc")).isEqualTo("def");
 	}
 
 	@Test
-	void loadsHomeProperties() throws Exception {
+	void loadsPropertiesFromConfigFolderUsingProperties() throws Exception {
 		Properties properties = new Properties();
 		properties.put("abc", "def");
-		OutputStream out = new FileOutputStream(new File(this.home, ".spring-boot-devtools.properties"));
+		OutputStream out = new FileOutputStream(new File(this.configDir, ".spring-boot-devtools.properties"));
 		properties.store(out, null);
 		out.close();
-		ConfigurableEnvironment environment = new MockEnvironment();
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
-		MockDevToolHomePropertiesPostProcessor postProcessor = new MockDevToolHomePropertiesPostProcessor();
+		assertThat(environment.getProperty("abc")).isEqualTo("def");
-		runPostProcessor(() -> postProcessor.postProcessEnvironment(environment, null));
+	}
+
+	@Test
+	void loadsPropertiesFromConfigFolderUsingYml() throws Exception {
+		Properties properties = new Properties();
+		properties.put("abc", "def");
+		OutputStream out = new FileOutputStream(new File(this.configDir, ".spring-boot-devtools.yml"));
+		properties.store(out, null);
+		out.close();
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
+		assertThat(environment.getProperty("abc")).isEqualTo("def");
+	}
+
+	@Test
+	void loadsPropertiesFromConfigFolderUsingYaml() throws Exception {
+		Properties properties = new Properties();
+		properties.put("abc", "def");
+		OutputStream out = new FileOutputStream(new File(this.configDir, ".spring-boot-devtools.yaml"));
+		properties.store(out, null);
+		out.close();
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
 		assertThat(environment.getProperty("abc")).isEqualTo("def");
 	}
 
+	@Test
+	void loadFromConfigFolderWithPropertiesTakingPrecedence() throws Exception {
+		Properties properties = new Properties();
+		properties.put("abc", "def");
+		properties.put("bar", "baz");
+		OutputStream out = new FileOutputStream(
+				new File(this.home + "/.config/spring-boot/", ".spring-boot-devtools.yaml"));
+		properties.store(out, null);
+		out.close();
+		Properties properties2 = new Properties();
+		properties2.put("abc", "jkl");
+		OutputStream out2 = new FileOutputStream(
+				new File(this.home + "/.config/spring-boot/", ".spring-boot-devtools.properties"));
+		properties2.store(out2, null);
+		out2.close();
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
+		assertThat(environment.getProperty("abc")).isEqualTo("jkl");
+		assertThat(environment.getProperty("bar")).isEqualTo("baz");
+	}
+
+	@Test
+	void loadFromConfigFolderTakesPrecedenceOverHomeFolder() throws Exception {
+		Properties properties = new Properties();
+		properties.put("abc", "def");
+		properties.put("bar", "baz");
+		writeFile(properties, ".spring-boot-devtools.properties");
+		Properties properties2 = new Properties();
+		properties2.put("abc", "jkl");
+		OutputStream out2 = new FileOutputStream(
+				new File(this.home + "/.config/spring-boot/", ".spring-boot-devtools.properties"));
+		properties2.store(out2, null);
+		out2.close();
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
+		assertThat(environment.getProperty("abc")).isEqualTo("jkl");
+		assertThat(environment.getProperty("bar")).isEqualTo(null);
+	}
+
+	@Test
+	void loadFromConfigFolderWithYamlTakesPrecedenceOverHomeFolder() throws Exception {
+		Properties properties = new Properties();
+		properties.put("abc", "def");
+		properties.put("bar", "baz");
+		writeFile(properties, ".spring-boot-devtools.properties");
+		Properties properties2 = new Properties();
+		properties2.put("abc", "jkl");
+		OutputStream out2 = new FileOutputStream(
+				new File(this.home + "/.config/spring-boot/", ".spring-boot-devtools.yml"));
+		properties2.store(out2, null);
+		out2.close();
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
+		assertThat(environment.getProperty("abc")).isEqualTo("jkl");
+		assertThat(environment.getProperty("bar")).isEqualTo(null);
+	}
+
 	@Test
 	void ignoresMissingHomeProperties() throws Exception {
+		ConfigurableEnvironment environment = getPostProcessedEnvironment();
+		assertThat(environment.getProperty("abc")).isNull();
+	}
+
+	private void writeFile(Properties properties, String s) throws IOException {
+		OutputStream out = new FileOutputStream(new File(this.home, s));
+		properties.store(out, null);
+		out.close();
+	}
+
+	private ConfigurableEnvironment getPostProcessedEnvironment() throws Exception {
 		ConfigurableEnvironment environment = new MockEnvironment();
 		MockDevToolHomePropertiesPostProcessor postProcessor = new MockDevToolHomePropertiesPostProcessor();
 		runPostProcessor(() -> postProcessor.postProcessEnvironment(environment, null));
-		assertThat(environment.getProperty("abc")).isNull();
+		return environment;
 	}
 
 	protected void runPostProcessor(Runnable runnable) throws Exception {

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -431,7 +431,7 @@ Spring Boot uses a very particular `PropertySource` order that is designed to al
 sensible overriding of values. Properties are considered in the following order:
 
 . <<using-boot-devtools-globalsettings,Devtools global settings properties>>
-on your home directory (`~/.spring-boot-devtools.properties` when devtools is active).
+in the `$HOME/.config/spring-boot` folder when devtools is active.
 . {spring-javadoc}/test/context/TestPropertySource.{dc-ext}[`@TestPropertySource`]
 annotations on your tests.
 . `properties` attribute on your tests. Available on

spring-boot-project/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc

@@ -1018,20 +1018,30 @@ from your IDE, only the first has LiveReload support.
 
 [[using-boot-devtools-globalsettings]]
 === Global Settings
-You can configure global devtools settings by adding a file named
+You can configure global devtools settings by adding any of the following files to the `$HOME/.config/spring-boot`
-`.spring-boot-devtools.properties` to your `$HOME` folder (note that the filename starts
+folder (note that the filenames startswith "`.`"):
-with "`.`"). Any properties added to this file apply to _all_ Spring Boot applications on
+
+. `.spring-boot-devtools.properties`
+. `.spring-boot-devtools.yaml`
+. `.spring-boot-devtools.yml`
+
+Any properties added to these file apply to _all_ Spring Boot applications on
 your machine that use devtools. For example, to configure restart to always use a
 <<using-boot-devtools-restart-triggerfile, trigger file>>, you would add the following
 property:
 
-.~/.spring-boot-devtools.properties
+.~/config/spring-boot/.spring-boot-devtools.properties
 [source,properties,indent=0]
 ----
 	spring.devtools.reload.trigger-file=.reloadtrigger
 ----
 
-NOTE: Profiles activated in `.spring-boot-devtools.properties` will not affect the
+NOTE: If devtools configuration files are not found in `$HOME/.config/spring-boot`, the root of the `$HOME` folder
+is searched for the presence of a `.spring-boot-devtools.properties` file. This allows you to share the devtools global
+configuration with applications that are on an older version of Spring Boot that does not support the `$HOME/.config/spring-boot`
+location.
+
+NOTE: Profiles activated in the above files will not affect the
 loading of <<spring-boot-features.adoc#boot-features-external-config-profile-specific-properties,
 profile-specific configuration files>>.