trait TimeLimitedTests extends TestSuiteMixin
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 a defaultTestInterruptor
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.
- Self Type
- TimeLimitedTests with TestSuite
- Source
- TimeLimitedTests.scala
- Alphabetic
- By Inheritance
- TimeLimitedTests
- TestSuiteMixin
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def expectedTestCount(filter: Filter): Int
The total number of tests that are expected to run when this
Suite
'srun
method is invoked.The total number of tests that are expected to run when this
Suite
'srun
method is invoked.- filter
a
Filter
with which to filter tests to count based on their tags
- Definition Classes
- SuiteMixin
- abstract def nestedSuites: IndexedSeq[Suite]
An immutable
IndexedSeq
of thisSuiteMixin
object's nestedSuite
s.An immutable
IndexedSeq
of thisSuiteMixin
object's nestedSuite
s. If thisSuiteMixin
contains no nestedSuite
s, this method returns an emptyIndexedSeq
.- Definition Classes
- SuiteMixin
- abstract def rerunner: Option[String]
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.
- Definition Classes
- SuiteMixin
- abstract def run(testName: Option[String], args: Args): Status
Runs this suite of tests.
Runs this suite of tests.
- 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
.- args
the
Args
for this run- 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.
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
if any passed parameter isnull
.
- abstract def runNestedSuites(args: Args): Status
Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
- 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.
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
ifargs
isnull
.
- abstract def runTest(testName: String, args: Args): Status
Runs a test.
Runs a test.
- testName
the name of one test to execute.
- args
the
Args
for this run- returns
a
Status
object that indicates when the test started by this method has completed, and whether or not it failed .
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
if any oftestName
orargs
isnull
.
- abstract def runTests(testName: Option[String], args: Args): Status
Runs zero to many of this suite's tests.
Runs zero to many of this suite's tests.
- 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
.- args
the
Args
for this run- returns
a
Status
object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
- Attributes
- protected
- Definition Classes
- SuiteMixin
- Exceptions thrown
NullArgumentException
if eithertestName
orargs
isnull
.
- abstract val styleName: String
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.
- Definition Classes
- SuiteMixin
- abstract def suiteId: String
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.
- Definition Classes
- SuiteMixin
- abstract def suiteName: String
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 forReport
s to pass to thesuiteStarting
,suiteCompleted
, andsuiteAborted
methods of theReporter
.- returns
this
Suite
object's suite name.
- Definition Classes
- SuiteMixin
- abstract def tags: Map[String, Set[String]]
A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tag names for the test.A
Map
whose keys areString
names of tagged tests and whose associated values are theSet
of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returnedMap
. If thisSuite
contains no tests with tags, this method returns an emptyMap
.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 returnedMap
.- Definition Classes
- SuiteMixin
- abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
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 towithFixture(NoArgTest)
andwithFixture(OneArgTest)
and thebeforeEach
andafterEach
methods of traitBeforeAndAfterEach
.- 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
- Definition Classes
- SuiteMixin
- abstract def testNames: Set[String]
A
Set
of test names.A
Set
of test names. If thisSuite
contains no tests, this method returns an emptySet
.Although subclass and subtrait implementations of this method may return a
Set
whose iterator producesString
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.- Definition Classes
- SuiteMixin
- abstract def timeLimit: Span
The time limit, in milliseconds, in which each test in a
Suite
that mixes inTimeLimitedTests
must complete.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val defaultTestSignaler: Signaler
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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withFixture(test: (TimeLimitedTests.this)#NoArgTest): Outcome
A stackable implementation of
withFixture
that wraps a call tosuper.withFixture
in afailAfter
invocation.A stackable implementation of
withFixture
that wraps a call tosuper.withFixture
in afailAfter
invocation.- test
the test on which to enforce a time limit
- Definition Classes
- TimeLimitedTests → TestSuiteMixin