Ensure @ActiveProfiles replaces existing profiles

Update `SpringBootContextLoader` to both add `spring.profiles.active`
properties and to directly call `Environment.setActiveProfiles`.
The additional `setActiveProfiles` call prevents `AbstractEnvironment`
from accidentally loading `spring.profiles.active` properties directly
when `doGetActiveProfiles` is called.

Directly setting active profiles has only become necessary since we
started adding properties using the square bracket notation. Previously
we added a comma-separated list which would be picked up by both the
`AbstractEnvironment` and the `ConfigurationFileApplicationListener`.

Closes gh-21302
This commit is contained in:
Phillip Webb 2020-05-08 17:16:06 -07:00
parent 28749e7fbb
commit 49921d65ac
3 changed files with 155 additions and 0 deletions

View File

@ -152,6 +152,8 @@ public class SpringBootContextLoader extends AbstractContextLoader {
}
private void setActiveProfiles(ConfigurableEnvironment environment, String[] profiles) {
environment.setActiveProfiles(profiles);
// Also add as properties to override any application.properties
String[] pairs = new String[profiles.length];
for (int i = 0; i < profiles.length; i++) {
pairs[i] = "spring.profiles.active[" + i + "]=" + profiles[i];

View File

@ -0,0 +1,74 @@
/*
* Copyright 2012-2020 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.test.context;
import java.util.LinkedHashMap;
import java.util.Map;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.ContextConfiguration;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link SpringBootTest @SpringBootTest} with an
* {@link ActiveProfiles @ActiveProfiles} annotation.
*
* @author Johnny Lim
* @author Phillip Webb
*/
@SpringBootTest
@ActiveProfiles({ "test1", "test2" })
@ContextConfiguration(loader = SpringBootTestWithActiveProfilesAndEnvironmentPropertyTests.Loader.class)
public class SpringBootTestWithActiveProfilesAndEnvironmentPropertyTests {
@Autowired
private Environment environment;
@Test
void getActiveProfiles() {
assertThat(this.environment.getActiveProfiles()).containsOnly("test1", "test2");
}
@Configuration
static class Config {
}
static class Loader extends SpringBootContextLoader {
@Override
protected ConfigurableEnvironment getEnvironment() {
ConfigurableEnvironment environment = super.getEnvironment();
MutablePropertySources sources = environment.getPropertySources();
Map<String, Object> map = new LinkedHashMap<>();
map.put("spring.profiles.active", "local");
sources.addLast(new MapPropertySource("profiletest", map));
return environment;
}
}
}

View File

@ -0,0 +1,79 @@
/*
* Copyright 2012-2020 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.test.context;
import java.util.LinkedHashMap;
import java.util.Map;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;
import org.springframework.core.env.StandardEnvironment;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.ContextConfiguration;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Integration tests for {@link SpringBootTest @SpringBootTest} with an
* {@link ActiveProfiles @ActiveProfiles} annotation.
*
* @author Johnny Lim
* @author Phillip Webb
*/
@SpringBootTest
@ActiveProfiles({ "test1", "test2" })
@ContextConfiguration(loader = SpringBootTestWithActiveProfilesAndSytemEnvironmentPropertyTests.Loader.class)
public class SpringBootTestWithActiveProfilesAndSytemEnvironmentPropertyTests {
@Autowired
private Environment environment;
@Test
void getActiveProfiles() {
assertThat(this.environment.getActiveProfiles()).containsOnly("test1", "test2");
}
@Configuration
static class Config {
}
static class Loader extends SpringBootContextLoader {
@Override
@SuppressWarnings("unchecked")
protected ConfigurableEnvironment getEnvironment() {
ConfigurableEnvironment environment = super.getEnvironment();
MutablePropertySources sources = environment.getPropertySources();
PropertySource<?> source = sources.get(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME);
Map<String, Object> map = new LinkedHashMap<>((Map<String, Object>) source.getSource());
map.put("SPRING_PROFILES_ACTIVE", "local");
sources.replace(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME,
new MapPropertySource(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, map));
return environment;
}
}
}