From 895d092640ae7cea28844695487f56be6a5ab319 Mon Sep 17 00:00:00 2001 From: Madhura Bhave Date: Mon, 13 Aug 2018 17:54:45 -0700 Subject: [PATCH] PropertySourcesLoader with highest precedence should win Fixes gh-13955 --- .../config/ConfigFileApplicationListener.java | 13 +++-- .../ConfigFileApplicationListenerTests.java | 17 ++++++- .../config/TestPropertySourceLoader1.java | 47 +++++++++++++++++++ .../config/TestPropertySourceLoader2.java | 47 +++++++++++++++++++ .../test/resources/META-INF/spring.factories | 3 ++ .../src/test/resources/application.custom | 0 6 files changed, 122 insertions(+), 5 deletions(-) create mode 100644 spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader1.java create mode 100644 spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader2.java create mode 100644 spring-boot-project/spring-boot/src/test/resources/META-INF/spring.factories create mode 100644 spring-boot-project/spring-boot/src/test/resources/application.custom diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java index 8a47727dd32..2c589e0bc44 100644 --- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java +++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java @@ -459,15 +459,20 @@ public class ConfigFileApplicationListener if (canLoadFileExtension(loader, location)) { load(loader, location, profile, filterFactory.getDocumentFilter(profile), consumer); + return; } } } + Set processedExtensions = new HashSet<>(); for (PropertySourceLoader loader : this.propertySourceLoaders) { for (String fileExtension : loader.getFileExtensions()) { - String prefix = location + name; - fileExtension = "." + fileExtension; - loadForFileExtension(loader, prefix, fileExtension, profile, - filterFactory, consumer); + if (!processedExtensions.contains(fileExtension)) { + processedExtensions.add(fileExtension); + String prefix = location + name; + fileExtension = "." + fileExtension; + loadForFileExtension(loader, prefix, fileExtension, profile, + filterFactory, consumer); + } } } } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigFileApplicationListenerTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigFileApplicationListenerTests.java index a3061139282..7c3f7760e97 100644 --- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigFileApplicationListenerTests.java +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigFileApplicationListenerTests.java @@ -926,6 +926,21 @@ public class ConfigFileApplicationListenerTests { assertThat(environment.getProperty("message")).isEqualTo("multiprofile"); } + @Test + public void propertiesFromCustomPropertySourceLoaderShouldBeUsed() { + this.initializer.postProcessEnvironment(this.environment, this.application); + assertThat(this.environment.getProperty("customloader1")).isEqualTo("true"); + } + + @Test + public void propertiesFromCustomPropertySourceLoaderShouldBeUsedWithSpecificResource() { + String location = "classpath:application.custom"; + TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.environment, + "spring.config.location=" + location); + this.initializer.postProcessEnvironment(this.environment, this.application); + assertThat(this.environment.getProperty("customloader1")).isEqualTo("true"); + } + private Condition matchingPropertySource( final String sourceName) { return new Condition( @@ -1018,7 +1033,7 @@ public class ConfigFileApplicationListenerTests { @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { - assertThat(environment.getPropertySources()).hasSize(4); + assertThat(environment.getPropertySources()).hasSize(5); } } diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader1.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader1.java new file mode 100644 index 00000000000..22342958df1 --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader1.java @@ -0,0 +1,47 @@ +/* + * Copyright 2012-2018 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 + * + * http://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.util.Collections; +import java.util.List; +import java.util.Map; + +import org.springframework.boot.env.PropertySourceLoader; +import org.springframework.core.env.MapPropertySource; +import org.springframework.core.env.PropertySource; +import org.springframework.core.io.Resource; + +/** + * {@link PropertySourceLoader} for tests. + * + * @author Madhura Bhave + */ +class TestPropertySourceLoader1 implements PropertySourceLoader { + + @Override + public String[] getFileExtensions() { + return new String[] { "custom" }; + } + + @Override + public List> load(String name, Resource resource) + throws IOException { + Map map = Collections.singletonMap("customloader1", "true"); + return Collections.singletonList(new MapPropertySource(name, map)); + } + +} diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader2.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader2.java new file mode 100644 index 00000000000..eaf304a6925 --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/TestPropertySourceLoader2.java @@ -0,0 +1,47 @@ +/* + * Copyright 2012-2018 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 + * + * http://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.util.Collections; +import java.util.List; +import java.util.Map; + +import org.springframework.boot.env.PropertySourceLoader; +import org.springframework.core.env.MapPropertySource; +import org.springframework.core.env.PropertySource; +import org.springframework.core.io.Resource; + +/** + * {@link PropertySourceLoader} for tests. + * + * @author Madhura Bhave + */ +class TestPropertySourceLoader2 implements PropertySourceLoader { + + @Override + public String[] getFileExtensions() { + return new String[] { "custom" }; + } + + @Override + public List> load(String name, Resource resource) + throws IOException { + Map map = Collections.singletonMap("customloader2", "true"); + return Collections.singletonList(new MapPropertySource(name, map)); + } + +} diff --git a/spring-boot-project/spring-boot/src/test/resources/META-INF/spring.factories b/spring-boot-project/spring-boot/src/test/resources/META-INF/spring.factories new file mode 100644 index 00000000000..28089105706 --- /dev/null +++ b/spring-boot-project/spring-boot/src/test/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +org.springframework.boot.env.PropertySourceLoader=\ +org.springframework.boot.context.config.TestPropertySourceLoader1,\ +org.springframework.boot.context.config.TestPropertySourceLoader2 \ No newline at end of file diff --git a/spring-boot-project/spring-boot/src/test/resources/application.custom b/spring-boot-project/spring-boot/src/test/resources/application.custom new file mode 100644 index 00000000000..e69de29bb2d