Add volume mount property source support

Add support for volume mounted directories where the filename becomes
the property key and the file contents becomes the value.

Support is provided via a dedicated `VolumeMountDirectoryPropertySource`
class which can either be used directly, or via a "volumemount:/..."
`spring.config.import` location.

Closes gh-19990

Co-authored-by: Phillip Webb <[email protected]>

Author: mbhave

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

@@ -670,7 +670,7 @@ Locations will be processed in the order that they are defined, with later impor
 [TIP]
 ====
 Spring Boot includes pluggable API that allows various different location addresses to be supported.
-By default you can import Java Properties and YAML.
+By default you can import Java Properties, YAML and volume mounts.
 
 Third-party jars can offer support for additional technologies (there's no requirement for files to be local).
 For example, you can imagine config data being from external stores such as Consul, Apache ZooKeeper or Netflix Archaius.
@@ -680,6 +680,48 @@ If you want to support your own locations, see the `ConfigDataLocationResolver`
 
 
 
+[[boot-features-external-config-files-voumemounts]]
+==== Using Volume Mount Properties
+When running applications on a cloud platform (such as Kubernetes) you often need to read config values that the platform supplies.
+It's not uncommon to use environment variables for such purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.
+
+As an alternative to environment variables, many cloud platforms now allow you to map configuration into mounted data volumes.
+For example, Kubernetes can volume mount both https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap[`ConfigMaps`] and https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod[`Secrets`].
+
+There are two common volume mount patterns that can be use:
+
+. A single file contains a complete set of properties (usually written as YAML).
+. Multiple files are written to a directory with the filename becoming the '`key`' and the contents becoming the '`value`'.
+
+For the first case, you can import the YAML or Properties file directly using `spring.config.import` as described <<boot-features-external-config-files-importing,above>>.
+For the second case, you need to use the `volumemount:` prefix so that Spring Boot knows it needs to expose all the files as properties.
+
+As an example, let's imagine that Kubernetes has mounted the following volume:
+
+[source,indent=0]
+----
+	etc/
+	  config/
+	    myapp/
+	      username
+	      password
+----
+
+The contents of the `username` file would be a config value, and the contents of `password` would be a secret.
+
+To import these properties, you can add the following to your `application.properties` file:
+
+[source,properties,indent=0]
+----
+spring.config.import=volumemount:/etc/config
+----
+
+You can then access or inject `myapp.username` and `myapp.password` properties from the `Environment` in the usual way.
+
+TIP: Volume mounted values can be bound to both string `String` and `byte[]` types depending on the contents expected.
+
+
+
 [[boot-features-external-config-placeholders-in-properties]]
 ==== Property Placeholders
 The values in `application.properties` and `application.yml` are filtered through the existing `Environment` when they are used, so you can refer back to previously defined values (for example, from System properties).

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/VolumeMountConfigDataLoader.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2012-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.springframework.boot.context.config;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Collections;
+
+import org.springframework.boot.env.VolumeMountDirectoryPropertySource;
+
+/**
+ * {@link ConfigDataLoader} for directory locations mounted as volumes.
+ *
+ * @author Madhura Bhave
+ * @author Phillip Webb
+ */
+class VolumeMountConfigDataLoader implements ConfigDataLoader<VolumeMountConfigDataLocation> {
+
+	@Override
+	public ConfigData load(VolumeMountConfigDataLocation location) throws IOException {
+		Path path = location.getPath();
+		String name = "Volume mount config '" + path + "'";
+		VolumeMountDirectoryPropertySource source = new VolumeMountDirectoryPropertySource(name, path);
+		return new ConfigData(Collections.singletonList(source));
+	}
+
+}

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/VolumeMountConfigDataLocation.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2012-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.springframework.boot.context.config;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Objects;
+
+import org.springframework.util.Assert;
+
+/**
+ * {@link ConfigDataLocation} backed by a directory mounted as a volume.
+ *
+ * @author Madhura Bhave
+ * @author Phillip Webb
+ */
+class VolumeMountConfigDataLocation extends ConfigDataLocation {
+
+	private final Path path;
+
+	VolumeMountConfigDataLocation(String path) {
+		Assert.notNull(path, "Path must not be null");
+		this.path = Paths.get(path).toAbsolutePath();
+	}
+
+	Path getPath() {
+		return this.path;
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		if (this == obj) {
+			return true;
+		}
+		if (obj == null || getClass() != obj.getClass()) {
+			return false;
+		}
+		VolumeMountConfigDataLocation other = (VolumeMountConfigDataLocation) obj;
+		return Objects.equals(this.path, other.path);
+	}
+
+	@Override
+	public int hashCode() {
+		return this.path.hashCode();
+	}
+
+	@Override
+	public String toString() {
+		return "volume mount [" + this.path + "]";
+	}
+
+}

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/VolumeMountConfigDataLocationResolver.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2012-2020 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License 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 org.springframework.boot.context.config;
+
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * {@link ConfigDataLocationResolver} for volume mounted locations such as Kubernetes
+ * ConfigMaps and Secrets.
+ *
+ * @author Madhura Bhave
+ * @author Phillip Webb
+ */
+class VolumeMountConfigDataLocationResolver implements ConfigDataLocationResolver<VolumeMountConfigDataLocation> {
+
+	private static final String PREFIX = "volumemount:";
+
+	@Override
+	public boolean isResolvable(ConfigDataLocationResolverContext context, String location) {
+		return location.startsWith(PREFIX);
+	}
+
+	@Override
+	public List<VolumeMountConfigDataLocation> resolve(ConfigDataLocationResolverContext context, String location) {
+		VolumeMountConfigDataLocation resolved = new VolumeMountConfigDataLocation(location.substring(PREFIX.length()));
+		return Collections.singletonList(resolved);
+	}
+
+}