gomplate

README

Gomplate

Flanksource Gomplate is a fork of the https://github.com/hairyhenderson/gomplate tool and adds

• A standard library interface for running templates using:
  • Go text/template
  • CEL (with celext, kubernetes extensions, and many gomplate functions remapped)
  • Javascript (otto)

Documentation

Index

• func CreateFuncs(ctx context.Context) template.FuncMap
• func GetCelEnv(environment map[string]any) []cel.EnvOption
• func LoadSharedLibrary(source string) error
• func RegisterType(i any)
• func RunExpression(_environment map[string]any, template Template) (any, error)
• func RunExpressionContext(ctx commonsContext.Context, _environment map[string]any, template Template) (any, error)
• func RunTemplate(environment map[string]any, template Template) (string, error)
• func RunTemplateBool(environment map[string]any, template Template) (bool, error)
• func RunTemplateContext(ctx commonsContext.Context, environment map[string]any, template Template) (string, error)
• func Serialize(in map[string]any) (map[string]any, error)
• type AsMapper
• type Delims
• type MetricsType
• type StructTemplater
  • func (w StructTemplater) Struct(reflect.Value) error
  • func (w StructTemplater) StructField(f reflect.StructField, v reflect.Value) error
  • func (w StructTemplater) Template(val string) (string, error)
  • func (w StructTemplater) Walk(object interface{}) error
• type Template
  • func (t Template) CacheKey(env map[string]any) string
  • func (t Template) IsCacheable() bool
  • func (t Template) IsEmpty() bool
  • func (t Template) ShortString() string
  • func (t Template) String() string

Functions

func CreateFuncs

func CreateFuncs(ctx context.Context) template.FuncMap

CreateFuncs - function mappings are created here

func GetCelEnv

func GetCelEnv(environment map[string]any) []cel.EnvOption

func LoadSharedLibrary

func LoadSharedLibrary(source string) error

LoadSharedLibrary loads a shared library for Otto

func RegisterType

func RegisterType(i any)

func RunExpression

func RunExpression(_environment map[string]any, template Template) (any, error)

func RunExpressionContext

func RunExpressionContext(ctx commonsContext.Context, _environment map[string]any, template Template) (any, error)

func RunTemplate

func RunTemplate(environment map[string]any, template Template) (string, error)

func RunTemplateBool

func RunTemplateBool(environment map[string]any, template Template) (bool, error)

func RunTemplateContext

func RunTemplateContext(ctx commonsContext.Context, environment map[string]any, template Template) (string, error)

func Serialize

func Serialize(in map[string]any) (map[string]any, error)

Serialize iterates over each key-value pair in the input map serializes any struct value to map[string]any.

Types

type AsMapper

type AsMapper interface {
	AsMap(fields ...string) map[string]any
}

type Delims

type Delims struct {
	Left, Right string
}

type MetricsType

type MetricsType struct {
	// times for rendering each template
	RenderDuration map[string]time.Duration
	// time it took to gather templates
	GatherDuration time.Duration
	// time it took to render all templates
	TotalRenderDuration time.Duration

	TemplatesGathered  int
	TemplatesProcessed int
	Errors             int
}

MetricsType - Warning: experimental! This may change in breaking ways without warning. This is not subject to any semantic versioning guarantees!

var Metrics *MetricsType

Metrics tracks interesting basic metrics around gomplate executions. Warning: experimental! This may change in breaking ways without warning. This is not subject to any semantic versioning guarantees!

type StructTemplater

type StructTemplater struct {
	Context context.Context
	Values  map[string]interface{}
	// IgnoreFields from walking where key is field name and value is field type
	IgnoreFields map[string]string
	Funcs        map[string]any
	DelimSets    []Delims
	// If specified create a function for each value so that is can be accessed via {{ value }} in addition to {{ .value }}
	ValueFunctions bool
	RequiredTag    string
}

func (StructTemplater) Struct

func (w StructTemplater) Struct(reflect.Value) error

this func is required to fulfil the reflectwalk.StructWalker interface

func (StructTemplater) StructField

func (w StructTemplater) StructField(f reflect.StructField, v reflect.Value) error

func (StructTemplater) Template

func (w StructTemplater) Template(val string) (string, error)

func (StructTemplater) Walk

func (w StructTemplater) Walk(object interface{}) error

type Template

type Template struct {
	Template   string `yaml:"template,omitempty" json:"template,omitempty"` // Go template
	JSONPath   string `yaml:"jsonPath,omitempty" json:"jsonPath,omitempty"`
	Expression string `yaml:"expr,omitempty" json:"expr,omitempty"` // A cel-go expression
	Javascript string `yaml:"javascript,omitempty" json:"javascript,omitempty"`
	RightDelim string `yaml:"-" json:"-"`
	LeftDelim  string `yaml:"-" json:"-"`

	// Pass in additional cel-env options like functions
	// that aren't simple enough to be included in Functions
	CelEnvs []cel.EnvOption `yaml:"-" json:"-"`

	// A map of functions that are accessible to cel expressions
	// and go templates.
	// NOTE: For cel expressions, the functions must be of type func() any.
	// If any other function type is used, an error will be returned.
	// Opt to CelEnvs for those cases.
	Functions map[string]any `yaml:"-" json:"-"`
}

func (Template) CacheKey

func (t Template) CacheKey(env map[string]any) string

func (Template) IsCacheable

func (t Template) IsCacheable() bool

func (Template) IsEmpty

func (t Template) IsEmpty() bool

func (Template) ShortString

func (t Template) ShortString() string

func (Template) String

func (t Template) String() string