exec

Documentation

Index

• func ExecCanceledError(method string) *execCanceledErr
• func ExecTimeoutError(method string, duration time.Duration) *execTimeoutErr
• func WithExecutorFactory(ctx context.Context, f ExecutorFactory) context.Context
• func WithExecutorOpts(ctx context.Context, opts *ExecutorOpts) context.Context
• type Executor
  • func (e *Executor) Format(ctx context.Context, input []byte) ([]byte, error)
  • func (e *Executor) Get(ctx context.Context, opts ...tfexec.GetCmdOption) error
  • func (e *Executor) GetExecPath() string
  • func (e *Executor) Init(ctx context.Context, opts ...tfexec.InitOption) error
  • func (e *Executor) ProviderSchemas(ctx context.Context) (*tfjson.ProviderSchemas, error)
  • func (e *Executor) SetExecLogPath(rawPath string) error
  • func (e *Executor) SetLogger(logger *log.Logger)
  • func (e *Executor) SetTimeout(duration time.Duration)
  • func (e *Executor) Validate(ctx context.Context) ([]tfjson.Diagnostic, error)
  • func (e *Executor) Version(ctx context.Context) (*version.Version, map[string]*version.Version, error)
• type ExecutorFactory
  • func ExecutorFactoryFromContext(ctx context.Context) (ExecutorFactory, bool)
  • func NewMockExecutor(calls *TerraformMockCalls) ExecutorFactory
• type ExecutorOpts
  • func ExecutorOptsFromContext(ctx context.Context) (*ExecutorOpts, bool)
• type ExitError
  • func (e *ExitError) Error() string
  • func (e *ExitError) Unwrap() error
• type Formatter
• type TerraformExecutor
  • func NewExecutor(workDir, execPath string) (TerraformExecutor, error)
• type TerraformMockCalls

Functions

func ExecCanceledError

func ExecCanceledError(method string) *execCanceledErr

func ExecTimeoutError

func ExecTimeoutError(method string, duration time.Duration) *execTimeoutErr

func WithExecutorFactory

func WithExecutorFactory(ctx context.Context, f ExecutorFactory) context.Context

func WithExecutorOpts

func WithExecutorOpts(ctx context.Context, opts *ExecutorOpts) context.Context

Types

type Executor

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

func (*Executor) Format

func (e *Executor) Format(ctx context.Context, input []byte) ([]byte, error)

func (*Executor) Get

func (e *Executor) Get(ctx context.Context, opts ...tfexec.GetCmdOption) error

func (*Executor) GetExecPath

func (e *Executor) GetExecPath() string

func (*Executor) Init

func (e *Executor) Init(ctx context.Context, opts ...tfexec.InitOption) error

func (*Executor) ProviderSchemas

func (e *Executor) ProviderSchemas(ctx context.Context) (*tfjson.ProviderSchemas, error)

func (*Executor) SetExecLogPath

func (e *Executor) SetExecLogPath(rawPath string) error

func (*Executor) SetLogger

func (e *Executor) SetLogger(logger *log.Logger)

func (*Executor) SetTimeout

func (e *Executor) SetTimeout(duration time.Duration)

func (*Executor) Validate

func (e *Executor) Validate(ctx context.Context) ([]tfjson.Diagnostic, error)

func (*Executor) Version

func (e *Executor) Version(ctx context.Context) (*version.Version, map[string]*version.Version, error)

type ExecutorFactory

type ExecutorFactory func(workDir, execPath string) (TerraformExecutor, error)

ExecutorFactory can be used in external consumers of exec pkg to enable easy swapping with MockExecutor

func ExecutorFactoryFromContext

func ExecutorFactoryFromContext(ctx context.Context) (ExecutorFactory, bool)

func NewMockExecutor

func NewMockExecutor(calls *TerraformMockCalls) ExecutorFactory

type ExecutorOpts

type ExecutorOpts struct {
	ExecPath    string
	ExecLogPath string
	Timeout     time.Duration
}

func ExecutorOptsFromContext

func ExecutorOptsFromContext(ctx context.Context) (*ExecutorOpts, bool)

type ExitError

type ExitError struct {
	Err    *exec.ExitError
	CtxErr error

	Method string
}

func (*ExitError) Error

func (e *ExitError) Error() string

func (*ExitError) Unwrap

func (e *ExitError) Unwrap() error

type Formatter

type Formatter func(ctx context.Context, input []byte) ([]byte, error)

type TerraformExecutor

type TerraformExecutor interface {
	SetLogger(logger *log.Logger)
	SetExecLogPath(path string) error
	SetTimeout(duration time.Duration)
	GetExecPath() string
	Init(ctx context.Context, opts ...tfexec.InitOption) error
	Get(ctx context.Context, opts ...tfexec.GetCmdOption) error
	Format(ctx context.Context, input []byte) ([]byte, error)
	Version(ctx context.Context) (*version.Version, map[string]*version.Version, error)
	Validate(ctx context.Context) ([]tfjson.Diagnostic, error)
	ProviderSchemas(ctx context.Context) (*tfjson.ProviderSchemas, error)
}

func NewExecutor

func NewExecutor(workDir, execPath string) (TerraformExecutor, error)

type TerraformMockCalls

type TerraformMockCalls struct {
	PerWorkDir map[string][]*mock.Call
	AnyWorkDir []*mock.Call
}