http4k-testing-chaos/org.http4k.chaos

Package-level declarations

Types

Behaviour

abstract class Behaviour : Filter

Encapsulates the type of bad behaviour to apply to the response.

ChaosBehaviours

object ChaosBehaviours

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,

ChaosStages

object ChaosStages

ChaosTriggers

object ChaosTriggers

ChaoticHttpHandler

abstract class ChaoticHttpHandler : Function1<request: Request, Response>

Useful for creating HttpHandlers with a built-in Chaos Engine API for enabling and disabling chaos.

RemoteChaosApi

object RemoteChaosApi

A set of endpoints to an application which will control the setting and toggling chaos behaviour. The added endpoints are: GET //status <- check the on off/status of the injected chaos POST //activate <- turn on the chaos. optionally POST a JSON body to set a list of new stages to use. POST //deactivate <- turn off the chaos POST //toggle <- toggle the chaos

Stage

typealias Stage = (Request) -> Filter?

Defines a periodic element during which a particular ChaosBehaviour is active.

Trigger

fun interface Trigger : Function1<Request, Boolean>

Properties

defaultLocalUri

val <T : ChaoticHttpHandler> KClass<T>.defaultLocalUri: Uri

Local URI for this ChaoticHttpHandler

defaultPort

val <T : ChaoticHttpHandler> KClass<T>.defaultPort: Int

Calculate a random standard port number for a ChaoticHttpHandler using the classname as a seed

Functions

and

infix fun Trigger.and(that: Trigger): Trigger

appliedWhen

fun Behaviour.appliedWhen(trigger: Trigger): (Request) -> Filter?

asFilter

fun Stage.asFilter(): Filter

Converts this chaos stage to a standard http4k Filter.

asStage

fun JsonNode.asStage(clock: Clock = Clock.systemUTC()): Stage

not

operator fun Trigger.not(): Trigger

infix fun Trigger.or(that: Trigger): Trigger

start

fun ChaoticHttpHandler.start(port: Int = this::class.defaultPort, serverConfig: (Int) -> ServerConfig = ::SunHttp): Http4kServer

Convert this ChaoticHttpHandler into a running server, defaulting on a port dependent on the classname.

then

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

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

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.