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).
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.
dynamic tags for the filter
a Boolean to indicate whether to run nested suites
a Set of String tag names to exclude (i.e., filter out) when filtering tests
an optional Set of String tag names to include (i.e., not filter out) when filtering tests
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
the test name to be filtered
a map from test name to tags, containing only test names that have at least one tag
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)
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
test names to be filtered
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
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)]
Use 'curried' instead
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.
test names to be filtered
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
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
Filter whose
applymethod 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.Ignoretag specially, in that itsapplymethod indicates which tests should be ignored based on whether they are tagged withorg.scalatest.Ignore. If"org.scalatest.Ignore"is not passed in thetagsToExcludeset, it will be implicitly added. However, if thetagsToIncludeoption is defined, and the contained set does not include"org.scalatest.Ignore", then only those tests that are both tagged withorg.scalatest.Ignoreand at least one of the tags in thetagsToIncludeset will be included in the result ofapplyand marked as ignored (so long as the test is not also marked with a tag other thanorg.scalatest.Ignorethat is a member of thetagsToExcludeset. For example, ifSlowAsMolassesis a member of thetagsToIncludeset and a test is tagged with bothorg.scalatest.IgnoreandSlowAsMolasses, andSlowAsMolassesappears in thetagsToExcludeset, theSlowAsMolassestag will "overpower" theorg.scalatest.Ignoretag, and the test will be filtered out entirely rather than being ignored.