waitport

Documentation

Overview

Package waitport provides an ability of waiting for a port on remote host to be opened for listening

Index

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

Constants

const (
	EventCmdStart = event.Name(Name + "Start")
	EventCmdEnd   = event.Name(Name + "End")
)

event names for this plugin.

const Name = "waitport"

Name is the name used to look this plugin up.

Variables

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

Events defines the events that a TestStep is allow to emit

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

Types

type WaitPort

type WaitPort struct {
}

WaitPort provides an ability of waiting for a port on remote host to be opened for listening

func (*WaitPort) Name

func (ts *WaitPort) Name() string

Name returns the plugin name.

func (*WaitPort) Run

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

Run executes the cmd step.

func (*WaitPort) ValidateParameters

func (ts *WaitPort) ValidateParameters(ctx xcontext.Context, params test.TestStepParameters) error

ValidateParameters validates the parameters associated to the TestStep