From 9e571a2827708ac5432db43dd1a4548044e749f4 Mon Sep 17 00:00:00 2001 From: Razib Shahriar Date: Sun, 4 Nov 2018 12:40:04 -0800 Subject: [PATCH 1/2] Fail fast if nested condition uses a phase inappropriate for its members See gh-15086 --- .../condition/AbstractNestedCondition.java | 26 ++- .../AbstractNestedConditionTest.java | 163 ++++++++++++++++++ 2 files changed, 187 insertions(+), 2 deletions(-) create mode 100644 spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java index a5c4c19b1e..6c1f6d0dde 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java @@ -61,7 +61,8 @@ public abstract class AbstractNestedCondition extends SpringBootCondition public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { String className = getClass().getName(); - MemberConditions memberConditions = new MemberConditions(context, className); + MemberConditions memberConditions = new MemberConditions(context, + this.configurationPhase, className); MemberMatchOutcomes memberOutcomes = new MemberMatchOutcomes(memberConditions); return getFinalMatchOutcome(memberOutcomes); } @@ -108,12 +109,19 @@ public abstract class AbstractNestedCondition extends SpringBootCondition private final MetadataReaderFactory readerFactory; + private final ConfigurationPhase nestedPhase; + + private final String nestedClassName; + private final Map> memberConditions; - MemberConditions(ConditionContext context, String className) { + MemberConditions(ConditionContext context, ConfigurationPhase nestedPhase, + String className) { this.context = context; this.readerFactory = new SimpleMetadataReaderFactory( context.getResourceLoader()); + this.nestedPhase = nestedPhase; + this.nestedClassName = className; String[] members = getMetadata(className).getMemberClassNames(); this.memberConditions = getMemberConditions(members); } @@ -126,6 +134,7 @@ public abstract class AbstractNestedCondition extends SpringBootCondition for (String[] conditionClasses : getConditionClasses(metadata)) { for (String conditionClass : conditionClasses) { Condition condition = getCondition(conditionClass); + validateMemberCondition(condition); memberConditions.add(metadata, condition); } } @@ -133,6 +142,19 @@ public abstract class AbstractNestedCondition extends SpringBootCondition return Collections.unmodifiableMap(memberConditions); } + private void validateMemberCondition(Condition condition) { + if (this.nestedPhase == ConfigurationPhase.PARSE_CONFIGURATION + && condition instanceof ConfigurationCondition) { + ConfigurationPhase memberPhase = ((ConfigurationCondition) condition) + .getConfigurationPhase(); + if (memberPhase == ConfigurationPhase.REGISTER_BEAN) { + throw new IllegalStateException("Nested condition " + + this.nestedClassName + " uses a configuration " + + "phase that is inappropriate for " + condition.getClass()); + } + } + } + private AnnotationMetadata getMetadata(String className) { try { return this.readerFactory.getMetadataReader(className) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java new file mode 100644 index 0000000000..b0aa1cda72 --- /dev/null +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java @@ -0,0 +1,163 @@ +/* + * Copyright 2012-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.boot.autoconfigure.condition; + +import org.junit.Test; + +import org.springframework.boot.test.context.runner.ApplicationContextRunner; +import org.springframework.context.annotation.AnnotationConfigApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Configuration; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Tests for {@link AbstractNestedCondition}. + * + * @author Razib Shahriar + */ +public class AbstractNestedConditionTest { + + private final ApplicationContextRunner contextRunner = new ApplicationContextRunner(); + + @Test + public void validMemberPhaseEvaluatesCorrectly() { + this.contextRunner.withUserConfiguration(ValidConfig.class) + .run((context) -> assertThat(context).hasBean("myBean")); + } + + @Test + public void invalidMemberPhaseThrowsIllegalState() { + this.contextRunner.withUserConfiguration(InvalidConfig.class).run((context) -> { + assertThat(context).hasFailed(); + assertThat(context.getStartupFailure().getCause()) + .isInstanceOf(IllegalStateException.class) + .hasMessageContaining("Nested condition " + + InvalidNestedCondition.class.getName() + + " uses a configuration phase that is inappropriate for class " + + OnBeanCondition.class.getName()); + }); + } + + @Test + public void invalidNestedMemberPhaseThrowsIllegalState() { + this.contextRunner.withUserConfiguration(DoubleNestedConfig.class) + .run((context) -> { + assertThat(context).hasFailed(); + assertThat(context.getStartupFailure().getCause()) + .isInstanceOf(IllegalStateException.class) + .hasMessageContaining("Nested condition " + + DoubleNestedCondition.class.getName() + + " uses a configuration phase that is inappropriate for class " + + ValidNestedCondition.class.getName()); + }); + } + + private AnnotationConfigApplicationContext load(Class config) { + AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); + context.register(config); + context.refresh(); + return context; + } + + @Configuration + @Conditional(ValidNestedCondition.class) + public static class ValidConfig { + + @Bean + public String myBean() { + return "myBean"; + } + + } + + static class ValidNestedCondition extends AbstractNestedCondition { + + ValidNestedCondition() { + super(ConfigurationPhase.REGISTER_BEAN); + } + + @Override + protected ConditionOutcome getFinalMatchOutcome( + MemberMatchOutcomes memberOutcomes) { + return ConditionOutcome.match(); + } + + @ConditionalOnMissingBean(name = "myBean") + static class MissingMyBean { + + } + + } + + @Configuration + @Conditional(InvalidNestedCondition.class) + public static class InvalidConfig { + + @Bean + public String myBean() { + return "myBean"; + } + + } + + static class InvalidNestedCondition extends AbstractNestedCondition { + + InvalidNestedCondition() { + super(ConfigurationPhase.PARSE_CONFIGURATION); + } + + @Override + protected ConditionOutcome getFinalMatchOutcome( + MemberMatchOutcomes memberOutcomes) { + return ConditionOutcome.match(); + } + + @ConditionalOnMissingBean(name = "myBean") + static class MissingMyBean { + + } + + } + + @Configuration + @Conditional(DoubleNestedCondition.class) + public static class DoubleNestedConfig { + + } + + static class DoubleNestedCondition extends AbstractNestedCondition { + + DoubleNestedCondition() { + super(ConfigurationPhase.PARSE_CONFIGURATION); + } + + @Override + protected ConditionOutcome getFinalMatchOutcome( + MemberMatchOutcomes memberOutcomes) { + return ConditionOutcome.match(); + } + + @Conditional(ValidNestedCondition.class) + static class NestedConditionThatIsValid { + + } + + } + +} From bbad720e2343997922a12f061289241f543c0fee Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 3 Dec 2018 14:12:30 +0100 Subject: [PATCH 2/2] Polish contribution Closes gh-15086 --- .../condition/AbstractNestedCondition.java | 23 ++++++++----------- ...java => AbstractNestedConditionTests.java} | 16 ++++--------- 2 files changed, 13 insertions(+), 26 deletions(-) rename spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/{AbstractNestedConditionTest.java => AbstractNestedConditionTests.java} (88%) diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java index 6c1f6d0dde..da6fa3aa5b 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/condition/AbstractNestedCondition.java @@ -109,32 +109,26 @@ public abstract class AbstractNestedCondition extends SpringBootCondition private final MetadataReaderFactory readerFactory; - private final ConfigurationPhase nestedPhase; - - private final String nestedClassName; - private final Map> memberConditions; - MemberConditions(ConditionContext context, ConfigurationPhase nestedPhase, + MemberConditions(ConditionContext context, ConfigurationPhase phase, String className) { this.context = context; this.readerFactory = new SimpleMetadataReaderFactory( context.getResourceLoader()); - this.nestedPhase = nestedPhase; - this.nestedClassName = className; String[] members = getMetadata(className).getMemberClassNames(); - this.memberConditions = getMemberConditions(members); + this.memberConditions = getMemberConditions(members, phase, className); } private Map> getMemberConditions( - String[] members) { + String[] members, ConfigurationPhase phase, String className) { MultiValueMap memberConditions = new LinkedMultiValueMap<>(); for (String member : members) { AnnotationMetadata metadata = getMetadata(member); for (String[] conditionClasses : getConditionClasses(metadata)) { for (String conditionClass : conditionClasses) { Condition condition = getCondition(conditionClass); - validateMemberCondition(condition); + validateMemberCondition(condition, phase, className); memberConditions.add(metadata, condition); } } @@ -142,14 +136,15 @@ public abstract class AbstractNestedCondition extends SpringBootCondition return Collections.unmodifiableMap(memberConditions); } - private void validateMemberCondition(Condition condition) { - if (this.nestedPhase == ConfigurationPhase.PARSE_CONFIGURATION + private void validateMemberCondition(Condition condition, + ConfigurationPhase nestedPhase, String nestedClassName) { + if (nestedPhase == ConfigurationPhase.PARSE_CONFIGURATION && condition instanceof ConfigurationCondition) { ConfigurationPhase memberPhase = ((ConfigurationCondition) condition) .getConfigurationPhase(); if (memberPhase == ConfigurationPhase.REGISTER_BEAN) { - throw new IllegalStateException("Nested condition " - + this.nestedClassName + " uses a configuration " + throw new IllegalStateException("Nested condition " + nestedClassName + + " uses a configuration " + "phase that is inappropriate for " + condition.getClass()); } } diff --git a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTests.java similarity index 88% rename from spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java rename to spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTests.java index b0aa1cda72..98f15a0832 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTest.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/condition/AbstractNestedConditionTests.java @@ -19,7 +19,6 @@ package org.springframework.boot.autoconfigure.condition; import org.junit.Test; import org.springframework.boot.test.context.runner.ApplicationContextRunner; -import org.springframework.context.annotation.AnnotationConfigApplicationContext; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Conditional; import org.springframework.context.annotation.Configuration; @@ -31,18 +30,18 @@ import static org.assertj.core.api.Assertions.assertThat; * * @author Razib Shahriar */ -public class AbstractNestedConditionTest { +public class AbstractNestedConditionTests { private final ApplicationContextRunner contextRunner = new ApplicationContextRunner(); @Test - public void validMemberPhaseEvaluatesCorrectly() { + public void validPhase() { this.contextRunner.withUserConfiguration(ValidConfig.class) .run((context) -> assertThat(context).hasBean("myBean")); } @Test - public void invalidMemberPhaseThrowsIllegalState() { + public void invalidMemberPhase() { this.contextRunner.withUserConfiguration(InvalidConfig.class).run((context) -> { assertThat(context).hasFailed(); assertThat(context.getStartupFailure().getCause()) @@ -55,7 +54,7 @@ public class AbstractNestedConditionTest { } @Test - public void invalidNestedMemberPhaseThrowsIllegalState() { + public void invalidNestedMemberPhase() { this.contextRunner.withUserConfiguration(DoubleNestedConfig.class) .run((context) -> { assertThat(context).hasFailed(); @@ -68,13 +67,6 @@ public class AbstractNestedConditionTest { }); } - private AnnotationConfigApplicationContext load(Class config) { - AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); - context.register(config); - context.refresh(); - return context; - } - @Configuration @Conditional(ValidNestedCondition.class) public static class ValidConfig {