Class TestKitSettings

Contains settings to be used when writing tests with TestKit.

Inheritance
object
TestKitSettings
Implements
Inherited Members
Namespace: Akka.TestKit
Assembly: Akka.TestKit.dll
Syntax
public class TestKitSettings : IExtension

Constructors

| Edit this page View Source

TestKitSettings(Config)

Initializes a new instance of the TestKitSettings class.

Declaration
public TestKitSettings(Config config)
Parameters
Type Name Description
Config config

The configuration to use when setting up the tests.
Exceptions
Type Condition
ConfigurationException

This exception is thrown when a negative value is given for the akka.test.timefactor configuration item.

Properties

| Edit this page View Source

DefaultTimeout

Gets the default timeout as specified in the setting akka.test.default-timeout. Typically used for Ask-timeouts. It is always finite.

Declaration
public TimeSpan DefaultTimeout { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

LogTestKitCalls

If set to true calls to testkit will be logged. This is enabled by setting the configuration value "akka.test.testkit.debug" to a true.

Declaration
public bool LogTestKitCalls { get; }
Property Value
Type Description
bool
| Edit this page View Source

SingleExpectDefault

Gets the config value "akka.test.single-expect-default". It is always finite.

Declaration
public TimeSpan SingleExpectDefault { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

TestEventFilterLeeway

Gets the config value "akka.test.filter-leeway". It is always finite.

Declaration
public TimeSpan TestEventFilterLeeway { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

TestKitStartupTimeout

Declaration
public TimeSpan TestKitStartupTimeout { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

TestTimeFactor

Gets the timefactor by which all values are scaled by.

The tight timeouts you use during testing on your lightning-fast notebook will invariably lead to spurious test failures on the heavily loaded CI server. To account for this situation, all maximum durations are internally scaled by this factor, which defaults to 1. To change this value set configuration "akka.test.timefactor" to a positive double/integer.

You can scale other durations with the same factor by using the Testkit.Dilated

Declaration
public double TestTimeFactor { get; }
Property Value
Type Description
double

Implements

Extension Methods