Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhance RegionProviderAutoConfiguration make profile configuration easier #1126

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance RegionProviderAutoConfiguration make profile configuration easier #1126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions ...e/src/main/java/io/awspring/cloud/autoconfigure/core/RegionProviderAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,36 +38,42 @@
*
* @author Siva Katamreddy
* @author Eddú Meléndez
* @author Wei Jiang
*/
@AutoConfiguration
@ConditionalOnClass({ StaticRegionProvider.class, AwsRegionProvider.class, ProfileFile.class })
@EnableConfigurationProperties(RegionProperties.class)
@EnableConfigurationProperties({ CredentialsProperties.class, RegionProperties.class })
public class RegionProviderAutoConfiguration {

private final RegionProperties properties;
private final CredentialsProperties credentialsProperties;

public RegionProviderAutoConfiguration(RegionProperties properties) {
this.properties = properties;
private final RegionProperties regionProperties;

public RegionProviderAutoConfiguration(CredentialsProperties credentialsProperties,
RegionProperties regionProperties) {
this.credentialsProperties = credentialsProperties;
this.regionProperties = regionProperties;
}

@Bean
@ConditionalOnMissingBean
public AwsRegionProvider regionProvider() {
return createRegionProvider(this.properties);
return createRegionProvider(this.credentialsProperties, this.regionProperties);
}

public static AwsRegionProvider createRegionProvider(RegionProperties properties) {
public static AwsRegionProvider createRegionProvider(CredentialsProperties credentialsProperties,
RegionProperties regionProperties) {
final List<AwsRegionProvider> providers = new ArrayList<>();

if (properties.getStatic() != null && properties.isStatic()) {
providers.add(new StaticRegionProvider(properties.getStatic()));
if (regionProperties.getStatic() != null && regionProperties.isStatic()) {
providers.add(new StaticRegionProvider(regionProperties.getStatic()));
}

if (properties.isInstanceProfile()) {
if (regionProperties.isInstanceProfile()) {
providers.add(new InstanceProfileRegionProvider());
}

Profile profile = properties.getProfile();
Profile profile = getConfigurationProfile(credentialsProperties, regionProperties);
if (profile != null && profile.getName() != null) {
providers.add(createProfileRegionProvider(profile));
}
Expand All @@ -83,6 +89,17 @@ else if (providers.size() == 1) {
}
}

private static Profile getConfigurationProfile(CredentialsProperties credentialsProperties,
RegionProperties regionProperties) {
Profile profile = regionProperties.getProfile();

if (profile != null) {
return profile;
}

return credentialsProperties.getProfile();
}

private static AwsProfileRegionProvider createProfileRegionProvider(Profile profile) {
Supplier<ProfileFile> profileFileFn = () -> {
if (profile.getPath() != null) {
Expand Down
32 changes: 32 additions & 0 deletions .../test/java/io/awspring/cloud/autoconfigure/core/RegionProviderAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,38 @@ void regionProvider_profileNameAndPathConfigured_profileRegionProviderConfigured
});
}

@Test
void regionProvider_credentialProfileNameAndPathConfigured_profileRegionProviderConfiguredWithCustomProfile()
throws IOException {
this.contextRunner.withPropertyValues("spring.cloud.aws.credentials.profile.name:customProfile",
"spring.cloud.aws.credentials.profile.path:"
+ new ClassPathResource(getClass().getSimpleName() + "-profile", getClass()).getFile()
.getAbsolutePath())
.run((context) -> {
AwsRegionProvider awsRegionProvider = context.getBean("regionProvider",
AwsProfileRegionProvider.class);
assertThat(awsRegionProvider).isNotNull();
assertThat(awsRegionProvider.getRegion()).isEqualTo(Region.EU_WEST_1);
});
}

@Test
void regionProvider_credentialAndRegionProfileNameAndPathBothConfigured_profileRegionProviderConfiguredWithCustomProfile()
throws IOException {
this.contextRunner.withPropertyValues("spring.cloud.aws.credentials.profile.name:noneProfile",
"spring.cloud.aws.credentials.profile.path:",
"spring.cloud.aws.region.profile.name:customProfile",
"spring.cloud.aws.region.profile.path:"
+ new ClassPathResource(getClass().getSimpleName() + "-profile", getClass()).getFile()
.getAbsolutePath())
.run((context) -> {
AwsRegionProvider awsRegionProvider = context.getBean("regionProvider",
AwsProfileRegionProvider.class);
assertThat(awsRegionProvider).isNotNull();
assertThat(awsRegionProvider.getRegion()).isEqualTo(Region.EU_WEST_1);
});
}

@Test
void regionProvider_instanceProfileConfigured_configuresInstanceProfileCredentialsProvider() {
this.contextRunner.withPropertyValues("spring.cloud.aws.region.instance-profile:true").run((context) -> {
Expand Down
Loading