org.junitpioneer.jupiter.params.DisableIfArgument Maven / Gradle / Ivy
/*
* Copyright 2016-2022 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junitpioneer.jupiter.params;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @DisableIfArgument} is a JUnit Jupiter extension that selectively disables a
* {@link org.junit.jupiter.params.ParameterizedTest} execution if the specified
* argument (as defined by {@link Object#toString()}) satisfies the specified condition.
*
* The extension uses Jupiter's {@link org.junit.jupiter.api.extension.InvocationInterceptor}.
* It's important to note that since it's marked as {@link org.apiguardian.api.API.Status#EXPERIMENTAL}
* it might be removed without prior notice.
* Unlike {@link org.junit.jupiter.api.Disabled} annotations, this extension doesn't disable the whole test method.
* With {@code DisableIfArgument}, it is possible to selectively disable tests out of the plethora
* of dynamically registered parameterized tests.
*
* The extension requires that exactly one of {@link DisableIfArgument#contains() contains} or
* {@link DisableIfArgument#matches() matches} is configured.
*
* This annotation is for disabling a test based on a single argument which can be designated with an
* implicit index, an explicit index or by name (if parameter name information is present). For more
* information how the extension resolves the annotations, check
* the documentation.
*
* @see DisableIfArgumentExtension
* @since 1.5.0
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(DisableIfArgument.DisableIfArguments.class)
@ExtendWith(DisableIfArgumentExtension.class)
public @interface DisableIfArgument {
/**
* The name of the parameter the extension checks.
* If parameter naming information is not present at runtime, setting this will throw
* {@link org.junit.jupiter.api.extension.ParameterResolutionException}.
*/
String name() default "";
/**
* The index of the parameter the extension checks, starting from 0.
* Negative values are ignored. Setting this to a number higher than the parameter count
* of the test method will result in {@link org.junit.jupiter.api.extension.ExtensionConfigurationException}.
*/
int index() default -1;
/**
* Disable test cases whose argument (converted to String with {@link Object#toString()})
* contains any of the the specified strings (according to {@link String#contains(CharSequence)}).
*/
String[] contains() default {};
/**
* Disable test cases whose argument (converted to String with {@link Object#toString()})
* matches any of the specified regular expressions (according to {@link String#matches(String)}).
*/
String[] matches() default {};
/**
* Containing annotation of repeatable {@code DisableIfArgument}.
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface DisableIfArguments {
DisableIfArgument[] value();
}
}