exec

type AnalyzerOption ¶

type AnalyzerOption func(*analyzerConfig)

AnalyzerOption is a functional option for configuring an OutputAnalyzer.

func StderrCheckForProvider(provider console.StackType) AnalyzerOption

func WithStderrCheck(check bool) AnalyzerOption

type Error ¶

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

func (in Error) ToError() error

type Errors ¶

type Errors []Error

func (in Errors) ToErrors() []error

type Executable ¶

type Executable interface {
	ID() string
	Run(ctx context.Context) error
	Start(ctx context.Context) (WaitFn, error)
	RunWithOutput(ctx context.Context) ([]byte, error)
	RunStream(ctx context.Context, cb func([]byte)) error
	Command() string
}

func NewExecutable(command string, options ...Option) Executable

type ExecutionStrategy ¶

type ExecutionStrategy string

ExecutionStrategy defines how executables queue should be processed.

const (
	ExecutionStrategyParallel ExecutionStrategy = "parallel"
	ExecutionStrategyOrdered  ExecutionStrategy = "ordered"
)

type Executor ¶

type Executor interface {
	Start(ctx context.Context) error
	Add(executable Executable) error
}

func NewExecutor(errChan chan error, finishedChan chan struct{}, options ...ExecutorOption) Executor

type ExecutorOption ¶

type ExecutorOption func(*executor)

func WithExecutionStrategy(strategy ExecutionStrategy) ExecutorOption

func WithPostRunFunc(fn func(string, error)) ExecutorOption

func WithPreRunFunc(fn func(string)) ExecutorOption

type Option ¶

type Option func(*executable)

func WithArgs(args []string) Option

func WithDir(workingDirectory string) Option

func WithEnv(env []string) Option

func WithHook(lifecycle v1.Lifecycle, fn v1.HookFunction) Option

func WithID(id string) Option

func WithOutputAnalyzer(heuristics []OutputAnalyzerHeuristic, opts ...AnalyzerOption) Option

func WithOutputSinks(sinks ...io.WriteCloser) Option

func WithTimeout(timeout time.Duration) Option

type OutputAnalyzer ¶

type OutputAnalyzer interface {
	Stdout() io.Writer
	Stderr() io.Writer

	// Detect scans the output for potential errors.
	// It uses a custom heuristics to detect issues.
	// It can result in a false positives.
	//
	// Note: Make sure that it is executed after Write
	//		 has finished to ensure proper detection.
	Detect() []error
}

OutputAnalyzer captures the command output and attempts to detect potential errors.

func NewOutputAnalyzer(heuristics []OutputAnalyzerHeuristic, opts ...AnalyzerOption) OutputAnalyzer

type OutputAnalyzerHeuristic ¶

type OutputAnalyzerHeuristic interface {
	Detect(input *bufio.Scanner) Errors
}

func NewKeywordDetector() OutputAnalyzerHeuristic

type StdioExecutable ¶ added in v0.6.65

type StdioExecutable interface {
	Executable
	StartWithStdio(context.Context) (*StdioProcess, error)
}

StdioExecutable is implemented by executables that can be started with bidirectional standard streams. It is intentionally separate from Executable so existing callers and test doubles keep their contracts.

type StdioProcess ¶ added in v0.6.65

type StdioProcess struct {
	Stdin  io.WriteCloser
	Stdout io.ReadCloser
	Stderr io.ReadCloser
	// contains filtered or unexported fields
}

StdioProcess is a running executable with bidirectional standard input and output. The process owner must drain Stdout before calling Wait. Standard error is retained as a bounded diagnostic tail. Stop closes the input stream and terminates the process; it is safe to call more than once.

func NewStdioProcess(stdin io.WriteCloser, stdout, stderr io.ReadCloser, hooks StdioProcessHooks) *StdioProcess

func StartWithStdio(ctx context.Context, command string, options ...Option) (*StdioProcess, error)

func (p *StdioProcess) Close() error

func (p *StdioProcess) Kill() error

func (p *StdioProcess) StderrTail() string

func (p *StdioProcess) Stop() error

func (p *StdioProcess) Wait() error

type StdioProcessHooks ¶ added in v0.6.65

type StdioProcessHooks struct {
	Wait       func() error
	Kill       func() error
	Stop       func() error
	Close      func() error
	StderrTail func() string
}

StdioProcessHooks supplies lifecycle operations for a StdioProcess. It is useful for protocol adapters and deterministic tests that provide their own in-memory streams.

type WaitFn ¶

type WaitFn func() error