A configuration parameter that specifies the number of dismissals to wait for before returning normally
from an await call on a Waiter.
A PatienceConfigParam that specifies the amount of time to sleep after
a retry.
Configuration object for asynchronous constructs, such as those provided by traits Eventually and
AsyncAssertions.
Abstract class defining a family of configuration parameters for traits Eventually and AsyncAssertions.
A PatienceConfigParam that specifies the maximum amount of time to wait for an asynchronous operation to
complete.
Class that facilitates performing assertions outside the main test thread, such as assertions in callback methods that are invoked asynchronously.
Returns a Dismissals configuration parameter containing the passed value, which
specifies the number of dismissals to wait for before returning normally from an await
call on a Waiter.
Returns an Interval configuration parameter containing the passed value, which
specifies the amount of time to sleep after a retry.
Returns an Interval configuration parameter containing the passed value, which
specifies the amount of time to sleep after a retry.
Implicit PatienceConfig value providing default configuration values.
Implicit PatienceConfig value providing default configuration values.
To change the default configuration, override or hide this def with another implicit
PatienceConfig containing your desired default configuration values.
Scales the passed Span by the Double factor returned
by spanScaleFactor.
Scales the passed Span by the Double factor returned
by spanScaleFactor.
The Span is scaled by invoking its scaledBy method,
thus this method has the same behavior:
The value returned by spanScaleFactor can be any positive number or zero,
including a fractional number. A number greater than one will scale the Span
up to a larger value. A fractional number will scale it down to a smaller value. A
factor of 1.0 will cause the exact same Span to be returned. A
factor of zero will cause Span.ZeroLength to be returned.
If overflow occurs, Span.Max will be returned. If underflow occurs,
Span.ZeroLength will be returned.
The factor by which the scaled method will scale Spans.
The default implementation of this method...
The factor by which the scaled method will scale Spans.
The default implementation of this method...
Returns a Timeout configuration parameter containing the passed value, which
specifies the maximum amount to wait for an asynchronous operation to complete.
Returns a Timeout configuration parameter containing the passed value, which
specifies the maximum amount to wait for an asynchronous operation to complete.
Trait that facilitates performing assertions outside the main test thread, such as assertions in callback methods that are invoked asynchronously.
Trait
AsyncAssertionsprovides aWaiterclass that you can use to orchestrate the inter-thread communication required to perform assertions outside the main test thread, and a means to configure it.To use
Waiter, create an instance of it in the main test thread:At some point later, call
awaiton the waiter:w.await() // Call await() from the main test threadThe
awaitcall will block until it either receives a report of a failed assertion from a different thread, at which point it will complete abruptly with the same exception, or until it is dismissed by a different thread (or threads), at which point it will return normally. You can optionally specify a timeout and/or a number of dismissals to wait for. Here's an example:The default value for
timeout, provided via an implicitPatienceConfigparameter, is 150 milliseconds. The default value fordismissalsis 1. Theawaitmethod will block until either it is dismissed a sufficient number of times by other threads or an assertion fails in another thread. Thus if you just want to perform assertions in just one other thread, only that thread will be performing a dismissal, so you can use the default value of 1 fordismissals.Waitercontains four overloaded forms ofawait, two of which take an implicitPatienceConfigparameter. To change the default timeout configuration, override or hide (if you imported the members ofAsyncAssertionscompanion object instead of mixing in the trait)patienceConfigwith a new one that returns your desired configuration.To dismiss a waiter, you just invoke
dismisson it:w.dismiss() // Call this from one or more other threadsYou may want to put
dismissinvocations in a finally clause to ensure they happen even if an exception is thrown. Otherwise if a dismissal is missed because of a thrown exception, anawaitcall will wait until it times out.Finally, to perform an assertion in a different thread, you just apply the
Waiterto the assertion code. Here are some examples:w { assert(1 + 1 === 3) } // Can use assertions w { 1 + 1 should equal (3) } // Or matchers w { "hi".charAt(-1) } // Any exceptions will be forwarded to awaitHere's a complete example: