http4k-testing-chaos/org.http4k.chaos/ChaosEngine

ChaosEngine

class ChaosEngine(initialStage: Stage = Wait) : Filter

The Chaos Engine controls the lifecycle of applying Chaotic behaviour to traffic, which is exposed as a standard Http4k Filter. Chaos can be programmatically updated and enabled/disabled. By default, the engine is deactivated, so activate() needs to be called to witness any change in behaviour,

Constructors

ChaosEngine

constructor(behaviour: Behaviour)

constructor(initialStage: Stage = Wait)

Functions

asFilter

fun Stage.asFilter(): Filter

Converts this chaos stage to a standard http4k Filter.

disable

fun disable(): ChaosEngine

Turn off Chaos Engine. No Chaotic behaviour will be applied.

enable

fun enable(): ChaosEngine

Turn on Chaos Engine using the pre-initialised chaotic behaviour. Note that this may not actually produce any effect based on the configured behaviour (e.g. if there is a specific Trigger that is condition-based.)

fun enable(stage: Stage): ChaosEngine

Update the new complex (multi-stage, triggers etc) Chaotic behaviour to be applied whenever the ChaosEngine is enabled.

fun enable(behaviour: Behaviour): ChaosEngine

Update with new simple Chaotic behaviour to be applied whenever the ChaosEngine is enabled.

invoke

open operator override fun invoke(p1: HttpHandler): (request: Request) -> Response

isEnabled

fun isEnabled(): Boolean

Check if the configured Chaos behaviour is currently being applied to all traffic.

then

fun Stage.then(nextStage: Stage): (Request) -> Filter?

Chain the next ChaosBehaviour to apply when this stage is finished.

toString

open override fun toString(): String

Outputs description of the current state.

until

fun Stage.until(trigger: Trigger): Stage

Stop applying the ChaosBehaviour of this stage when the ChaosTrigger fires.

withChaosApi

fun HttpHandler.withChaosApi(engine: ChaosEngine = ChaosEngine(), security: Security = NoSecurity, controlsPath: String = "/chaos", openApiPath: String = "", corsPolicy: CorsPolicy = UnsafeGlobalPermissive, clock: Clock = Clock.systemUTC(), apiName: String = "http4k"): RoutingHttpHandler

Mixin the set of remote Chaos API endpoints to a standard HttpHandler, using the passed ChaosStage. Optionally a Security can be passed to limit access to the chaos controls.