Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Call ¶
Decorates testify's Call struct with additional methods for simulating stdout / stderr output from a mocked command
func (*Call) ExitsNonZero ¶
Configures the mock command to exit with a non-zero exit code
func (*Call) WithStderr ¶
Configures the mock command to write the given data to stderr
func (*Call) WithStdout ¶
Configures the mock command to write the given data to stdout
type CmdDumpStyle ¶
type CmdDumpStyle int
CmdDumpStyle how to style commands when they are printed to the console
const ( Default CmdDumpStyle = iota Pretty Spew )
Default prints the command using "%v" Pretty formats commands using PrettyFormat Spew uses the spew library to spew the entire struct
type Command ¶
type Command struct {
Prog string // Prog Main CLI program to execute
Args []string // Args Arguments to pass to program
Env []string // Env List of environment variables, eg []string{ "FOO=BAR", "BAZ=QUUX" }, to set when executing
Dir string // Dir Directory where command should be run
PristineEnv bool // PristineEnv When true, set only supplied Env vars without inheriting current process's env vars
}
Command encapsulates a shell command
func CmdFromArgs ¶
Convenience function to build a shell.Command from a list of arguments
Eg. CmdFromArgs("FOO=BAR", "ls", "-al", ".") ->
Command{
Env: []string{"FOO=BAR"},
Prog: "ls",
Args: []string{"-al", "."},
Dir: ""
}
func CmdFromFmt ¶
Convenience function to build a shell.Command from a format string and arguments
Eg. CmdFromFmt("HOME=%s FOO=BAR ls -al %s", "/tmp", "Documents") ->
Command{
Env: []string{"HOME=/tmp", "FOO=BAR"},
Prog: "ls",
Args: []string{"-al", "Documents},
Dir: ""
}
func (Command) PrettyFormat ¶
PrettyFormat converts a command into a simple string for easy inspection. Eg.
&Command{
Prog: []string{"echo"},
Args: []string{"foo", "bar", "baz"},
Dir: "/tmp",
Env: []string{"A=B", "C=D"}
}
-> "A=B C=D echo foo bar baz"
type Error ¶
type Error struct {
Command Command // the command that generated this error e
// contains filtered or unexported fields
}
Error is a generic error that is returned in situations other than the command failing. (eg. if the Command's Directory does not exist)
type ExitError ¶
type ExitError struct {
Command Command // the command that generated this error
ExitCode int // exit code of command
Stderr string // stderr output
}
ExitError is returned when a command fails
type MockOptions ¶
type MockOptions struct {
VerifyOrder bool // VerifyOrder If true, verify commands are run in the order they were declared
DumpStyle CmdDumpStyle // DumpStyle how to style the dump
IgnoreEnvVars []string // Array of environment variable names to strip when matching shell.Command arguments
IgnoreDir bool // If true, ignore Dir field of shell.Command arguments
}
options for a MockRunner
type MockRunner ¶
MockRunner is an implementation of Runner interface for use with testify/mock.
func DefaultMockRunner ¶
func DefaultMockRunner() *MockRunner
DefaultMockRunner returns a new mock runner instance with default settings
func NewMockRunner ¶
func NewMockRunner(options MockOptions) *MockRunner
NewMockRunner constructor for MockRunner
func (*MockRunner) ExpectCmd ¶
func (m *MockRunner) ExpectCmd(cmd Command) *Call
ExpectCmd sets an expectation for a command that should be run.
func (*MockRunner) Run ¶
func (m *MockRunner) Run(cmd Command) error
Run Instead of executing the command, logs an info message and registers the call with testify mock
func (*MockRunner) RunWith ¶
func (m *MockRunner) RunWith(cmd Command, opts RunOptions) error
Capture Instead of executing the command, log an info message and register the call with testify mock
func (*MockRunner) Test ¶
func (m *MockRunner) Test(t *testing.T)
Test decorates Testify's mock.Mock#Test() function by adding a cleanup hook to the test object that dumps the set of expected command matchers to stderr in the event of a test failure. This is useful because most command matchers are functions and so Testify can't generate a pretty diff for them; you end up with:
(shell.Command={...}) not matched by func(Command) bool
type RealRunner ¶
type RealRunner struct {
// contains filtered or unexported fields
}
RealRunner is an implementation of the Runner interface that actually executes shell commands
func (*RealRunner) Run ¶
func (r *RealRunner) Run(cmd Command) error
Run runs a Command, returning an error if the command exits non-zero
func (*RealRunner) RunWith ¶
func (r *RealRunner) RunWith(cmd Command, opts RunOptions) error
Capture runs a Command, streaming stdout and stderr to the given writers. An error is returned if the command exits non-zero.
type RunOptions ¶
type RunOptions struct {
// optional logger to use for logging this command
Logger *zerolog.Logger
// optional level at which command should be logged
LogLevel *zerolog.Level
// optional writer where stdout should be written
Stdout io.Writer
// optional writer where stderr should be written
Stderr io.Writer
}
Options for a RunWith() invocation
type Runner ¶
type Runner interface {
// Run runs a command, streaming stdout and stderr to the log at debug level.
Run(cmd Command) error
// Capture runs a Command, streaming stdout and stderr to the given writers.
// An error is returned if the command exits non-zero.
// If you're only interested in stdout, pass in nil for stderr (and vice versa)
RunWith(cmd Command, opts RunOptions) error
}
Runner is an interface for running shell commands. It exists to support mocking shell commands in unit tests.
https://joshrendek.com/2014/06/go-lang-mocking-exec-dot-command-using-interfaces/
Source Files