org.springframework.test.context.junit.jupiter

Class EnabledIfCondition

java.lang.Object

org.springframework.test.context.junit.jupiter.EnabledIfCondition

All Implemented Interfaces:

org.junit.jupiter.api.extension.ContainerExecutionCondition, org.junit.jupiter.api.extension.Extension, org.junit.jupiter.api.extension.TestExecutionCondition

public class EnabledIfCondition
extends Object

EnabledIfCondition is a composite ContainerExecutionCondition and TestExecutionCondition that supports the @EnabledIf annotation when using the Spring TestContext Framework in conjunction with JUnit 5's Jupiter programming model.

Any attempt to use the EnabledIfCondition without the presence of @EnabledIf will result in an enabled ConditionEvaluationResult.

Since:

5.0

Author:

Sam Brannen

See Also:

EnabledIf, DisabledIf, SpringExtension

Constructor Summary

Constructors

Constructor and Description
EnabledIfCondition()

Method Summary

Modifier and Type	Method and Description
org.junit.jupiter.api.extension.ConditionEvaluationResult	evaluate(org.junit.jupiter.api.extension.ContainerExtensionContext context) Containers are enabled if @EnabledIf is present on the test class and the configured expression evaluates to true.
org.junit.jupiter.api.extension.ConditionEvaluationResult	evaluate(org.junit.jupiter.api.extension.TestExtensionContext context) Tests are enabled if @EnabledIf is present on the test method and the configured expression evaluates to true.
protected <A extends Annotation> org.junit.jupiter.api.extension.ConditionEvaluationResult	evaluateAnnotation(Class<A> annotationType, Function<A,String> expressionExtractor, Function<A,String> reasonExtractor, Function<A,Boolean> loadContextExtractor, boolean enabledOnTrue, org.junit.jupiter.api.extension.ExtensionContext context) Evaluate the expression configured via the supplied annotation type on the AnnotatedElement for the supplied ExtensionContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnabledIfCondition

public EnabledIfCondition()

Method Detail

evaluate

public org.junit.jupiter.api.extension.ConditionEvaluationResult evaluate(org.junit.jupiter.api.extension.ContainerExtensionContext context)

Containers are enabled if @EnabledIf is present on the test class and the configured expression evaluates to true.

evaluate

public org.junit.jupiter.api.extension.ConditionEvaluationResult evaluate(org.junit.jupiter.api.extension.TestExtensionContext context)

Tests are enabled if @EnabledIf is present on the test method and the configured expression evaluates to true.

evaluateAnnotation

protected <A extends Annotation> org.junit.jupiter.api.extension.ConditionEvaluationResult evaluateAnnotation(Class<A> annotationType,
                                                                                                              Function<A,String> expressionExtractor,
                                                                                                              Function<A,String> reasonExtractor,
                                                                                                              Function<A,Boolean> loadContextExtractor,
                                                                                                              boolean enabledOnTrue,
                                                                                                              org.junit.jupiter.api.extension.ExtensionContext context)

Evaluate the expression configured via the supplied annotation type on the AnnotatedElement for the supplied ExtensionContext.

Parameters:

annotationType - the type of annotation to process

expressionExtractor - a function that extracts the expression from the annotation

reasonExtractor - a function that extracts the reason from the annotation

loadContextExtractor - a function that extracts the loadContext flag from the annotation

enabledOnTrue - indicates whether the returned ConditionEvaluationResult should be enabled if the expression evaluates to true

context - the ExtensionContext

Returns:

enabled if the container or test should be enabled; otherwise disabled