exec

Documentation

Overview

Package exec wraps os/exec to add a little error sanitization and standardization around process return codes and a channel-based cancel mechanism

Index

• type CmdRunResult
  • func NewCmdRunResultWithErr(err error) CmdRunResult
  • func (r *CmdRunResult) AttachErrorf(msg string, err error)
  • func (r CmdRunResult) ErrorStr() string
  • func (r CmdRunResult) IsEmpty() bool
  • func (r CmdRunResult) WithFriendlyYAMLStrings() CmdRunResult
• type CmdRunner
• type Flag
  • func NewFlagFromString(str string) (Flag, error)
• type FlagSet
  • func NewFlagSet(optss ...[]string) FlagSet
  • func (s FlagSet) Includes(name string) bool
• type PlainCmdRunner
  • func NewPlainCmdRunner() PlainCmdRunner
  • func (PlainCmdRunner) Run(cmd *exec.Cmd) error
  • func (PlainCmdRunner) RunWithCancel(cmd *exec.Cmd, cancelCh chan struct{}) error

Types

type CmdRunResult

type CmdRunResult struct {
	Stdout   string
	Stderr   string
	ExitCode int
	Error    error
	Finished bool
}

func NewCmdRunResultWithErr

func NewCmdRunResultWithErr(err error) CmdRunResult

func (*CmdRunResult) AttachErrorf

func (r *CmdRunResult) AttachErrorf(msg string, err error)

func (CmdRunResult) ErrorStr

func (r CmdRunResult) ErrorStr() string

func (CmdRunResult) IsEmpty

func (r CmdRunResult) IsEmpty() bool

func (CmdRunResult) WithFriendlyYAMLStrings

func (r CmdRunResult) WithFriendlyYAMLStrings() CmdRunResult

type CmdRunner

type CmdRunner interface {
	Run(*exec.Cmd) error
	RunWithCancel(cmd *exec.Cmd, cancelCh chan struct{}) error
}

CmdRunner allows to run commands on the OS. All commands running within kapp-controller should happen through an instance of this interface so that they can be intercepted and potentially modified in kctrl when running kapp-controller locally.

type Flag

type Flag struct {
	Name  string // e.g. --name
	Value string
}

func NewFlagFromString

func NewFlagFromString(str string) (Flag, error)

type FlagSet

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

func NewFlagSet

func NewFlagSet(optss ...[]string) FlagSet

func (FlagSet) Includes

func (s FlagSet) Includes(name string) bool

type PlainCmdRunner

type PlainCmdRunner struct{}

PlainCmdRunner implements CmdRunner interface by simply running exec.Cmd.

func NewPlainCmdRunner

func NewPlainCmdRunner() PlainCmdRunner

NewPlainCmdRunner returns a new PlainCmdRunner.

func (PlainCmdRunner) Run

func (PlainCmdRunner) Run(cmd *exec.Cmd) error

Run executes exec.Cmd.

func (PlainCmdRunner) RunWithCancel

func (PlainCmdRunner) RunWithCancel(cmd *exec.Cmd, cancelCh chan struct{}) error

RunWithCancel executes exec.Cmd. Kills execution immediately if value is read from cancelCh.