command

Documentation

Overview

Package command provide utilities around os/exec package

Index

• Variables
• func CmdArgsFromString(s string) ([]string, error)
• func ShLimitCommands(l limits.T) string
• func WithArgs(args []string) funcopt.O
• func WithBufferedStderr() funcopt.O
• func WithBufferedStdout() funcopt.O
• func WithCWD(cwd string) funcopt.O
• func WithCommandLogLevel(l zerolog.Level) funcopt.O
• func WithContext(ctx context.Context) funcopt.O
• func WithEnv(env []string) funcopt.O
• func WithErrorExitCodeLogLevel(l zerolog.Level) funcopt.O
• func WithGroup(group string) funcopt.O
• func WithIgnoredExitCodes(codes ...int) funcopt.O
• func WithLogLevel(l zerolog.Level) funcopt.O
• func WithLogger(l *plog.Logger) funcopt.O
• func WithName(name string) funcopt.O
• func WithOnStderrLine(f func(string)) funcopt.O
• func WithOnStdoutLine(f func(string)) funcopt.O
• func WithPrompt(l *bufio.Reader) funcopt.O
• func WithStderrLogLevel(l zerolog.Level) funcopt.O
• func WithStdoutLogLevel(l zerolog.Level) funcopt.O
• func WithTimeout(timeout time.Duration) funcopt.O
• func WithUser(user string) funcopt.O
• func WithVarArgs(args ...string) funcopt.O
• func WithVarEnv(env ...string) funcopt.O
• type ErrExitCode
  • func (e *ErrExitCode) Error() string
  • func (e *ErrExitCode) ExitCode() int
• type T
  • func New(opts ...funcopt.O) *T
  • func (t *T) Cmd() *exec.Cmd
  • func (t *T) ExitCode() int
  • func (t T) Output() ([]byte, error)
  • func (t *T) Run() error
  • func (t *T) Start() (err error)
  • func (t T) Stderr() []byte
  • func (t T) Stdout() []byte
  • func (t *T) String() string
  • func (t *T) Wait() (err error)

Variables

var (
	ErrAlreadyStarted = errors.New("command: already started")
	ErrAlreadyWaited  = errors.New("command: already waited")
	ErrPromptAbort    = errors.New("command: aborted by prompt")
)

Functions

func CmdArgsFromString

func CmdArgsFromString(s string) ([]string, error)

CmdArgsFromString returns args for exec.Command from a string command 's' When string command 's' contains multiple commands,

exec.Command("/bin/sh", "-c", s)

else

exec.Command from shlex.Split(s)

func ShLimitCommands

func ShLimitCommands(l limits.T) string

ShLimitCommands provides ulimit commands for sh launcher max value of LimitVMem, LimitAs is used to set virtual memory limit

func WithArgs

func WithArgs(args []string) funcopt.O

WithArgs sets the process args[1:] from a string slice

func WithBufferedStderr

func WithBufferedStderr() funcopt.O

WithBufferedStderr activates the buffering of the lines emited by the process on stderr

func WithBufferedStdout

func WithBufferedStdout() funcopt.O

WithBufferedStdout activates the buffering of the lines emited by the process on stdout

func WithCWD

func WithCWD(cwd string) funcopt.O

func WithCommandLogLevel

func WithCommandLogLevel(l zerolog.Level) funcopt.O

WithCommandLogLevel show command name and args during Start

default zerolog.DebugLevel

func WithContext

func WithContext(ctx context.Context) funcopt.O

WithContext sets the command context

func WithEnv

func WithEnv(env []string) funcopt.O

func WithErrorExitCodeLogLevel

func WithErrorExitCodeLogLevel(l zerolog.Level) funcopt.O

WithErrorExitCodeLogLevel sets the level of the log entries for error exit code.

func WithGroup

func WithGroup(group string) funcopt.O

func WithIgnoredExitCodes

func WithIgnoredExitCodes(codes ...int) funcopt.O

WithIgnoredExitCodes set alternate list of successful exit codes.

exit codes are checked during Wait().
- default successful exit code is 0 when WithIgnoredExitCodes is not used
- Ignore all exit codes: WithIgnoredExitCodes()
- Accept 0, 1 or 6 exit code: WithIgnoredExitCodes(0, 1, 6)

func WithLogLevel

func WithLogLevel(l zerolog.Level) funcopt.O

WithLogLevel sets the level of the log entries.

func WithLogger

func WithLogger(l *plog.Logger) funcopt.O

WithLogger defines the Logger that will receive this pkg logs and process outputs

func WithName

func WithName(name string) funcopt.O

WithName sets the process args[0]

func WithOnStderrLine

func WithOnStderrLine(f func(string)) funcopt.O

func WithOnStdoutLine

func WithOnStdoutLine(f func(string)) funcopt.O

func WithPrompt

func WithPrompt(l *bufio.Reader) funcopt.O

WithLogger defines the Logger that will receive this pkg logs and process outputs

func WithStderrLogLevel

func WithStderrLogLevel(l zerolog.Level) funcopt.O

WithStderrLogLevel sets the level of the log entries coming from the process stderr If not set, stderr lines are not logged.

func WithStdoutLogLevel

func WithStdoutLogLevel(l zerolog.Level) funcopt.O

WithStdoutLogLevel sets the level of the log entries coming from the process stdout. If not set, stdout lines are not logged.

func WithTimeout

func WithTimeout(timeout time.Duration) funcopt.O

WithTimeout sets the max duration the process is allowed to run. After this duration, the process is killed and an error is reported.

func WithUser

func WithUser(user string) funcopt.O

func WithVarArgs

func WithVarArgs(args ...string) funcopt.O

WithVarArgs sets the process args[1:] from a variadic string slice

func WithVarEnv

func WithVarEnv(env ...string) funcopt.O

Types

type ErrExitCode

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

func (*ErrExitCode) Error

func (e *ErrExitCode) Error() string

func (*ErrExitCode) ExitCode

func (e *ErrExitCode) ExitCode() int

type T

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

func New

func New(opts ...funcopt.O) *T

func (*T) Cmd

func (t *T) Cmd() *exec.Cmd

func (*T) ExitCode

func (t *T) ExitCode() int

func (T) Output

func (t T) Output() ([]byte, error)

Output returns stdout results of command (meaningful after Wait() or Run()), command created without funcopt WithBufferedStdout() return nil valid results

func (*T) Run

func (t *T) Run() error

func (*T) Start

func (t *T) Start() (err error)

Start prepare command, then call underlying cmd.Start() it takes care of preparing logging, timeout, stdout and stderr watchers

func (T) Stderr

func (t T) Stderr() []byte

Stderr returns stderr results of command (meaningful after Wait() or Run()) command created without funcopt WithBufferedStderr() return nil

func (T) Stdout

func (t T) Stdout() []byte

Stdout returns stdout results of command (meaningful after Wait() or Run()), command created without funcopt WithBufferedStdout() return nil valid results

func (*T) String

func (t *T) String() string

func (*T) Wait

func (t *T) Wait() (err error)