Is there a way to access values of a custom annotation in a ExecutionCondition of junit 5 tests?

Question

I have the following annotation to mark test code that should not be executed if a server does not listen on a host and port each specified in a properties file:

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@ExtendWith(DisableOnServerNotListening.class)
public @interface DisabledOnServerNotListening
{
    String propertyNameHost() default "host";
    String propertyNamePort() default "port";
}

In a junit 5 ÈxecutionCondition I want to look up the actual configured host/port values from the property file to decide if the test should be run (port is listening) or not (port is not listening). Because there may be more than one host/port configuration in my tests I need to be flexible regarding property names. So how can I access the values of the annotation? Debugging shows that there is a field called testDescriptor in ExtensionContext, but it is not exposed for access.

johanneslink · Accepted Answer · 2023-07-05T10:15:40.260

Looking at existing Jupiter functionality you can see that most existing implementations of ExecutionCondition work with annotations. Thus, what you want to do is possible.

Let's look at (parts of) the implementation of DisabledCondition:


import static org.junit.platform.commons.util.AnnotationUtils.findAnnotation;


class DisabledCondition implements ExecutionCondition {

    private static final ConditionEvaluationResult ENABLED = ConditionEvaluationResult.enabled(
        "@Disabled is not present");

    @Override
    public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) {
        AnnotatedElement element = context.getElement().orElse(null);
        return findAnnotation(element, Disabled.class) //
                .map(annotation -> toResult(element, annotation)) //
                .orElse(ENABLED);
    }

    private ConditionEvaluationResult toResult(AnnotatedElement element, Disabled annotation) {
        String value = annotation.value();
        String reason = StringUtils.isNotBlank(value) ? value : element + " is @Disabled";
        return ConditionEvaluationResult.disabled(reason);
    }

}

If you replace Disabled with DisabledOnServerNotListening you have a head start on the implementation of your own ExecutionCondition subtype.

The actual checking code for host availability would probably reside within the toResult method. Similar to:

private ConditionEvaluationResult toResult(AnnotatedElement element, DisabledOnServerNotListening annotation) {
    String hostPropName = annotation.propertyNameHost();
    String portPropName = annotation.propertyNamePort();
    boolean disabled = !checkIfHostIsListening(hostPropName, portPropName);
    if (disabled) 
        return ConditionEvaluationResult.disabled("host not listening");
    else
        return ConditionEvaluationResult.enabled();
}

Thanks a lot @johanneslink, perfect answer accepted. I did not see context.getElement(). Thanks for your explanations, too. — r-uu, Jul 05 '23 at 10:42
It seems like this solution does not work with jpms activated, right? I can not find out how to fix ``` cannot access class org.junit.platform.commons.util.Preconditions (in module org.junit.platform.commons) because module org.junit.platform.commons does not export org.junit.platform.commons.util to unnamed module ``` — r-uu, Jul 06 '23 at 09:40
You can use `org.junit.platform.commons.support.AnnotationSupport.findAnnotation` instead of `AnnotationUtil.findAnnotation`. This is in a published package. — johanneslink, Jul 06 '23 at 11:11
Thanks for your advice. I successfully replaced my own jpms-version of 'findAnnotation' with 'org.junit.platform.commons.support.AnnotationSupport.findAnnotation'. — r-uu, Jul 11 '23 at 11:57

Is there a way to access values of a custom annotation in a ExecutionCondition of junit 5 tests?

1 Answers1