Version: v1.7.16 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2018 License: Apache-2.0 Imports: 5 Imported by: 0



Package exec provides an injectable interface and implementations for running commands.



This section is empty.


View Source
var ErrExecutableNotFound = osexec.ErrNotFound

ErrExecutableNotFound is returned if the executable is not found.


This section is empty.


type Cmd

type Cmd interface {
	// Run runs the command to the completion.
	Run() error
	// CombinedOutput runs the command and returns its combined standard output
	// and standard error.  This follows the pattern of package os/exec.
	CombinedOutput() ([]byte, error)
	// Output runs the command and returns standard output, but not standard err
	Output() ([]byte, error)
	SetDir(dir string)
	SetStdin(in io.Reader)
	SetStdout(out io.Writer)
	SetStderr(out io.Writer)
	// Stops the command by sending SIGTERM. It is not guaranteed the
	// process will stop before this function returns. If the process is not
	// responding, an internal timer function will send a SIGKILL to force
	// terminate after 10 seconds.

Cmd is an interface that presents an API that is very similar to Cmd from os/exec. As more functionality is needed, this can grow. Since Cmd is a struct, we will have to replace fields with get/set method pairs.

func InitFakeCmd added in v0.5.1

func InitFakeCmd(fake *FakeCmd, cmd string, args ...string) Cmd

type CodeExitError added in v1.4.0

type CodeExitError struct {
	Err  error
	Code int

CodeExitError is an implementation of ExitError consisting of an error object and an exit code (the upper bits of os.exec.ExitStatus).

func (CodeExitError) Error added in v1.4.0

func (e CodeExitError) Error() string

func (CodeExitError) ExitStatus added in v1.4.0

func (e CodeExitError) ExitStatus() int

func (CodeExitError) Exited added in v1.4.0

func (e CodeExitError) Exited() bool

func (CodeExitError) String added in v1.4.0

func (e CodeExitError) String() string

type ExitError

type ExitError interface {
	String() string
	Error() string
	Exited() bool
	ExitStatus() int

ExitError is an interface that presents an API similar to os.ProcessState, which is what ExitError from os/exec is. This is designed to make testing a bit easier and probably loses some of the cross-platform properties of the underlying library.

type ExitErrorWrapper added in v1.4.0

type ExitErrorWrapper struct {

ExitErrorWrapper is an implementation of ExitError in terms of os/exec ExitError. Note: standard exec.ExitError is type *os.ProcessState, which already implements Exited().

func (ExitErrorWrapper) ExitStatus added in v1.4.0

func (eew ExitErrorWrapper) ExitStatus() int

ExitStatus is part of the ExitError interface.

type FakeCmd added in v0.5.1

type FakeCmd struct {
	Argv                 []string
	CombinedOutputScript []FakeCombinedOutputAction
	CombinedOutputCalls  int
	CombinedOutputLog    [][]string
	RunScript            []FakeRunAction
	RunCalls             int
	RunLog               [][]string
	Dirs                 []string
	Stdin                io.Reader
	Stdout               io.Writer
	Stderr               io.Writer

A simple scripted Cmd type.

func (*FakeCmd) CombinedOutput added in v0.5.1

func (fake *FakeCmd) CombinedOutput() ([]byte, error)

func (*FakeCmd) Output added in v1.1.4

func (fake *FakeCmd) Output() ([]byte, error)

func (*FakeCmd) Run added in v1.7.0

func (fake *FakeCmd) Run() error

func (*FakeCmd) SetDir added in v0.5.1

func (fake *FakeCmd) SetDir(dir string)

func (*FakeCmd) SetStderr added in v1.7.0

func (fake *FakeCmd) SetStderr(out io.Writer)

func (*FakeCmd) SetStdin added in v1.4.0

func (fake *FakeCmd) SetStdin(in io.Reader)

func (*FakeCmd) SetStdout added in v1.4.0

func (fake *FakeCmd) SetStdout(out io.Writer)

func (*FakeCmd) Stop added in v1.6.0

func (fake *FakeCmd) Stop()

type FakeCombinedOutputAction added in v0.5.1

type FakeCombinedOutputAction func() ([]byte, error)

type FakeCommandAction added in v0.5.1

type FakeCommandAction func(cmd string, args ...string) Cmd

type FakeExec added in v0.5.1

type FakeExec struct {
	CommandScript []FakeCommandAction
	CommandCalls  int
	LookPathFunc  func(string) (string, error)

A simple scripted Interface type.

func (*FakeExec) Command added in v0.5.1

func (fake *FakeExec) Command(cmd string, args ...string) Cmd

func (*FakeExec) LookPath added in v1.1.0

func (fake *FakeExec) LookPath(file string) (string, error)

type FakeExitError added in v0.5.1

type FakeExitError struct {
	Status int

A simple fake ExitError type.

func (*FakeExitError) Error added in v0.5.1

func (fake *FakeExitError) Error() string

func (*FakeExitError) ExitStatus added in v0.5.1

func (fake *FakeExitError) ExitStatus() int

func (*FakeExitError) Exited added in v0.5.1

func (fake *FakeExitError) Exited() bool

func (*FakeExitError) String added in v0.5.1

func (fake *FakeExitError) String() string

type FakeRunAction added in v1.7.0

type FakeRunAction func() ([]byte, []byte, error)

type Interface

type Interface interface {
	// Command returns a Cmd instance which can be used to run a single command.
	// This follows the pattern of package os/exec.
	Command(cmd string, args ...string) Cmd

	// LookPath wraps os/exec.LookPath
	LookPath(file string) (string, error)

Interface is an interface that presents a subset of the os/exec API. Use this when you want to inject fakeable/mockable exec behavior.

func New

func New() Interface

New returns a new Interface which will os/exec to run commands.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL