commandexecutor

Jul 7, 2025

Changes in this version

type CommandOutput

+ ReturnCode *int

+ Stderr *[]byte

+ Stdout *[]byte

Apr 20, 2025

Changes in this version

+ func IsLiveOutputOnStdoutEnabled(ctx context.Context) bool

+ func WithLiveOutputOnStdout(ctx context.Context) context.Context

+ func WithLiveOutputOnStdoutEnabled(ctx context.Context, enabled bool) context.Context

+ func WithLiveOutputOnStdoutIfVerbose(ctx context.Context) context.Context

+ type ContextKeyLiveOutputOnStdout struct

Feb 22, 2025

Changes in this version

+ type PowerShellService struct

+ func NewPowerShell() (p *PowerShellService)

+ func NewPowerShellService() (p *PowerShellService)

+ func PowerShell() (p *PowerShellService)

+ func (b *PowerShellService) RunCommand(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput, err error)

+ func (p *PowerShellService) MustRunCommand(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput)

+ func (p *PowerShellService) MustRunOneLiner(oneLiner string, verbose bool) (output *CommandOutput)

+ func (p *PowerShellService) MustRunOneLinerAndGetStdoutAsString(oneLiner string, verbose bool) (stdout string)

+ func (p *PowerShellService) RunOneLiner(oneLiner string, verbose bool) (output *CommandOutput, err error)

+ func (p *PowerShellService) RunOneLinerAndGetStdoutAsString(oneLiner string, verbose bool) (stdout string, err error)

Jan 17, 2025

Changes in this version

+ type BashService struct

+ func Bash() (b *BashService)

+ func NewBashService() (b *BashService)

+ func (b *BashService) GetDeepCopy() (deepCopy CommandExecutor)

+ func (b *BashService) GetHostDescription() (hostDescription string, err error)

+ func (b *BashService) MustGetHostDescription() (hostDescription string)

+ func (b *BashService) MustRunCommand(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput)

+ func (b *BashService) MustRunOneLiner(oneLiner string, verbose bool) (output *CommandOutput)

+ func (b *BashService) MustRunOneLinerAndGetStdoutAsLines(oneLiner string, verbose bool) (stdoutLines []string)

+ func (b *BashService) MustRunOneLinerAndGetStdoutAsString(oneLiner string, verbose bool) (stdout string)

+ func (b *BashService) RunCommand(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput, err error)

+ func (b *BashService) RunOneLiner(oneLiner string, verbose bool) (output *CommandOutput, err error)

+ func (b *BashService) RunOneLinerAndGetStdoutAsLines(oneLiner string, verbose bool) (stdoutLines []string, err error)

+ func (b *BashService) RunOneLinerAndGetStdoutAsString(oneLiner string, verbose bool) (stdout string, err error)

+ type CommandExecutor interface

+ GetHostDescription func() (hostDescription string, err error)

+ IsRunningOnLocalhost func() (isRunningOnLocalhost bool, err error)

+ MustGetHostDescription func() (hostDescription string)

+ MustIsRunningOnLocalhost func() (isRunningOnLocalhost bool)

+ MustRunCommand func(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput)

+ MustRunCommandAndGetStdoutAsBytes func(options *parameteroptions.RunCommandOptions) (stdout []byte)

+ MustRunCommandAndGetStdoutAsFloat64 func(options *parameteroptions.RunCommandOptions) (stdout float64)

+ MustRunCommandAndGetStdoutAsInt64 func(options *parameteroptions.RunCommandOptions) (stdout int64)

+ MustRunCommandAndGetStdoutAsLines func(options *parameteroptions.RunCommandOptions) (stdoutLines []string)

+ MustRunCommandAndGetStdoutAsString func(options *parameteroptions.RunCommandOptions) (stdout string)

+ RunCommand func(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput, err error)

+ RunCommandAndGetStdoutAsBytes func(options *parameteroptions.RunCommandOptions) (stdout []byte, err error)

