Trait

org.scalatest

DoNotDiscover

Related Doc: package scalatest

Permalink

trait DoNotDiscover extends Annotation

Annotation used to indicate that an otherwise discoverable test class should not be discovered.

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.

ScalaTest will discover any class that either extends Suite and has a public, no-arg constructor, or is annotated with a valid WrapWith annotation. If you wish to prevent a class from being discovered, simply annotate it with DoNotDiscover, like this:

import org.scalatest._

@DoNotDiscover
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
    }
  }
}

ScalaTest will run classes annotated with DoNotDiscover if asked to explicitly, it just won't discover them.

Source
DoNotDiscover.scala
Linear Supertypes
Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DoNotDiscover
  2. Annotation
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def annotationType(): Class[_ <: Annotation]

    Permalink
    Definition Classes
    Annotation