shell

Documentation

Overview

Package shell allows to run commands in a shell.

Index

• func GetExitCodeForRunCommandError(err error) (int, error)
• func RunCommand(t testing.TestingT, command Command)
• func RunCommandAndGetOutput(t testing.TestingT, command Command) string
• func RunCommandAndGetOutputE(t testing.TestingT, command Command) (string, error)
• func RunCommandAndGetStdOut(t testing.TestingT, command Command) string
• func RunCommandAndGetStdOutE(t testing.TestingT, command Command) (string, error)
• func RunCommandAndGetStdOutErr(t testing.TestingT, command Command) (stdout string, stderr string)
• func RunCommandAndGetStdOutErrE(t testing.TestingT, command Command) (stdout string, stderr string, err error)
• func RunCommandContext(t testing.TestingT, ctx context.Context, command *Command)
• func RunCommandContextAndGetOutput(t testing.TestingT, ctx context.Context, command *Command) string
• func RunCommandContextAndGetOutputE(t testing.TestingT, ctx context.Context, command *Command) (string, error)
• func RunCommandContextAndGetStdOut(t testing.TestingT, ctx context.Context, command *Command) string
• func RunCommandContextAndGetStdOutE(t testing.TestingT, ctx context.Context, command *Command) (string, error)
• func RunCommandContextAndGetStdOutErr(t testing.TestingT, ctx context.Context, command *Command) (stdout string, stderr string)
• func RunCommandContextAndGetStdOutErrE(t testing.TestingT, ctx context.Context, command *Command) (stdout string, stderr string, err error)
• func RunCommandContextE(t testing.TestingT, ctx context.Context, command *Command) error
• func RunCommandE(t testing.TestingT, command Command) error
• type Command
• type ErrWithCmdOutput
  • func (e *ErrWithCmdOutput) Error() string

Functions

func GetExitCodeForRunCommandError

func GetExitCodeForRunCommandError(err error) (int, error)

GetExitCodeForRunCommandError tries to read the exit code for the error object returned from running a shell command. This is a bit tricky to do in a way that works across platforms.

func RunCommand

func RunCommand(t testing.TestingT, command Command)

RunCommand runs a shell command and redirects its stdout and stderr to the stdout of the atomic script itself. If there are any errors, fail the test.

Deprecated: Use RunCommandContext instead.

func RunCommandAndGetOutput

func RunCommandAndGetOutput(t testing.TestingT, command Command) string

RunCommandAndGetOutput runs a shell command and returns its stdout and stderr as a string. The stdout and stderr of that command will also be logged with Command.Log to make debugging easier. If there are any errors, fail the test.

Deprecated: Use RunCommandContextAndGetOutput instead.

func RunCommandAndGetOutputE

func RunCommandAndGetOutputE(t testing.TestingT, command Command) (string, error)

RunCommandAndGetOutputE runs a shell command and returns its stdout and stderr as a string. The stdout and stderr of that command will also be logged with Command.Log to make debugging easier. Any returned error will be of type ErrWithCmdOutput, containing the output streams and the underlying error.

Deprecated: Use RunCommandContextAndGetOutputE instead.

func RunCommandAndGetStdOut

func RunCommandAndGetStdOut(t testing.TestingT, command Command) string

RunCommandAndGetStdOut runs a shell command and returns solely its stdout (but not stderr) as a string. The stdout and stderr of that command will also be logged with Command.Log to make debugging easier. If there are any errors, fail the test.

Deprecated: Use RunCommandContextAndGetStdOut instead.

func RunCommandAndGetStdOutE

func RunCommandAndGetStdOutE(t testing.TestingT, command Command) (string, error)

RunCommandAndGetStdOutE runs a shell command and returns solely its stdout (but not stderr) as a string. The stdout and stderr of that command will also be printed to the stdout and stderr of this Go program to make debugging easier. Any returned error will be of type ErrWithCmdOutput, containing the output streams and the underlying error.

Deprecated: Use RunCommandContextAndGetStdOutE instead.

func RunCommandAndGetStdOutErr

func RunCommandAndGetStdOutErr(t testing.TestingT, command Command) (stdout string, stderr string)

RunCommandAndGetStdOutErr runs a shell command and returns solely its stdout and stderr as a string. The stdout and stderr of that command will also be logged with Command.Log to make debugging easier. If there are any errors, fail the test.

Deprecated: Use RunCommandContextAndGetStdOutErr instead.

func RunCommandAndGetStdOutErrE

func RunCommandAndGetStdOutErrE(t testing.TestingT, command Command) (stdout string, stderr string, err error)

RunCommandAndGetStdOutErrE runs a shell command and returns solely its stdout and stderr as a string. The stdout and stderr of that command will also be printed to the stdout and stderr of this Go program to make debugging easier. Any returned error will be of type ErrWithCmdOutput, containing the output streams and the underlying error.

Deprecated: Use RunCommandContextAndGetStdOutErrE instead.

func RunCommandContext

func RunCommandContext(t testing.TestingT, ctx context.Context, command *Command)

RunCommandContext is like RunCommand but includes a context.

func RunCommandContextAndGetOutput

func RunCommandContextAndGetOutput(t testing.TestingT, ctx context.Context, command *Command) string

RunCommandContextAndGetOutput is like RunCommandAndGetOutput but includes a context.

func RunCommandContextAndGetOutputE

func RunCommandContextAndGetOutputE(t testing.TestingT, ctx context.Context, command *Command) (string, error)

RunCommandContextAndGetOutputE is like RunCommandAndGetOutputE but includes a context.

func RunCommandContextAndGetStdOut

func RunCommandContextAndGetStdOut(t testing.TestingT, ctx context.Context, command *Command) string

RunCommandContextAndGetStdOut is like RunCommandAndGetStdOut but includes a context.

func RunCommandContextAndGetStdOutE

func RunCommandContextAndGetStdOutE(t testing.TestingT, ctx context.Context, command *Command) (string, error)

RunCommandContextAndGetStdOutE is like RunCommandAndGetStdOutE but includes a context.

func RunCommandContextAndGetStdOutErr

func RunCommandContextAndGetStdOutErr(t testing.TestingT, ctx context.Context, command *Command) (stdout string, stderr string)

RunCommandContextAndGetStdOutErr is like RunCommandAndGetStdOutErr but includes a context.

func RunCommandContextAndGetStdOutErrE

func RunCommandContextAndGetStdOutErrE(t testing.TestingT, ctx context.Context, command *Command) (stdout string, stderr string, err error)

RunCommandContextAndGetStdOutErrE is like RunCommandAndGetStdOutErrE but includes a context.

func RunCommandContextE

func RunCommandContextE(t testing.TestingT, ctx context.Context, command *Command) error

RunCommandContextE is like RunCommandE but includes a context.

func RunCommandE

func RunCommandE(t testing.TestingT, command Command) error

RunCommandE runs a shell command and redirects its stdout and stderr to the stdout of the atomic script itself. Any returned error will be of type ErrWithCmdOutput, containing the output streams and the underlying error.

Deprecated: Use RunCommandContextE instead.

Types

type Command

type Command struct {
	// Use the specified logger for the command's output. Use logger.Discard to not print the output while executing the command.
	Logger     *logger.Logger
	Stdin      io.Reader
	Env        map[string]string // Additional environment variables to set
	Command    string            // The command to run
	WorkingDir string            // The working directory
	Args       []string          // The args to pass to the command
}

Command is a simpler struct for defining commands than Go's built-in Cmd.

type ErrWithCmdOutput

type ErrWithCmdOutput struct {
	Underlying error
	Output     *output
}

ErrWithCmdOutput wraps an underlying error with the captured stdout and stderr from the command that produced it.

func (*ErrWithCmdOutput) Error

func (e *ErrWithCmdOutput) Error() string