crash

README

Crash

A command-line tool for executing test plans and reporting results. Test plans, Crashfiles, defined in YAML, direct the execution of actions, such as HTTP requests, checks, such as asserting an HTTP response code of 200, repetitions, and concurrency.

Crash is currently in alpha development, and pretty much everything is subject to change. It is not yet suitable for production use until 1.0 is released.

Documentation

User documentation can be found at https://troykinsella.github.io/crash/

Roadmap

• Way more fucking documentation. WAY more.
• HTTPS action support
• Shell action support
• Configurable input sources and output targets
• Shell script execution

License

MIT © Troy Kinsella

Documentation

Index

• type ActionConfig
• type Config
  • func NewConfig() *Config
  • func (config *Config) Dump()
  • func (config *Config) MarshalYAML() ([]byte, error)
  • func (config *Config) UnmarshalYAML(bytes []byte) error
  • func (config *Config) UnmarshalYAMLFile(file string) error
• type IOConfig
• type IOConfigs
• type PlanConfig
• type PlanConfigs
• type StepConfig
• type StepConfigs
• type TestOptions
• type WithConfig
• type WithRangeConfig

Types

type ActionConfig

type ActionConfig struct {
	Name   string            `yaml:"name"`
	Type   string            `yaml:"type"`
	Params map[string]string `yaml:"params"`
}

type Config

type Config struct {
	Variables map[string]string `yaml:"vars,omitempty"`
	Inputs    *IOConfigs        `yaml:"inputs,omitempty"`
	Outputs   *IOConfigs        `yaml:"outputs,omitempty"`
	Checks    map[string]string `yaml:"checks,omitempty"`
	Plans     *PlanConfigs      `yaml:"plans"`
}

func NewConfig

func NewConfig() *Config

func (*Config) Dump

func (config *Config) Dump()

func (*Config) MarshalYAML

func (config *Config) MarshalYAML() ([]byte, error)

func (*Config) UnmarshalYAML

func (config *Config) UnmarshalYAML(bytes []byte) error

func (*Config) UnmarshalYAMLFile

func (config *Config) UnmarshalYAMLFile(file string) error

type IOConfig

type IOConfig struct {
	Name   string
	Type   string
	Params map[string]interface{}
}

type IOConfigs

type IOConfigs []IOConfig

type PlanConfig

type PlanConfig struct {
	Name  string       `yaml:"plan"`
	Steps *StepConfigs `yaml:"steps"`
}

type PlanConfigs

type PlanConfigs []PlanConfig

type StepConfig

type StepConfig struct {
	Run      *ActionConfig `yaml:"run,omitempty"`
	Serial   *StepConfigs  `yaml:"serial,omitempty"`
	Parallel *StepConfigs  `yaml:"parallel,omitempty"`
	With     *WithConfig   `yaml:"with,omitempty"`

	Success *StepConfigs `yaml:"success,omitempty"`
	Failure *StepConfigs `yaml:"failure,omitempty"`
	Always  *StepConfigs `yaml:"always,omitempty"`

	Checks  []string `yaml:"check,omitempty"`
	Timeout string   `yaml:"timeout,omitempty"`
}

type StepConfigs

type StepConfigs []StepConfig

type TestOptions

type TestOptions struct {
	Crashfile      string
	LogLevel       logging.Level
	Colorize       bool
	LogJson        bool
	Variables      map[string]string
	VariablesFiles []string
}

type WithConfig

type WithConfig struct {
	Item  string            `yaml:"item,omitempty"`
	List  []string          `yaml:"list,omitempty"`
	Map   map[string]string `yaml:"map,omitempty"`
	Range *WithRangeConfig  `yaml:"range,omitempty"`

	As string `yaml:"as,omitempty"`
}

type WithRangeConfig

type WithRangeConfig struct {
	From string `yaml:"from"`
	To   string `yaml:"to"`
	Step string `yaml:"step,omitempty"`
}