IntegrationPatience

Stackable modification trait for PatienceConfiguration that provides default timeout and interval values appropriate for integration testing.

The default values for the parameters are:

Configuration ParameterDefault Value
timeout scaled(15 seconds)
interval scaled(150 milliseconds)

The default values of both timeout and interval are passed to the scaled method, inherited from ScaledTimeSpans, so that the defaults can be scaled up or down together with other scaled time spans. See the documentation for trait ScaledTimeSpans for more information.

Mix this trait into any class that uses PatienceConfiguration (such as classes that mix in Eventually or Waiters) to get timeouts tuned towards integration testing, like this:

class ExampleSpec extends FeatureSpec with Eventually with IntegrationPatience {
 // ...
}
class Object
trait Matchable
class Any

Type members

Inherited classlikes

final case class PatienceConfig(timeout: Span, interval: Span)

Configuration object for asynchronous constructs, such as those provided by traits Eventually and Waiters.

Configuration object for asynchronous constructs, such as those provided by traits Eventually and Waiters.

The default values for the parameters are:

Configuration ParameterDefault Value
timeout scaled(150 milliseconds)
interval scaled(15 milliseconds)
Value parameters:
interval

the amount of time to sleep between each check of the status of an asynchronous operation when polling

timeout

the maximum amount of time to wait for an asynchronous operation to complete before giving up and throwing TestFailedException.

Inherited from:
AbstractPatienceConfiguration

Value members

Inherited methods

final def scaled(span: Span): Span

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.

Throws:
IllegalArgumentException

if the value returned from spanScaleFactor is less than zero

Inherited from:
ScaledTimeSpans
def spanScaleFactor: Double

The factor by which the scaled method will scale Spans.

The factor by which the scaled method will scale Spans.

The default implementation of this method will return the span scale factor that was specified for the run, or 1.0 if no factor was specified. For example, you can specify a span scale factor when invoking ScalaTest via the command line by passing a -F argument to Runner.

Inherited from:
ScaledTimeSpans

Implicits

Implicits

Implicit PatienceConfig value providing default configuration values suitable for integration testing.

Implicit PatienceConfig value providing default configuration values suitable for integration testing.