teststep

Documentation

Index

• Constants
• Variables
• func Load() (string, test.TestStepFactory, []event.Name)
• func New() test.TestStep
• type Step
  • func (ts Step) Name() string
  • func (ts *Step) Run(ctx xcontext.Context, ch test.TestStepChannels, ev testevent.Emitter, ...) (json.RawMessage, error)
  • func (ts *Step) ValidateParameters(_ xcontext.Context, params test.TestStepParameters) error

Constants

const (
	// A comma-delimited list of target IDs to fail on.
	FailTargetsParam = "FailTargets"
	// Alternatively, fail this percentage of targets at random.
	FailPctParam = "FailPct"
	// A comma-delimited list of target IDs to delay and by how much, ID=delay_ms.
	DelayTargetsParam = "DelayTargets"
)

const (
	StartedEvent      = event.Name("TestStartedEvent")
	FinishedEvent     = event.Name("TestFinishedEvent")
	FailedEvent       = event.Name("TestFailedEvent")
	StepRunningEvent  = event.Name("TestStepRunningEvent")
	StepFinishedEvent = event.Name("TestStepFinishedEvent")
)

Variables

var Events = []event.Name{StartedEvent, FinishedEvent, FailedEvent, StepRunningEvent, StepFinishedEvent}

var Name = "Test"

Functions

func Load

func Load() (string, test.TestStepFactory, []event.Name)

Load returns the name, factory and events which are needed to register the step.

func New

func New() test.TestStep

New initializes and returns a new TestStep.

Types

type Step

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

func (Step) Name

func (ts Step) Name() string

Name returns the name of the Step

func (*Step) Run

func (ts *Step) Run(
	ctx xcontext.Context,
	ch test.TestStepChannels,
	ev testevent.Emitter,
	stepsVars test.StepsVariables,
	params test.TestStepParameters,
	resumeState json.RawMessage,
) (json.RawMessage, error)

Run executes the example step.

func (*Step) ValidateParameters

func (ts *Step) ValidateParameters(_ xcontext.Context, params test.TestStepParameters) error

ValidateParameters validates the parameters associated to the TestStep