exec

Documentation

Overview

Package exec contains an interface for executing commands, along with helpers TODO(bentheelder): add standardized timeout functionality & a default timeout so that commands cannot hang indefinitely (!)

Index

• Variables
• func CombinedOutputLines(cmd Cmd) (lines []string, err error)
• func InheritOutput(cmd Cmd)
• func RunLoggingOutputOnFail(cmd Cmd) error
• type Cmd
  • func Command(command string, args ...string) Cmd
• type Cmder
• type LocalCmd
  • func (cmd *LocalCmd) Run() error
  • func (cmd *LocalCmd) SetEnv(env ...string)
  • func (cmd *LocalCmd) SetStderr(w io.Writer)
  • func (cmd *LocalCmd) SetStdin(r io.Reader)
  • func (cmd *LocalCmd) SetStdout(w io.Writer)
• type LocalCmder
  • func (c *LocalCmder) Command(name string, arg ...string) Cmd

Variables

var DefaultCmder = &LocalCmder{}

DefaultCmder is a LocalCmder instance used for convienience, packages originally using os/exec.Command can instead use pkg/kind/exec.Command which forwards to this instance TODO(bentheelder): swap this for testing TODO(bentheelder): consider not using a global for this :^)

Functions

func CombinedOutputLines

func CombinedOutputLines(cmd Cmd) (lines []string, err error)

CombinedOutputLines is like os/exec's cmd.CombinedOutput(), but over our Cmd interface, and instead of returning the byte buffer of stderr + stdout, it scans these for lines and returns a slice of output lines

func InheritOutput

func InheritOutput(cmd Cmd)

InheritOutput sets cmd's output to write to the current process's stdout and stderr

func RunLoggingOutputOnFail

func RunLoggingOutputOnFail(cmd Cmd) error

RunLoggingOutputOnFail runs the cmd, logging error output if Run returns an error

Types

type Cmd

type Cmd interface {
	Run() error
	// Each entry should be of the form "key=value"
	SetEnv(...string)
	SetStdin(io.Reader)
	SetStdout(io.Writer)
	SetStderr(io.Writer)
}

Cmd abstracts over running a command somewhere, this is useful for testing

func Command

func Command(command string, args ...string) Cmd

Command is a convience wrapper over DefaultCmder.Command

type Cmder

type Cmder interface {
	// command, args..., just like os/exec.Cmd
	Command(string, ...string) Cmd
}

Cmder abstracts over creating commands

type LocalCmd

type LocalCmd struct {
	*osexec.Cmd
}

LocalCmd wraps os/exec.Cmd, implementing the kind/pkg/exec.Cmd interface

func (*LocalCmd) Run

func (cmd *LocalCmd) Run() error

Run runs

func (*LocalCmd) SetEnv

func (cmd *LocalCmd) SetEnv(env ...string)

SetEnv sets env

func (*LocalCmd) SetStderr

func (cmd *LocalCmd) SetStderr(w io.Writer)

SetStderr sets stderr

func (*LocalCmd) SetStdin

func (cmd *LocalCmd) SetStdin(r io.Reader)

SetStdin sets stdin

func (*LocalCmd) SetStdout

func (cmd *LocalCmd) SetStdout(w io.Writer)

SetStdout set stdout

type LocalCmder

type LocalCmder struct{}

LocalCmder is a factory for LocalCmd, implementing Cmder

func (*LocalCmder) Command

func (c *LocalCmder) Command(name string, arg ...string) Cmd

Command returns a new exec.Cmd backed by Cmd