types

type Assertions interface {
	// OK returns true if all contained assertions pass successfully, false
	// otherwise. If false is returned, Failures() is guaranteed to be
	// non-empty.
	OK(context.Context) bool
	// Fail appends a supplied error to the set of failed assertions
	Fail(error)
	// Failures returns a slice of failure messages indicating which assertions
	// did not succeed.
	Failures() []error
}

type Defaults map[string]interface{}

type Evaluable interface {
	// Eval performs an action and evaluates the results of that action,
	// returning a Result that informs the Scenario about what failed or
	// succeeded about the Evaluable's conditions.
	Eval(context.Context, *testing.T) *result.Result
	// SetBase sets the Evaluable's base Spec
	SetBase(Spec)
	// Base returns the Evaluable's base Spec
	Base() *Spec
}

type Fixture interface {
	// Start sets up the fixture
	Start(context.Context) error
	// Stop tears down the fixture, cleaning up any owned resources
	Stop(context.Context)
	// HasState returns true if the fixture contains some state with the given
	// key
	HasState(string) bool
	// State returns the state data at the given key, or nil if no such state
	// key is managed by the fixture
	State(string) interface{}
}

type FlexStrings struct {
	// contains filtered or unexported fields
}

type Plugin interface {
	// Info returns a struct that describes what the plugin does
	Info() PluginInfo
	// Defaults returns a YAML Unmarshaler types that the plugin knows how
	// to parse its defaults configuration with.
	Defaults() yaml.Unmarshaler
	// Specs returns a list of YAML Unmarshaler types that the plugin knows
	// how to parse.
	Specs() []Evaluable
}

type PluginInfo struct {
	// Name is the primary name of the plugin
	Name string
	// Aliases is an optional set of aliased names for the plugin
	Aliases []string
	// Description describes what types of tests the plugin can handle.
	Description string
	// Retry is a Retry that should be used by default for test specs of this
	// plugin.
	Retry *Retry
}

type Retry struct {
	// Attempts is the number of  times that the test unit should be retried in
	// the event of assertion failure.
	Attempts *int `yaml:"attempts,omitempty"`
	// Interval is the amount of time that the plugin should wait before
	// retrying the test unit in the event of assertion failure.
	// Specify a duration using Go's time duration string.
	// See https://pkg.go.dev/time#ParseDuration
	Interval string `yaml:"interval,omitempty"`
	// Exponential indicates that an exponential backoff should be applied to
	// the retry. When true, the value of Interval, if any, is used as the
	// initial interval for the backoff algoritm.
	Exponential bool `yaml:"exponential,omitempty"`
}

type Spec struct {
	// Defaults contains the parsed defaults for the Spec. These are injected
	// by the scenario during parse.
	Defaults *Defaults `yaml:"-"`
	// Index within the scenario where this Spec is located
	Index int `yaml:"-"`
	// Name for the individual test unit
	Name string `yaml:"name,omitempty"`
	// Description of the test unit
	Description string `yaml:"description,omitempty"`
	// Timeout contains the timeout configuration for the Spec
	Timeout *Timeout `yaml:"timeout,omitempty"`
	// Wait contains the wait configuration for the Spec
	Wait *Wait `yaml:"wait,omitempty"`
	// Retry contains the retry configuration for the Spec
	Retry *Retry `yaml:"retry,omitempty"`
}

type Timeout struct {
	// After is the amount of time that the test unit should complete within.
	// Specify a duration using Go's time duration string.
	// See https://pkg.go.dev/time#ParseDuration
	After string `yaml:"after,omitempty"`
	// Expected indicates whether the timeout is expected to be exceeded. This
	// is mostly useful for unit testing of the timeout functionality itself.
	Expected bool `yaml:"expected,omitempty"`
}

type Wait struct {
	// Before is the amount of time that the test unit should wait before
	// executing its action.
	// Specify a duration using Go's time duration string.
	// See https://pkg.go.dev/time#ParseDuration
	Before string `yaml:"before,omitempty"`
	// After is the amount of time that the test unit should wait after
	// executing its action.
	// Specify a duration using Go's time duration string.
	// See https://pkg.go.dev/time#ParseDuration
	After string `yaml:"after,omitempty"`
}