command

Documentation

Index

• Constants
• type Cmd
  • func (c *Cmd) RetryCommand(numOfRetries int) error
  • func (c *Cmd) RetryCommandWithCallback(numOfRetries int, callback func() error) error
  • func (c *Cmd) RetryCommandWithOutput(numOfRetries int) ([]byte, error)
• type Wrapper
  • func GetStdErr(prefix string) Wrapper
  • func GetStdOut(prefix string) Wrapper
  • func (w Wrapper) Write(p []byte) (n int, err error)

Constants

const (
	STDOUT = 0
	STDERR = 1
)

Types

type Cmd

type Cmd struct {
	Command        string
	Options        []string
	Dir            string
	Stdout         io.Writer
	Stderr         io.Writer
	CommandTimeout int
}

func (*Cmd) RetryCommand

func (c *Cmd) RetryCommand(numOfRetries int) error

RetryCommand retries the given command, with exponential backoff, maxing at 5 min, for numOfRetries times. Returns error if all retries fail, nil otherwise.

func (*Cmd) RetryCommandWithCallback

func (c *Cmd) RetryCommandWithCallback(numOfRetries int, callback func() error) error

RetryCommandWithCallback retries the given command, with exponential backoff, maxing at 5 min, for numOfRetries times. After every failed attempt the passed in callback is called.

func (*Cmd) RetryCommandWithOutput

func (c *Cmd) RetryCommandWithOutput(numOfRetries int) ([]byte, error)

RetryCommandWithOutput retries the given command, with exponential backoff, maxing at 5 min, for numOfRetries times. returns (nil, error) if all retries fail, (output, nil) otherwise.

type Wrapper

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

Wrapper struct holds data for the wrapper around stdout & stderr.

func GetStdErr

func GetStdErr(prefix string) Wrapper

GetStdErr returns an io.Writer for exec with the defined prefix. Cannot be used with cmd.CombinedOutput().

func GetStdOut

func GetStdOut(prefix string) Wrapper

GetStdOut returns an io.Writer for exec with the defined prefix. Cannot be used with cmd.CombinedOutput().

func (Wrapper) Write

func (w Wrapper) Write(p []byte) (n int, err error)

Write is implementation of the function from io.Writer interface.