engine

package

v0.1.57 Latest Latest Go to latest Published: Sep 27, 2025 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/simplecontainer/smr

Links

Open Source Insights

Documentation ¶

Index ¶

type CmdSource
type CommandBuilder
- func NewCommandBuilder(binary string, config Config) (*CommandBuilder, error)
- func NewCommandBuilderFromSlice(cmdParts []string, config Config) *CommandBuilder
- func (cb *CommandBuilder) BuildCommand(sources ...CmdSource) ([]string, string, error)
type Config
- func DefaultConfig() Config
type Engine
- func NewEngine(binary string) (*Engine, error)
- func NewEngineFromSlice(cmdParts []string) *Engine
- func NewEngineFromSliceWithConfig(cmdParts []string, config Config) *Engine
- func NewEngineFromSliceWithOptions(cmdParts []string, options Options) *Engine
- func NewEngineWithConfig(binary string, config Config) (*Engine, error)
- func NewEngineWithOptions(binary string, options Options) *Engine
- func (e *Engine) GetStderr() string
- func (e *Engine) GetStdout() string
- func (e *Engine) Run(t *testing.T, command ...CmdSource) error
- func (e *Engine) RunAndCapture(t *testing.T, command ...CmdSource) (string, error)
- func (e *Engine) RunBackground(t *testing.T, command ...CmdSource) error
- func (e *Engine) SetFailOnError(failOnError bool)
- func (e *Engine) Stop(t *testing.T) error
- func (e *Engine) StopWithError() error
type ErrorHandler
- func NewErrorHandler(config Config, logger Logger) *ErrorHandler
- func (eh *ErrorHandler) HandleError(fullCmd []string, output *OutputCapture, err error) error
type Logger
type Options
- func DefaultEngineOptions() Options
type OutputCapture
- func NewOutputCapture() *OutputCapture
- func (oc *OutputCapture) CreateWriters(logger Logger, cmdStr string, suffix string) (io.Writer, io.Writer)
- func (oc *OutputCapture) GetStderr() string
- func (oc *OutputCapture) GetStdout() string
- func (oc *OutputCapture) Reset()
type ProcessManager
- func NewProcessManager(config Config, logger Logger) *ProcessManager
- func (pm *ProcessManager) IsRunning() bool
- func (pm *ProcessManager) Start(cmd *exec.Cmd) error
- func (pm *ProcessManager) Stop() error
- func (pm *ProcessManager) StopWithoutLogging() error
type SliceCmd
- func (s SliceCmd) String() string
- func (s SliceCmd) ToCmdArgs() ([]string, error)
type StringCmd
- func NewStringCmd(command string, args ...any) StringCmd
- func (s StringCmd) String() string
- func (s StringCmd) ToCmdArgs() ([]string, error)
type TestLogger
- func NewTestLogger(t *testing.T) *TestLogger
- func (tl *TestLogger) Errorf(format string, args ...interface{})
- func (tl *TestLogger) Fatalf(format string, args ...interface{})
- func (tl *TestLogger) Logf(format string, args ...interface{})

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type CmdSource ¶

type CmdSource interface {
	ToCmdArgs() ([]string, error)
	String() string
}

type CommandBuilder ¶ added in v0.1.57

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

func NewCommandBuilder ¶ added in v0.1.57

func NewCommandBuilder(binary string, config Config) (*CommandBuilder, error)

func NewCommandBuilderFromSlice ¶ added in v0.1.57

func NewCommandBuilderFromSlice(cmdParts []string, config Config) *CommandBuilder

func (*CommandBuilder) BuildCommand ¶ added in v0.1.57

func (cb *CommandBuilder) BuildCommand(sources ...CmdSource) ([]string, string, error)

type Config ¶ added in v0.1.57

type Config struct {
	FailOnError bool
	Suffix      string
}

func DefaultConfig ¶ added in v0.1.57

func DefaultConfig() Config

type Engine ¶

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

func NewEngine ¶ added in v0.1.57

func NewEngine(binary string) (*Engine, error)

func NewEngineFromSlice ¶ added in v0.1.57

func NewEngineFromSlice(cmdParts []string) *Engine

func NewEngineFromSliceWithConfig ¶ added in v0.1.57

func NewEngineFromSliceWithConfig(cmdParts []string, config Config) *Engine

func NewEngineFromSliceWithOptions ¶

