workspace

Documentation

Index

• func IsNoTfVersionSelected(err error) bool
• func IsVersionSelectionNotFound(err error) bool
• func ReadSingleLineFrom(fileReader io.Reader) (string, error)
• type Config
• type SelectionSourceType
• type TerraformVersionSelection
  • func (config *TerraformVersionSelection) Source() string
  • func (config *TerraformVersionSelection) VersionSpec() *version.TerraformVersionSpec
• type Workspace
  • func GetWorkspace() (*Workspace, error)
  • func (workspace *Workspace) GetConfig() *Config
  • func (workspace *Workspace) GetTerraformVersionSelection() (*TerraformVersionSelection, error)
  • func (workspace *Workspace) WriteTerraformVersionSelection(tfVersionSelection string) error

Functions

func IsNoTfVersionSelected

func IsNoTfVersionSelected(err error) bool

IsNoTfVersionSelected answer if an error's cause is that no terraform version has been selected.

func IsVersionSelectionNotFound

func IsVersionSelectionNotFound(err error) bool

IsVersionSelectionNotFound answers if an error means that no .terraform-version file could be found.

func ReadSingleLineFrom

func ReadSingleLineFrom(fileReader io.Reader) (string, error)

ReadSingleLineFrom reads a single line, in case of multiples the last one, with comment lines (starting with #) or empty ones being skipped

Types

type Config

type Config struct {
	Sources []string
	Verbose bool `ini:"verbose"`
}

Config is the tfvm config.

type SelectionSourceType

type SelectionSourceType int

SelectionSourceType describes the method how a TerraformVersionSelection is selected.

const (
	// File means the terraform version is selected via a .terraform-version file.
	File SelectionSourceType = 0
	// Env means the terraform version is selected via a env variable.
	Env SelectionSourceType = 1
)

type TerraformVersionSelection

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

TerraformVersionSelection describes the result of version selection.

func (*TerraformVersionSelection) Source

func (config *TerraformVersionSelection) Source() string

Source gives the source of version section.

func (*TerraformVersionSelection) VersionSpec

func (config *TerraformVersionSelection) VersionSpec() *version.TerraformVersionSpec

VersionSpec returns the version specification in the TerraformVersionSelection.

type Workspace

type Workspace struct {
	RootDir string
	Config  *Config
}

Workspace represents a workspace, that possibly contains a .terraform-version file with a terraform version selection.

func GetWorkspace

func GetWorkspace() (*Workspace, error)

GetWorkspace returns an initialized workspace instance.

func (*Workspace) GetConfig

func (workspace *Workspace) GetConfig() *Config

GetConfig returns the config of a workspace.

func (*Workspace) GetTerraformVersionSelection

func (workspace *Workspace) GetTerraformVersionSelection() (*TerraformVersionSelection, error)

GetTerraformVersionSelection get the terraform version selection in a workspace.

func (*Workspace) WriteTerraformVersionSelection

func (workspace *Workspace) WriteTerraformVersionSelection(tfVersionSelection string) error

WriteTerraformVersionSelection writes a terraform selection to a .terraform-version file.