+ RunCommandAndGetStdoutAsFloat64 func(options *parameteroptions.RunCommandOptions) (stdout float64, err error)

+ RunCommandAndGetStdoutAsInt64 func(options *parameteroptions.RunCommandOptions) (stdout int64, err error)

+ RunCommandAndGetStdoutAsLines func(options *parameteroptions.RunCommandOptions) (stdoutLines []string, err error)

+ RunCommandAndGetStdoutAsString func(options *parameteroptions.RunCommandOptions) (stdout string, err error)

+ func GetDeepCopyOfCommandExecutor(commandExectuor CommandExecutor) (copy CommandExecutor, err error)

+ func MustGetDeepCopyOfCommandExecutor(commandExectuor CommandExecutor) (copy CommandExecutor)

+ type CommandExecutorBase struct

+ func NewCommandExecutorBase() (c *CommandExecutorBase)

+ func (c *CommandExecutorBase) GetParentCommandExecutorForBaseClass() (parentCommandExecutorForBaseClass CommandExecutor, err error)

+ func (c *CommandExecutorBase) IsRunningOnLocalhost() (isRunningOnLocalhost bool, err error)

+ func (c *CommandExecutorBase) MustGetParentCommandExecutorForBaseClass() (parentCommandExecutorForBaseClass CommandExecutor)

+ func (c *CommandExecutorBase) MustIsRunningOnLocalhost() (isRunningOnLocalhost bool)

+ func (c *CommandExecutorBase) MustRunCommandAndGetStdoutAsBytes(options *parameteroptions.RunCommandOptions) (stdout []byte)

+ func (c *CommandExecutorBase) MustRunCommandAndGetStdoutAsFloat64(options *parameteroptions.RunCommandOptions) (stdout float64)

+ func (c *CommandExecutorBase) MustRunCommandAndGetStdoutAsInt64(options *parameteroptions.RunCommandOptions) (stdout int64)

+ func (c *CommandExecutorBase) MustRunCommandAndGetStdoutAsLines(options *parameteroptions.RunCommandOptions) (stdoutLines []string)

+ func (c *CommandExecutorBase) MustRunCommandAndGetStdoutAsString(options *parameteroptions.RunCommandOptions) (stdout string)

+ func (c *CommandExecutorBase) MustSetParentCommandExecutorForBaseClass(parentCommandExecutorForBaseClass CommandExecutor)

+ func (c *CommandExecutorBase) RunCommandAndGetStdoutAsBytes(options *parameteroptions.RunCommandOptions) (stdout []byte, err error)

+ func (c *CommandExecutorBase) RunCommandAndGetStdoutAsFloat64(options *parameteroptions.RunCommandOptions) (stdout float64, err error)

+ func (c *CommandExecutorBase) RunCommandAndGetStdoutAsInt64(options *parameteroptions.RunCommandOptions) (stdout int64, err error)

+ func (c *CommandExecutorBase) RunCommandAndGetStdoutAsLines(options *parameteroptions.RunCommandOptions) (stdoutLines []string, err error)

+ func (c *CommandExecutorBase) RunCommandAndGetStdoutAsString(options *parameteroptions.RunCommandOptions) (stdout string, err error)

+ func (c *CommandExecutorBase) SetParentCommandExecutorForBaseClass(parentCommandExecutorForBaseClass CommandExecutor) (err error)

+ type CommandOutput struct

+ func NewCommandOutput() (c *CommandOutput)

+ func (c *CommandOutput) GetCmdRunError() (cmdRunError *error, err error)

+ func (c *CommandOutput) GetFirstLineOfStdoutAsString() (firstLine string, err error)

+ func (c *CommandOutput) GetStderr() (stderr *[]byte, err error)

+ func (c *CommandOutput) GetStdout() (stdout *[]byte, err error)

+ func (c *CommandOutput) GetStdoutAsFloat64() (stdout float64, err error)

+ func (c *CommandOutput) IsStderrEmpty() (isEmpty bool, err error)

+ func (c *CommandOutput) IsStdoutAndStderrEmpty() (isEmpty bool, err error)

