templates

Documentation

Index

• func Get(name string) (check.Template, bool)
• func List() []check.Template
• func Register(t check.Template)
• type TemplateTestSuite
  • func (s *TemplateTestSuite) Init(templateKey string)
  • func (s *TemplateTestSuite) Validate(ctx lintcontext.LintContext, cases []TestCase)
• type TestCase

Functions

func Get

func Get(name string) (check.Template, bool)

Get gets a template by name, returning a boolean indicating whether it was found.

func List

func List() []check.Template

List returns all known templates, sorted by name.

func Register

func Register(t check.Template)

Register registers a template with the given name. Intended to be called at program init time.

Types

type TemplateTestSuite

type TemplateTestSuite struct {
	suite.Suite

	Template check.Template
}

TemplateTestSuite is a basic testing suite for all templates test with some generic helper functions

func (*TemplateTestSuite) Init

func (s *TemplateTestSuite) Init(templateKey string)

Init initializes the test suite with a template

func (*TemplateTestSuite) Validate

func (s *TemplateTestSuite) Validate(
	ctx lintcontext.LintContext,
	cases []TestCase,
)

Validate validates the given test cases against the LintContext passed in.

type TestCase

type TestCase struct {
	Param                    interface{}
	Diagnostics              map[string][]diagnostic.Diagnostic
	ExpectInstantiationError bool
}

TestCase represents a single test case which can be verified under a LintContext