From fef62f784a7f07de11d37a00c23018c54b09c9ab Mon Sep 17 00:00:00 2001
From: Phillip Webb <pwebb@vmware.com>
Date: Thu, 6 May 2021 18:08:29 -0700
Subject: [PATCH] Import profile specific files in correct order

Update `StandardConfigDataLoader` to mark profile specific files with
`Option.PROFILE` so that they are added in the correct order. This is
a variation of the same issue described in commit 5774ea3f0c.

Closes gh-26400

Co-authored-by: Scott Frederick <sfrederick@vmware.com>
Co-authored-by: Madhura Bhave <mbhave@vmware.com>
---
 .../boot/context/config/ConfigData.java        | 18 +++++++++++++++---
 .../config/StandardConfigDataLoader.java       |  9 ++++++++-
 ...vironmentPostProcessorIntegrationTests.java |  8 ++++++++
 ...-import-with-profile-variant-dev.properties |  1 +
 ...ith-profile-variant-imported-dev.properties |  1 +
 ...rt-with-profile-variant-imported.properties |  1 +
 ...tion-import-with-profile-variant.properties |  2 ++
 7 files changed, 36 insertions(+), 4 deletions(-)
 create mode 100644 spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-dev.properties
 create mode 100644 spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported-dev.properties
 create mode 100644 spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported.properties
 create mode 100644 spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant.properties

diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigData.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigData.java
index fcb5eb83fc..d9e5a4be8f 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigData.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigData.java
@@ -118,6 +118,13 @@ public final class ConfigData {
 	@FunctionalInterface
 	public interface PropertySourceOptions {
 
+		/**
+		 * {@link PropertySourceOptions} instance that always returns
+		 * {@link Options#NONE}.
+		 * @since 2.4.6
+		 */
+		PropertySourceOptions ALWAYS_NONE = new AlwaysPropertySourceOptions(Options.NONE);
+
 		/**
 		 * Return the options that should apply for the given property source.
 		 * @param propertySource the property source
@@ -142,6 +149,9 @@ public final class ConfigData {
 		 * @return a new {@link PropertySourceOptions} instance
 		 */
 		static PropertySourceOptions always(Options options) {
+			if (options == Options.NONE) {
+				return ALWAYS_NONE;
+			}
 			return new AlwaysPropertySourceOptions(options);
 		}
 
@@ -175,7 +185,7 @@ public final class ConfigData {
 		/**
 		 * No options.
 		 */
-		public static final Options NONE = Options.of();
+		public static final Options NONE = new Options(Collections.emptySet());
 
 		private final Set<Option> options;
 
@@ -238,8 +248,10 @@ public final class ConfigData {
 		 */
 		public static Options of(Option... options) {
 			Assert.notNull(options, "Options must not be null");
-			return new Options(
-					(options.length != 0) ? EnumSet.copyOf(Arrays.asList(options)) : EnumSet.noneOf(Option.class));
+			if (options.length == 0) {
+				return NONE;
+			}
+			return new Options(EnumSet.copyOf(Arrays.asList(options)));
 		}
 
 	}
diff --git a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/StandardConfigDataLoader.java b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/StandardConfigDataLoader.java
index e4c9cf7123..ff35c0e518 100644
--- a/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/StandardConfigDataLoader.java
+++ b/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/context/config/StandardConfigDataLoader.java
@@ -19,6 +19,8 @@ package org.springframework.boot.context.config;
 import java.io.IOException;
 import java.util.List;
 
+import org.springframework.boot.context.config.ConfigData.Option;
+import org.springframework.boot.context.config.ConfigData.PropertySourceOptions;
 import org.springframework.boot.origin.Origin;
 import org.springframework.boot.origin.OriginTrackedResource;
 import org.springframework.core.env.PropertySource;
@@ -33,6 +35,10 @@ import org.springframework.core.io.Resource;
  */
 public class StandardConfigDataLoader implements ConfigDataLoader<StandardConfigDataResource> {
 
+	private static final PropertySourceOptions PROFILE_SPECIFIC = PropertySourceOptions.always(Option.PROFILE_SPECIFIC);
+
+	private static final PropertySourceOptions NON_PROFILE_SPECIFIC = PropertySourceOptions.ALWAYS_NONE;
+
 	@Override
 	public ConfigData load(ConfigDataLoaderContext context, StandardConfigDataResource resource)
 			throws IOException, ConfigDataNotFoundException {
@@ -46,7 +52,8 @@ public class StandardConfigDataLoader implements ConfigDataLoader<StandardConfig
 		String name = String.format("Config resource '%s' via location '%s'", resource,
 				reference.getConfigDataLocation());
 		List<PropertySource<?>> propertySources = reference.getPropertySourceLoader().load(name, originTrackedResource);
-		return new ConfigData(propertySources);
+		PropertySourceOptions options = (resource.getProfile() != null) ? PROFILE_SPECIFIC : NON_PROFILE_SPECIFIC;
+		return new ConfigData(propertySources, options);
 	}
 
 }
diff --git a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataEnvironmentPostProcessorIntegrationTests.java b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataEnvironmentPostProcessorIntegrationTests.java
index f0e7d1f628..1d8b523220 100644
--- a/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataEnvironmentPostProcessorIntegrationTests.java
+++ b/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/context/config/ConfigDataEnvironmentPostProcessorIntegrationTests.java
@@ -596,6 +596,14 @@ class ConfigDataEnvironmentPostProcessorIntegrationTests {
 		assertThat(context.getEnvironment().getProperty("my.value")).isEqualTo("iwasimported");
 	}
 
+	@Test
+	void runWhenImportWithProfileVariantOrdersPropertySourcesCorrectly() {
+		this.application.setAdditionalProfiles("dev");
+		ConfigurableApplicationContext context = this.application
+				.run("--spring.config.location=classpath:application-import-with-profile-variant.properties");
+		assertThat(context.getEnvironment().getProperty("my.value")).isEqualTo("iwasimported-dev");
+	}
+
 	@Test
 	void runWhenHasPropertyInProfileDocumentThrowsException() {
 		assertThatExceptionOfType(BindException.class).isThrownBy(() -> this.application.run(
diff --git a/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-dev.properties b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-dev.properties
new file mode 100644
index 0000000000..ec5f485d75
--- /dev/null
+++ b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-dev.properties
@@ -0,0 +1 @@
+my.value=notimported-dev
diff --git a/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported-dev.properties b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported-dev.properties
new file mode 100644
index 0000000000..721c5ce5e5
--- /dev/null
+++ b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported-dev.properties
@@ -0,0 +1 @@
+my.value=iwasimported-dev
diff --git a/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported.properties b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported.properties
new file mode 100644
index 0000000000..545e85f1b6
--- /dev/null
+++ b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant-imported.properties
@@ -0,0 +1 @@
+my.value=iwasimported
diff --git a/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant.properties b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant.properties
new file mode 100644
index 0000000000..0dee106b62
--- /dev/null
+++ b/spring-boot-project/spring-boot/src/test/resources/application-import-with-profile-variant.properties
@@ -0,0 +1,2 @@
+spring.config.import=classpath:application-import-with-profile-variant-imported.properties
+my.value=notimported