Skip to content

Commit 6b4d01c

Browse files
ryanjbaxterryanjbaxter
authored
Merge pull request #1956 from wind57/fix-1935
Fix 1935
2 parents 577dc93 + d7062a6 commit 6b4d01c

File tree

14 files changed

+795
-59
lines changed

14 files changed

+795
-59
lines changed

‎spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/ConfigMapPropertySourceLocator.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ private void addPropertySourcesFromPaths(Environment environment, CompositePrope
136136
filename, composite);
137137
}
138138
else if (filename.endsWith(".yml") || filename.endsWith(".yaml")) {
139-
addPropertySourceIfNeeded(c -> PROPERTIES_TO_MAP.apply(yamlParserGenerator(environment).apply(c)),
140-
content, filename, composite);
139+
addPropertySourceIfNeeded(c -> yamlParserGenerator(environment).apply(c), content, filename,
140+
composite);
141141
}
142142
}
143143
catch (IOException e) {

‎spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/ProfileActivationAwareYamlPropertiesFactoryBean.java‎

Lines changed: 270 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
1+
/*
2+
* Copyright 2013-2025 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.cloud.kubernetes.commons.config;
18+
19+
import java.io.IOException;
20+
import java.io.Reader;
21+
import java.nio.charset.StandardCharsets;
22+
import java.util.ArrayList;
23+
import java.util.Collection;
24+
import java.util.Collections;
25+
import java.util.LinkedHashMap;
26+
import java.util.List;
27+
import java.util.Map;
28+
import java.util.Properties;
29+
import java.util.stream.Collectors;
30+
31+
import org.apache.commons.logging.LogFactory;
32+
import org.yaml.snakeyaml.Yaml;
33+
import org.yaml.snakeyaml.reader.UnicodeReader;
34+
35+
import org.springframework.core.CollectionFactory;
36+
import org.springframework.core.io.ByteArrayResource;
37+
import org.springframework.core.io.Resource;
38+
import org.springframework.core.log.LogAccessor;
39+
import org.springframework.lang.Nullable;
40+
import org.springframework.util.StringUtils;
41+
42+
import static org.springframework.beans.factory.config.YamlProcessor.DocumentMatcher;
43+
import static org.springframework.beans.factory.config.YamlProcessor.MatchStatus;
44+
import static org.springframework.cloud.kubernetes.commons.config.Constants.SPRING_CONFIG_ACTIVATE_ON_PROFILE;
45+
import static org.springframework.cloud.kubernetes.commons.config.Constants.SPRING_PROFILES;
46+
47+
/**
48+
* A class based on
49+
* {@link org.springframework.beans.factory.config.YamlPropertiesFactoryBean} that takes
50+
* care to override profile-based collections and maps.
51+
*
52+
* We can't use the same functionality of loading yaml files that spring-boot does :
53+
* {@link org.springframework.boot.env.YamlPropertySourceLoader} and thus OriginTrackedYamlLoader,
54+
* because spring-boot loads every single yaml document (all in a file) into a separate PropertySource.
55+
* So each yaml document ends up in a separate PropertySource. We, on the other hand, have to load all yaml documents
56+
* into a single Properties file, that ends up being a single PropertySource.
57+
* This happens because we first have to read configmaps / secrets
58+
* and only at that point do we know if a yaml contains more than one document.
59+
*
60+
* As such, we mimic the same things that spring-boot achieves by creating our own yaml reader, that is neavily based
61+
* on the YamlPropertiesFactoryBean.
62+
*
63+
* This is how it does things:
64+
*
65+
* <ul>
66+
* <li>read all the documents in a yaml file</li>
67+
* <li>flatten all properties besides collection and maps,
68+
* YamlPropertiesFactoryBean does not do that and starts flattening everything</li>
69+
* <li>take only those that match the document matchers</li>
70+
* <li>split them in two : those that have profile activation and those that don't</li>
71+
* <li>override properties in the non-profile based yamls with the ones from profile based ones.
72+
* This achieves the same result as a plain spring-boot app, where profile based properties have a higher
73+
* precedence.</li>
74+
* <li>once the overriding happened, we do another flattening, this time including collection and maps</li>
75+
* </ul>
76+
*
77+
* @author wind57
78+
*/
79+
final class ProfileActivationAwareYamlPropertiesFactoryBean {
80+
81+
private static final LogAccessor LOG = new LogAccessor(LogFactory.getLog(ProfileActivationAwareYamlPropertiesFactoryBean.class));
82+
83+
private List<DocumentMatcher> documentMatchers = Collections.emptyList();
84+
85+
Map<String, Object> createProperties(String source) {
86+
LinkedHashMap<String, Object> finalMap = new LinkedHashMap<>();
87+
Yaml yaml = new Yaml();
88+
89+
Resource resource = new ByteArrayResource(source.getBytes(StandardCharsets.UTF_8));
90+
try (Reader reader = new UnicodeReader(resource.getInputStream())) {
91+
Iterable<Object> iterable = yaml.loadAll(reader);
92+
93+
List<LinkedHashMap<String, Object>> allYamlDocuments = new ArrayList<>();
94+
95+
// 1. read all the documents that are contained in the yaml (might be more
96+
// than one).
97+
// We flatten all properties besides collection and maps. This is needed to
98+
// be able to properly override them
99+
for (Object singleYamlDocument : iterable) {
100+
if (singleYamlDocument != null) {
101+
LinkedHashMap<String, Object> flattenedMap = new LinkedHashMap<>();
102+
Map<String, Object> originalSource = asMap(singleYamlDocument);
103+
buildFlattenedMapWithoutComplexObjects(flattenedMap, originalSource, null);
104+
allYamlDocuments.add(flattenedMap);
105+
}
106+
}
107+
108+
// 2. take only those that match document matchers
109+
List<LinkedHashMap<String, Object>> yamlDocumentsMatchedAgainstDocumentMatchers = filterBasedOnDocumentMatchers(
110+
allYamlDocuments);
111+
112+
// 3. split them in two: ones that do not have any profile activation
113+
// and ones that do have profile activation.
114+
Map<Boolean, List<LinkedHashMap<String, Object>>> partitioned = yamlDocumentsMatchedAgainstDocumentMatchers
115+
.stream()
116+
.collect(Collectors.partitioningBy(
117+
x -> !x.containsKey(SPRING_CONFIG_ACTIVATE_ON_PROFILE) && !x.containsKey(SPRING_PROFILES)));
118+
119+
LOG.debug(() -> "non-profile source : " + partitioned.get(Boolean.TRUE).toString());
120+
LOG.debug(() -> "profile source : " + partitioned.get(Boolean.FALSE));
121+
122+
// 4. once they are split, iterate and compute a single properties map
123+
// (with collections and maps unflattened yet), but correctly overridden.
124+
// Meaning non-profile-based sources come first.
125+
126+
LinkedHashMap<String, Object> flattenedWithoutComplexObjects = new LinkedHashMap<>();
127+
partitioned.get(Boolean.TRUE).forEach(flattenedWithoutComplexObjects::putAll);
128+
partitioned.get(Boolean.FALSE).forEach(flattenedWithoutComplexObjects::putAll);
129+
130+
// 5. we now know the correct order, let's do the final flattening
131+
buildFlattenedMap(finalMap, flattenedWithoutComplexObjects, null);
132+
133+
LOG.debug(() -> "final source : " + finalMap);
134+
135+
}
136+
catch (IOException e) {
137+
throw new RuntimeException(e);
138+
}
139+
140+
return finalMap;
141+
}
142+
143+
void setDocumentMatchers(DocumentMatcher... matchers) {
144+
this.documentMatchers = List.of(matchers);
145+
}
146+
147+
private List<LinkedHashMap<String, Object>> filterBasedOnDocumentMatchers(
148+
List<LinkedHashMap<String, Object>> allDocuments) {
149+
return allDocuments.stream().filter(x -> {
150+
Properties properties = CollectionFactory.createStringAdaptingProperties();
151+
properties.putAll(x);
152+
MatchStatus matchStatus = MatchStatus.ABSTAIN;
153+
for (DocumentMatcher matcher : this.documentMatchers) {
154+
MatchStatus match = matcher.matches(properties);
155+
matchStatus = MatchStatus.getMostSpecific(match, matchStatus);
156+
if (match == MatchStatus.FOUND) {
157+
LOG.debug(() -> "Matched document with document matcher: " + properties);
158+
return true;
159+
}
160+
161+
if (matchStatus == MatchStatus.ABSTAIN) {
162+
LOG.debug(() -> "Matched document with default matcher: " + properties);
163+
return true;
164+
}
165+
}
166+
return false;
167+
}).toList();
168+
}
169+
170+
/**
171+
* builds the flattened properties.
172+
*/
173+
@SuppressWarnings({ "rawtypes", "unchecked" })
174+
private static void buildFlattenedMap(Map<String, Object> result, Map<String, Object> source,
175+
@Nullable String path) {
176+
source.forEach((key, value) -> {
177+
if (StringUtils.hasText(path)) {
178+
if (key.startsWith("[")) {
179+
key = path + key;
180+
}
181+
else {
182+
key = path + '.' + key;
183+
}
184+
}
185+
if (value instanceof String) {
186+
result.put(key, value);
187+
}
188+
else if (value instanceof Map map) {
189+
// Need a compound key
190+
buildFlattenedMap(result, map, key);
191+
}
192+
else if (value instanceof Collection collection) {
193+
// Need a compound key
194+
if (collection.isEmpty()) {
195+
result.put(key, "");
196+
}
197+
else {
198+
int count = 0;
199+
for (Object object : collection) {
200+
buildFlattenedMap(result, Collections.singletonMap("[" + (count++) + "]", object), key);
201+
}
202+
}
203+
}
204+
else {
205+
result.put(key, (value != null ? value : ""));
206+
}
207+
});
208+
}
209+
210+
/**
211+
* flatten properties, but without collections or maps. So it looks like this, for
212+
* example: <pre>
213+
* bean.test=[{name=Alice, role=admin}, {name=ER, role=user}]}, {bean.items=[Item 10]}]
214+
* </pre>
215+
*/
216+
@SuppressWarnings({ "rawtypes", "unchecked" })
217+
private static void buildFlattenedMapWithoutComplexObjects(Map<String, Object> result, Map<String, Object> source,
218+
@Nullable String path) {
219+
source.forEach((key, value) -> {
220+
if (StringUtils.hasText(path)) {
221+
if (key.startsWith("[")) {
222+
key = path + key;
223+
}
224+
else {
225+
key = path + '.' + key;
226+
}
227+
}
228+
if (value instanceof String) {
229+
result.put(key, value);
230+
}
231+
else if (value instanceof Map map) {
232+
// Need a compound key
233+
buildFlattenedMapWithoutComplexObjects(result, map, key);
234+
}
235+
else if (value instanceof Collection collection) {
236+
if (collection.isEmpty()) {
237+
result.put(key, "");
238+
}
239+
else {
240+
result.put(key, collection);
241+
}
242+
}
243+
else {
244+
result.put(key, (value != null ? value : ""));
245+
}
246+
});
247+
}
248+
249+
@SuppressWarnings({ "rawtypes", "unchecked" })
250+
private static Map<String, Object> asMap(Object object) {
251+
Map<String, Object> result = new LinkedHashMap<>();
252+
if (object instanceof Map map) {
253+
map.forEach((key, value) -> {
254+
if (value instanceof Map) {
255+
value = asMap(value);
256+
}
257+
if (key instanceof CharSequence) {
258+
result.put(key.toString(), value);
259+
}
260+
else {
261+
// It has to be a map key in this case
262+
result.put("[" + key.toString() + "]", value);
263+
}
264+
});
265+
}
266+
267+
return result;
268+
}
269+
270+
}

‎spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/PropertySourceUtils.java‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,14 @@
1919
import java.io.ByteArrayInputStream;
2020
import java.io.IOException;
2121
import java.io.UncheckedIOException;
22-
import java.nio.charset.StandardCharsets;
2322
import java.util.Map;
2423
import java.util.Properties;
2524
import java.util.function.BinaryOperator;
2625
import java.util.function.Function;
2726
import java.util.stream.Collectors;
2827

29-
import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
3028
import org.springframework.core.env.Environment;
3129
import org.springframework.core.env.Profiles;
32-
import org.springframework.core.io.ByteArrayResource;
3330
import org.springframework.util.StringUtils;
3431

3532
import static org.springframework.beans.factory.config.YamlProcessor.MatchStatus.ABSTAIN;
@@ -76,9 +73,9 @@ private PropertySourceUtils() {
7673
* @param environment Environment.
7774
* @return properties.
7875
*/
79-
public static Function<String, Properties> yamlParserGenerator(Environment environment) {
80-
return s -> {
81-
YamlPropertiesFactoryBean yamlFactory = new YamlPropertiesFactoryBean();
76+
public static Function<String, Map<String, Object>> yamlParserGenerator(Environment environment) {
77+
return source -> {
78+
ProfileActivationAwareYamlPropertiesFactoryBean yamlFactory = new ProfileActivationAwareYamlPropertiesFactoryBean();
8279
yamlFactory.setDocumentMatchers(properties -> {
8380
if (environment != null) {
8481
String profiles = null;
@@ -98,8 +95,7 @@ else if (springProfiles != null) {
9895
}
9996
return ABSTAIN;
10097
});
101-
yamlFactory.setResources(new ByteArrayResource(s.getBytes(StandardCharsets.UTF_8)));
102-
return yamlFactory.getObject();
98+
return yamlFactory.createProperties(source);
10399
};
104100
}
105101

@@ -109,6 +105,7 @@ else if (springProfiles != null) {
109105
* @param <T> type of the argument
110106
* @return a {@link BinaryOperator}
111107
*/
108+
@Deprecated(forRemoval = true)
112109
public static <T> BinaryOperator<T> throwingMerger() {
113110
return (left, right) -> {
114111
throw new IllegalStateException("Duplicate key " + left);

‎spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/config/SourceDataEntriesProcessor.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public static Map<String, Object> processAllEntries(Map<String, String> input, E
7171
String propertyValue = singleEntry.getValue();
7272
if (propertyName.endsWith(".yml") || propertyName.endsWith(".yaml")) {
7373
LOG.debug("The single property with name: [" + propertyName + "] will be treated as a yaml file");
74-
return yamlParserGenerator(environment).andThen(PROPERTIES_TO_MAP).apply(propertyValue);
74+
return yamlParserGenerator(environment).apply(propertyValue);
7575
}
7676
else if (propertyName.endsWith(".properties")) {
7777
LOG.debug("The single property with name: [" + propertyName + "] will be treated as a properties file");
@@ -176,15 +176,15 @@ private static Map<String, Object> defaultProcessAllEntries(Map<String, String>
176176

177177
private static Map<String, Object> extractProperties(String resourceName, String content, Environment environment) {
178178

179-
if (resourceName.endsWith(".yml") || resourceName.endsWith(".yaml") || resourceName.endsWith(".properties")) {
179+
if (ENDS_IN_EXTENSION.test(resourceName)) {
180180

181181
if (resourceName.endsWith(".properties")) {
182182
LOG.debug("entry : " + resourceName + " will be treated as a single properties file");
183183
return KEY_VALUE_TO_PROPERTIES.andThen(PROPERTIES_TO_MAP).apply(content);
184184
}
185185
else {
186186
LOG.debug("entry : " + resourceName + " will be treated as a single yml/yaml file");
187-
return yamlParserGenerator(environment).andThen(PROPERTIES_TO_MAP).apply(content);
187+
return yamlParserGenerator(environment).apply(content);
188188
}
189189
}
190190

0 commit comments

Comments
 (0)