org.testng.annotations.DataProvider Maven / Gradle / Ivy
package org.testng.annotations;
import static java.lang.annotation.ElementType.METHOD;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.testng.IRetryDataProvider;
/**
* Mark a method as supplying data for a test method.
*
* The {@link #name() name} defaults to the name of the annotated method.
*
*
The annotated method must return any of the following:
*
*
* - {@code Object[][]} or {@code Iterator
}, where each {@code Object[]} is assigned
* to the parameter list of the test method.
* - {@code Object[]} or {@code Iterator
*
* The {@link Test @Test} method that wants to receive data from this {@link DataProvider} needs
* to use a {@link Test#dataProvider()} name equal to the name of this annotation.
*/
@Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
@Target({METHOD})
@Documented
public @interface DataProvider {
/**
* The name of this DataProvider.
*
* @return the value (default empty)
*/
String name() default "";
/**
* Whether this data provider should be run in parallel.
*
* @return the value (default false)
*/
boolean parallel() default false;
/**
* Which indices to run from this data provider, default: all.
*
* @return the value
*/
int[] indices() default {};
/**
* Helps TestNG decide if it should treat data provider failures as test failures.
*
* @return the value
*/
boolean propagateFailureAsTestFailure() default false;
/**
* @return - An Class which implements {@link IRetryDataProvider} and which can be used to retry a
* data provider.
*/
Class retryUsing() default
IRetryDataProvider.DisableDataProviderRetries.class;
}