template

Documentation

Index

• Variables
• func Compile(tpl *Template, env *Env, mode ...Mode) (*Template, *Env, error)
• func IsRevertible(t *Template) bool
• func MatchStringParamValue(s string) bool
• func NewDefaultPrinter(w io.Writer) *defaultPrinter
• func NewJSONPrinter(w io.Writer) *jsonPrinter
• func NewLogPrinter(w io.Writer) *logPrinter
• func ParseParams(text string) (map[string]interface{}, error)
• type Definition
  • func (def Definition) Extra() []string
  • func (def Definition) GetTemplate() (*Template, error)
  • func (def Definition) Name() string
  • func (def Definition) Required() []string
  • func (def Definition) String() string
• type DefinitionLookupFunc
• type Definitions
  • func (defs Definitions) Map(fn func(Definition) string) (reduced []string)
• type Env
  • func NewEnv() *Env
  • func (e *Env) AddFillers(fills ...map[string]interface{})
  • func (e *Env) GetProcessedFillers() (copy map[string]interface{})
• type Errors
  • func (d *Errors) Error() string
  • func (d *Errors) Errors() ([]error, bool)
• type LookupGraphFunc
• type Mode
• type ParamIsSetValidator
  • func (v *ParamIsSetValidator) Execute(t *Template) (errs []error)
• type Printer
• type Template
  • func MustParse(text string) *Template
  • func Parse(text string) (tmpl *Template, err error)
  • func (s *Template) CmdNodesReverseIterator() (nodes []*ast.CommandNode)
  • func (s *Template) CommandNodesIterator() (nodes []*ast.CommandNode)
  • func (s *Template) DryRun(env *Env) error
  • func (t *Template) HasErrors() bool
  • func (te *Template) Revert() (*Template, error)
  • func (s *Template) Run(env *Env) (*Template, error)
  • func (t *Template) UniqueDefinitions(fn DefinitionLookupFunc) (definitions Definitions)
  • func (s *Template) Validate(rules ...Validator) (all []error)
• type TemplateExecution
  • func (t *TemplateExecution) MarshalJSON() ([]byte, error)
  • func (t *TemplateExecution) UnmarshalJSON(b []byte) error
• type UniqueNameValidator
  • func (v *UniqueNameValidator) Execute(t *Template) (errs []error)
• type Validator

Variables

var (
	LenientCompileMode = []compileFunc{
		resolveAgainstDefinitions,
		checkInvalidReferenceDeclarations,
		resolveHolesPass,
		resolveMissingHolesPass,
		replaceVariableValuePass,
		removeValueStatementsPass,
		resolveAliasPass,
	}

	NormalCompileMode = append(
		LenientCompileMode,
		failOnUnresolvedHoles,
		failOnUnresolvedAlias,
	)
)

Functions

func Compile

func Compile(tpl *Template, env *Env, mode ...Mode) (*Template, *Env, error)

func IsRevertible

func IsRevertible(t *Template) bool

func MatchStringParamValue

func MatchStringParamValue(s string) bool

func NewDefaultPrinter

func NewDefaultPrinter(w io.Writer) *defaultPrinter

func NewJSONPrinter

func NewJSONPrinter(w io.Writer) *jsonPrinter

func NewLogPrinter

func NewLogPrinter(w io.Writer) *logPrinter

func ParseParams

func ParseParams(text string) (map[string]interface{}, error)

Types

type Definition

type Definition struct {
	Action, Entity, Api         string
	RequiredParams, ExtraParams []string
}

func (Definition) Extra

func (def Definition) Extra() []string

func (Definition) GetTemplate

func (def Definition) GetTemplate() (*Template, error)

func (Definition) Name

func (def Definition) Name() string

func (Definition) Required

func (def Definition) Required() []string

func (Definition) String

func (def Definition) String() string

type DefinitionLookupFunc

type DefinitionLookupFunc func(key string) (Definition, bool)

type Definitions

type Definitions []Definition

func (Definitions) Map

func (defs Definitions) Map(fn func(Definition) string) (reduced []string)

type Env

type Env struct {
	Driver driver.Driver

	ResolvedReferences map[string]interface{}

	Fillers          map[string]interface{}
	DefLookupFunc    DefinitionLookupFunc
	AliasFunc        func(entity, key, alias string) string
	MissingHolesFunc func(string) interface{}
	Log              *logger.Logger
	// contains filtered or unexported fields
}

func NewEnv

func NewEnv() *Env

func (*Env) AddFillers

func (e *Env) AddFillers(fills ...map[string]interface{})

func (*Env) GetProcessedFillers

func (e *Env) GetProcessedFillers() (copy map[string]interface{})

type Errors

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

func (*Errors) Error

func (d *Errors) Error() string

func (*Errors) Errors

func (d *Errors) Errors() ([]error, bool)

type LookupGraphFunc

type LookupGraphFunc func(key string) (*graph.Graph, bool)

type Mode

type Mode []compileFunc

type ParamIsSetValidator

type ParamIsSetValidator struct {
	Entity, Action, Param, WarningMessage string
}

func (*ParamIsSetValidator) Execute

func (v *ParamIsSetValidator) Execute(t *Template) (errs []error)

type Printer

type Printer interface {
	Print(*TemplateExecution) error
}

type Template

type Template struct {
	ID string
	*ast.AST
}

func MustParse

func MustParse(text string) *Template

func Parse

func Parse(text string) (tmpl *Template, err error)

func (*Template) CmdNodesReverseIterator

func (s *Template) CmdNodesReverseIterator() (nodes []*ast.CommandNode)

func (*Template) CommandNodesIterator

func (s *Template) CommandNodesIterator() (nodes []*ast.CommandNode)

func (*Template) DryRun

func (s *Template) DryRun(env *Env) error

func (*Template) HasErrors

func (t *Template) HasErrors() bool

func (*Template) Revert

func (te *Template) Revert() (*Template, error)

func (*Template) Run

func (s *Template) Run(env *Env) (*Template, error)

func (*Template) UniqueDefinitions

func (t *Template) UniqueDefinitions(fn DefinitionLookupFunc) (definitions Definitions)

func (*Template) Validate

func (s *Template) Validate(rules ...Validator) (all []error)

type TemplateExecution

type TemplateExecution struct {
	*Template
	Author, Source, Locale, Profile string
	Fillers                         map[string]interface{}
}

Allow template executions serialization with context for JSON storage without altering the template.Template model

func (*TemplateExecution) MarshalJSON

func (t *TemplateExecution) MarshalJSON() ([]byte, error)

func (*TemplateExecution) UnmarshalJSON

func (t *TemplateExecution) UnmarshalJSON(b []byte) error

type UniqueNameValidator

type UniqueNameValidator struct {
	LookupGraph LookupGraphFunc
}

func (*UniqueNameValidator) Execute

func (v *UniqueNameValidator) Execute(t *Template) (errs []error)

type Validator

type Validator interface {
	Execute(t *Template) []error
}