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

Let spring.profiles.[include|active] accept list as well as comma separated value in bootstrapProperties #1464

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

Let spring.profiles.[include|active] accept list as well as comma separated value in bootstrapProperties #1464

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
34 changes: 15 additions & 19 deletions ...java/org/springframework/cloud/bootstrap/config/PropertySourceBootstrapConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2025 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.
Expand Down Expand Up @@ -34,6 +34,8 @@
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.context.properties.bind.Bindable;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.context.properties.bind.PropertySourcesPlaceholdersResolver;
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
import org.springframework.boot.logging.LogFile;
import org.springframework.boot.logging.LoggingInitializationContext;
import org.springframework.boot.logging.LoggingSystem;
Expand All @@ -46,6 +48,7 @@
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.core.Ordered;
import org.springframework.core.ResolvableType;
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
import org.springframework.core.env.AbstractEnvironment;
import org.springframework.core.env.CompositePropertySource;
Expand All @@ -54,13 +57,13 @@
import org.springframework.core.env.Environment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.util.StringUtils;

import static org.springframework.cloud.bootstrap.encrypt.AbstractEnvironmentDecrypt.DECRYPTED_PROPERTY_SOURCE_NAME;
import static org.springframework.core.env.StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME;

/**
* @author Dave Syer
* @author Yanming Zhou
*
*/
@Configuration(proxyBeanMethods = false)
Expand Down Expand Up @@ -294,6 +297,7 @@ private List<String> addActiveProfilesTo(List<String> profiles, PropertySource<?
return addProfilesTo(profiles, propertySource, AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME, environment);
}

@SuppressWarnings("unchecked")
private <T extends Collection<String>> T addProfilesTo(T profiles, PropertySource<?> propertySource,
String property, ConfigurableEnvironment environment) {
if (propertySource instanceof CompositePropertySource) {
Expand All @@ -303,27 +307,19 @@ private <T extends Collection<String>> T addProfilesTo(T profiles, PropertySourc
}
}
else {
Collections.addAll(profiles, getProfilesForValue(propertySource.getProperty(property), environment));
// bootstrapProperties is loaded as package-private
// ConfigurationPropertySourcesPropertySource
ResolvableType requiredType = ResolvableType.forClassWithGenerics(PropertySource.class,
ResolvableType.forClassWithGenerics(Iterable.class, ConfigurationPropertySource.class));
if (requiredType.isInstance(propertySource)) {
Binder binder = new Binder((Iterable<ConfigurationPropertySource>) propertySource.getSource(),
new PropertySourcesPlaceholdersResolver(environment));
binder.bind(property, Bindable.listOf(String.class)).ifBound(profiles::addAll);
}
}
return profiles;
}

private String[] getProfilesForValue(Object property, ConfigurableEnvironment environment) {
final String value = (property == null ? null : property.toString());
return property == null ? new String[0] : resolvePlaceholdersInProfiles(value, environment);
}

private String[] resolvePlaceholdersInProfiles(String profiles, ConfigurableEnvironment environment) {
return Arrays.stream(StringUtils.tokenizeToStringArray(profiles, ",")).map(s -> {
if (s.startsWith("${") && s.endsWith("}")) {
return environment.resolvePlaceholders(s);
}
else {
return s;
}
}).toArray(String[]::new);
}

/*
* The ConextRefreshedEvent gets called at the end of the boostrap phase after config
* data is loaded during bootstrap. This will run and do an "initial fetch" of
Expand Down
30 changes: 28 additions & 2 deletions ...src/test/java/org/springframework/cloud/bootstrap/config/BootstrapConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2012-2020 the original author or authors.
* Copyright 2012-2025 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.
Expand Down Expand Up @@ -49,6 +49,7 @@

/**
* @author Dave Syer
* @author Yanming Zhou
*
*/
public class BootstrapConfigurationTests {
Expand Down Expand Up @@ -597,6 +598,19 @@ public void includeProfileFromBootstrapPropertySourceWithAppContext() {

private void includeProfileFromBootstrapPropertySource(String... properties) {
PropertySourceConfiguration.MAP.put("spring.profiles.include", "bar,baz");
assertIncludeProfileFromBootstrapPropertySource(properties);

PropertySourceConfiguration.MAP.clear();
PropertySourceConfiguration.MAP.put("spring.profiles.include[0]", "bar");
PropertySourceConfiguration.MAP.put("spring.profiles.include[1]", "baz");
assertIncludeProfileFromBootstrapPropertySource(properties);

PropertySourceConfiguration.MAP.clear();
PropertySourceConfiguration.MAP.put("spring.profiles.include", "${ENVIRONMENT_PROFILE_NAME:bar,baz}");
assertIncludeProfileFromBootstrapPropertySource(properties);
}

private void assertIncludeProfileFromBootstrapPropertySource(String... properties) {
this.context = new SpringApplicationBuilder().web(WebApplicationType.NONE)
.properties(properties)
.profiles("foo")
Expand All @@ -622,13 +636,25 @@ public void activeProfileFromBootstrapPropertySourceWithAppContext() {

private void activeProfileFromBootstrapPropertySource(String... properties) {
PropertySourceConfiguration.MAP.put("spring.profiles.active", "bar,baz");
assertActiveProfileFromBootstrapPropertySource(properties);

PropertySourceConfiguration.MAP.clear();
PropertySourceConfiguration.MAP.put("spring.profiles.active[0]", "bar");
PropertySourceConfiguration.MAP.put("spring.profiles.active[1]", "baz");
assertActiveProfileFromBootstrapPropertySource(properties);

PropertySourceConfiguration.MAP.clear();
PropertySourceConfiguration.MAP.put("spring.profiles.active", "${ENVIRONMENT_PROFILE_NAME:bar,baz}");
assertActiveProfileFromBootstrapPropertySource(properties);
}

private void assertActiveProfileFromBootstrapPropertySource(String... properties) {
this.context = new SpringApplicationBuilder().web(WebApplicationType.NONE)
.properties(properties)
.profiles("foo")
.sources(BareConfiguration.class)
.run();
then(this.context.getEnvironment().acceptsProfiles("baz", "bar", "foo")).isTrue();

}

@Test
Expand Down
Loading