TimeLimitedTests
Trait that when mixed into a suite class establishes a time limit for its tests.
Unfortunately this trait experienced a potentially breaking change in 3.0: previously this trait declared adefaultTestInterruptor
val
of type
Interruptor
, in 3.0 that was renamed to defaultTestSignaler
and given type Signaler
. The reason is that the default Interruptor
, ThreadInterruptor
,
did not make sense on Scala.js—in fact, the entire notion of interruption did not make
sense on Scala.js. Signaler
's default is DoNotSignal
, which is a better
default on Scala.js, and works fine as a default on the JVM.
Timeouts
was left the same in 3.0, so existing code using it would
continue to work as before, but after a deprecation period Timeouts
will be
supplanted by TimeLimits
, which uses Signaler
. TimeLimitedTests
now uses TimeLimits
instead of Timeouts
, so if you overrode the default
Interruptor
before, you'll need to change it to the equivalent Signaler
.
And if you were depending on the default being a ThreadInterruptor
, you'll need to
override defaultTestSignaler
and set it to ThreadSignaler
.
This trait overrides withFixture
, wrapping a super.withFixture(test)
call
in a failAfter
invocation, specifying a time limit obtained by invoking timeLimit
and a Signaler
by invoking defaultTestSignaler
:
failAfter(timeLimit) { super.withFixture(test) } (defaultTestSignaler)
Note that the failAfter
method executes the body of the by-name passed to it using the same
thread that invoked failAfter
. This means that the same thread will run the withFixture
method
as well as each test, so no extra synchronization is required. A second thread is used to run a timer, and if the timeout
expires, that second thread will attempt to signal the main test thread via the defaultTestSignaler
.
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:
import org.scalatest.FunSpec import org.scalatest.concurrent.TimeLimitedTests import org.scalatest.time.SpanSugar._ class ExampleSpec extends FunSpec with TimeLimitedTests { // Note: You may need to either write 200.millis or (200 millis), or // place a semicolon or blank line after plain old 200 millis, to // avoid the semicolon inference problems of postfix operator notation. val timeLimit = 200 millis describe("A time-limited test") { it("should succeed if it completes within the time limit") { Thread.sleep(100) } it("should fail if it is taking too darn long") { Thread.sleep(300) } } }
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.
The failAfter
method uses an Signaler
to attempt to signal the main test thread if the timeout
expires. The default Signaler
returned by the defaultTestSignaler
method is a
DoNotSignal
, which does not signal the main test thread to stop. If you wish to change this
signaling strategy, override defaultTestSignaler
to return a different Signaler
. For example,
here's how you'd change the default to ThreadSignaler
, which will
interrupt the main test thread when time is up:
import org.scalatest.FunSpec import org.scalatest.concurrent.{ThreadSignaler, TimeLimitedTests} import org.scalatest.time.SpanSugar._ class ExampleSignalerSpec extends FunSpec with TimeLimitedTests { val timeLimit = 200 millis override val defaultTestSignaler = ThreadSignaler describe("A time-limited test") { it("should succeed if it completes within the time limit") { Thread.sleep(100) } it("should fail if it is taking too darn long") { Thread.sleep(300) } } }
Like the previous incarnation of ExampleSuite
, the second test will fail with an error message that indicates
a timeout expired. But whereas in the previous case, the Thread.sleep
would be interrupted after 200 milliseconds,
in this case it is never interrupted. In the previous case, the failed test requires a little over 200 milliseconds to run.
In this case, because the sleep(300)
is never interrupted, the failed test requires a little over 300 milliseconds
to run.
Value members
Abstract methods
Concrete methods
Inherited methods
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.
- Value parameters:
- filter
a
Filter
with which to filter tests to count based on their tags
- Inherited from:
- SuiteMixin
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
.
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
.
- Inherited from:
- SuiteMixin
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.
- Inherited from:
- SuiteMixin
Runs this suite of tests.
Runs this suite of tests.
- Value parameters:
- args
the
Args
for this run- testName
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 thisSuite
.
- Returns:
a
Status
object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.- Throws:
- NullArgumentException
if any passed parameter is
null
.
- Inherited from:
- SuiteMixin
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
- Value parameters:
- args
the
Args
for this run
- Returns:
a
Status
object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.- Throws:
- NullArgumentException
if
args
isnull
.
- Inherited from:
- SuiteMixin
Runs a test.
Runs a test.
- Value parameters:
- args
the
Args
for this run- testName
the name of one test to execute.
- Returns:
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .- Throws:
- NullArgumentException
if any of
testName
orargs
isnull
.
- Inherited from:
- SuiteMixin
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
- Value parameters:
- args
the
Args
for this run- testName
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 thisSuite
.
- Returns:
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.- Throws:
- NullArgumentException
if either
testName
orargs
isnull
.
- Inherited from:
- SuiteMixin
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.
- Returns:
this
Suite
object's ID.- Inherited from:
- SuiteMixin
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
.
- Returns:
this
Suite
object's suite name.- Inherited from:
- SuiteMixin
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
.
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
.
- Inherited from:
- SuiteMixin
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
.
- Value parameters:
- testName
the name of the test for which to return a
TestData
instance- theConfigMap
the config map to include in the returned
TestData
- Returns:
a
TestData
instance for the specified test, which includes the specified config map- Inherited from:
- SuiteMixin
A Set
of test names. If this Suite
contains no tests, this method returns an empty Set
.
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.
- Inherited from:
- SuiteMixin
Concrete fields
The default Signaler
strategy used to interrupt tests that exceed their time limit.
The default Signaler
strategy used to interrupt tests that exceed their time limit.
This trait's implementation of this method returns DoNotSignal
, which does not signal/interrupt
the main test and future thread. Override this method to change the test signaling strategy.
- Returns:
a
ThreadInterruptor
Deprecated and Inherited fields
The styleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
The styleName
lifecycle method has been deprecated and will be removed in a future version of ScalaTest.
This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0
will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for styleName
.
- Deprecated
- Inherited from:
- SuiteMixin