testutil

package

v2.0.0-beta.4 Latest Latest Go to latest Published: Jul 8, 2026 License: MIT Imports: 15 Imported by: 0

Details

Package testutil provides utilities for unit tests.

This section is empty.

This section is empty.

func DiffPretty[T1 []byte | string, T2 []byte | string](v1 T1, v2 T2) []byte

DiffPretty returns pretty formatted diff between given bytes.

func DoTestCase(m MarkdownToStringFunc, testCase MarkdownTestCase, t TestingT)

DoTestCase runs a test case.

func DoTestCaseFile(m MarkdownToStringFunc, filename string, t TestingT, no ...int)

DoTestCaseFile runs test cases in a given file.

func DoTestCases(m MarkdownToStringFunc, cases []MarkdownTestCase, t TestingT)

DoTestCases runs a set of test cases.

func ParseCliCaseArg() []int

ParseCliCaseArg parses -case command line args.

type MarkdownTestCase struct {
	No          int
	Description string
	Options     MarkdownTestCaseOptions
	Markdown    string
	Expected    string
}

MarkdownTestCase represents a test case.

type MarkdownTestCaseOptions struct {
	EnableEscape bool
	Trim         bool
}

MarkdownTestCaseOptions represents options for each test case.

type MarkdownToStringFunc func(source string) (string, error)

MarkdownToStringFunc is a function type that converts markdown to HTML.

func NewMarkdownToStringFunc(p parser.Parser, r renderer.Renderer[io.Writer]) MarkdownToStringFunc

NewMarkdownToStringFunc returns a MarkdownToStringFunc that uses the given parser and renderer.

type TestingT interface {
	Logf(string, ...any)
	Skipf(string, ...any)
	Errorf(string, ...any)
	FailNow()
}

TestingT is a subset of the functionality provided by testing.T.