schema

type Bind struct {
	Vars map[string]interface{} `yaml:"vars"`
}

type Config struct {
	SchemaVersion   string          `yaml:"schemaVersion,omitempty"`
	Scenarios       []string        `yaml:"scenarios,omitempty"`
	PluginDirectory string          `yaml:"pluginDirectory,omitempty"`
	Plugins         PluginConfigMap `yaml:"plugins,omitempty"`
	Output          OutputConfig    `yaml:"output,omitempty"`

	// absolute path to the configuration file
	Root string `yaml:"-"`
}

type Duration time.Duration

type JSONReportConfig struct {
	Filename string `yaml:"filename,omitempty"`
}

type JUnitReportConfig struct {
	Filename string `yaml:"filename,omitempty"`
}

type OutputConfig struct {
	Verbose bool         `yaml:"verbose,omitempty"`
	Colored *bool        `yaml:"colored,omitempty"`
	Report  ReportConfig `yaml:"report,omitempty"`
}

type PluginConfig struct {
	Order int    `yaml:"-"`
	Name  string `yaml:"-"`
	Src   string `yaml:"src,omitempty"`
}

type PluginConfigMap map[string]PluginConfig

type ReportConfig struct {
	JSON  JSONReportConfig  `yaml:"json,omitempty"`
	JUnit JUnitReportConfig `yaml:"junit,omitempty"`
}

type RetryPolicy struct {
	Constant    *RetryPolicyConstant    `yaml:"constant"`
	Exponential *RetryPolicyExponential `yaml:"exponential"`
}

type RetryPolicyConstant struct {
	Interval       *Duration `yaml:"interval"`       // default value is 1s
	MaxRetries     *int      `yaml:"maxRetries"`     // default value is 5, 0 means forever
	MaxElapsedTime *Duration `yaml:"maxElapsedTime"` // default value is 0, 0 means forever
}

type RetryPolicyExponential struct {
	InitialInterval *Duration `yaml:"initialInterval"` // default value is 500ms
	Factor          *float64  `yaml:"factor"`          // default value is 1.5
	JitterFactor    *float64  `yaml:"jitterFactor"`    // default value is 0.5
	MaxInterval     *Duration `yaml:"maxInterval"`     // default value is 15min
	MaxRetries      *int      `yaml:"maxRetries"`      // default value is 5, 0 means forever
	MaxElapsedTime  *Duration `yaml:"maxElapsedTime"`  // default value is 0, 0 means forever
}

type Scenario struct {
	Title       string                 `yaml:"title,omitempty"`
	Description string                 `yaml:"description,omitempty"`
	Plugins     map[string]string      `yaml:"plugins,omitempty"`
	Vars        map[string]interface{} `yaml:"vars,omitempty"`
	Steps       []*Step                `yaml:"steps,omitempty"`

	// The strict YAML decoder fails to decode if finds an unknown field.
	// Anchors is the field for enabling to define YAML anchors by avoiding the error.
	// This field doesn't need to hold some data because anchors expand by the decoder.
	Anchors anchors `yaml:"anchors,omitempty"`

	Node ast.Node `yaml:"-"`
	// contains filtered or unexported fields
}

type Step struct {
	Title       string                    `yaml:"title,omitempty"`
	Description string                    `yaml:"description,omitempty"`
	Vars        map[string]interface{}    `yaml:"vars,omitempty"`
	Protocol    string                    `yaml:"protocol,omitempty"`
	Request     protocol.Invoker          `yaml:"request,omitempty"`
	Expect      protocol.AssertionBuilder `yaml:"expect,omitempty"`
	Include     string                    `yaml:"include,omitempty"`
	Ref         interface{}               `yaml:"ref,omitempty"`
	Bind        Bind                      `yaml:"bind,omitempty"`
	Retry       *RetryPolicy              `yaml:"retry,omitempty"`
	Timeout     *Duration                 `yaml:"timeout,omitempty"`
}