io.cucumber.testng.CucumberOptions Maven / Gradle / Ivy
package io.cucumber.testng;
import io.cucumber.plugin.Plugin;
import org.apiguardian.api.API;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Configure Cucumbers options.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@API(status = API.Status.STABLE)
public @interface CucumberOptions {
/**
* @return true if glue code execution should be skipped.
*/
boolean dryRun() default false;
/**
* @return true if undefined and pending steps should be treated as errors.
*/
boolean strict() default false;
/**
* Either a URI or path to a directory of features or a URI or path to a single
* feature optionally followed by a colon and line numbers.
*
* When no feature path is provided, Cucumber will use the package of the annotated
* class. For example, if the annotated class is {@code com.example.RunCucumber}
* then features are assumed to be located in {@code classpath:com/example}.
*
* @return list of files or directories
* @see io.cucumber.core.feature.FeatureWithLines
*/
String[] features() default {};
/**
* Package to load glue code (step definitions,
* hooks and plugins) from. E.g: {@code com.example.app}
*
* When no glue is provided, Cucumber will use the package of the annotated
* class. For example, if the annotated class is {@code com.example.RunCucumber}
* then glue is assumed to be located in {@code com.example}.
*
* @return list of package names
* @see io.cucumber.core.feature.GluePath
*/
String[] glue() default {};
/**
* Package to load additional glue code (step definitions, hooks and
* plugins) from. E.g: {@code com.example.app}
*
* These packages are used in addition to the default described in {@code #glue}.
*
* @return list of package names
*/
String[] extraGlue() default {};
/**
* Only run scenarios tagged with tags matching {@code TAG_EXPRESSION}.
*
* For example {@code "@smoke and not @fast"}.
*
* @return list of tags
*/
String[] tags() default {};
/**
* Register plugins.
* Built-in plugin types: {@code junit}, {@code html},
* {@code pretty}, {@code progress}, {@code json}, {@code usage},
* {@code unused}, {@code rerun}, {@code testng}.
*
* Can also be a fully qualified class name, allowing
* registration of 3rd party plugins.
*
* Plugins can be provided with an argument. For example
* {@code json:target/cucumber-report.json}
*
* @return list of plugins
* @see Plugin
*/
String[] plugin() default {};
/**
* @return true if terminal output should be without colours.
*/
boolean monochrome() default false;
/**
* Only run scenarios whose names match one of the provided regular expressions.
*
* @return a list of regular expressions
*/
String[] name() default {};
/**
* @return the format of the generated snippets.
*/
SnippetType snippets() default SnippetType.UNDERSCORE;
/**
* Specify a custom ObjectFactory.
*
* In case a custom ObjectFactory is needed, the class can be specified here.
* A custom ObjectFactory might be needed when more granular control is needed
* over the dependency injection mechanism.
*
* @return an {@link io.cucumber.core.backend.ObjectFactory} implementation
*/
Class objectFactory() default NoObjectFactory.class;
enum SnippetType {
UNDERSCORE, CAMELCASE
}
}