executor

Documentation

Index

• type Executor
  • func New(program string, args ...string) Executor
  • func NewShell(cmdline string) Executor
• type Result

Types

type Executor

type Executor interface {
	SetCwd(cwd string) Executor
	SetEnv(env []string) Executor
	SetEnvVar(name, value string) Executor
	SetOutputPrefix(prefix string) Executor
	SetPTY(enabled bool) Executor
	AddOutputFilter(substring string) Executor
	Run() *Result
	Capture() *Result
	CaptureAndTrim() *Result
}

Executor prepares and run a command execution

func New

func New(program string, args ...string) Executor

New returns an Executor that will run the program with arguments

func NewShell

func NewShell(cmdline string) Executor

NewShell returns an Executor that will run the command line in a shell

type Result

type Result struct {
	Code        int    // code returned by the process
	Error       error  // error about the process launch and exit
	LaunchError error  // error about the process launch
	Output      string // command output if captured, otherwise empty
}

Result represents the result of a command execution