chaos

Documentation

Overview

Package chaos is used to simulate Chaos engineering (random failures) in the SMTPD server. See https://en.wikipedia.org/wiki/Chaos_engineering See https://mailpit.axllent.org/docs/integration/chaos/

Index

• Variables
• func Set(key string, errorCode int, probability int) error
• func SetFromStruct(c Triggers) error
• type Trigger
  • func (c Trigger) Trigger() (bool, int)
• type Triggers

Variables

var (
	// Enabled is a flag to enable or disable support for chaos
	Enabled = false

	// Config is the global Chaos configuration
	Config = Triggers{
		Sender:         Trigger{ErrorCode: 451, Probability: 0},
		Recipient:      Trigger{ErrorCode: 451, Probability: 0},
		Authentication: Trigger{ErrorCode: 535, Probability: 0},
	}
)

Functions

func Set

func Set(key string, errorCode int, probability int) error

Set will set the chaos configuration for the given key (CLI & setMap())

func SetFromStruct

func SetFromStruct(c Triggers) error

SetFromStruct will set a whole map of chaos configurations (ie: API)

Types

type Trigger

type Trigger struct {
	// SMTP error code to return. The value must range from 400 to 599.
	// required: true
	// example: 451
	ErrorCode int

	// Probability (chance) of triggering the error. The value must range from 0 to 100.
	// required: true
	// example: 5
	Probability int
}

Trigger for Chaos

func (Trigger) Trigger

func (c Trigger) Trigger() (bool, int)

Trigger will return whether the Chaos rule is triggered based on the configuration and a randomly-generated percentage value.

type Triggers

type Triggers struct {
	// Sender trigger to fail on From, Sender
	Sender Trigger
	// Recipient trigger to fail on To, Cc, Bcc
	Recipient Trigger
	// Authentication trigger to fail while authenticating (auth must be configured)
	Authentication Trigger
}

Triggers for the Chaos configuration

swagger:model Triggers