template

Documentation

Index

• Constants
• Variables
• func IsReservedName(templateName string) bool
• func RenderBody(templateBody string, aStruct interface{}) (string, error)
• func RenderWithEnrichedDefault(templateBody string, templateVars []Variable, ...) (string, error)
• type Filter
• type NotFoundError
  • func (err NotFoundError) Error() string
• type Repository
• type Service
  • func NewService(repository Repository) *Service
  • func (s *Service) Delete(ctx context.Context, name string) error
  • func (s *Service) GetByName(ctx context.Context, name string) (*Template, error)
  • func (s *Service) List(ctx context.Context, flt Filter) ([]Template, error)
  • func (s *Service) Render(ctx context.Context, name string, requestVariables map[string]string) (string, error)
  • func (s *Service) Upsert(ctx context.Context, template *Template) error
• type Template
  • func FromV1beta1Proto(proto *sirenv1beta1.Template) Template
  • func (t *Template) ToV1beta1Proto() *sirenv1beta1.Template
• type TemplateFile
• type Variable

Constants

const (
	ReservedName_SystemDefault = "system-default"
)

Variables

var (
	ErrDuplicate = errors.New("name already exist")
)

Functions

func IsReservedName

func IsReservedName(templateName string) bool

func RenderBody

func RenderBody(templateBody string, aStruct interface{}) (string, error)

func RenderWithEnrichedDefault

func RenderWithEnrichedDefault(templateBody string, templateVars []Variable, requestVariables map[string]string) (string, error)

Types

type Filter

type Filter struct {
	Tag string
}

type NotFoundError

type NotFoundError struct {
	Name string
}

func (NotFoundError) Error

func (err NotFoundError) Error() string

type Repository

type Repository interface {
	Upsert(context.Context, *Template) error
	List(context.Context, Filter) ([]Template, error)
	GetByName(context.Context, string) (*Template, error)
	Delete(context.Context, string) error
}

type Service

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

Service handles business logic

func NewService

func NewService(repository Repository) *Service

NewService returns repository struct

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, name string) error

func (*Service) GetByName

func (s *Service) GetByName(ctx context.Context, name string) (*Template, error)

func (*Service) List

func (s *Service) List(ctx context.Context, flt Filter) ([]Template, error)

func (*Service) Render

func (s *Service) Render(ctx context.Context, name string, requestVariables map[string]string) (string, error)

TODO might want to delete this and use the static function instead

func (*Service) Upsert

func (s *Service) Upsert(ctx context.Context, template *Template) error

type Template

type Template struct {
	ID        uint64     `json:"id"`
	Name      string     `json:"name" validate:"required"`
	Body      string     `json:"body" validate:"required"`
	Tags      []string   `json:"tags" validate:"required"`
	Variables []Variable `json:"variables" validate:"required,dive,required"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`
}

func FromV1beta1Proto

func FromV1beta1Proto(proto *sirenv1beta1.Template) Template

func (*Template) ToV1beta1Proto

func (t *Template) ToV1beta1Proto() *sirenv1beta1.Template

type TemplateFile

type TemplateFile struct {
	Name       string              `yaml:"name"`
	ApiVersion string              `yaml:"apiVersion"`
	Type       string              `yaml:"type"`
	Body       []templatedRuleFile `yaml:"body"`
	Tags       []string            `yaml:"tags"`
	Variables  []Variable          `yaml:"variables"`
}

type Variable

type Variable struct {
	Name        string `json:"name" validate:"required"`
	Type        string `json:"type" validate:"required"`
	Default     string `json:"default"`
	Description string `json:"description"`
}