scriptrunner

Documentation

Index

• type CmdOptions
• type Config
• type OutputConfig
• type ScriptRunner
  • func NewScriptRunner(config *Config) *ScriptRunner
  • func (b *ScriptRunner) Error() error
  • func (b *ScriptRunner) ExitCode() int
  • func (b *ScriptRunner) Run(ctx context.Context) chan struct{}
  • func (b *ScriptRunner) Stop() error
  • func (b *ScriptRunner) Successful() bool

Types

type CmdOptions

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

type Config

type Config struct {
	Name       string
	Executable string
	ScriptArgs []string
	// ScriptEnv is the environment variables that are always passed to the script.
	ScriptEnv []string
	// ScriptEnv are environment variables that are only set on the first script run.
	FirstRunEnv   []string
	AbsWorkingDir string
	Logger        *zap.Logger
	Output        *OutputConfig
}

type OutputConfig

type OutputConfig struct {
	Stdout io.Writer
	Stderr io.Writer
	Pipe   func(line string) string
}

OutputConfig configures the script output. Stdout and Stderr default to os.Stdout/os.Stderr, even if OutputConfig is nil. Pipe is an optional function that transforms each output line before printing it.

type ScriptRunner

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

func NewScriptRunner

func NewScriptRunner(config *Config) *ScriptRunner

func (*ScriptRunner) Error

func (b *ScriptRunner) Error() error

func (*ScriptRunner) ExitCode

func (b *ScriptRunner) ExitCode() int

func (*ScriptRunner) Run

func (b *ScriptRunner) Run(ctx context.Context) chan struct{}

func (*ScriptRunner) Stop

func (b *ScriptRunner) Stop() error

func (*ScriptRunner) Successful

func (b *ScriptRunner) Successful() bool

Successful returns true if the script exited with <= 0 and without an error. This method should only be called after the script is done.