+ func (c *CommandOutput) IsStdoutEmpty() (isEmpty bool, err error)

+ func (c *CommandOutput) LogStdoutAsInfo() (err error)

+ func (c *CommandOutput) MustCheckExitSuccess(verbose bool)

+ func (c *CommandOutput) MustGetCmdRunError() (cmdRunError *error)

+ func (c *CommandOutput) MustGetFirstLineOfStdoutAsString() (firstLine string)

+ func (c *CommandOutput) MustGetReturnCode() (returnCode int)

+ func (c *CommandOutput) MustGetStderr() (stderr *[]byte)

+ func (c *CommandOutput) MustGetStderrAsString() (stdout string)

+ func (c *CommandOutput) MustGetStdout() (stdout *[]byte)

+ func (c *CommandOutput) MustGetStdoutAsBytes() (stdout []byte)

+ func (c *CommandOutput) MustGetStdoutAsFloat64() (stdout float64)

+ func (c *CommandOutput) MustGetStdoutAsLines(removeLastLineIfEmpty bool) (stdoutLines []string)

+ func (c *CommandOutput) MustGetStdoutAsString() (stdout string)

+ func (c *CommandOutput) MustIsStderrEmpty() (isEmpty bool)

+ func (c *CommandOutput) MustIsStdoutAndStderrEmpty() (isEmpty bool)

+ func (c *CommandOutput) MustIsStdoutEmpty() (isEmpty bool)

+ func (c *CommandOutput) MustIsTimedOut() (IsTimedOut bool)

+ func (c *CommandOutput) MustLogStdoutAsInfo()

+ func (c *CommandOutput) MustSetReturnCode(returnCode int)

+ func (c *CommandOutput) MustSetStderr(stderr []byte)

+ func (c *CommandOutput) MustSetStderrByString(stderr string)

+ func (c *CommandOutput) MustSetStdout(stdout []byte)

+ func (c *CommandOutput) MustSetStdoutByString(stdout string)

+ func (o *CommandOutput) CheckExitSuccess(verbose bool) (err error)

+ func (o *CommandOutput) GetCmdRunErrorStringOrEmptyStringIfUnset() (cmdRunErrorString string)

+ func (o *CommandOutput) GetReturnCode() (returnCode int, err error)

+ func (o *CommandOutput) GetStderrAsString() (stderr string, err error)

+ func (o *CommandOutput) GetStderrAsStringOrEmptyIfUnset() (stderr string)

+ func (o *CommandOutput) GetStdoutAsBytes() (stdout []byte, err error)

+ func (o *CommandOutput) GetStdoutAsLines(removeLastLineIfEmpty bool) (stdoutLines []string, err error)

+ func (o *CommandOutput) GetStdoutAsString() (stdout string, err error)

+ func (o *CommandOutput) IsExitSuccess() (isSuccess bool)

+ func (o *CommandOutput) IsTimedOut() (IsTimedOut bool, err error)

+ func (o *CommandOutput) SetCmdRunError(err error)

+ func (o *CommandOutput) SetReturnCode(returnCode int) (err error)

+ func (o *CommandOutput) SetStderr(stderr []byte) (err error)

+ func (o *CommandOutput) SetStderrByString(stderr string) (err error)

+ func (o *CommandOutput) SetStdout(stdout []byte) (err error)

+ func (o *CommandOutput) SetStdoutByString(stdout string) (err error)

+ type ExecService struct

+ func Exec() (e *ExecService)

+ func NewExec() (e *ExecService)

+ func NewExecService() (e *ExecService)

+ func (e *ExecService) GetDeepCopy() (deepCopy CommandExecutor)

+ func (e *ExecService) GetHostDescription() (hostDescription string, err error)

+ func (e *ExecService) MustGetHostDescription() (hostDescription string)

+ func (e *ExecService) MustRunCommand(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput)

+ func (e *ExecService) RunCommand(options *parameteroptions.RunCommandOptions) (commandOutput *CommandOutput, err error)