TimeLimitedTests

Trait that when mixed into a suite class establishes a time limit for its tests.

This trait overrides withFixture, wrapping a super.withFixture(test) call in a failAfter invocation, specifying a timeout obtained by invoking timeLimit and an Interruptor by invoking defaultTestInterruptor:

failAfter(timeLimit) {
  super.withFixture(test)
} (defaultTestInterruptor)

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 interrupt the main test thread via the defaultTestInterruptor.

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.Span

class ExampleSpec extends FunSpec with TimeLimitedTests {

  val timeLimit = Span(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.

If you prefer, you can mix in or import the members of SpanSugar and place units on the time limit, for example:

import org.scalatest.time.SpanSugar._

val timeLimit = 200 millis

The failAfter method uses an Interruptor to attempt to interrupt the main test thread if the timeout expires. The default Interruptor returned by the defaultTestInterruptor method is a ThreadInterruptor, which calls interrupt on the main test thread. If you wish to change this interruption strategy, override defaultTestInterruptor to return a different Interruptor. For example, here's how you'd change the default to DoNotInterrupt, a very patient interruption strategy that does nothing to interrupt the main test thread:

import org.scalatest.FunSpec
import org.scalatest.concurrent.TimeLimitedTests
import org.scalatest.time.SpanSugar._

class ExampleSpec extends FunSpec with TimeLimitedTests {

  val timeLimit = 200 millis

  override val defaultTestInterruptor = DoNotInterrupt

  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 Suite

Linear Supertypes

AbstractSuite, AnyRef, Any

Abstract Value Members

abstract def expectedTestCount(filter: Filter): Int

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.
filter
a Filter with which to filter tests to count based on their tags

Definition Classes
AbstractSuite
abstract def nestedSuites: List[Suite]

A List of this Suite object's nested Suites.
A List of this Suite object's nested Suites. If this Suite contains no nested Suites, this method returns an empty List.

Definition Classes
AbstractSuite
abstract def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

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 this Suite.
reporter
the Reporter to which results will be reported
stopper
the Stopper that will be consulted to determine whether to stop execution early.
filter
a Filter with which to filter tests based on their tags
configMap
a Map of key-value pairs that can be used by the executing Suite of tests.
distributor
an optional Distributor, into which to put nested Suites to be executed by another entity, such as concurrently by a pool of threads. If None, nested Suites will be executed sequentially.
tracker
a Tracker tracking Ordinals being fired by the current thread.

Definition Classes
AbstractSuite
Exceptions thrown
NullPointerException
if any passed parameter is null.
abstract def runNestedSuites(reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

Runs zero to many of this suite's nested suites.
Runs zero to many of this suite's nested suites.
reporter
the Reporter to which results will be reported
stopper
the Stopper that will be consulted to determine whether to stop execution early.
filter
a Filter with which to filter tests based on their tags
configMap
a Map of key-value pairs that can be used by the executing Suite of tests.
distributor
an optional Distributor, into which to put nested Suites to be run by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
tracker
a Tracker tracking Ordinals being fired by the current thread.

Attributes
protected
Definition Classes
AbstractSuite
Exceptions thrown
NullPointerException
if any passed parameter is null.
abstract def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker): Unit

Runs a test.
Runs a test.
testName
the name of one test to execute.
reporter
the Reporter to which results will be reported
stopper
the Stopper that will be consulted to determine whether to stop execution early.
configMap
a Map of key-value pairs that can be used by the executing Suite of tests.
tracker
a Tracker tracking Ordinals being fired by the current thread.

Attributes
protected
Definition Classes
AbstractSuite
Exceptions thrown
NullPointerException
if any of testName, reporter, stopper, configMap, or tracker is null.
abstract def runTests(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

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 this Suite.
reporter
the Reporter to which results will be reported
stopper
the Stopper that will be consulted to determine whether to stop execution early.
filter
a Filter with which to filter tests based on their tags
configMap
a Map of key-value pairs that can be used by the executing Suite of tests.
distributor
an optional Distributor, into which instances of this Suite class that are responsible for executing individual tests contained in this Suite, or groups of this Suite's tests, may be placed so as to be run by another entity, such as concurrently by a pool of threads.
tracker
a Tracker tracking Ordinals being fired by the current thread.

Attributes
protected
Definition Classes
AbstractSuite
Exceptions thrown
NullPointerException
if any of testName, reporter, stopper, groupsToInclude, groupsToExclude, or configMap is null.
abstract val styleName: String

Suite style name.
Suite style name.

Definition Classes
AbstractSuite
abstract def tags: Map[String, Set[String]]

A Map whose keys are String tag names with which tests in this Suite are marked, and whose values are the Set of test names marked with each tag.
A Map whose keys are String tag names with which tests in this Suite are marked, and whose values are the Set of test names marked with each tag. If this Suite contains no tags, this method returns an empty Map.
Subclasses may implement 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 tag has no tests, its name should not appear as a key in the returned Map.

Definition Classes
AbstractSuite
abstract def testNames: Set[String]

An Set of test names.
An 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.

Definition Classes
AbstractSuite
abstract def timeLimit: Span

The time limit, in milliseconds, in which each test in a Suite that mixes in TimeLimitedTests must complete.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
val defaultTestInterruptor: Interruptor

The default Interruptor strategy used to interrupt tests that exceed their time limit.
The default Interruptor strategy used to interrupt tests that exceed their time limit.
This trait's implementation of this method returns ThreadInterruptor, which invokes interrupt on the main test thread. Override this method to change the test interruption strategy.
returns
a ThreadInterruptor
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()
def withFixture(test: (TimeLimitedTests.this)#NoArgTest): Unit

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.
test
the test on which to enforce a time limit

Definition Classes
TimeLimitedTests → AbstractSuite

trait TimeLimitedTests extends AbstractSuite

Abstract Value Members

abstract def expectedTestCount(filter: Filter): Int

abstract def nestedSuites: List[Suite]

abstract def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

abstract def runNestedSuites(reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

abstract def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker): Unit

abstract def runTests(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker): Unit

abstract val styleName: String

abstract def tags: Map[String, Set[String]]

abstract def testNames: Set[String]

abstract def timeLimit: Span

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultTestInterruptor: Interruptor

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFixture(test: (TimeLimitedTests.this)#NoArgTest): Unit

Inherited from AbstractSuite

Inherited from AnyRef

Inherited from Any

Ungrouped