org.scalatest.Ignore Maven / Gradle / Ivy
/*
* Copyright 2001-2013 Artima, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.scalatest;
import java.lang.annotation.*;
/**
* Annotation used to tag a test, or suite of tests, as ignored.
*
*
* Note: This is actually an annotation defined in Java, not a Scala trait. It must be defined in Java instead of Scala so it will be accessible
* at runtime. It has been inserted into Scaladoc by pretending it is a trait.
*
*
*
* If you wish to temporarily ignore an entire suite of tests, you can annotate the test class with @Ignore, like this:
*
*
*
* package org.scalatest.examples.flatspec.ignoreall
*
* import org.scalatest._
*
* @Ignore
* class SetSpec extends FlatSpec {
*
* "An empty Set" should "have size 0" in {
* assert(Set.empty.size === 0)
* }
*
* it should "produce NoSuchElementException when head is invoked" in {
* intercept[NoSuchElementException] {
* Set.empty.head
* }
* }
* }
*
*
*
* When you mark a test class with a tag annotation, ScalaTest will mark each test defined in that class with that tag.
* Thus, marking the SetSpec in the above example with the @Ignore tag annotation means that both tests
* in the class will be ignored. If you run the above SetSpec in the Scala interpreter, you'll see:
*
*
*
* scala> org.scalatest.run(new SetSpec)
* An empty Set
* - should have size 0 !!! IGNORED !!!
* - should produce NoSuchElementException when head is invoked !!! IGNORED !!!
*
*
*
* Note that marking a test class as ignored won't prevent it from being discovered by ScalaTest. Ignored classes
* will be discovered and run, and all their tests will be reported as ignored. This is intended to keep the ignored
* class somewhat visible, to encourage the developers to eventually fix and un-ignore it. If you want to
* prevent a class from being discovered at all, use the DoNotDiscover annotation instead.
*
*
*
* Another use case for @Ignore is to mark test methods as ignored in traits Spec
* and fixture.Spec. Here's an example:
*
*
*
* package org.scalatest.examples.spec.ignore
*
* import org.scalatest._
*
* class SetSpec extends RefSpec {
*
* @Ignore def `an empty Set should have size 0` {
* assert(Set.empty.size === 0)
* }
*
* def `invoking head on an empty Set should produce NoSuchElementException` {
* intercept[NoSuchElementException] {
* Set.empty.head
* }
* }
* }
*
*
*
* If you run this version of SetSpec in the Scala interpreter, you'll see that it
* runs only the second test and reports that the first test was ignored:
*
*
*
* scala> org.scalatest.run(new SetSpec)
* SetSpec:
* - an empty Set should have size 0 !!! IGNORED !!!
* - invoking head on an empty Set should produce NoSuchElementException
*
*
*
* Note that because reflection is not supported on Scala.js, this annotation will only work on the JVM, not on Scala.js.
*
*
* @author Bill Venners
* @author Chua Chee Seng
*/
@TagAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Ignore {
}