root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Fix legacy environment names in isAncestorOf 

Fix the `SystemEnvironmentPropertyMapper.isAncestorOf` implementation
to convert names based on their dashed form and to silently ignore
any invalid results.

Closes gh-14479
This commit is contained in:
Phillip Webb 2020-05-06 11:35:39 -07:00
parent 70c4baeef6
commit b4963d2463
2 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/properties/source/SystemEnvironmentPropertyMapper.java
View File

@ -39,7 +39,7 @@ final class SystemEnvironmentPropertyMapper implements PropertyMapper {
@Override @Override
public PropertyMapping[] map(ConfigurationPropertyName configurationPropertyName) { public PropertyMapping[] map(ConfigurationPropertyName configurationPropertyName) {
String name = convertName(configurationPropertyName); String name = convertName(configurationPropertyName);
String legacyName = convertLegacyName(configurationPropertyName, '_', true); String legacyName = convertLegacyName(configurationPropertyName);
if (name.equals(legacyName)) { if (name.equals(legacyName)) {
return new PropertyMapping[] { new PropertyMapping(name, configurationPropertyName) }; return new PropertyMapping[] { new PropertyMapping(name, configurationPropertyName) };
} }
@ -62,7 +62,25 @@ final class SystemEnvironmentPropertyMapper implements PropertyMapper {
} }
private boolean isLegacyAncestorOf(ConfigurationPropertyName name, ConfigurationPropertyName candidate) { private boolean isLegacyAncestorOf(ConfigurationPropertyName name, ConfigurationPropertyName candidate) {
return ConfigurationPropertyName.of(convertLegacyName(name, '.', false)).isAncestorOf(candidate); if (!hasDashedEntries(name)) {
return false;
}
StringBuilder legacyCompatibleName = new StringBuilder();
for (int i = 0; i < name.getNumberOfElements(); i++) {
legacyCompatibleName.append((i != 0) ? "." : "");
legacyCompatibleName.append(name.getElement(i, Form.DASHED).replace('-', '.'));
}
return ConfigurationPropertyName.isValid(legacyCompatibleName)
&& ConfigurationPropertyName.of(legacyCompatibleName).isAncestorOf(candidate);
}
boolean hasDashedEntries(ConfigurationPropertyName name) {
for (int i = 0; i < name.getNumberOfElements(); i++) {
if (name.getElement(i, Form.DASHED).indexOf('-') != -1) {
return true;
}
}
return false;
} }
private ConfigurationPropertyName convertName(String propertySourceName) { private ConfigurationPropertyName convertName(String propertySourceName) {
@ -89,21 +107,19 @@ final class SystemEnvironmentPropertyMapper implements PropertyMapper {
return result.toString(); return result.toString();
} }
private String convertLegacyName(ConfigurationPropertyName name, char joinChar, boolean uppercase) { private String convertLegacyName(ConfigurationPropertyName name) {
StringBuilder result = new StringBuilder(); StringBuilder result = new StringBuilder();
for (int i = 0; i < name.getNumberOfElements(); i++) { for (int i = 0; i < name.getNumberOfElements(); i++) {
if (result.length() > 0) { if (result.length() > 0) {
result.append(joinChar); result.append("_");
} }
String element = name.getElement(i, Form.ORIGINAL); result.append(convertLegacyNameElement(name.getElement(i, Form.ORIGINAL)));
result.append(convertLegacyNameElement(element, joinChar, uppercase));
} }
return result.toString(); return result.toString();
} }
private Object convertLegacyNameElement(String element, char joinChar, boolean uppercase) { private Object convertLegacyNameElement(String element) {
String converted = element.replace('-', joinChar); return element.replace('-', '_').toUpperCase(Locale.ENGLISH);
return !uppercase ? converted : converted.toUpperCase(Locale.ENGLISH);
} }
private CharSequence processElementValue(CharSequence value) { private CharSequence processElementValue(CharSequence value) {

8
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/properties/source/SystemEnvironmentPropertyMapperTests.java
View File

@ -83,4 +83,12 @@ class SystemEnvironmentPropertyMapperTests extends AbstractPropertyMapperTests {
assertThat(getMapper().isAncestorOf(name, ConfigurationPropertyName.of("my.boot.property"))).isFalse(); assertThat(getMapper().isAncestorOf(name, ConfigurationPropertyName.of("my.boot.property"))).isFalse();
} }
@Test
void isAncestorOfWhenCamelCaseSourceConsidersLegacyNames() {
ConfigurationPropertyName name = ConfigurationPropertyName.adapt("my.springBoot", '.');
assertThat(getMapper().isAncestorOf(name, ConfigurationPropertyName.of("my.spring-boot.property"))).isTrue();
assertThat(getMapper().isAncestorOf(name, ConfigurationPropertyName.of("my.springboot.property"))).isTrue();
assertThat(getMapper().isAncestorOf(name, ConfigurationPropertyName.of("my.boot.property"))).isFalse();
}
} }