template

Documentation

Index

• Variables
• func IsRevertible(t *Template) bool
• func MatchStringParamValue(s string) bool
• func NewEnv() *envBuilder
• func NewRunEnv(cenv env.Compiling, context ...map[string]interface{}) env.Running
• func ParseParams(text string) (map[string]interface{}, error)
• type Errors
  • func (d *Errors) Error() string
  • func (d *Errors) Errors() ([]error, bool)
• type Execution
  • func (t *Execution) Date() time.Time
  • func (t *Execution) IsOneLiner() bool
  • func (t *Execution) MarshalJSON() ([]byte, error)
  • func (t *Execution) SetMessage(s string)
  • func (t *Execution) Stats() *ExecutionStats
  • func (t *Execution) UnmarshalJSON(b []byte) error
• type ExecutionStats
  • func (te *ExecutionStats) AllKO() bool
• type LookupGraphFunc
• type Mode
• type ParamIsSetValidator
  • func (v *ParamIsSetValidator) Execute(t *Template) (errs []error)
• type Runner
  • func (ru *Runner) Run() error
• type Template
  • func Compile(tpl *Template, cenv env.Compiling, mode ...Mode) (*Template, env.Compiling, error)
  • func MustParse(text string) *Template
  • func Parse(text string) (tmpl *Template, err error)
  • func (s *Template) CommandNodesIterator() (nodes []*ast.CommandNode)
  • func (s *Template) CommandNodesReverseIterator() (nodes []*ast.CommandNode)
  • func (t *Template) DryRun(renv env.Running) (tpl *Template, err error)
  • func (t *Template) HasErrors() bool
  • func (temp *Template) Revert() (*Template, error)
  • func (s *Template) Run(renv env.Running) (*Template, error)
  • func (t *Template) UniqueDefinitions(apis map[string]string) (res []string)
  • func (t *Template) Validate(rules ...Validator) (all []error)
• type UniqueNameValidator
  • func (v *UniqueNameValidator) Execute(t *Template) (errs []error)
• type Validator

Variables

var (
	// TestCompileMode is a standard template compilation Mode.
	TestCompileMode = []compileFunc{
		injectCommandsInNodesPass,
		failOnDeclarationWithNoResultPass,
		processAndValidateParamsPass,
		checkInvalidReferenceDeclarationsPass,
		resolveHolesPass,
		resolveMissingHolesPass,
		removeOptionalHolesPass,
		resolveAliasPass,
		inlineVariableValuePass,
		resolveParamsAndExtractRefsPass,
	}

	// PreRevertCompileMode is a compilation Mode for reverting templates.
	PreRevertCompileMode = []compileFunc{
		resolveParamsAndExtractRefsPass,
	}

	// NewRunnerCompileMode is a compilation Mode for new runners.
	NewRunnerCompileMode = []compileFunc{
		injectCommandsInNodesPass,
		failOnDeclarationWithNoResultPass,
		processAndValidateParamsPass,
		checkInvalidReferenceDeclarationsPass,
		resolveHolesPass,
		resolveMissingHolesPass,
		removeOptionalHolesPass,
		resolveAliasPass,
		inlineVariableValuePass,
		failOnUnresolvedHolesPass,
		failOnUnresolvedAliasPass,
		resolveParamsAndExtractRefsPass,
		convertParamsPass,
		validateCommandsPass,
	}
)

Functions

func IsRevertible

func IsRevertible(t *Template) bool

func MatchStringParamValue

func MatchStringParamValue(s string) bool

func NewEnv

func NewEnv() *envBuilder

NewEnv create a new environment.

func NewRunEnv

func NewRunEnv(cenv env.Compiling, context ...map[string]interface{}) env.Running

func ParseParams

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

Types

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 Execution

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

Execution allows template execution serialization with context for JSON storage without altering the template.Template model

func (*Execution) Date

func (t *Execution) Date() time.Time

Date extract the date from the ulid template identifier

func (*Execution) IsOneLiner

func (t *Execution) IsOneLiner() bool

func (*Execution) MarshalJSON

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

func (*Execution) SetMessage

func (t *Execution) SetMessage(s string)

SetMessage set the value of Message, truncating it if exceeds max len

func (*Execution) Stats

func (t *Execution) Stats() *ExecutionStats

func (*Execution) UnmarshalJSON

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

type ExecutionStats

type ExecutionStats struct {
	KOCount, OKCount, CmdCount int
	ActionEntityCount          map[string]int
	Oneliner                   string
}

ExecutionStats holds template execution statistics.

func (*ExecutionStats) AllKO

func (te *ExecutionStats) AllKO() bool

type LookupGraphFunc

type LookupGraphFunc func(key string) (cloud.GraphAPI, bool)

type Mode

type Mode []compileFunc

Mode defines a list of template compiler passes.

type ParamIsSetValidator

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

func (*ParamIsSetValidator) Execute

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

type Runner

type Runner struct {
	Template                               *Template
	Locale, Profile, Message, TemplatePath string
	Log                                    *logger.Logger
	Fillers                                []map[string]interface{}
	AliasFunc                              func(paramPath, alias string) string
	MissingHolesFunc                       func(string, []string, bool) string
	CmdLookuper                            func(tokens ...string) interface{}
	Validators                             []Validator
	ParamsSuggested                        int

	BeforeRun func(*Execution) (bool, error)
	AfterRun  func(*Execution) error
}

func (*Runner) Run

func (ru *Runner) Run() error

type Template

type Template struct {
	ID string
	*ast.AST
}

Template is an awless template definition.

func Compile

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

Compile a Template.

func MustParse

func MustParse(text string) *Template

func Parse

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

func (*Template) CommandNodesIterator

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

func (*Template) CommandNodesReverseIterator

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

func (*Template) DryRun

func (t *Template) DryRun(renv env.Running) (tpl *Template, err error)

DryRun performs a template dry run.

func (*Template) HasErrors

func (t *Template) HasErrors() bool

func (*Template) Revert

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

func (*Template) Run

func (s *Template) Run(renv env.Running) (*Template, error)

func (*Template) UniqueDefinitions

func (t *Template) UniqueDefinitions(apis map[string]string) (res []string)

func (*Template) Validate

func (t *Template) Validate(rules ...Validator) (all []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
}