shell

Documentation

Index

• Variables
• func BinaryExists(binName, hint string) bool
• func CurrentDir() string
• func RedirectStreams(src *gocmd.Cmd, stdoutDest, stderrDest io.Writer)
• func ShutdownHookForChildCommand(cmd *gocmd.Cmd)
• func Start(cmd *gocmd.Cmd, done chan gocmd.Status)

Variables

var (
	// StreamOutput sets streaming of output instead of buffering it when running gocmd.Cmd.
	StreamOutput gocmd.Options = gocmd.Options{
		Buffered:  false,
		Streaming: true,
	}

	// BufferAndStreamOutput sets buffering and streaming of output when running gocmd.Cmd
	// Buffering lets easy inspection of outputs in tests through inspecting gocmd.Cmd.Status.Stdout/err slices.
	BufferAndStreamOutput = gocmd.Options{
		Buffered:  true,
		Streaming: true,
	}
)

Functions

func BinaryExists

func BinaryExists(binName, hint string) bool

BinaryExists ensures that binary with given name (binName) is available on the PATH. hint lets you customize the error message.

func CurrentDir

func CurrentDir() string

CurrentDir returns current directory from where binary is executed.

func RedirectStreams

func RedirectStreams(src *gocmd.Cmd, stdoutDest, stderrDest io.Writer)

RedirectStreams redirects Stdout and Stderr of the gocmd.Cmd process to passed io.Writers.

func ShutdownHookForChildCommand

func ShutdownHookForChildCommand(cmd *gocmd.Cmd)

ShutdownHookForChildCommand will wait for SIGTERM signal and stop the cmd unless done receiving channel passed to it receives status or is closed.

func Start

func Start(cmd *gocmd.Cmd, done chan gocmd.Status)

Start starts new process (gocmd) and wait until it's done. Status struct is then propagated back to done channel passed as argument.