executor

Documentation

Index

• type DryRun
  • func NewDryRun() *DryRun
  • func (e *DryRun) Log() []string
  • func (e *DryRun) Run(ctx context.Context, cmd string, args ...string) (*Result, error)
  • func (e *DryRun) RunShell(ctx context.Context, script string) (*Result, error)
  • func (e *DryRun) RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error
  • func (e *DryRun) SetResponse(cmdPrefix string, result *Result)
• type Executor
• type Local
  • func NewLocal() *Local
  • func (e *Local) Run(ctx context.Context, cmd string, args ...string) (*Result, error)
  • func (e *Local) RunShell(ctx context.Context, script string) (*Result, error)
  • func (e *Local) RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error
• type Result
  • func (r *Result) Success() bool
• type SSH
  • func NewSSH(client *ssh.Client) *SSH
  • func (e *SSH) Run(ctx context.Context, cmd string, args ...string) (*Result, error)
  • func (e *SSH) RunShell(ctx context.Context, script string) (*Result, error)
  • func (e *SSH) RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error
• type StreamingExecutor

Types

type DryRun

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

func NewDryRun

func NewDryRun() *DryRun

func (*DryRun) Log

func (e *DryRun) Log() []string

func (*DryRun) Run

func (e *DryRun) Run(ctx context.Context, cmd string, args ...string) (*Result, error)

func (*DryRun) RunShell

func (e *DryRun) RunShell(ctx context.Context, script string) (*Result, error)

func (*DryRun) RunStreaming

func (e *DryRun) RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error

func (*DryRun) SetResponse

func (e *DryRun) SetResponse(cmdPrefix string, result *Result)

type Executor

type Executor interface {
	Run(ctx context.Context, cmd string, args ...string) (*Result, error)
	RunShell(ctx context.Context, script string) (*Result, error)
}

type Local

type Local struct{}

func NewLocal

func NewLocal() *Local

func (*Local) Run

func (e *Local) Run(ctx context.Context, cmd string, args ...string) (*Result, error)

func (*Local) RunShell

func (e *Local) RunShell(ctx context.Context, script string) (*Result, error)

func (*Local) RunStreaming

func (e *Local) RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error

type Result

type Result struct {
	ExitCode int
	Stdout   string
	Stderr   string
}

func (*Result) Success

func (r *Result) Success() bool

type SSH

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

func NewSSH

func NewSSH(client *ssh.Client) *SSH

func (*SSH) Run

func (e *SSH) Run(ctx context.Context, cmd string, args ...string) (*Result, error)

func (*SSH) RunShell

func (e *SSH) RunShell(ctx context.Context, script string) (*Result, error)

func (*SSH) RunStreaming

func (e *SSH) RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error

type StreamingExecutor

type StreamingExecutor interface {
	Executor
	RunStreaming(ctx context.Context, cmd string, stdout, stderr io.Writer, args ...string) error
}