package org.junit;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
Sometimes you want to temporarily disable a test or a group of tests. Methods annotated with Test
that are also annotated with @Ignore
will not be executed as tests.
Also, you can annotate a class containing test methods with @Ignore
and none of the containing
tests will be executed. Native JUnit 4 test runners should report the number of ignored tests along with the
number of tests that ran and the number of tests that failed.
For example:
@Ignore @Test public void something() { ...
@Ignore takes an optional default parameter if you want to record why a test is being ignored:
@Ignore("not ready yet") @Test public void something() { ...
@Ignore can also be applied to the test class:
@Ignore public class IgnoreMe {
@Test public void test1() { ... }
@Test public void test2() { ... }
}
Since: 4.0
/**
* Sometimes you want to temporarily disable a test or a group of tests. Methods annotated with
* {@link org.junit.Test} that are also annotated with <code>@Ignore</code> will not be executed as tests.
* Also, you can annotate a class containing test methods with <code>@Ignore</code> and none of the containing
* tests will be executed. Native JUnit 4 test runners should report the number of ignored tests along with the
* number of tests that ran and the number of tests that failed.
*
* <p>For example:
* <pre>
* @Ignore @Test public void something() { ...
* </pre>
* @Ignore takes an optional default parameter if you want to record why a test is being ignored:
* <pre>
* @Ignore("not ready yet") @Test public void something() { ...
* </pre>
* @Ignore can also be applied to the test class:
* <pre>
* @Ignore public class IgnoreMe {
* @Test public void test1() { ... }
* @Test public void test2() { ... }
* }
* </pre>
*
* @since 4.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Ignore {
The optional reason why the test is ignored.
/**
* The optional reason why the test is ignored.
*/
String value() default "";
}