The total number of tests that are expected to run when this Suite
's run
method is invoked.
The total number of tests that are expected to run when this Suite
's run
method is invoked.
a Filter
with which to filter tests to count based on their tags
An immutable IndexedSeq
of this SuiteMixin
object's nested Suite
s.
An immutable IndexedSeq
of this SuiteMixin
object's nested Suite
s. If this SuiteMixin
contains no nested Suite
s,
this method returns an empty IndexedSeq
.
The fully qualified name of the class that can be used to rerun this suite.
The fully qualified name of the class that can be used to rerun this suite.
Runs this suite of tests.
Runs this suite of tests.
an optional name of one test to execute. If None
, all relevant tests should be executed.
I.e., None
acts like a wildcard that means execute all relevant tests in this Suite
.
the Args
for this run
a Status
object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
NullArgumentException
if any passed parameter is null
.
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
the Args
for this run
a Status
object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.
NullArgumentException
if args
is null
.
Runs a test.
Runs a test.
the name of one test to execute.
the Args
for this run
a Status
object that indicates when the test started by this method has completed, and whether or not it failed .
NullArgumentException
if any of testName
or args
is null
.
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
an optional name of one test to run. If None
, all relevant tests should be run.
I.e., None
acts like a wildcard that means run all relevant tests in this Suite
.
the Args
for this run
a Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
NullArgumentException
if either testName
or args
is null
.
This suite's style name.
This suite's style name.
This lifecycle method provides a string that is used to determine whether this suite object's style is one of the chosen styles for the project.
A string ID for this Suite
that is intended to be unique among all suites reported during a run.
A string ID for this Suite
that is intended to be unique among all suites reported during a run.
The suite ID is intended to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.
this Suite
object's ID.
A user-friendly suite name for this Suite
.
A user-friendly suite name for this Suite
.
This trait's
implementation of this method returns the simple name of this object's class. This
trait's implementation of runNestedSuites
calls this method to obtain a
name for Report
s to pass to the suiteStarting
, suiteCompleted
,
and suiteAborted
methods of the Reporter
.
this Suite
object's suite name.
A Map
whose keys are String
names of tagged tests and
whose associated values are the Set
of tag names for the test.
A Map
whose keys are String
names of tagged tests and
whose associated values are the Set
of tag names for the test. If a test has no associated tags, its name
does not appear as a key in the returned Map
. If this Suite
contains no tests with tags, this
method returns an empty Map
.
Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations
should never return an empty Set
as a value. If a test has no tags, its name should not appear as a key in the
returned Map
.
Provides a TestData
instance for the passed test name, given the passed config map.
Provides a TestData
instance for the passed test name, given the passed config map.
This method is used to obtain a TestData
instance to pass to withFixture(NoArgTest)
and withFixture(OneArgTest)
and the beforeEach
and afterEach
methods
of trait BeforeAndAfterEach
.
the name of the test for which to return a TestData
instance
the config map to include in the returned TestData
a TestData
instance for the specified test, which includes the specified config map
A Set
of test names.
A Set
of test names. If this Suite
contains no tests, this method returns an empty Set
.
Although subclass and subtrait implementations of this method may return a Set
whose iterator produces String
test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to
implement this method and return test names in either a defined or undefined order.
The time limit, in Span
, in which each test in a AsyncTestSuite
that mixes in
AsyncTimeLimitedTests
must complete.
The time limit, in Span
, in which each test in a AsyncTestSuite
that mixes in
AsyncTimeLimitedTests
must complete.
Executes the passed function, enforcing the passed time limit by attempting to signal the operation if the
time limit is exceeded, and "canceling" if the time limit has been
exceeded after the function completes, where what it means to "cancel" is determined by the implicitly passed Timed[T]
instance.
Executes the passed function, enforcing the passed time limit by attempting to signal the operation if the
time limit is exceeded, and "canceling" if the time limit has been
exceeded after the function completes, where what it means to "cancel" is determined by the implicitly passed Timed[T]
instance.
The Timed
companion object offers three implicits, one for FutureOutcome
, one for Future[U]
and one for any other type. The implicit Timed[FutureOutcome]
defines cancelation as canceling the FutureOutcome
:
no exception will be thrown. The implicit Timed[Future[U]]
defines canceling as failing the Future[U]
with a TestCanceledException
:
no exception will be thrown. The implicit for any other type defines failure as throwing
TestCanceledException
. For the details, see the Scaladoc of the implicit Timed
providers
in the Timed
companion object.
the maximimum amount of time allowed for the passed operation
a strategy for signaling the passed operation
a Prettifier
for prettifying error messages
the Position
of the caller site
the Timed
type class that provides the behavior implementation of the timing restriction.
Executes the passed function, enforcing the passed time limit by attempting to signal the operation if the
time limit is exceeded, and "failing" if the time limit has been
exceeded after the function completes, where what it means to "fail" is determined by the implicitly passed Timed[T]
instance.
Executes the passed function, enforcing the passed time limit by attempting to signal the operation if the
time limit is exceeded, and "failing" if the time limit has been
exceeded after the function completes, where what it means to "fail" is determined by the implicitly passed Timed[T]
instance.
The Timed
companion object offers three implicits, one for FutureOutcome
, one for Future[U]
and one for any other type. The implicit Timed[FutureOutcome]
defines failure as failing the FutureOutcome
with a TestFailedDueToTimeoutException
:
no exception will be thrown. The implicit Timed[Future[U]]
defines failure as failing the Future[U]
with a TestFailedDueToTimeoutException
:
no exception will be thrown. The implicit for any other type defines failure as throwing
TestFailedDueToTimeoutException
. For the details, see the Scaladoc of the implicit Timed
providers
in the Timed
companion object.
the maximimum amount of time allowed for the passed operation
the operation on which to enforce the passed timeout
a strategy for signaling the passed operation
a Prettifier
for prettifying error messages
the Position
of the caller site
the Timed
type class that provides the behavior implementation of the timing restriction.
A stackable implementation of withFixture
that wraps a call to super.withFixture
in a
failAfter
invocation.
A stackable implementation of withFixture
that wraps a call to super.withFixture
in a
failAfter
invocation.
the test on which to enforce a time limit
Trait that when mixed into an asynchronous suite class establishes a time limit for its tests.
This trait overrides
withFixture
, wrapping asuper.withFixture(test)
call in afailAfter
invocation, specifying a timeout obtained by invokingtimeLimit
:failAfter(timeLimit) { super.withFixture(test) }
Note that the
failAfter
method executes the body of the by-name passed to it using the same thread that invokedfailAfter
. This means that the calling ofwithFixture
method will be run using the same thread, but the test body may be run using a different thread, depending on theexecutionContext
set at theAsyncTestSuite
level.The
timeLimit
field is abstract in this trait. Thus you must specify a time limit when you use it. For example, the following code specifies that each test must complete within 200 milliseconds:If you run the above
ExampleSpec
, the second test will fail with the error message:The test did not complete within the specified 200 millisecond time limit.
Different from
TimeLimitedTests
,AsyncTimeLimitedTests
does not supportInterruptor
for now.