plugin

Documentation

Index

• Variables
• type FmtOptions
• type InitOptions
• type Plugin
  • func New(options wp.Options, settings *Settings) *Plugin
  • func (p *Plugin) Execute() error
  • func (p *Plugin) FlagsFromContext() error
  • func (p *Plugin) Validate() error
• type Settings

Variables

var (
	ErrTaintedPath        = errors.New("filepath is tainted")
	ErrMaxSizeSizeLimit   = errors.New("max size limit of decoded data exceeded")
	ErrActionUnknown      = errors.New("action not found")
	ErrInvalidTofuVersion = errors.New("invalid version string")
	ErrHTTPError          = errors.New("http error")
)

Types

type FmtOptions

type FmtOptions struct {
	List  *bool `json:"list"`
	Write *bool `json:"write"`
	Diff  *bool `json:"diff"`
	Check *bool `json:"check"`
}

FmtOptions fmt options for the OpenTofu fmt command.

type InitOptions

type InitOptions struct {
	BackendConfig []string `json:"backend-config"`
	Lock          *bool    `json:"lock"`
	LockTimeout   string   `json:"lock-timeout"`
}

InitOptions include options for the OpenTofu init command.

type Plugin

type Plugin struct {
	*wp.Plugin
	Settings *Settings
}

Plugin implements provide the plugin.

func New

func New(options wp.Options, settings *Settings) *Plugin

func (*Plugin) Execute

func (p *Plugin) Execute() error

Execute provides the implementation of the plugin.

func (*Plugin) FlagsFromContext

func (p *Plugin) FlagsFromContext() error

func (*Plugin) Validate

func (p *Plugin) Validate() error

Validate handles the settings validation of the plugin.

type Settings

type Settings struct {
	Action cli.StringSlice

	TofuVersion string
	InitOptions InitOptions
	FmtOptions  FmtOptions

	RootDir     string
	DataDir     string
	OutFile     string
	Parallelism int
	Targets     cli.StringSlice
	Refresh     bool
	NoLog       bool
}

Settings for the Plugin.