cmd

Documentation

Index

• func IsSignaled(err error) bool
• func MustStop(ctx context.Context, cmd *exec.Cmd) error
• func Stop(cmd *exec.Cmd) error
• func WaitCmd(ctx context.Context, cmd *exec.Cmd, startResult *Result) error
• type Cfg
• type Result
  • func Run(command ...string) (*Result, error)
  • func RunCmd(ctx context.Context, cmd *exec.Cmd, cfg *Cfg, ...) (*Result, error)
  • func RunRaw(ctx context.Context, cfg *Cfg, beforeRun ...func(cmd *exec.Cmd) error) (*Result, error)
  • func StartCmd(cmd *exec.Cmd, beforeRun ...func(cmd *exec.Cmd) error) *Result

Functions

func IsSignaled

func IsSignaled(err error) bool

IsSignaled err is Cmd.Wait() or Cmd.Run() result error.

func MustStop

func MustStop(ctx context.Context, cmd *exec.Cmd) error

func Stop

func Stop(cmd *exec.Cmd) error

func WaitCmd

func WaitCmd(ctx context.Context, cmd *exec.Cmd, startResult *Result) error

WaitCmd wait command exit Must called after StartCmd

Types

type Cfg

type Cfg struct {
	Command    []string          `json:"command"    validate:"required,min=1" yaml:"command"`
	Env        map[string]string `json:"env"        yaml:"env"`
	RunAsUser  string            `json:"runAsUser"  yaml:"runAsUser"`
	WorkingDir string            `json:"workingDir" yaml:"workingDir"`
}

type Result

type Result struct {
	Stdout        []string `json:"stdout"`
	Stderr        []string `json:"stderr"`
	ExitCode      int      `json:"exitCode"`
	Pid           int      `json:"pid"`
	StartTimeNano int64    `json:"startTimeNano"`
	StopTimeNano  int64    `json:"stopTimeNano"`
	Signaled      bool     `json:"signaled"`
	// contains filtered or unexported fields
}

func Run

func Run(command ...string) (*Result, error)

func RunCmd

func RunCmd(ctx context.Context, cmd *exec.Cmd, cfg *Cfg, beforeRun ...func(cmd *exec.Cmd) error) (*Result, error)

func RunRaw

func RunRaw(ctx context.Context, cfg *Cfg, beforeRun ...func(cmd *exec.Cmd) error) (*Result, error)

func StartCmd

func StartCmd(cmd *exec.Cmd, beforeRun ...func(cmd *exec.Cmd) error) *Result

StartCmd start a command if error is nil, you can get pid from Result.Pid. Must call WaitCmd after StartCmd whether error is nil or not