audit

Documentation

Index

• Constants
• type Load
• type Message
• type Ready
• type Reporter
  • func (r *Reporter) Report(writer io.Writer) error
• type Scenario
• type Scenarios

Constants

const (
	// SuccessResult indicates success of result in message.
	SuccessResult = "Success"
	// FailureResult indicates failure of result in message.
	FailureResult = "Failure"
)

Types

type Load

type Load struct {
	// PreLoad contains report information of pre system load hook.
	PreLoad Message `json:"pre_load"`
	// PostLoad contains report information of post system load hook.
	PostLoad Message `json:"post_load"`
	// Message contains report information of actual system load phase.
	Message
}

Load contains the report information of load phase.

type Message

type Message struct {
	// Result indicates success or failure.
	Result string `json:"result"`
	// Message gives more context to the user about what happened.
	Message string `json:"message"`
}

Message is the basic message structure in chaos test report.

type Ready

type Ready struct {
	// PreReady contains report information of pre ready hook.
	PreReady Message `json:"pre_ready"`
	// PostReady contains report information of post ready hook.
	PostReady Message `json:"post_ready"`
	// Message contains report information of actual ready phase.
	Message
}

Ready contains the report information of ready phase.

type Reporter

type Reporter struct {
	// Ready represents ready phase.
	Ready `json:"ready"`
	// Load represents system load phase.
	Load `json:"load"`
	// Scenarios represents actual chaos testing phase.
	Scenarios `json:"scenarios"`
	// Miscellaneous contains any other information.
	Miscellaneous []Message `json:"miscellaneous"`
}

Reporter represents the complete report of chaos test execution.

func (*Reporter) Report

func (r *Reporter) Report(writer io.Writer) error

Report writes the json representation of Reporter into the writer passed.

type Scenario

type Scenario struct {
	// Identifiers indicate the identifiers involved in the chaos test scenario.
	Identifiers string `json:"identifiers"`
	// Message contains report information of chaos test scenario.
	Message
}

Scenario represents a single chaos test scenario.

type Scenarios

type Scenarios struct {
	// PreChaosTests contains report information of pre chaos test hook.
	PreChaosTests Message `json:"pre_chaos_tests"`
	// PostChaosTests contains report information of post chaos test hook.
	PostChaosTests Message `json:"post_chaos_tests"`
	// Scenarios contain report information of all chaos test scenarios.
	Scenarios []Scenario `json:"scenarios"`
}

Scenarios contains the report information of actual chaos testing phase.