parser

Documentation

Index

• func Functions(target fs.FS, baseDir string) map[string]function.Function
• func OptionStopOnHCLError(stop bool) options.ParserOption
• func OptionWithDownloads(allowed bool) options.ParserOption
• func OptionWithTFVarsPaths(paths ...string) options.ParserOption
• func OptionWithWorkspaceName(workspaceName string) options.ParserOption
• type ConfigurableTerraformParser
• type Metrics
• type ModuleDefinition
• type ModuleResolver
• type Option
• type Parser
  • func New(moduleFS fs.FS, moduleSource string, opts ...options.ParserOption) *Parser
  • func (p *Parser) EvaluateAll(ctx context.Context) (terraform.Modules, cty.Value, error)
  • func (p *Parser) GetFilesystemMap() map[string]fs.FS
  • func (p *Parser) Metrics() Metrics
  • func (p *Parser) ParseFS(ctx context.Context, dir string) error
  • func (p *Parser) ParseFile(_ context.Context, fullPath string) error
  • func (p *Parser) SetAllowDownloads(b bool)
  • func (p *Parser) SetDebugWriter(writer io.Writer)
  • func (p *Parser) SetSkipRequiredCheck(b bool)
  • func (p *Parser) SetStopOnHCLError(b bool)
  • func (p *Parser) SetTFVarsPaths(s ...string)
  • func (p *Parser) SetWorkspaceName(s string)

Functions

func Functions

func Functions(target fs.FS, baseDir string) map[string]function.Function

Functions returns the set of functions that should be used to when evaluating expressions in the receiving scope.

func OptionStopOnHCLError

func OptionStopOnHCLError(stop bool) options.ParserOption

func OptionWithDownloads

func OptionWithDownloads(allowed bool) options.ParserOption

func OptionWithTFVarsPaths

func OptionWithTFVarsPaths(paths ...string) options.ParserOption

func OptionWithWorkspaceName

func OptionWithWorkspaceName(workspaceName string) options.ParserOption

Types

type ConfigurableTerraformParser

type ConfigurableTerraformParser interface {
	options.ConfigurableParser
	SetTFVarsPaths(...string)
	SetStopOnHCLError(bool)
	SetWorkspaceName(string)
	SetAllowDownloads(bool)
}

type Metrics

type Metrics struct {
	Timings struct {
		DiskIODuration time.Duration
		ParseDuration  time.Duration
	}
	Counts struct {
		Blocks          int
		Modules         int
		ModuleDownloads int
		Files           int
	}
}

type ModuleDefinition

type ModuleDefinition struct {
	Name       string
	Path       string
	FileSystem fs.FS
	Definition *terraform.Block
	Parser     *Parser
	External   bool
}

type ModuleResolver

type ModuleResolver interface {
	Resolve(context.Context, fs.FS, resolvers.Options) (filesystem fs.FS, prefix string, downloadPath string, applies bool, err error)
}

type Option

type Option func(p ConfigurableTerraformParser)

type Parser

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

Parser is a tool for parsing terraform templates at a given file system location

func New

func New(moduleFS fs.FS, moduleSource string, opts ...options.ParserOption) *Parser

New creates a new Parser

func (*Parser) EvaluateAll

func (p *Parser) EvaluateAll(ctx context.Context) (terraform.Modules, cty.Value, error)

func (*Parser) GetFilesystemMap

func (p *Parser) GetFilesystemMap() map[string]fs.FS

func (*Parser) Metrics

func (p *Parser) Metrics() Metrics

func (*Parser) ParseFS

func (p *Parser) ParseFS(ctx context.Context, dir string) error

ParseFS parses a root module, where it exists at the root of the provided filesystem

func (*Parser) ParseFile

func (p *Parser) ParseFile(_ context.Context, fullPath string) error

func (*Parser) SetAllowDownloads

func (p *Parser) SetAllowDownloads(b bool)

func (*Parser) SetDebugWriter

func (p *Parser) SetDebugWriter(writer io.Writer)

func (*Parser) SetSkipRequiredCheck

func (p *Parser) SetSkipRequiredCheck(b bool)

func (*Parser) SetStopOnHCLError

func (p *Parser) SetStopOnHCLError(b bool)

func (*Parser) SetTFVarsPaths

func (p *Parser) SetTFVarsPaths(s ...string)

func (*Parser) SetWorkspaceName

func (p *Parser) SetWorkspaceName(s string)