Merge pull request #18915 from schulzh

* pr/18915: Polish contribution Handle JSON keys containing a dot from CF environment as a single path segment Closes gh-18915
spring-projects · Feb 11, 2020 · 3917968 · 3917968
2 parents b0aba9e + 544dca7
commit 3917968
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/...rc/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java b/...rc/main/java/org/springframework/boot/cloud/CloudFoundryVcapEnvironmentPostProcessor.java
@@ -87,6 +87,7 @@
  *
  * @author Dave Syer
  * @author Andy Wilkinson
+ * @author Madhura Bhave
  * @since 1.3.0
  */
 public class CloudFoundryVcapEnvironmentPostProcessor
@@ -230,7 +231,19 @@ private String getPropertyName(String path, String key) {
 		if (key.startsWith("[")) {
 			return path + key;
 		}
+		if (shouldWrap(key)) {
+			return path + "[" + key + "]";
+		}
 		return path + "." + key;
 	}
 
+	private boolean shouldWrap(String key) {
+		for (char ch : key.toCharArray()) {
+			if (!Character.isLowerCase(ch) && !Character.isDigit(ch) && ch != '-') {
+				return true;
+			}
+		}
+		return false;
+	}
+
 }
diff --git a/...pringframework/boot/cloud/cloudfoundry/CloudFoundryVcapEnvironmentPostProcessorTests.java b/...pringframework/boot/cloud/cloudfoundry/CloudFoundryVcapEnvironmentPostProcessorTests.java
@@ -30,6 +30,8 @@
  *
  * @author Dave Syer
  * @author Andy Wilkinson
+ * @author Hans Schulz
+ * @author Madhura Bhave
  */
 public class CloudFoundryVcapEnvironmentPostProcessorTests {
 
@@ -117,6 +119,26 @@ public void testServicePropertiesWithoutNA() {
 		assertThat(getProperty("vcap.services.mysql.credentials.port")).isEqualTo("3306");
 	}
 
+	@Test
+	public void testServicePropertiesContainingKeysWithDot() {
+		TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.context,
+				"VCAP_SERVICES={\"user-provided\":[{\"name\":\"test\",\"label\":\"test-label\","
+						+ "\"credentials\":{\"key.with.dots\":\"some-value\"}}]}");
+		this.initializer.postProcessEnvironment(this.context.getEnvironment(), null);
+		assertThat(getProperty("vcap.services.test.name")).isEqualTo("test");
+		assertThat(getProperty("vcap.services.test.credentials[key.with.dots]")).isEqualTo("some-value");
+	}
+
+	@Test
+	public void testServicePropertiesContainingKeysWithUpperCaseAndNonAlphaNumericCharacters() {
+		TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.context,
+				"VCAP_SERVICES={\"user-provided\":[{\"name\":\"test\",\"label\":\"test-label\","
+						+ "\"credentials\":{\"My-Key\":\"some-value\", \"foo@\":\"bar\"}}]}");
+		this.initializer.postProcessEnvironment(this.context.getEnvironment(), null);
+		assertThat(getProperty("vcap.services.test.credentials[My-Key]")).isEqualTo("some-value");
+		assertThat(getProperty("vcap.services.test.credentials[foo@]")).isEqualTo("bar");
+	}
+
 	private String getProperty(String key) {
 		return this.context.getEnvironment().getProperty(key);
 	}