func NewEngineFromSliceWithOptions(cmdParts []string, options Options) *Engine

func NewEngineWithConfig ¶ added in v0.1.57

func NewEngineWithConfig(binary string, config Config) (*Engine, error)

func NewEngineWithOptions ¶

func NewEngineWithOptions(binary string, options Options) *Engine

Legacy constructor functions for backward compatibility

func (*Engine) GetStderr ¶

func (e *Engine) GetStderr() string

func (*Engine) GetStdout ¶

func (e *Engine) GetStdout() string

func (*Engine) Run ¶

func (e *Engine) Run(t *testing.T, command ...CmdSource) error

func (*Engine) RunAndCapture ¶

func (e *Engine) RunAndCapture(t *testing.T, command ...CmdSource) (string, error)

func (*Engine) RunBackground ¶

func (e *Engine) RunBackground(t *testing.T, command ...CmdSource) error

func (*Engine) SetFailOnError ¶

func (e *Engine) SetFailOnError(failOnError bool)

func (*Engine) Stop ¶

func (e *Engine) Stop(t *testing.T) error

func (*Engine) StopWithError ¶

func (e *Engine) StopWithError() error

type ErrorHandler ¶ added in v0.1.57

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

func NewErrorHandler ¶ added in v0.1.57

func NewErrorHandler(config Config, logger Logger) *ErrorHandler

func (*ErrorHandler) HandleError ¶ added in v0.1.57

func (eh *ErrorHandler) HandleError(fullCmd []string, output *OutputCapture, err error) error

type Logger ¶ added in v0.1.57

type Logger interface {
	Logf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Fatalf(format string, args ...interface{})
}

type Options ¶

type Options struct {
	FailOnError bool
	Suffix      string
}

func DefaultEngineOptions ¶

func DefaultEngineOptions() Options

type OutputCapture ¶ added in v0.1.57

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

func NewOutputCapture ¶ added in v0.1.57

func NewOutputCapture() *OutputCapture

func (*OutputCapture) CreateWriters ¶ added in v0.1.57

func (oc *OutputCapture) CreateWriters(logger Logger, cmdStr string, suffix string) (io.Writer, io.Writer)

func (*OutputCapture) GetStderr ¶ added in v0.1.57

func (oc *OutputCapture) GetStderr() string

func (*OutputCapture) GetStdout ¶ added in v0.1.57

func (oc *OutputCapture) GetStdout() string

func (*OutputCapture) Reset ¶ added in v0.1.57

func (oc *OutputCapture) Reset()

type ProcessManager ¶ added in v0.1.57

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

func NewProcessManager ¶ added in v0.1.57

func NewProcessManager(config Config, logger Logger) *ProcessManager

func (*ProcessManager) IsRunning ¶ added in v0.1.57

func (pm *ProcessManager) IsRunning() bool

func (*ProcessManager) Start ¶ added in v0.1.57

func (pm *ProcessManager) Start(cmd *exec.Cmd) error

func (*ProcessManager) Stop ¶ added in v0.1.57

func (pm *ProcessManager) Stop() error

func (*ProcessManager) StopWithoutLogging ¶ added in v0.1.57

func (pm *ProcessManager) StopWithoutLogging() error

type SliceCmd ¶

type SliceCmd []string

func (SliceCmd) String ¶

func (s SliceCmd) String() string

func (SliceCmd) ToCmdArgs ¶

func (s SliceCmd) ToCmdArgs() ([]string, error)

type StringCmd ¶

type StringCmd string

func NewStringCmd ¶

func NewStringCmd(command string, args ...any) StringCmd

func (StringCmd) String ¶

func (s StringCmd) String() string

func (StringCmd) ToCmdArgs ¶

func (s StringCmd) ToCmdArgs() ([]string, error)

type TestLogger ¶ added in v0.1.57

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

func NewTestLogger ¶ added in v0.1.57

func NewTestLogger(t *testing.T) *TestLogger

func (*TestLogger) Errorf ¶ added in v0.1.57

func (tl *TestLogger) Errorf(format string, args ...interface{})

func (*TestLogger) Fatalf ¶ added in v0.1.57

func (tl *TestLogger) Fatalf(format string, args ...interface{})

func (*TestLogger) Logf ¶ added in v0.1.57

func (tl *TestLogger) Logf(format string, args ...interface{})

Source Files ¶

View all Source files

Engine.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL