Skip to content

S
spring-boot
Commit d1b256a1 authored by Phillip Webb's avatar Phillip Webb
Browse files
Options

Prevent indirect standard profile-specific imports 

Update `StandardConfigDataLocationResolver` so that profile-specific
imports can only be used when there is no parent import.

Prior to this commit, given the following application.properties file:

	spring.profiles.active=p1,p2
	spring.config.import=other.properties

We would attempt to import `other.properties`, `other-p1.properties`
and `other-p2.properties`. This seems quite confusing and when we really
only need to support profile-specific properties for the initial root
set of locations.

Fixes gh-26752
parent ad99aa2f
Hide whitespace changes
Inline Side-by-side
Showing with 33 additions and 8 deletions
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/StandardConfigDataLocationResolver.java
View file @ d1b256a1
...@@ -135,6 +135,9 @@ public class StandardConfigDataLocationResolver ...@@ -135,6 +135,9 @@ public class StandardConfigDataLocationResolver
@Override @Override
public List<StandardConfigDataResource> resolveProfileSpecific(ConfigDataLocationResolverContext context, public List<StandardConfigDataResource> resolveProfileSpecific(ConfigDataLocationResolverContext context,
ConfigDataLocation location, Profiles profiles) { ConfigDataLocation location, Profiles profiles) {
if (context.getParent() != null) {
return null;
}
return resolve(getProfileSpecificReferences(context, location, profiles)); return resolve(getProfileSpecificReferences(context, location, profiles));
} }
......
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataEnvironmentPostProcessorIntegrationTests.java
View file @ d1b256a1
...@@ -614,7 +614,8 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests { ...@@ -614,7 +614,8 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests {
this.application.setAdditionalProfiles("dev"); this.application.setAdditionalProfiles("dev");
ConfigurableApplicationContext context = this.application ConfigurableApplicationContext context = this.application
.run("--spring.config.location=classpath:application-import-with-profile-variant.properties"); .run("--spring.config.location=classpath:application-import-with-profile-variant.properties");
assertThat(context.getEnvironment().getProperty("my.value")).isEqualTo("iwasimported-dev"); assertThat(context.getEnvironment().getProperty("my.value"))
.isEqualTo("application-import-with-profile-variant-dev");
} }
@Test @Test
...@@ -622,7 +623,8 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests { ...@@ -622,7 +623,8 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests {
this.application.setAdditionalProfiles("dev"); this.application.setAdditionalProfiles("dev");
ConfigurableApplicationContext context = this.application.run( ConfigurableApplicationContext context = this.application.run(
"--spring.config.location=classpath:application-import-with-profile-variant-and-direct-profile-import.properties"); "--spring.config.location=classpath:application-import-with-profile-variant-and-direct-profile-import.properties");
assertThat(context.getEnvironment().getProperty("my.value")).isEqualTo("iwasimported-dev"); assertThat(context.getEnvironment().getProperty("my.value"))
.isEqualTo("application-import-with-profile-variant-imported-dev");
} }
@Test @Test
...@@ -746,6 +748,19 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests { ...@@ -746,6 +748,19 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests {
assertThat(environment.getProperty("test2")).isEqualTo("test2"); assertThat(environment.getProperty("test2")).isEqualTo("test2");
} }
@Test // gh-26752
void runWhenHasProfileSpecificImportWithImportDoesNotImportSecondProfileSpecificFile() {
ConfigurableApplicationContext context = this.application
.run("--spring.config.name=application-profile-specific-import-with-import");
ConfigurableEnvironment environment = context.getEnvironment();
assertThat(environment.containsProperty("application-profile-specific-import-with-import")).isTrue();
assertThat(environment.containsProperty("application-profile-specific-import-with-import-p1")).isTrue();
assertThat(environment.containsProperty("application-profile-specific-import-with-import-p2")).isFalse();
assertThat(environment.containsProperty("application-profile-specific-import-with-import-import")).isTrue();
assertThat(environment.containsProperty("application-profile-specific-import-with-import-import-p1")).isFalse();
assertThat(environment.containsProperty("application-profile-specific-import-with-import-import-p2")).isFalse();
}
private Condition<ConfigurableEnvironment> matchingPropertySource(final String sourceName) { private Condition<ConfigurableEnvironment> matchingPropertySource(final String sourceName) {
return new Condition<ConfigurableEnvironment>("environment containing property source " + sourceName) { return new Condition<ConfigurableEnvironment>("environment containing property source " + sourceName) {
......
spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-and-direct-profile-import-dev.properties
View file @ d1b256a1
spring.config.import=classpath:application-import-with-profile-variant-imported-dev.properties spring.config.import=classpath:application-import-with-profile-variant-imported-dev.properties
my.value=notimported-dev my.value=application-import-with-profile-variant-and-direct-profile-import-dev
spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-and-direct-profile-import.properties
View file @ d1b256a1
spring.config.import=classpath:application-import-with-profile-variant-imported.properties spring.config.import=classpath:application-import-with-profile-variant-imported.properties
my.value=notimported my.value=application-import-with-profile-variant-and-direct-profile-import
spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant.properties
View file @ d1b256a1
spring.config.import=classpath:application-import-with-profile-variant-imported.properties spring.config.import=classpath:application-import-with-profile-variant-imported.properties
my.value=notimported my.value=application-import-with-profile-variant
spring-boot-project/spring-boot/src/test/resources/application-profile-specific-import-with-import-p1.properties 0 → 100644
View file @ d1b256a1
application-profile-specific-import-with-import-p1=true
spring.config.import=application-profile-specific-import-with-import-import.properties
spring-boot-project/spring-boot/src/test/resources/application-profile-specific-import-with-import.properties 0 → 100644
View file @ d1b256a1
spring.profiles.active=p1,p2
application-profile-specific-import-with-import=true
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment