shell

type Call struct {
	*mock.Call
	// contains filtered or unexported fields
}

type CmdDumpStyle int

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
}

type Error struct {
	Command Command // the command that generated this error e
	// contains filtered or unexported fields
}

type ExitError struct {
	Command  Command // the command that generated this error
	ExitCode int     // exit code of command
	Stderr   string  // stderr output
}

type LoggingWriter struct {
	// contains filtered or unexported fields
}

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
}

type MockRunner struct {
	mock.Mock
	// contains filtered or unexported fields
}

type RealRunner struct {
	// contains filtered or unexported fields
}

type RunOption func(*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 level at which command output (stdout/stderr) should be logged
	OutputLogLevel zerolog.Level
	// optional reader from which stdin should be read
	Stdin io.Reader
	// optional writer where stdout should be written
	Stdout io.Writer
	// optional writer where stderr should be written
	Stderr io.Writer
	// if false, do not send stdout to logging system
	LogStdout bool
}

type Runner interface {
	// Run runs a Command, streaming stdout and stderr to the log at debug level.
	// Behavior can be customized by passing in one or more RunOption functions
	Run(cmd Command, opts ...RunOption) error
	// PrepareSubprocess sets up a Subprocess to run a Command, similar to Run but asynchronous.
	PrepareSubprocess(cmd Command, opts ...RunOption) Subprocess
}

type Subprocess interface {
	// Start begins running the actual Command the Subprocess is configured for
	Start() error
	// Wait synchronously blocks until normal completion of the Command
	Wait() error
	// Stop signals the process to exit, and synchronously waits until it does; after three seconds it will be forcibly
	// killed and an error returned
	Stop() error
}