Ensure last-wins profile order is respected for AWS Parameter Store a…

…nd Secrets Manager (#2386) Fixes #2385
spring-cloud · Mar 12, 2024 · cad977d · cad977d
1 parent 3070176
commit cad977d
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 14 deletions.
diff --git a/...ringframework/cloud/config/server/environment/AwsParameterStoreEnvironmentRepository.java b/...ringframework/cloud/config/server/environment/AwsParameterStoreEnvironmentRepository.java
@@ -18,6 +18,7 @@
 
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedHashSet;
 import java.util.List;
@@ -90,7 +91,9 @@ private Set<String> buildParameterPaths(String application, String[] profiles) {
 		String profileSeparator = environmentProperties.getProfileSeparator();
 		String defaultProfile = configServerProperties.getDefaultProfile();
 
-		List<String> orderedProfiles = Stream.concat(Arrays.stream(profiles).filter(p -> !p.equals(defaultProfile)),
+		List<String> reversedProfiles = new ArrayList<>(Arrays.asList(profiles));
+		Collections.reverse(reversedProfiles);
+		List<String> orderedProfiles = Stream.concat(reversedProfiles.stream().filter(p -> !p.equals(defaultProfile)),
 				Arrays.stream(new String[] { defaultProfile })).collect(Collectors.toList());
 
 		if (application.equals(defaultApplication)) {

diff --git a/...ringframework/cloud/config/server/environment/AwsSecretsManagerEnvironmentRepository.java b/...ringframework/cloud/config/server/environment/AwsSecretsManagerEnvironmentRepository.java
@@ -17,8 +17,11 @@
 package org.springframework.cloud.config.server.environment;
 
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import com.fasterxml.jackson.core.type.TypeReference;
@@ -98,7 +101,9 @@ else if (StringUtils.isEmpty(label)) {
 			environment.add(new PropertySource("overrides", overrides));
 		}
 
-		for (String profile : profiles) {
+		List<String> reversedProfiles = new ArrayList<>(Arrays.asList(profiles));
+		Collections.reverse(reversedProfiles);
+		for (String profile : reversedProfiles) {
 			addPropertySource(environment, application, profile, label);
 			if (!defaultApplication.equals(application)) {
 				addPropertySource(environment, defaultApplication, profile, label);

diff --git a/...ramework/cloud/config/server/environment/AwsParameterStoreEnvironmentRepositoryTests.java b/...ramework/cloud/config/server/environment/AwsParameterStoreEnvironmentRepositoryTests.java
@@ -559,6 +559,35 @@ public void testFindOneWithExistentApplicationAndMultipleExistentProfiles() {
 		assertThat(result).usingRecursiveComparison().withStrictTypeChecking().isEqualTo(expected);
 	}
 
+	@Test
+	public void testFindOneWithExistentApplicationAndMultipleOrderedExistentProfiles() {
+		// Arrange
+		String application = "application";
+		String profile = "profile1,profile2,profile3";
+		String[] profiles = StringUtils.commaDelimitedListToStringArray(profile);
+
+		String profile1ParamsPsName = "aws:ssm:parameter:/config/application-profile1/";
+		PropertySource profile1ParamsPs = new PropertySource(profile1ParamsPsName, SHARED_PROPERTIES);
+
+		String profile2ParamsPsName = "aws:ssm:parameter:/config/application-profile2/";
+		PropertySource profile2ParamsPs = new PropertySource(profile2ParamsPsName, SHARED_DEFAULT_PROPERTIES);
+
+		String profile3ParamsPsName = "aws:ssm:parameter:/config/application-profile3/";
+		PropertySource profile3ParamsPs = new PropertySource(profile3ParamsPsName, SHARED_PRODUCTION_PROPERTIES);
+
+		Environment expected = new Environment(application, profiles, null, null, null);
+
+		expected.addAll(Arrays.asList(profile3ParamsPs, profile2ParamsPs, profile1ParamsPs));
+
+		putParameters(expected);
+
+		// Act
+		Environment result = repository.findOne(application, profile, null);
+
+		// Assert
+		assertThat(result).usingRecursiveComparison().withStrictTypeChecking().isEqualTo(expected);
+	}
+
 	@Test
 	public void testFindOneWithOverrides() {
 		// Arrange

diff --git a/...ramework/cloud/config/server/environment/AwsSecretsManagerEnvironmentRepositoryTests.java b/...ramework/cloud/config/server/environment/AwsSecretsManagerEnvironmentRepositoryTests.java
@@ -809,8 +809,8 @@ public void testFindOneWithExistingApplicationAndMultipleExistingProfileAndNullL
 				getApplicationEastProperties());
 
 		Environment expectedEnv = new Environment(application, profiles, defaultLabel, null, null);
-		expectedEnv.addAll(Arrays.asList(fooProdProperties, applicationProdProperties, fooEastProperties,
-				applicationEastProperties, fooDefaultProperties, applicationDefaultProperties, fooProperties,
+		expectedEnv.addAll(Arrays.asList(fooEastProperties, applicationEastProperties, fooProdProperties,
+				applicationProdProperties, fooDefaultProperties, applicationDefaultProperties, fooProperties,
 				applicationProperties));
 
 		putSecrets(expectedEnv);
@@ -849,8 +849,8 @@ public void testFindOneWithExistingApplicationAndMultipleExistingProfileAndNoDef
 				getApplicationEastProperties());
 
 		Environment expectedEnv = new Environment(application, profiles, defaultLabel, null, null);
-		expectedEnv.addAll(Arrays.asList(fooProdProperties, applicationProdProperties, fooEastProperties,
-				applicationEastProperties, fooProperties, applicationProperties));
+		expectedEnv.addAll(Arrays.asList(fooEastProperties, applicationEastProperties, fooProdProperties,
+				applicationProdProperties, fooProperties, applicationProperties));
 
 		putSecrets(expectedEnv);
 
@@ -1786,8 +1786,8 @@ public void testFindOneWithExistingApplicationAndMultipleExistingProfileAndExist
 				getApplicationEastReleaseProperties());
 
 		Environment expectedEnv = new Environment(application, profiles, label, null, null);
-		expectedEnv.addAll(Arrays.asList(fooProdProperties, applicationProdProperties, fooEastProperties,
-				applicationEastProperties, fooDefaultProperties, applicationDefaultProperties, fooProperties,
+		expectedEnv.addAll(Arrays.asList(fooEastProperties, applicationEastProperties, fooProdProperties,
+				applicationProdProperties, fooDefaultProperties, applicationDefaultProperties, fooProperties,
 				applicationProperties));
 
 		putSecrets(expectedEnv);
@@ -1826,8 +1826,8 @@ public void testFindOneWithExistingApplicationAndMultipleExistingProfileAndNoDef
 				getApplicationEastReleaseProperties());
 
 		Environment expectedEnv = new Environment(application, profiles, label, null, null);
-		expectedEnv.addAll(Arrays.asList(fooProdProperties, applicationProdProperties, fooEastProperties,
-				applicationEastProperties, fooProperties, applicationProperties));
+		expectedEnv.addAll(Arrays.asList(fooEastProperties, applicationEastProperties, fooProdProperties,
+				applicationProdProperties, fooProperties, applicationProperties));
 
 		putSecrets(expectedEnv);
 
@@ -2461,8 +2461,8 @@ public void testFindOneWithExistingApplicationAndMultipleExistingProfile() {
 				getApplicationEastProperties());
 
 		Environment environment = new Environment(application, profiles, null, null, null);
-		environment.addAll(Arrays.asList(fooProdProperties, applicationProdProperties, fooEastProperties,
-				applicationEastProperties, fooDefaultProperties, applicationDefaultProperties, fooProperties,
+		environment.addAll(Arrays.asList(fooEastProperties, applicationEastProperties, fooProdProperties,
+				applicationProdProperties, fooDefaultProperties, applicationDefaultProperties, fooProperties,
 				applicationProperties));
 
 		putSecrets(environment);
@@ -2500,8 +2500,33 @@ public void testFindOneWithExistingApplicationAndMultipleExistingProfileAndNoDef
 				getApplicationEastProperties());
 
 		Environment environment = new Environment(application, profiles, null, null, null);
-		environment.addAll(Arrays.asList(fooProdProperties, applicationProdProperties, fooEastProperties,
-				applicationEastProperties, fooProperties, applicationProperties));
+		environment.addAll(Arrays.asList(fooEastProperties, applicationEastProperties, fooProdProperties,
+				applicationProdProperties, fooProperties, applicationProperties));
+
+		putSecrets(environment);
+
+		Environment resultEnv = repository.findOne(application, profile, null);
+
+		assertThat(resultEnv).usingRecursiveComparison().withStrictTypeChecking().isEqualTo(environment);
+	}
+
+	@Test
+	public void testFindOneWithExistingApplicationAndOrderedMultipleExistingProfileAndNoDefaults() {
+		String application = "foo";
+		String profile = "profile1,profile2,profile3";
+		String[] profiles = StringUtils.commaDelimitedListToStringArray(profile);
+
+		String fooProfile1PropertiesName = "aws:secrets:/secret/foo-profile1/";
+		PropertySource fooProfile1Properties = new PropertySource(fooProfile1PropertiesName, getFooDefaultProperties());
+
+		String fooProfile2PropertiesName = "aws:secrets:/secret/foo-profile2/";
+		PropertySource fooProfile2Properties = new PropertySource(fooProfile2PropertiesName, getFooEastProperties());
+
+		String fooProfile3PropertiesName = "aws:secrets:/secret/foo-profile3/";
+		PropertySource fooProfile3Properties = new PropertySource(fooProfile3PropertiesName, getFooProdProperties());
+
+		Environment environment = new Environment(application, profiles, null, null, null);
+		environment.addAll(Arrays.asList(fooProfile3Properties, fooProfile2Properties, fooProfile1Properties));
 
 		putSecrets(environment);