executor

Documentation

Overview

package executor

It uses the mvdan.sh shell implementation in Go. injects a custom environment per execution

not all *nix* commands are available, should only be used for a limited number of scenarios

Index

• func IsExitStatus(err error) (uint8, bool)
• type DefaultExecutor
  • func NewDefaultExecutor(stdin io.Reader, stdout, stderr io.Writer) (*DefaultExecutor, error)
  • func (e *DefaultExecutor) Execute(ctx context.Context, job *Job) ([]byte, error)
  • func (e *DefaultExecutor) WithReset(doReset bool) *DefaultExecutor
• type Executor
• type Job
  • func NewJobFromCommand(command string) *Job

Functions

func IsExitStatus

func IsExitStatus(err error) (uint8, bool)

IsExitStatus checks if given `err` is an exit status

Types

type DefaultExecutor

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

DefaultExecutor is a default executor used for jobs Uses `mvdan.cc/sh/v3/interp` under the hood

func NewDefaultExecutor

func NewDefaultExecutor(stdin io.Reader, stdout, stderr io.Writer) (*DefaultExecutor, error)

NewDefaultExecutor creates new default executor

func (*DefaultExecutor) Execute

func (e *DefaultExecutor) Execute(ctx context.Context, job *Job) ([]byte, error)

Execute executes given job with provided context Returns job output

func (*DefaultExecutor) WithReset

func (e *DefaultExecutor) WithReset(doReset bool) *DefaultExecutor

type Executor

type Executor interface {
	Execute(context.Context, *Job) ([]byte, error)
}

Executor executes given job

type Job

type Job struct {
	Command string
	Dir     string
	Env     variables.Container
	Vars    variables.Container
	Timeout *time.Duration

	Stdout, Stderr io.Writer
	Stdin          io.Reader

	Next *Job
}

Job is a linked list of jobs to execute by Executor

func NewJobFromCommand

func NewJobFromCommand(command string) *Job

NewJobFromCommand creates new Job instance from given command