gathercmd

Documentation

Index

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

Constants

const (
	EventCmdStart = event.Name("GatherCmdStart")
	EventCmdEnd   = event.Name("GatherCmdEnd")
)

event names for this plugin

Variables

var Events = []event.Name{
	EventCmdStart,
	EventCmdEnd,
}

Events defines the events that a TestStep is allow to emit

var Name = "GatherCmd"

Name is the name used to look this plugin up.

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 GatherCmd test step.

Types

type GatherCmd

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

GatherCmd is used to run arbitrary commands as test steps but only once for all the targets. This can be used as test setup/teardown.

func (GatherCmd) Name

func (ts GatherCmd) Name() string

Name returns the plugin name.

func (*GatherCmd) Run

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

Run executes the step

func (*GatherCmd) ValidateParameters

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

ValidateParameters validates the parameters associated to the TestStep