result

Documentation

Index

• type Result
  • func New(mods ...ResultModifier) *Result
  • func (r *Result) Data() map[string]interface{}
  • func (r *Result) Failed() bool
  • func (r *Result) Failures() []error
  • func (r *Result) HasData() bool
  • func (r *Result) SetData(key string, val interface{})
  • func (r *Result) SetFailures(failures ...error)
• type ResultModifier
  • func WithData(key string, val interface{}) ResultModifier
  • func WithFailures(failures ...error) ResultModifier

Types

type Result

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

Result is returned from a `Evaluable.Eval` execution. It serves two purposes:

1) to return an error, if any, from the Eval execution. This error will *always* be a `gdterrors.RuntimeError`. Failed assertions are not errors. 2) to pass back information about the Run that can be injected into the context's `PriorRun` cache. Some plugins, e.g. the gdt-http plugin, use cached data from a previous run in order to construct current Run fixtures. In the case of the gdt=http plugin, the previous `nethttp.Response` is returned in the Result and the `Scenario.Run` method injects that information into the context that is supplied to the next Spec's `Run`.

func New

func New(mods ...ResultModifier) *Result

New returns a new Result

func (*Result) Data

func (r *Result) Data() map[string]interface{}

Data returns the raw run data saved in the result

func (*Result) Failed

func (r *Result) Failed() bool

Failed returns true if any assertion failed during Eval(), false otherwise.

func (*Result) Failures

func (r *Result) Failures() []error

Failures returns the collection of assertion failures that occurred during Eval().

func (*Result) HasData

func (r *Result) HasData() bool

HasData returns true if any of the run data has been set, false otherwise.

func (*Result) SetData

func (r *Result) SetData(
	key string,
	val interface{},
)

SetData sets a value in the result's run data cache.

func (*Result) SetFailures

func (r *Result) SetFailures(failures ...error)

SetFailures sets the result's collection of assertion failures.

type ResultModifier

type ResultModifier func(*Result)

func WithData

func WithData(key string, val interface{}) ResultModifier

WithData modifies the Result with the supplied run data key and value

func WithFailures

func WithFailures(failures ...error) ResultModifier

WithFailures modifies the Result the supplied collection of assertion failures