com.tngtech.jgiven.annotation.NotImplementedYet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jgiven-core Show documentation

JGiven core module

There is a newer version: 1.3.1

package com.tngtech.jgiven.annotation;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Marks methods of step definitions as not implemented yet.
 * Such steps will not be executed, but will appear in
 * the report as not implemented yet.
 * 
 * This is useful if one already wants to define the scenario without
 * already implementing all steps, for example, to verify that
 * all acceptance criteria of a story are covered by the scenario.
 * 

 * Annotating a stage class indicates
 * that no step is implemented yet.
 * 

 * Finally, a test method can be annotated to indicate that the whole
 * test is not implemented yet. The test will then be ignored by the testing-framework.
 * (In fact an AssumptionException is thrown. It depends on the test runner how this
 * is interpreted)
 * Currently only works for JUnit
 *
 * 
Example
 *  * {@literal @}NotImplementedYet
 * public void my_cool_new_feature() {
 *
 * }
 * 
 *
 * @deprecated use {@link Pending} instead
 */
@Deprecated
@Documented
@Inherited
@Retention( RUNTIME )
@Target( { METHOD, TYPE } )
public @interface NotImplementedYet {
    /**
     * Optional description to describe when the implementation will be done.
     */
    String value() default "";

    /**
     * Instead of only reporting not implemented yet steps,
     * the steps are actually executed.
     * This is useful to see whether some steps fail, for example.
     * Failing steps, however, have no influence on the overall test result.
     */
    boolean executeSteps() default false;

    /**
     * If no step fails during the execution of the test,
     * the test will fail.
     * 
     * This makes sense if one ensures that a not implemented feature
     * always leads to failing tests in the spirit of test-driven development.
     * 
     * If this is true, the executeSteps attribute is implicitly true.
     */
    boolean failIfPass() default false;
}