Preserve property ordering in SpringIterableConfigurationPropertySource

Fixes gh-21470
spring-projects · May 18, 2020 · beb7cb4 · beb7cb4
1 parent 4f31c3b
commit beb7cb4
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/...ngframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java b/...ngframework/boot/context/properties/source/SpringIterableConfigurationPropertySource.java
@@ -19,9 +19,9 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.ConcurrentModificationException;
-import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.NoSuchElementException;
 import java.util.Objects;
@@ -259,7 +259,7 @@ private void updateMappings(String[] propertyNames) {
 		}
 
 		private <K, V> Map<K, V> cloneOrCreate(Map<K, V> source, int size) {
-			return (source != null) ? new HashMap<>(source) : new HashMap<>(size);
+			return (source != null) ? new LinkedHashMap<>(source) : new LinkedHashMap<>(size);
 		}
 
 		private void addParents(Map<ConfigurationPropertyName, Set<ConfigurationPropertyName>> descendants,

diff --git a/...mework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java b/...mework/boot/context/properties/source/SpringIterableConfigurationPropertySourceTests.java
@@ -224,6 +224,20 @@ void readOnlyOriginTrackedMapPropertySourceKeyAdditionDoesNotInvalidateCache() {
 		assertThat(adapter.stream()).hasSize(2);
 	}
 
+	@Test
+	void orderOfUnderlyingSourceIsPreserved() {
+		Map<String, Object> map = new LinkedHashMap<>();
+		map.put("test.map.alpha", "value1");
+		map.put("test.map.bravo", "value2");
+		map.put("test.map.charlie", "value3");
+		map.put("test.map.delta", "value4");
+		EnumerablePropertySource<?> source = new OriginTrackedMapPropertySource("test", map, true);
+		SpringIterableConfigurationPropertySource propertySource = new SpringIterableConfigurationPropertySource(source,
+				DefaultPropertyMapper.INSTANCE);
+		assertThat(propertySource.stream().map(ConfigurationPropertyName::toString)).containsExactly("test.map.alpha",
+				"test.map.bravo", "test.map.charlie", "test.map.delta");
+	}
+
 	/**
 	 * Test {@link PropertySource} that's also an {@link OriginLookup}.
 	 *