AsyncTimeLimitedTests
Trait that when mixed into an asynchronous 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
:
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 invoked failAfter
. This means that the calling of withFixture
method will be run using the same thread, but the test body may be run using a different thread, depending on the executionContext
set at the AsyncTestSuite
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:
import org.scalatest.AsyncFunSpec import org.scalatest.concurrent.AsyncTimeLimitedTests import org.scalatest.time.SpanSugar._ class ExampleSpec extends AsyncFunSpec with AsyncTimeLimitedTests { // 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("An asynchronous time-limited test") { it("should succeed if it completes within the time limit") { Thread.sleep(100) succeed } it("should fail if it is taking too darn long") { Thread.sleep(300) succeed } } }
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 support Interruptor
for now.
Attributes
- Graph
-
- Supertypes
-
trait TimeLimitstrait AsyncTestSuiteMixintrait SuiteMixinclass Objecttrait Matchableclass AnyShow all
- Self type
Members list
Value members
Abstract methods
The time limit, in <code>Span</code>, in which each test in a AsyncTestSuite
that mixes in AsyncTimeLimitedTests
must complete.
The time limit, in <code>Span</code>, in which each test in a AsyncTestSuite
that mixes in AsyncTimeLimitedTests
must complete.
Attributes
Concrete methods
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.
Value parameters
- test
-
the test on which to enforce a time limit
Attributes
Inherited methods
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.
Value parameters
- f
-
the operation on which to enforce the passed timeout
- pos
-
the
Position
of the caller site - prettifier
-
a
Prettifier
for prettifying error messages - signaler
-
a strategy for signaling the passed operation
- timed
-
the
Timed
type class that provides the behavior implementation of the timing restriction. - timeout
-
the maximimum amount of time allowed for the passed operation
Attributes
- Inherited from:
- TimeLimits
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
Attributes
- Inherited from:
- SuiteMixin
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.
Value parameters
- fun
-
the operation on which to enforce the passed timeout
- pos
-
the
Position
of the caller site - prettifier
-
a
Prettifier
for prettifying error messages - signaler
-
a strategy for signaling the passed operation
- timed
-
the
Timed
type class that provides the behavior implementation of the timing restriction. - timeout
-
the maximimum amount of time allowed for the passed operation
Attributes
- Inherited from:
- TimeLimits
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
.
Attributes
- 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.
Attributes
- 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
.
Attributes
- 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
Attributes
- 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.
Attributes
- 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
.
Attributes
- 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.
Attributes
- 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
.
Attributes
- 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
.
Attributes
- 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
Attributes
- 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.
Attributes
- Inherited from:
- SuiteMixin