Filter

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
NullPointerException
if either tagsToInclude or tagsToExclude are null

Linear Supertypes

Serializable, Serializable, (Set[String], Map[String, Set[String]]) ⇒ List[(String, Boolean)], AnyRef, Any

Instance Constructors

new Filter(tagsToInclude: Option[Set[String]], tagsToExclude: Set[String])

This constructor has been deprecated and will be removed in a future version of ScalaTest. Please use the factory method, named apply, in the Filter companion object instead. (I.e., to get rid of the deprecation warning, just remove new in front of Filter).
This constructor has been deprecated and will be removed in a future version of ScalaTest. Please use the factory method, named apply, in the Filter companion object instead. (I.e., to get rid of the deprecation warning, just remove new in front of Filter).

Annotations
@deprecated
Deprecated
This overloaded constructor has been deprecated and will be removed in a future version of ScalaTest. Please use the factory method (named apply) in the Filter companion object instead.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def apply(testName: String, tags: Map[String, Set[String]], suiteId: String): (Boolean, Boolean)
def apply(testNames: Set[String], tags: Map[String, Set[String]], suiteId: String): List[(String, Boolean)]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
def curried: (Set[String]) ⇒ (Map[String, Set[String]]) ⇒ List[(String, Boolean)]

Definition Classes
Function2
Annotations
@unspecialized()
val dynaTags: DynaTags

dynamic tags for the filter
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val excludeNestedSuites: Boolean

a Boolean to indicate whether to run nested suites
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def runnableTestCount(testNames: Set[String], testTags: Map[String, Set[String]], suiteId: String): Int
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tagsToExclude: Set[String]

a Set of String tag names to exclude (i.e., filter out) when filtering tests
val tagsToInclude: Option[Set[String]]

an optional Set of String tag names to include (i.e., not filter out) when filtering tests
def toString(): String

Definition Classes
Function2 → AnyRef → Any
def tupled: ((Set[String], Map[String, Set[String]])) ⇒ List[(String, Boolean)]

Definition Classes
Function2
Annotations
@unspecialized()
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

Deprecated Value Members

def apply(testName: String, tags: Map[String, Set[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

Annotations
@deprecated
Deprecated
Please use the apply method that takes a suite instead, the one with this signature: def apply(testName: String, testTags: Map[String, Set[String]], suiteId: String): (Boolean, Boolean)
Exceptions thrown
IllegalArgumentException
if any set contained in the passed tags map is empty
def apply(testNames: Set[String], tags: Map[String, Set[String]]): List[(String, Boolean)]

Filter test names based on their tags.
Filter test names based on their tags.
Each tuple in the returned list contains a String test name and 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 test's 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 a list that does not include the test name.
```
for ((testName, ignoreTest) <- filter(testNames, tags))
  if (ignoreTest)
    // ignore the test
  else
    // execute the test
```
testNames
test names to be filtered
tags
a map from test name to tags, containing only test names included in the testNames set, and only test names that have at least one tag

Definition Classes
Filter → Function2
Annotations
@deprecated
Deprecated
Please use the apply method that takes a suiteId instead, the one with this signature: def apply(testNames: Set[String], testTags: Map[String, Set[String]], suiteId: String): List[(String, Boolean)]
Exceptions thrown
IllegalArgumentException
if any set contained in the passed tags map is empty
def runnableTestCount(testNames: Set[String], tags: Map[String, Set[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
tags
a map from test name to tags, containing only test names included in the testNames set, and only test names that have at least one tag

Annotations
@deprecated
Deprecated
Please use the runnableTestCount method that takes a suiteId instead, the one with this signature: def runnableTestCount(testNames: Set[String], testTags: Map[String, Set[String]], suiteId: String): Int
Exceptions thrown
IllegalArgumentException
if any set contained in the passed tags map is empty

final class Filter extends (Set[String], Map[String, Set[String]]) ⇒ List[(String, Boolean)] with Serializable

Instance Constructors

new Filter(tagsToInclude: Option[Set[String]], tagsToExclude: Set[String])

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def apply(testName: String, tags: Map[String, Set[String]], suiteId: String): (Boolean, Boolean)

def apply(testNames: Set[String], tags: Map[String, Set[String]], suiteId: String): List[(String, Boolean)]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def curried: (Set[String]) ⇒ (Map[String, Set[String]]) ⇒ List[(String, Boolean)]

val dynaTags: DynaTags

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val excludeNestedSuites: Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def runnableTestCount(testNames: Set[String], testTags: Map[String, Set[String]], suiteId: String): Int

final def synchronized[T0](arg0: ⇒ T0): T0

val tagsToExclude: Set[String]

val tagsToInclude: Option[Set[String]]

def toString(): String

def tupled: ((Set[String], Map[String, Set[String]])) ⇒ List[(String, Boolean)]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def apply(testName: String, tags: Map[String, Set[String]]): (Boolean, Boolean)

def apply(testNames: Set[String], tags: Map[String, Set[String]]): List[(String, Boolean)]

def runnableTestCount(testNames: Set[String], tags: Map[String, Set[String]]): Int

Inherited from Serializable

Inherited from Serializable

Inherited from (Set[String], Map[String, Set[String]]) ⇒ List[(String, Boolean)]

Inherited from AnyRef

Inherited from Any

Ungrouped