Add profile expression support
Allow the `Environment` to accept a generic `Profiles` interface which can support more complex matching rules. The previous `acceptsProfiles(String...)` method now uses `Profiles.of` which supports basic profile expressions such as "(a | b) & !c" Issue: SPR-12458
This commit is contained in:
Phillip Webb
committed by
Stephane Nicoll
Stephane Nicoll
parent
58cce615f5
commit
e2623b7d35
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2016 the original author or authors.
|
||||
* Copyright 2002-2018 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.
|
||||
@@ -74,8 +74,7 @@ public class DummyEnvironment implements Environment {
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean acceptsProfiles(String... profiles) {
|
||||
public boolean acceptsProfiles(Profiles profiles) {
|
||||
return false;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
222
spring-core/src/test/java/org/springframework/core/env/ProfilesTests.java
vendored
Normal file
222
spring-core/src/test/java/org/springframework/core/env/ProfilesTests.java
vendored
Normal file
@@ -0,0 +1,222 @@
|
||||
/*
|
||||
* Copyright 2002-2018 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
|
||||
*
|
||||
* http://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.core.env;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.Set;
|
||||
import java.util.function.Supplier;
|
||||
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.ExpectedException;
|
||||
import org.springframework.core.env.Profiles.ActiveProfiles;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
import static org.junit.Assert.*;
|
||||
|
||||
/**
|
||||
* Tests for {@link Profiles}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class ProfilesTests {
|
||||
|
||||
@Rule
|
||||
public ExpectedException thrown = ExpectedException.none();
|
||||
|
||||
@Test
|
||||
public void ofWhenNullThrowsException() {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("Must specify at least one profile");
|
||||
Profiles.of((String[]) null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofWhenEmptyThrowsException() {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("Must specify at least one profile");
|
||||
Profiles.of();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofNullElement() throws Exception {
|
||||
this.thrown.expect(IllegalArgumentException.class);
|
||||
this.thrown.expectMessage("must contain text");
|
||||
Profiles.of((String)null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofSingleElement() {
|
||||
Profiles profiles = Profiles.of("spring");
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("framework")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofSingleInvertedElement() {
|
||||
Profiles profiles = Profiles.of("!spring");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofMultipleElements() {
|
||||
Profiles profiles = Profiles.of("spring", "framework");
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofMultipleElementsWithInverted() {
|
||||
Profiles profiles = Profiles.of("!spring", "framework");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofMultipleElementsAllInverted() {
|
||||
Profiles profiles = Profiles.of("!spring", "!framework");
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertFalse(
|
||||
profiles.matches(new MockActiveProfiles("spring", "framework", "java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofSingleExpression() throws Exception {
|
||||
Profiles profiles = Profiles.of("(spring)");
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("framework")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofSingleInvertedExpression() throws Exception {
|
||||
Profiles profiles = Profiles.of("(!spring)");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofOrExpression() throws Exception {
|
||||
Profiles profiles = Profiles.of("(spring | framework)");
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofAndExpression() throws Exception {
|
||||
Profiles profiles = Profiles.of("(spring & framework)");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofAndExpressionWithoutBraces() throws Exception {
|
||||
Profiles profiles = Profiles.of("spring & framework");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofNotAndExpression() throws Exception {
|
||||
Profiles profiles = Profiles.of("!(spring & framework)");
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofNotOrExpression() throws Exception {
|
||||
Profiles profiles = Profiles.of("!(spring | framework)");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("framework")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("java")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ofComplex() throws Exception {
|
||||
Profiles profiles = Profiles.of("(spring & framework) | (spring & java)");
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("spring")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring", "framework")));
|
||||
assertTrue(profiles.matches(new MockActiveProfiles("spring", "java")));
|
||||
assertFalse(profiles.matches(new MockActiveProfiles("java", "framework")));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void malformedExpressions() throws Exception {
|
||||
assertMalformed(() -> Profiles.of("("));
|
||||
assertMalformed(() -> Profiles.of(")"));
|
||||
assertMalformed(() -> Profiles.of("a & b | c"));
|
||||
}
|
||||
|
||||
private void assertMalformed(Supplier<Profiles> supplier) {
|
||||
try {
|
||||
supplier.get();
|
||||
fail("Not malformed");
|
||||
}
|
||||
catch (IllegalArgumentException ex) {
|
||||
assertTrue(ex.getMessage().contains("Malformed"));
|
||||
}
|
||||
}
|
||||
|
||||
private static class MockActiveProfiles implements ActiveProfiles {
|
||||
|
||||
private Set<String> activeProfiles;
|
||||
|
||||
private Set<String> defaultProfiles;
|
||||
|
||||
|
||||
public MockActiveProfiles(String... activeProfiles) {
|
||||
this(Arrays.asList(activeProfiles));
|
||||
}
|
||||
|
||||
public MockActiveProfiles(Collection<String> activeProfiles) {
|
||||
this(activeProfiles, Collections.singleton("default"));
|
||||
}
|
||||
|
||||
public MockActiveProfiles(Collection<String> activeProfiles,
|
||||
Collection<String> defaultProfiles) {
|
||||
this.activeProfiles = new LinkedHashSet<>(activeProfiles);
|
||||
this.defaultProfiles = new LinkedHashSet<>(defaultProfiles);
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public boolean contains(String profile) {
|
||||
if (!StringUtils.hasText(profile) || profile.charAt(0) == '!') {
|
||||
throw new IllegalArgumentException("Invalid profile [" + profile + "]");
|
||||
}
|
||||
return (this.activeProfiles.contains(profile)
|
||||
|| (this.activeProfiles.isEmpty() && this.defaultProfiles.contains(profile)));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2014 the original author or authors.
|
||||
* Copyright 2002-2018 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.
|
||||
@@ -283,7 +283,6 @@ public class StandardEnvironmentTests {
|
||||
environment.acceptsProfiles("");
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
public void acceptsProfiles_activeProfileSetProgrammatically() {
|
||||
assertThat(environment.acceptsProfiles("p1", "p2"), is(false));
|
||||
@@ -326,6 +325,15 @@ public class StandardEnvironmentTests {
|
||||
environment.acceptsProfiles("p1", "!");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void acceptsProfiles_withProfileExpression() throws Exception {
|
||||
assertThat(environment.acceptsProfiles("p1 & p2"), is(false));
|
||||
environment.addActiveProfile("p1");
|
||||
assertThat(environment.acceptsProfiles("p1 & p2"), is(false));
|
||||
environment.addActiveProfile("p2");
|
||||
assertThat(environment.acceptsProfiles("p1 & p2"), is(true));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void environmentSubclass_withCustomProfileValidation() {
|
||||
ConfigurableEnvironment env = new AbstractEnvironment() {
|
||||
|
||||
Reference in New Issue
Block a user