ScaledTimeSpans
Related Doc:
package concurrent
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.
IllegalArgumentException if the value returned from spanScaleFactor
is less than zero
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.
Trait providing a
scaledmethod that can be used to scale timeSpans used during the testing of asynchronous operations.The
scaledmethod allows tests of asynchronous operations to be tuned according to need. For example,Spans can be scaled larger when running tests on slower continuous integration servers or smaller when running on faster development machines.The
Doublefactor by which to scale theSpans passed toscaledis obtained from thespanScaleFactormethod, also declared in this trait. By default this method returns 1.0, but can be configured to return a different value by passing a-Fargument toRunner(or an equivalent mechanism in an ant, sbt, or Maven build file).The default timeouts and intervals defined for traits
EventuallyandAsyncAssertionsinvokescaled, so those defaults will be scaled automatically. Other than such defaults, however, to get aSpanto scale you'll need to explicitly pass it toscaled. For example, here's how you would scale aSpanyou supply to thefailAftermethod from traitTimeouts:failAfter(scaled(150 millis)) { // ... }The reason
Spans are not scaled automatically in the general case is to make code obvious. If a reader seesfailAfter(1 second), it will mean exactly that: fail after one second. And if aSpanwill be scaled, the reader will clearly see that as well:failAfter(scaled(1 second)).Overriding
spanScaleFactorYou can override the
spanScaleFactormethod to configure the factor by a different means. For example, to configure the factor from Akka TestKit's test time factor you might create a trait like this:import org.scalatest.concurrent.ScaledTimeSpans import akka.actor.ActorSystem import akka.testkit.TestKitExtension trait AkkaSpanScaleFactor extends ScaledTimeSpans { override def spanScaleFactor: Double = TestKitExtension.get(ActorSystem()).TestTimeFactor }This trait overrides
spanScaleFactorso that it takes its scale factor from Akka'sapplication.conffile. You could then scaleSpans tenfold in Akka's configuration file like this:akka { test { timefactor = 10.0 } }Armed with this trait and configuration file, you can simply mix trait
AkkaSpanScaleFactorinto any test class whoseSpans you want to scale, like this:class MySpec extends FunSpec with Eventually with AkkaSpanScaleFactor { // .. }