Packages

final class Filter extends Serializable

Filter whose apply method determines which of the passed tests to run and ignore based on tags to include and exclude passed as as class parameters.

This class handles the org.scalatest.Ignore tag specially, in that its apply method indicates which tests should be ignored based on whether they are tagged with org.scalatest.Ignore. If "org.scalatest.Ignore" is not passed in the tagsToExclude set, it will be implicitly added. However, if the tagsToInclude option is defined, and the contained set does not include "org.scalatest.Ignore", then only those tests that are both tagged with org.scalatest.Ignore and at least one of the tags in the tagsToInclude set will be included in the result of apply and marked as ignored (so long as the test is not also marked with a tag other than org.scalatest.Ignore that is a member of the tagsToExclude set. For example, if SlowAsMolasses is a member of the tagsToInclude set and a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolasses appears in the tagsToExclude set, the SlowAsMolasses tag will "overpower" the org.scalatest.Ignore tag, and the test will be filtered out entirely rather than being ignored.

Source
Filter.scala
Exceptions thrown

IllegalArgumentException if tagsToInclude is defined, but contains an empty set

NullArgumentException if either tagsToInclude or tagsToExclude are null

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Filter
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(testName: String, tags: Map[String, Set[String]], suiteId: String): (Boolean, Boolean)

    Filter one test name based on its tags.

    Filter one test name based on its tags.

    The returned tuple contains a Boolean that indicates whether the test should be filtered, and if not, a Boolean that indicates whether the test should be ignored. A test will be marked as ignored if org.scalatest.Ignore is in its tags set, and either tagsToInclude is None, or tagsToInclude's value (a set) contains the passed test name, unless another tag for that test besides org.scalatest.Ignore is also included in tagsToExclude. For example, if a test is tagged with both org.scalatest.Ignore and SlowAsMolasses, and SlowAsMolasses appears in the tagsToExclude set, the SlowAsMolasses tag will "overpower" the org.scalatest.Ignore tag, and this method will return (true, false).

    val (filterTest, ignoreTest) = filter(testName, tags)
if (!filterTest)
  if (ignoreTest)
    // ignore the test
  else
    // execute the test

    testName

    the test name to be filtered

    tags

    a map from test name to tags, containing only test names that have at least one tag

    suiteId

    the suite Id of the suite to filter

    Exceptions thrown

    IllegalArgumentException if any set contained in the passed tags map is empty

  5. def apply(testNames: Set[String], tags: Map[String, Set[String]], suiteId: String): List[(String, Boolean)]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val dynaTags: DynaTags
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. val excludeNestedSuites: Boolean
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  19. def runnableTestCount(testNames: Set[String], testTags: Map[String, Set[String]], suiteId: String): Int

    Returns the number of tests that should be run after the passed testNames and tags have been filtered with the tagsToInclude and tagsToExclude class parameters.

    Returns the number of tests that should be run after the passed testNames and tags have been filtered with the tagsToInclude and tagsToExclude class parameters.

    The result of this method may be smaller than the number of elements in the list returned by apply, because the count returned by this method does not include ignored tests, and the list returned by apply does include ignored tests.

    testNames

    test names to be filtered

    suiteId

    the suite Id of the suite to filter

    Exceptions thrown

    IllegalArgumentException if any set contained in the passed tags map is empty

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. val tagsToExclude: Set[String]
  22. val tagsToInclude: Option[Set[String]]
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped