terminalexpect

Documentation

Index

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

Variables

var Events = []event.Name{}

Events defines the events that a TestStep is allow to emit

var Name = "TerminalExpect"

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

Types

type TerminalExpect

type TerminalExpect struct {
	Port    string
	Speed   int
	Match   string
	Timeout time.Duration
}

TerminalExpect reads from a terminal and returns when the given Match string is found on an output line.

func (TerminalExpect) Name

func (ts TerminalExpect) Name() string

Name returns the plugin name.

func (*TerminalExpect) Run

func (ts *TerminalExpect) 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 terminal step.

func (*TerminalExpect) ValidateParameters

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

ValidateParameters validates the parameters associated to the TestStep