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 ParseParams(text string) (map[string]interface{}, error)
• 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 LookupFunc
• type LookupGraphFunc
• type Mode
• type ParamIsSetValidator
  • func (v *ParamIsSetValidator) Execute(t *Template) (errs []error)
• type Runner
  • func (ru *Runner) Run() error
• type Template
  • 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) HasErrors() bool
  • func (te *Template) Revert() (*Template, error)
  • func (s *Template) Run(env *Env) (*Template, error)
  • func (t *Template) UniqueDefinitions(apis map[string]string) (res []string)
  • func (s *Template) Validate(rules ...Validator) (all []error)
  • func (s *Template) WithRefsIterator() (nodes []ast.WithRefs)
• type TemplateExecution
  • func (t *TemplateExecution) Date() time.Time
  • func (t *TemplateExecution) IsOneLiner() bool
  • func (t *TemplateExecution) MarshalJSON() ([]byte, error)
  • func (t *TemplateExecution) SetMessage(s string)
  • func (t *TemplateExecution) Stats() *TemplateExecutionStats
  • func (t *TemplateExecution) UnmarshalJSON(b []byte) error
• type TemplateExecutionStats
  • func (te *TemplateExecutionStats) AllKO() bool
• type UniqueNameValidator
  • func (v *UniqueNameValidator) Execute(t *Template) (errs []error)
• type Validator

Variables

var (
	TestCompileMode = []compileFunc{
		verifyCommandsDefinedPass,
		failOnDeclarationWithNoResultPass,
		validateCommandsParamsPass,
		normalizeMissingRequiredParamsAsHolePass,
		checkInvalidReferenceDeclarationsPass,
		resolveHolesPass,
		resolveMissingHolesPass,
		resolveAliasPass,
		inlineVariableValuePass,
	}

	NewRunnerCompileMode = []compileFunc{
		verifyCommandsDefinedPass,
		failOnDeclarationWithNoResultPass,
		validateCommandsParamsPass,
		normalizeMissingRequiredParamsAsHolePass,
		checkInvalidReferenceDeclarationsPass,
		resolveHolesPass,
		resolveMissingHolesPass,
		resolveAliasPass,
		inlineVariableValuePass,
		failOnUnresolvedHolesPass,
		failOnUnresolvedAliasPass,
		convertParamsPass,
		validateCommandsPass,
		injectCommandsPass,
	}
)

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 ParseParams

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

Types

type Env

type Env struct {
	Lookuper LookupFunc
	IsDryRun bool

	ResolvedVariables map[string]interface{}

	Fillers          map[string]interface{}
	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 LookupFunc

type LookupFunc func(...string) interface{}

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 Runner

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

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

func (*Runner) Run

func (ru *Runner) Run() 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) CommandNodesIterator

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

func (*Template) CommandNodesReverseIterator

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

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(apis map[string]string) (res []string)

func (*Template) Validate

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

func (*Template) WithRefsIterator

func (s *Template) WithRefsIterator() (nodes []ast.WithRefs)

type TemplateExecution

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

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

func (*TemplateExecution) Date

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

Date extract the date from the ulid template identifier

func (*TemplateExecution) IsOneLiner

func (t *TemplateExecution) IsOneLiner() bool

func (*TemplateExecution) MarshalJSON

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

func (*TemplateExecution) SetMessage

func (t *TemplateExecution) SetMessage(s string)

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

func (*TemplateExecution) Stats

func (t *TemplateExecution) Stats() *TemplateExecutionStats

func (*TemplateExecution) UnmarshalJSON

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

type TemplateExecutionStats

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

func (*TemplateExecutionStats) AllKO

func (te *TemplateExecutionStats) AllKO() bool

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
}