sshcmd

Documentation

Index

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

Variables

var Events = []event.Name{}

Events is used by the framework to determine which events this plugin will emit. Any emitted event that is not registered here will cause the plugin to fail.

var Name = "SSHCmd"

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

Types

type SSHCmd

type SSHCmd struct {
	Host            *test.Param
	Port            *test.Param
	User            *test.Param
	PrivateKeyFile  *test.Param
	Password        *test.Param
	Executable      *test.Param
	Args            []test.Param
	Expect          *test.Param
	Timeout         *test.Param
	SkipIfEmptyHost *test.Param
}

SSHCmd is used to run arbitrary commands as test steps.

func (SSHCmd) Name

func (ts SSHCmd) Name() string

Name returns the plugin name.

func (*SSHCmd) Run

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

Run executes the cmd step.

func (*SSHCmd) ValidateParameters

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

ValidateParameters validates the parameters associated to the TestStep