command

Documentation

Overview

Package command provides a uniform interface for executing commands on local and remote hosts.

Index

• type CommandResult
• type Executor
• type LocalExecutor
  • func NewLocalExecutor(config LocalExecutorConfig) *LocalExecutor
  • func (e *LocalExecutor) Exec(ctx context.Context, command string) (*CommandResult, error)
• type LocalExecutorConfig
• type MockExecutor
  • func NewMockExecutor(rules []MockRule) *MockExecutor
  • func (e *MockExecutor) Exec(ctx context.Context, command string) (*CommandResult, error)
• type MockRule
• type RemoteExecutor
  • func NewRemoteExecutor(config RemoteExecutorConfig) *RemoteExecutor
  • func (e *RemoteExecutor) Exec(ctx context.Context, command string) (*CommandResult, error)
  • func (e *RemoteExecutor) Shutdown(ctx context.Context) error
  • func (e *RemoteExecutor) Startup(ctx context.Context) error
• type RemoteExecutorConfig

Types

type CommandResult

type CommandResult struct {
	Stdout   string
	Stderr   string
	ExitCode int
}

type Executor

type Executor interface {
	Exec(ctx context.Context, command string) (*CommandResult, error)
}

type LocalExecutor

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

func NewLocalExecutor

func NewLocalExecutor(config LocalExecutorConfig) *LocalExecutor

func (*LocalExecutor) Exec

func (e *LocalExecutor) Exec(ctx context.Context, command string) (*CommandResult, error)

type LocalExecutorConfig

type LocalExecutorConfig struct {
	RunAsRoot bool
}

type MockExecutor

type MockExecutor struct {
	Rules []MockRule
}

func NewMockExecutor

func NewMockExecutor(rules []MockRule) *MockExecutor

func (*MockExecutor) Exec

func (e *MockExecutor) Exec(ctx context.Context, command string) (*CommandResult, error)

type MockRule

type MockRule struct {
	// CommandContains is a string that must be present in the command for the rule to match.
	CommandContains string
	// Stdout is the simulated standard output.
	Stdout string
	// Stderr is the simulated standard error.
	Stderr string
	// ExitCode is the simulated exit code.
	ExitCode int
}

type RemoteExecutor

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

func NewRemoteExecutor

func NewRemoteExecutor(config RemoteExecutorConfig) *RemoteExecutor

func (*RemoteExecutor) Exec

func (e *RemoteExecutor) Exec(ctx context.Context, command string) (*CommandResult, error)

func (*RemoteExecutor) Shutdown

func (e *RemoteExecutor) Shutdown(ctx context.Context) error

func (*RemoteExecutor) Startup

func (e *RemoteExecutor) Startup(ctx context.Context) error

type RemoteExecutorConfig

type RemoteExecutorConfig struct {
	RunAsRoot bool
	Address   string `validate:"required"`
	Port      uint16 `validate:"required"`
	Username  string `validate:"required"`
	Password  string
}