executors

README

Venom Executor

Write your executor

An executor has to implement this interface

// Executor executes a testStep.
type Executor interface {
	// Run runs a Test Step
	Run(ctx context.Content, TestStep) (interface{}, error)
}

Example

// Name of executor
const Name = "myexecutor"

// New returns a new Executor
func New() venom.Executor {
	return &Executor{}
}

// Executor struct
type Executor struct {
	Command string `json:"command,omitempty" yaml:"command,omitempty"`
}

// Result represents a step result
type Result struct {
	Code        int    `json:"code,omitempty" yaml:"code,omitempty"`
	Command     string `json:"command,omitempty" yaml:"command,omitempty"`
	Systemout   string   `json:"systemout,omitempty" yaml:"systemout,omitempty"` // put in testcase.Systemout by venom if present
	Systemerr   string   `json:"systemerr,omitempty" yaml:"systemerr,omitempty"` // put in testcase.Systemerr by venom if present
}

// GetDefaultAssertions returns the default assertions for this executor
// Optional
func (Executor) GetDefaultAssertions() *venom.StepAssertions {
	return &venom.StepAssertions{Assertions: []venom.Assertion{"result.code ShouldEqual 0"}}
}

// Run executes TestStep
func (Executor)	Run(ctx context.Context, step venom.TestStep) (interface{}, error) {
	// transform step to Executor Instance
	var e Executor
	if err := mapstructure.Decode(step, &e); err != nil {
		return nil, err
	}

	// to something with e.Command here...
	//...

	systemout := "foo"
	outputCode := 0

	// prepare result
	r := Result{
		Code:    outputCode, // return Output Code
		Command: e.Command, // return Command executed
		Systemout: systemout, // return Output string
	}

	return r, nil
}

Feel free to open a Pull Request with your executors.

Documentation

Index

• Variables
• type Constructor

Variables

var Registry map[string]Constructor = map[string]Constructor{
	amqp.Name:       amqp.New,
	dbfixtures.Name: dbfixtures.New,
	exec.Name:       exec.New,
	grpc.Name:       grpc.New,
	http.Name:       http.New,
	imap.Name:       imap.New,
	kafka.Name:      kafka.New,
	mqtt.Name:       mqtt.New,
	ovhapi.Name:     ovhapi.New,
	rabbitmq.Name:   rabbitmq.New,
	readfile.Name:   readfile.New,
	redis.Name:      redis.New,
	smtp.Name:       smtp.New,
	sql.Name:        sql.New,
	ssh.Name:        ssh.New,
	mongo.Name:      mongo.New,
	web.Name:        web.New,
}

Registry is a map of executors to executor constructor functions.

Types

type Constructor

type Constructor func() venom.Executor