test

Documentation

Overview

Package test defines a tree structure that describes the tests loaded from one or more Aureus Markdown documents.

Index

• type Assertion
• type Content
• type ContentMetaData
• type Option
  • func WithAssertions(assertions ...Assertion) Option
  • func WithSkip(skip bool) Option
  • func WithSubTests(subTests ...Test) Option
• type Test
  • func New(name string, options ...Option) Test
• type TestingT
• type VisitOption
  • func WithT(t TestingT) VisitOption

Types

type Assertion

type Assertion struct {
	Input  Content
	Output Content
}

Assertion represents a requirement that an input match a specific output.

type Content

type Content struct {
	// ContentMetaData is additional information about the content.
	ContentMetaData

	// Data is the content itself.
	Data []byte
}

Content is data used as input or output in tests.

type ContentMetaData

type ContentMetaData struct {
	// File is the path of the file from which the content was loaded.
	File string

	// Line is the line number within the file where the content begins, or 0 if
	// the content represents the entire file.
	Line int

	// Language is the language of the content, if known, e.g. "json", "yaml",
	// etc. Content with an empty language is treated as plain text.
	Language string

	// Attributes is a set of key-value pairs that provide additional
	// loader-specific information about the data.
	Attributes map[string]string
}

ContentMetaData contains information about input or output content.

type Option

type Option func(*Test)

Option is an option that controls how a test is created by New.

func WithAssertions

func WithAssertions(assertions ...Assertion) Option

WithAssertions is a [TestOption] thatadds assertions to the test.

func WithSkip

func WithSkip(skip bool) Option

WithSkip is a [TestOption] that sets the skip flag.

func WithSubTests

func WithSubTests(subTests ...Test) Option

WithSubTests is a [TestOption] that adds sub-tests to the test.

type Test

type Test struct {
	Name       string
	Skip       bool
	SubTests   []Test
	Assertions []Assertion
}

Test is a (possibly nested) test.

func New

func New(name string, options ...Option) Test

New creates a new Test.

It returns the test and the set of flags that should be inherited by any sub-tests.

type TestingT

type TestingT interface {
	Helper()
}

TestingT is the subset of the *testing.T interface that is used when dispatching a visitor to ensure that the internals of the visitor mechanism are properly marked as test helpers.

type VisitOption

type VisitOption func(*visitConfig)

VisitOption is an option for configuring a visitor.

func WithT

func WithT(t TestingT) VisitOption

WithT configures the visitor to use t to mark the internal mechanism of the visitor as test helpers.