rattle.go

package rattle

import (
	"context"
	"time"
)

type Fault interface {
	Name() string
	Apply(ctx context.Context, env Environment, p Params) (Rollback, error)
}

type Rollback func(ctx context.Context) error

type Probe interface {
	Name() string
	Check(ctx context.Context, env Environment, p Params) error
}

type Environment interface {
	Name() string
	Exec(ctx context.Context, cmd string, args ...string) ([]byte, error)
	Close() error
}

type FailureAction string

const (
	FailureAbort    FailureAction = "abort"
	FailureContinue FailureAction = "continue"
)

type Scenario struct {
	Name        string
	Description string
	Env         Environment
	Hypothesis  []ProbeStep
	Faults      []FaultStep
	Monitors    []MonitorStep
	Recovery    []ProbeStep
	Schedule    Schedule
	OnFailure   FailureAction
}

type ProbeStep struct {
	Name   string
	Probe  Probe
	Params Params
	Retry  RetryConfig
	Env    Environment
}

type FaultStep struct {
	Name     string
	Fault    Fault
	Params   Params
	Duration time.Duration
	Env      Environment
}

type MonitorStep struct {
	ProbeStep
	Interval time.Duration
}

type Schedule struct {
	Mode  ScheduleMode
	Delay time.Duration
}

type ScheduleMode uint8

const (
	Sequential ScheduleMode = iota
	Parallel
	Staggered
)

type RetryConfig struct {
	Attempts int
	Delay    time.Duration
}