diff --git a/spring-core/src/main/java/org/springframework/core/env/Environment.java b/spring-core/src/main/java/org/springframework/core/env/Environment.java index 5a9c0348162..f1ffb0a2f8e 100644 --- a/spring-core/src/main/java/org/springframework/core/env/Environment.java +++ b/spring-core/src/main/java/org/springframework/core/env/Environment.java @@ -57,6 +57,7 @@ package org.springframework.core.env; * of property sources prior to application context {@code refresh()}. * * @author Chris Beams + * @author Phillip Webb * @since 3.1 * @see PropertyResolver * @see EnvironmentCapable @@ -95,14 +96,17 @@ public interface Environment extends PropertyResolver { String[] getDefaultProfiles(); /** - * Return whether one or more of the given profiles is active or, in the case of no - * explicit active profiles, whether one or more of the given profiles is included in - * the set of default profiles. If a profile begins with '!' the logic is inverted, - * i.e. the method will return {@code true} if the given profile is not active. - * For example, {@code env.acceptsProfiles("p1", "!p2")} will return {@code true} if - * profile 'p1' is active or 'p2' is not active. - * @throws IllegalArgumentException if called with zero arguments - * or if any profile is {@code null}, empty, or whitespace only + * Determine whether one or more of the given profiles is active — or + * in the case of no explicit {@linkplain #getActiveProfiles() active profiles}, + * whether one or more of the given profiles is included in the set of + * {@linkplain #getDefaultProfiles() default profiles}. + *

If a profile begins with '!' the logic is inverted, meaning this method + * will return {@code true} if the given profile is not active. For + * example, {@code env.acceptsProfiles("p1", "!p2")} will return {@code true} + * if profile 'p1' is active or 'p2' is not active. + * @throws IllegalArgumentException if called with a {@code null} array, an + * empty array, zero arguments or if any profile is {@code null}, empty, or + * whitespace only * @see #getActiveProfiles * @see #getDefaultProfiles * @see #acceptsProfiles(Profiles) @@ -112,8 +116,14 @@ public interface Environment extends PropertyResolver { boolean acceptsProfiles(String... profiles); /** - * Return whether the {@linkplain #getActiveProfiles() active profiles} - * match the given {@link Profiles} predicate. + * Determine whether the given {@link Profiles} predicate matches the + * {@linkplain #getActiveProfiles() active profiles} — or in the case + * of no explicit active profiles, whether the given {@code Profiles} predicate + * matches the {@linkplain #getDefaultProfiles() default profiles}. + *

If you wish to check a single profile expression, consider using + * {@link #acceptsProfiles(String)} instead. + * @since 5.1 + * @see Profiles#of(String...) */ boolean acceptsProfiles(Profiles profiles); diff --git a/spring-core/src/main/java/org/springframework/core/env/Profiles.java b/spring-core/src/main/java/org/springframework/core/env/Profiles.java index 7f4fba7073c..340bb2b181c 100644 --- a/spring-core/src/main/java/org/springframework/core/env/Profiles.java +++ b/spring-core/src/main/java/org/springframework/core/env/Profiles.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2020 the original author or authors. + * Copyright 2002-2023 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. @@ -43,32 +43,32 @@ public interface Profiles { /** * Create a new {@link Profiles} instance that checks for matches against - * the given profile strings. + * the given profile expressions. *

The returned instance will {@linkplain Profiles#matches(Predicate) match} - * if any one of the given profile strings matches. - *

A profile string may contain a simple profile name (for example - * {@code "production"}) or a profile expression. A profile expression allows + * if any one of the given profile expressions matches. + *

A profile expression may contain a simple profile name (for example + * {@code "production"}) or a compound expression. A compound expression allows * for more complicated profile logic to be expressed, for example * {@code "production & cloud"}. *

The following operators are supported in profile expressions. *

*

Please note that the {@code &} and {@code |} operators may not be mixed - * without using parentheses. For example {@code "a & b | c"} is not a valid - * expression; it must be expressed as {@code "(a & b) | c"} or + * without using parentheses. For example, {@code "a & b | c"} is not a valid + * expression: it must be expressed as {@code "(a & b) | c"} or * {@code "a & (b | c)"}. *

As of Spring Framework 5.1.17, two {@code Profiles} instances returned * by this method are considered equivalent to each other (in terms of * {@code equals()} and {@code hashCode()} semantics) if they are created - * with identical profile strings. - * @param profiles the profile strings to include + * with identical profile expressions. + * @param profileExpressions the profile expressions to include * @return a new {@link Profiles} instance */ - static Profiles of(String... profiles) { - return ProfilesParser.parse(profiles); + static Profiles of(String... profileExpressions) { + return ProfilesParser.parse(profileExpressions); } } diff --git a/spring-core/src/main/java/org/springframework/core/env/ProfilesParser.java b/spring-core/src/main/java/org/springframework/core/env/ProfilesParser.java index 133aa0669c0..5e7fce7c6c4 100644 --- a/spring-core/src/main/java/org/springframework/core/env/ProfilesParser.java +++ b/spring-core/src/main/java/org/springframework/core/env/ProfilesParser.java @@ -43,7 +43,7 @@ final class ProfilesParser { static Profiles parse(String... expressions) { - Assert.notEmpty(expressions, "Must specify at least one profile"); + Assert.notEmpty(expressions, "Must specify at least one profile expression"); Profiles[] parsed = new Profiles[expressions.length]; for (int i = 0; i < expressions.length; i++) { parsed[i] = parseExpression(expressions[i]); @@ -137,8 +137,8 @@ final class ProfilesParser { return activeProfile -> activeProfile.test(profile); } - private static Predicate isMatch(Predicate activeProfile) { - return profiles -> profiles.matches(activeProfile); + private static Predicate isMatch(Predicate activeProfiles) { + return profiles -> profiles.matches(activeProfiles); } diff --git a/spring-core/src/test/java/org/springframework/core/env/ProfilesTests.java b/spring-core/src/test/java/org/springframework/core/env/ProfilesTests.java index 01454ad10e4..421d26edb88 100644 --- a/spring-core/src/test/java/org/springframework/core/env/ProfilesTests.java +++ b/spring-core/src/test/java/org/springframework/core/env/ProfilesTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2021 the original author or authors. + * Copyright 2002-2023 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. @@ -40,30 +40,30 @@ class ProfilesTests { @Test void ofWhenNullThrowsException() { - assertThatIllegalArgumentException().isThrownBy(() -> - Profiles.of((String[]) null)) - .withMessageContaining("Must specify at least one profile"); + assertThatIllegalArgumentException() + .isThrownBy(() -> Profiles.of((String[]) null)) + .withMessage("Must specify at least one profile expression"); } @Test void ofWhenEmptyThrowsException() { assertThatIllegalArgumentException() .isThrownBy(Profiles::of) - .withMessageContaining("Must specify at least one profile"); + .withMessage("Must specify at least one profile expression"); } @Test void ofNullElement() { - assertThatIllegalArgumentException().isThrownBy(() -> - Profiles.of((String) null)) - .withMessageContaining("must contain text"); + assertThatIllegalArgumentException() + .isThrownBy(() -> Profiles.of((String) null)) + .withMessage("Invalid profile expression [null]: must contain text"); } @Test void ofEmptyElement() { - assertThatIllegalArgumentException().isThrownBy(() -> - Profiles.of(" ")) - .withMessageContaining("must contain text"); + assertThatIllegalArgumentException() + .isThrownBy(() -> Profiles.of(" ")) + .withMessage("Invalid profile expression [ ]: must contain text"); } @Test @@ -356,7 +356,7 @@ class ProfilesTests { private static void assertMalformed(Supplier supplier) { assertThatIllegalArgumentException() .isThrownBy(supplier::get) - .withMessageContaining("Malformed"); + .withMessageStartingWith("Malformed profile expression"); } private static Predicate activeProfiles(String... profiles) { diff --git a/spring-core/src/test/java/org/springframework/core/env/StandardEnvironmentTests.java b/spring-core/src/test/java/org/springframework/core/env/StandardEnvironmentTests.java index e711924d1d1..71881d3e9d5 100644 --- a/spring-core/src/test/java/org/springframework/core/env/StandardEnvironmentTests.java +++ b/spring-core/src/test/java/org/springframework/core/env/StandardEnvironmentTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2021 the original author or authors. + * Copyright 2002-2023 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. @@ -18,9 +18,9 @@ package org.springframework.core.env; import java.security.AccessControlException; import java.security.Permission; -import java.util.Arrays; import java.util.Map; +import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Test; import org.springframework.core.SpringProperties; @@ -40,8 +40,7 @@ import static org.springframework.core.env.AbstractEnvironment.RESERVED_DEFAULT_ * @author Juergen Hoeller * @author Sam Brannen */ -@SuppressWarnings("deprecation") -public class StandardEnvironmentTests { +class StandardEnvironmentTests { private static final String ALLOWED_PROPERTY_NAME = "theanswer"; private static final String ALLOWED_PROPERTY_VALUE = "42"; @@ -81,8 +80,8 @@ public class StandardEnvironmentTests { assertThat(parent.getProperty("parentKey")).isEqualTo("parentVal"); assertThat(parent.getProperty("bothKey")).isEqualTo("parentBothVal"); - assertThat(child.getActiveProfiles()).isEqualTo(new String[]{"c1","c2"}); - assertThat(parent.getActiveProfiles()).isEqualTo(new String[]{"p1","p2"}); + assertThat(child.getActiveProfiles()).containsExactly("c1", "c2"); + assertThat(parent.getActiveProfiles()).containsExactly("p1", "p2"); child.merge(parent); @@ -94,8 +93,8 @@ public class StandardEnvironmentTests { assertThat(parent.getProperty("parentKey")).isEqualTo("parentVal"); assertThat(parent.getProperty("bothKey")).isEqualTo("parentBothVal"); - assertThat(child.getActiveProfiles()).isEqualTo(new String[]{"c1","c2","p1","p2"}); - assertThat(parent.getActiveProfiles()).isEqualTo(new String[]{"p1","p2"}); + assertThat(child.getActiveProfiles()).containsExactly("c1", "c2", "p1", "p2"); + assertThat(parent.getActiveProfiles()).containsExactly("p1", "p2"); } @Test @@ -121,16 +120,14 @@ public class StandardEnvironmentTests { @Test void defaultProfilesContainsDefaultProfileByDefault() { - assertThat(environment.getDefaultProfiles().length).isEqualTo(1); - assertThat(environment.getDefaultProfiles()[0]).isEqualTo("default"); + assertThat(environment.getDefaultProfiles()).containsExactly("default"); } @Test void setActiveProfiles() { environment.setActiveProfiles("local", "embedded"); String[] activeProfiles = environment.getActiveProfiles(); - assertThat(activeProfiles).contains("local", "embedded"); - assertThat(activeProfiles.length).isEqualTo(2); + assertThat(activeProfiles).containsExactly("local", "embedded"); } @Test @@ -177,15 +174,12 @@ public class StandardEnvironmentTests { void addActiveProfile() { assertThat(environment.getActiveProfiles().length).isEqualTo(0); environment.setActiveProfiles("local", "embedded"); - assertThat(environment.getActiveProfiles()).contains("local", "embedded"); - assertThat(environment.getActiveProfiles().length).isEqualTo(2); + assertThat(environment.getActiveProfiles()).containsExactly("local", "embedded"); environment.addActiveProfile("p1"); - assertThat(environment.getActiveProfiles()).contains("p1"); - assertThat(environment.getActiveProfiles().length).isEqualTo(3); + assertThat(environment.getActiveProfiles()).containsExactly("local", "embedded", "p1"); environment.addActiveProfile("p2"); environment.addActiveProfile("p3"); - assertThat(environment.getActiveProfiles()).contains("p2", "p3"); - assertThat(environment.getActiveProfiles().length).isEqualTo(5); + assertThat(environment.getActiveProfiles()).containsExactly("local", "embedded", "p1", "p2", "p3"); } @Test @@ -195,65 +189,41 @@ public class StandardEnvironmentTests { env.getPropertySources().addFirst(new MockPropertySource().withProperty(ACTIVE_PROFILES_PROPERTY_NAME, "p1")); assertThat(env.getProperty(ACTIVE_PROFILES_PROPERTY_NAME)).isEqualTo("p1"); env.addActiveProfile("p2"); - assertThat(env.getActiveProfiles()).contains("p1", "p2"); + assertThat(env.getActiveProfiles()).containsExactly("p1", "p2"); } @Test void reservedDefaultProfile() { - assertThat(environment.getDefaultProfiles()).isEqualTo(new String[]{RESERVED_DEFAULT_PROFILE_NAME}); - System.setProperty(DEFAULT_PROFILES_PROPERTY_NAME, "d0"); - assertThat(environment.getDefaultProfiles()).isEqualTo(new String[]{"d0"}); - environment.setDefaultProfiles("d1", "d2"); - assertThat(environment.getDefaultProfiles()).isEqualTo(new String[]{"d1","d2"}); - System.clearProperty(DEFAULT_PROFILES_PROPERTY_NAME); + assertThat(environment.getDefaultProfiles()).containsExactly(RESERVED_DEFAULT_PROFILE_NAME); + try { + System.setProperty(DEFAULT_PROFILES_PROPERTY_NAME, "d0"); + assertThat(environment.getDefaultProfiles()).containsExactly("d0"); + environment.setDefaultProfiles("d1", "d2"); + assertThat(environment.getDefaultProfiles()).containsExactly("d1","d2"); + } + finally { + System.clearProperty(DEFAULT_PROFILES_PROPERTY_NAME); + } } @Test void defaultProfileWithCircularPlaceholder() { try { System.setProperty(DEFAULT_PROFILES_PROPERTY_NAME, "${spring.profiles.default}"); - assertThatIllegalArgumentException().isThrownBy(environment::getDefaultProfiles); + assertThatIllegalArgumentException() + .isThrownBy(environment::getDefaultProfiles) + .withMessage("Circular placeholder reference 'spring.profiles.default' in property definitions"); } finally { System.clearProperty(DEFAULT_PROFILES_PROPERTY_NAME); } } - @Test - void getActiveProfiles_systemPropertiesEmpty() { - assertThat(environment.getActiveProfiles().length).isEqualTo(0); - System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, ""); - assertThat(environment.getActiveProfiles().length).isEqualTo(0); - System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); - } - - @Test - void getActiveProfiles_fromSystemProperties() { - System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, "foo"); - assertThat(Arrays.asList(environment.getActiveProfiles())).contains("foo"); - System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); - } - - @Test - void getActiveProfiles_fromSystemProperties_withMultipleProfiles() { - System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, "foo,bar"); - assertThat(environment.getActiveProfiles()).contains("foo", "bar"); - System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); - } - - @Test - void getActiveProfiles_fromSystemProperties_withMultipleProfiles_withWhitespace() { - System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, " bar , baz "); // notice whitespace - assertThat(environment.getActiveProfiles()).contains("bar", "baz"); - System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); - } - @Test void getDefaultProfiles() { - assertThat(environment.getDefaultProfiles()).isEqualTo(new String[] {RESERVED_DEFAULT_PROFILE_NAME}); + assertThat(environment.getDefaultProfiles()).containsExactly(RESERVED_DEFAULT_PROFILE_NAME); environment.getPropertySources().addFirst(new MockPropertySource().withProperty(DEFAULT_PROFILES_PROPERTY_NAME, "pd1")); - assertThat(environment.getDefaultProfiles().length).isEqualTo(1); - assertThat(Arrays.asList(environment.getDefaultProfiles())).contains("pd1"); + assertThat(environment.getDefaultProfiles()).containsExactly("pd1"); } @Test @@ -261,82 +231,9 @@ public class StandardEnvironmentTests { environment.setDefaultProfiles(); assertThat(environment.getDefaultProfiles().length).isEqualTo(0); environment.setDefaultProfiles("pd1"); - assertThat(Arrays.asList(environment.getDefaultProfiles())).contains("pd1"); + assertThat(environment.getDefaultProfiles()).containsExactly("pd1"); environment.setDefaultProfiles("pd2", "pd3"); - assertThat(environment.getDefaultProfiles()).doesNotContain("pd1"); - assertThat(environment.getDefaultProfiles()).contains("pd2", "pd3"); - } - - @Test - void acceptsProfiles_withEmptyArgumentList() { - assertThatIllegalArgumentException().isThrownBy( - environment::acceptsProfiles); - } - - @Test - void acceptsProfiles_withNullArgumentList() { - assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles((String[]) null)); - } - - @Test - void acceptsProfiles_withNullArgument() { - assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles((String) null)); - } - - @Test - void acceptsProfiles_withEmptyArgument() { - assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles("")); - } - - @Test - void acceptsProfiles_activeProfileSetProgrammatically() { - assertThat(environment.acceptsProfiles("p1", "p2")).isFalse(); - environment.setActiveProfiles("p1"); - assertThat(environment.acceptsProfiles("p1", "p2")).isTrue(); - environment.setActiveProfiles("p2"); - assertThat(environment.acceptsProfiles("p1", "p2")).isTrue(); - environment.setActiveProfiles("p1", "p2"); - assertThat(environment.acceptsProfiles("p1", "p2")).isTrue(); - } - - @Test - void acceptsProfiles_activeProfileSetViaProperty() { - assertThat(environment.acceptsProfiles("p1")).isFalse(); - environment.getPropertySources().addFirst(new MockPropertySource().withProperty(ACTIVE_PROFILES_PROPERTY_NAME, "p1")); - assertThat(environment.acceptsProfiles("p1")).isTrue(); - } - - @Test - void acceptsProfiles_defaultProfile() { - assertThat(environment.acceptsProfiles("pd")).isFalse(); - environment.setDefaultProfiles("pd"); - assertThat(environment.acceptsProfiles("pd")).isTrue(); - environment.setActiveProfiles("p1"); - assertThat(environment.acceptsProfiles("pd")).isFalse(); - assertThat(environment.acceptsProfiles("p1")).isTrue(); - } - - @Test - void acceptsProfiles_withNotOperator() { - assertThat(environment.acceptsProfiles("p1")).isFalse(); - assertThat(environment.acceptsProfiles("!p1")).isTrue(); - environment.addActiveProfile("p1"); - assertThat(environment.acceptsProfiles("p1")).isTrue(); - assertThat(environment.acceptsProfiles("!p1")).isFalse(); - } - - @Test - void acceptsProfiles_withInvalidNotOperator() { - assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles("p1", "!")); - } - - @Test - void acceptsProfiles_withProfileExpression() { - assertThat(environment.acceptsProfiles(Profiles.of("p1 & p2"))).isFalse(); - environment.addActiveProfile("p1"); - assertThat(environment.acceptsProfiles(Profiles.of("p1 & p2"))).isFalse(); - environment.addActiveProfile("p2"); - assertThat(environment.acceptsProfiles(Profiles.of("p1 & p2"))).isTrue(); + assertThat(environment.getDefaultProfiles()).containsExactly("pd2", "pd3"); } @Test @@ -346,88 +243,99 @@ public class StandardEnvironmentTests { protected void validateProfile(String profile) { super.validateProfile(profile); if (profile.contains("-")) { - throw new IllegalArgumentException( - "Invalid profile [" + profile + "]: must not contain dash character"); + throw new IllegalArgumentException("Invalid profile [" + profile + "]: must not contain dash character"); } } }; env.addActiveProfile("validProfile"); // succeeds - assertThatIllegalArgumentException().isThrownBy(() -> - env.addActiveProfile("invalid-profile")) + assertThatIllegalArgumentException() + .isThrownBy(() -> env.addActiveProfile("invalid-profile")) .withMessage("Invalid profile [invalid-profile]: must not contain dash character"); } @Test void suppressGetenvAccessThroughSystemProperty() { - System.setProperty("spring.getenv.ignore", "true"); - assertThat(environment.getSystemEnvironment().isEmpty()).isTrue(); - System.clearProperty("spring.getenv.ignore"); + try { + System.setProperty("spring.getenv.ignore", "true"); + assertThat(environment.getSystemEnvironment()).isEmpty(); + } + finally { + System.clearProperty("spring.getenv.ignore"); + } } @Test void suppressGetenvAccessThroughSpringProperty() { - SpringProperties.setProperty("spring.getenv.ignore", "true"); - assertThat(environment.getSystemEnvironment().isEmpty()).isTrue(); - SpringProperties.setProperty("spring.getenv.ignore", null); + try { + SpringProperties.setProperty("spring.getenv.ignore", "true"); + assertThat(environment.getSystemEnvironment()).isEmpty(); + } + finally { + SpringProperties.setProperty("spring.getenv.ignore", null); + } } @Test void suppressGetenvAccessThroughSpringFlag() { - SpringProperties.setFlag("spring.getenv.ignore"); - assertThat(environment.getSystemEnvironment().isEmpty()).isTrue(); - SpringProperties.setProperty("spring.getenv.ignore", null); + try { + SpringProperties.setFlag("spring.getenv.ignore"); + assertThat(environment.getSystemEnvironment()).isEmpty(); + } + finally { + SpringProperties.setProperty("spring.getenv.ignore", null); + } } @Test void getSystemProperties_withAndWithoutSecurityManager() { - System.setProperty(ALLOWED_PROPERTY_NAME, ALLOWED_PROPERTY_VALUE); - System.setProperty(DISALLOWED_PROPERTY_NAME, DISALLOWED_PROPERTY_VALUE); - System.getProperties().put(STRING_PROPERTY_NAME, NON_STRING_PROPERTY_VALUE); - System.getProperties().put(NON_STRING_PROPERTY_NAME, STRING_PROPERTY_VALUE); + SecurityManager originalSecurityManager = System.getSecurityManager(); + try { + System.setProperty(ALLOWED_PROPERTY_NAME, ALLOWED_PROPERTY_VALUE); + System.setProperty(DISALLOWED_PROPERTY_NAME, DISALLOWED_PROPERTY_VALUE); + System.getProperties().put(STRING_PROPERTY_NAME, NON_STRING_PROPERTY_VALUE); + System.getProperties().put(NON_STRING_PROPERTY_NAME, STRING_PROPERTY_VALUE); - { - Map systemProperties = environment.getSystemProperties(); - assertThat(systemProperties).isNotNull(); - assertThat(System.getProperties()).isSameAs(systemProperties); - assertThat(systemProperties.get(ALLOWED_PROPERTY_NAME)).isEqualTo(ALLOWED_PROPERTY_VALUE); - assertThat(systemProperties.get(DISALLOWED_PROPERTY_NAME)).isEqualTo(DISALLOWED_PROPERTY_VALUE); - - // non-string keys and values work fine... until the security manager is introduced below - assertThat(systemProperties.get(STRING_PROPERTY_NAME)).isEqualTo(NON_STRING_PROPERTY_VALUE); - assertThat(systemProperties.get(NON_STRING_PROPERTY_NAME)).isEqualTo(STRING_PROPERTY_VALUE); - } + { + Map systemProperties = environment.getSystemProperties(); + assertThat(systemProperties).isNotNull(); + assertThat(System.getProperties()).isSameAs(systemProperties); + assertThat(systemProperties.get(ALLOWED_PROPERTY_NAME)).isEqualTo(ALLOWED_PROPERTY_VALUE); + assertThat(systemProperties.get(DISALLOWED_PROPERTY_NAME)).isEqualTo(DISALLOWED_PROPERTY_VALUE); - SecurityManager oldSecurityManager = System.getSecurityManager(); - SecurityManager securityManager = new SecurityManager() { - @Override - public void checkPropertiesAccess() { - // see https://download.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperties() - throw new AccessControlException("Accessing the system properties is disallowed"); + // non-string keys and values work fine... until the security manager is introduced below + assertThat(systemProperties.get(STRING_PROPERTY_NAME)).isEqualTo(NON_STRING_PROPERTY_VALUE); + assertThat(systemProperties.get(NON_STRING_PROPERTY_NAME)).isEqualTo(STRING_PROPERTY_VALUE); } - @Override - public void checkPropertyAccess(String key) { - // see https://download.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperty(java.lang.String) - if (DISALLOWED_PROPERTY_NAME.equals(key)) { - throw new AccessControlException( - String.format("Accessing the system property [%s] is disallowed", DISALLOWED_PROPERTY_NAME)); + + SecurityManager securityManager = new SecurityManager() { + @Override + public void checkPropertiesAccess() { + // see https://download.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperties() + throw new AccessControlException("Accessing the system properties is disallowed"); } - } - @Override - public void checkPermission(Permission perm) { - // allow everything else - } - }; + @Override + public void checkPropertyAccess(String key) { + // see https://download.oracle.com/javase/1.5.0/docs/api/java/lang/System.html#getProperty(java.lang.String) + if (DISALLOWED_PROPERTY_NAME.equals(key)) { + throw new AccessControlException( + String.format("Accessing the system property [%s] is disallowed", DISALLOWED_PROPERTY_NAME)); + } + } + @Override + public void checkPermission(Permission perm) { + // allow everything else + } + }; - try { System.setSecurityManager(securityManager); { Map systemProperties = environment.getSystemProperties(); assertThat(systemProperties).isNotNull(); assertThat(systemProperties).isInstanceOf(ReadOnlySystemAttributesMap.class); - assertThat((String)systemProperties.get(ALLOWED_PROPERTY_NAME)).isEqualTo(ALLOWED_PROPERTY_VALUE); + assertThat(systemProperties.get(ALLOWED_PROPERTY_NAME)).isEqualTo(ALLOWED_PROPERTY_VALUE); assertThat(systemProperties.get(DISALLOWED_PROPERTY_NAME)).isNull(); // nothing we can do here in terms of warning the user that there was @@ -441,12 +349,12 @@ public class StandardEnvironmentTests { // the user that under these very special conditions (non-object key + // SecurityManager that disallows access to system properties), they // cannot do what they're attempting. - assertThatIllegalArgumentException().as("searching with non-string key against ReadOnlySystemAttributesMap").isThrownBy(() -> - systemProperties.get(NON_STRING_PROPERTY_NAME)); + assertThatIllegalArgumentException().as("searching with non-string key against ReadOnlySystemAttributesMap") + .isThrownBy(() -> systemProperties.get(NON_STRING_PROPERTY_NAME)); } } finally { - System.setSecurityManager(oldSecurityManager); + System.setSecurityManager(originalSecurityManager); System.clearProperty(ALLOWED_PROPERTY_NAME); System.clearProperty(DISALLOWED_PROPERTY_NAME); System.getProperties().remove(STRING_PROPERTY_NAME); @@ -499,4 +407,138 @@ public class StandardEnvironmentTests { EnvironmentTestUtils.getModifiableSystemEnvironment().remove(DISALLOWED_PROPERTY_NAME); } + @Nested + class GetActiveProfiles { + + @Test + void systemPropertiesEmpty() { + assertThat(environment.getActiveProfiles()).isEmpty(); + try { + System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, ""); + assertThat(environment.getActiveProfiles()).isEmpty(); + } + finally { + System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); + } + } + + @Test + void fromSystemProperties() { + try { + System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, "foo"); + assertThat(environment.getActiveProfiles()).containsExactly("foo"); + } + finally { + System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); + } + } + + @Test + void fromSystemProperties_withMultipleProfiles() { + try { + System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, "foo,bar"); + assertThat(environment.getActiveProfiles()).containsExactly("foo", "bar"); + } + finally { + System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); + } + } + + @Test + void fromSystemProperties_withMultipleProfiles_withWhitespace() { + try { + System.setProperty(ACTIVE_PROFILES_PROPERTY_NAME, " bar , baz "); // notice whitespace + assertThat(environment.getActiveProfiles()).containsExactly("bar", "baz"); + } + finally { + System.clearProperty(ACTIVE_PROFILES_PROPERTY_NAME); + } + } + } + + @Nested + class AcceptsProfilesTests { + + @Test + @SuppressWarnings("deprecation") + void withEmptyArgumentList() { + assertThatIllegalArgumentException().isThrownBy(environment::acceptsProfiles); + } + + @Test + @SuppressWarnings("deprecation") + void withNullArgumentList() { + assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles((String[]) null)); + } + + @Test + @SuppressWarnings("deprecation") + void withNullArgument() { + assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles((String) null)); + } + + @Test + @SuppressWarnings("deprecation") + void withEmptyArgument() { + assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles("")); + } + + @Test + @SuppressWarnings("deprecation") + void activeProfileSetProgrammatically() { + assertThat(environment.acceptsProfiles("p1", "p2")).isFalse(); + environment.setActiveProfiles("p1"); + assertThat(environment.acceptsProfiles("p1", "p2")).isTrue(); + environment.setActiveProfiles("p2"); + assertThat(environment.acceptsProfiles("p1", "p2")).isTrue(); + environment.setActiveProfiles("p1", "p2"); + assertThat(environment.acceptsProfiles("p1", "p2")).isTrue(); + } + + @Test + @SuppressWarnings("deprecation") + void activeProfileSetViaProperty() { + assertThat(environment.acceptsProfiles("p1")).isFalse(); + environment.getPropertySources().addFirst(new MockPropertySource().withProperty(ACTIVE_PROFILES_PROPERTY_NAME, "p1")); + assertThat(environment.acceptsProfiles("p1")).isTrue(); + } + + @Test + @SuppressWarnings("deprecation") + void defaultProfile() { + assertThat(environment.acceptsProfiles("pd")).isFalse(); + environment.setDefaultProfiles("pd"); + assertThat(environment.acceptsProfiles("pd")).isTrue(); + environment.setActiveProfiles("p1"); + assertThat(environment.acceptsProfiles("pd")).isFalse(); + assertThat(environment.acceptsProfiles("p1")).isTrue(); + } + + @Test + @SuppressWarnings("deprecation") + void withNotOperator() { + assertThat(environment.acceptsProfiles("p1")).isFalse(); + assertThat(environment.acceptsProfiles("!p1")).isTrue(); + environment.addActiveProfile("p1"); + assertThat(environment.acceptsProfiles("p1")).isTrue(); + assertThat(environment.acceptsProfiles("!p1")).isFalse(); + } + + @Test + @SuppressWarnings("deprecation") + void withInvalidNotOperator() { + assertThatIllegalArgumentException().isThrownBy(() -> environment.acceptsProfiles("p1", "!")); + } + + @Test + void withProfileExpression() { + assertThat(environment.acceptsProfiles(Profiles.of("p1 & p2"))).isFalse(); + environment.addActiveProfile("p1"); + assertThat(environment.acceptsProfiles(Profiles.of("p1 & p2"))).isFalse(); + environment.addActiveProfile("p2"); + assertThat(environment.acceptsProfiles(Profiles.of("p1 & p2"))).isTrue(); + } + + } + }