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
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
This method is used to compare the receiver object (this
)
with the argument object (arg0
) for equivalence
This method is used to compare the receiver object (this
)
with the argument object (arg0
) for equivalence.
The default implementations of this method is an equivalence relation:
x
of type Any
,
x.equals(x)
should return true
.x
and y
of type
Any
, x.equals(y)
should return true
if and only
if y.equals(x)
returns true
.x
, y
, and z
of type AnyRef
if x.equals(y)
returns true
and
y.equals(z)
returns
true
, then x.equals(z)
should return true
.
If you override this method, you should verify that
your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to
override hashCode
to ensure that objects that are
"equal" (o1.equals(o2)
returns true
)
hash to the same Int
(o1.hashCode.equals(o2.hashCode)
).
the object to compare against this object for equality.
true
if the receiver object is equivalent to the argument; false
otherwise.
Returns a hash code value for the object
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash
codes (o1.hashCode.equals(o2.hashCode)
) yet not be
equal (o1.equals(o2)
returns false
). A
degenerate implementation could always return 0
.
However, it is required that if two objects are equal
(o1.equals(o2)
returns true
) that they
have identical hash codes
(o1.hashCode.equals(o2.hashCode)
). Therefore, when
overriding this method, be sure to verify that the behavior is
consistent with the equals
method.
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
Returns a string representation of the object
Returns a string representation of the object.
The default representation is platform dependent.
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 itsapply
method indicates which tests should be ignored based on whether they are tagged withorg.scalatest.Ignore
. If"org.scalatest.Ignore"
is not passed in thetagsToExclude
set, it will be implicitly added. However, if thetagsToInclude
option is defined, and the contained set does not include"org.scalatest.Ignore"
, then only those tests that are both tagged withorg.scalatest.Ignore
and at least one of the tags in thetagsToInclude
set will be included in the result ofapply
and marked as ignored (so long as the test is not also marked with a tag other thanorg.scalatest.Ignore
that is a member of thetagsToExclude
set. For example, ifSlowAsMolasses
is a member of thetagsToInclude
set and a test is tagged with bothorg.scalatest.Ignore
andSlowAsMolasses
, andSlowAsMolasses
appears in thetagsToExclude
set, theSlowAsMolasses
tag will "overpower" theorg.scalatest.Ignore
tag, and the test will be filtered out entirely rather than being ignored.