testsupport

Documentation

Index

• Variables
• func ContainAnyMessageWithLevels(level log.Level, otherLevels ...log.Level) types.GomegaMatcher
• func ContainJSONLog(level log.Level, msg string) types.GomegaMatcher
• func ContainJSONLogWithOffset(level log.Level, startOffset int, endOffset int, msg string) types.GomegaMatcher
• func MatchDocument(expected *types.Document) gomegatypes.GomegaMatcher
• func MatchDocumentFragment(expected types.DocumentFragment) gomegatypes.GomegaMatcher
• func MatchDocumentFragments(expected []types.DocumentFragment) gomegatypes.GomegaMatcher
• func MatchHTML(expected string) gomegatypes.GomegaMatcher
• func MatchHTMLFromFile(filename string) gomegatypes.GomegaMatcher
• func MatchHTMLTemplate(expectedTmpl string, data interface{}) gomegatypes.GomegaMatcher
• func MatchHTMLTemplateFile(filename string, data interface{}) gomegatypes.GomegaMatcher
• func MatchInlineElements(expected []interface{}) gomegatypes.GomegaMatcher
• func MatchMetadata(expected types.Metadata) gomegatypes.GomegaMatcher
• func MatchTableOfContents(expected *types.TableOfContents) gomegatypes.GomegaMatcher
• func ParseDocument(actual string, options ...interface{}) (*types.Document, error)
• func ParseDocumentFragments(actual string, options ...parser.Option) ([]types.DocumentFragment, error)
• func PreparseDocument(source string, options ...interface{}) (string, error)
• func RenderHTML(actual string, settings ...configuration.Setting) (string, error)
• func RenderHTMLFromFile(filename string, settings ...configuration.Setting) (string, types.Metadata, error)
• func RenderHTMLWithMetadata(actual string, settings ...configuration.Setting) (string, types.Metadata, error)
• type Console
• type ConsoleOutput
  • func ConfigureLogger(level log.Level, opts ...TeeOption) (*ConsoleOutput, func())
  • func NewConsoleOutput() *ConsoleOutput
  • func (t ConsoleOutput) Content() io.Reader
  • func (t *ConsoleOutput) Write(p []byte) (n int, err error)
• type TeeOption

Variables

var IncludeStdOut = func(t *ConsoleOutput) {
	t.out = os.Stdout
}

Functions

func ContainAnyMessageWithLevels

func ContainAnyMessageWithLevels(level log.Level, otherLevels ...log.Level) types.GomegaMatcher

ContainAnyMessageWithLevels a custom Matcher to verify that no message with the any of the given levels was logged

func ContainJSONLog

func ContainJSONLog(level log.Level, msg string) types.GomegaMatcher

ContainJSONLog a custom Matcher to verify that a message at a given level was logged

func ContainJSONLogWithOffset

func ContainJSONLogWithOffset(level log.Level, startOffset int, endOffset int, msg string) types.GomegaMatcher

ContainJSONLogWithOffset a custom Matcher to verify that a message with offset position and at a given level was logged

func MatchDocument

func MatchDocument(expected *types.Document) gomegatypes.GomegaMatcher

MatchDocument a custom matcher to verify that a document matches the given expectation Similar to the standard `Equal` matcher, but display a diff when the values don't match

func MatchDocumentFragment

func MatchDocumentFragment(expected types.DocumentFragment) gomegatypes.GomegaMatcher

MatchDocumentFragment a custom matcher to verify that a document matches the given expectation Similar to the standard `Equal` matcher, but display a diff when the values don't match

func MatchDocumentFragments

func MatchDocumentFragments(expected []types.DocumentFragment) gomegatypes.GomegaMatcher

MatchDocumentFragments a custom matcher to verify that a document matches the given expectation Similar to the standard `Equal` matcher, but display a diff when the values don't match

func MatchHTML

func MatchHTML(expected string) gomegatypes.GomegaMatcher

MatchHTML a custom matcher to verify that a document renders as the given template which will be processed with the given args

func MatchHTMLFromFile

func MatchHTMLFromFile(filename string) gomegatypes.GomegaMatcher

MatchHTMLFromFile a custom matcher to verify that a document renders as the content of the file with the given name

func MatchHTMLTemplate

func MatchHTMLTemplate(expectedTmpl string, data interface{}) gomegatypes.GomegaMatcher

MatchHTMLTemplate a custom matcher to verify that a document renders as the given template which will be processed with the given args

func MatchHTMLTemplateFile

func MatchHTMLTemplateFile(filename string, data interface{}) gomegatypes.GomegaMatcher

MatchHTMLTemplate a custom matcher to verify that a document renders as the given template which will be processed with the given args

func MatchInlineElements

func MatchInlineElements(expected []interface{}) gomegatypes.GomegaMatcher

MatchInlineElements a custom matcher to verify that a document matches the given expectation Similar to the standard `Equal` matcher, but display a diff when the values don't match

func MatchMetadata

func MatchMetadata(expected types.Metadata) gomegatypes.GomegaMatcher

func MatchTableOfContents

func MatchTableOfContents(expected *types.TableOfContents) gomegatypes.GomegaMatcher

MatchTableOfContents a custom matcher to verify that a TableOfContents matches the given expectation Similar to the standard `Equal` matcher, but display a diff when the values don't match

func ParseDocument

func ParseDocument(actual string, options ...interface{}) (*types.Document, error)

ParseDocument parses the actual value into a Document

func ParseDocumentFragments

func ParseDocumentFragments(actual string, options ...parser.Option) ([]types.DocumentFragment, error)

ParseDocumentFragments parses the actual source with the options

func PreparseDocument

func PreparseDocument(source string, options ...interface{}) (string, error)

func RenderHTML

func RenderHTML(actual string, settings ...configuration.Setting) (string, error)

RenderHTML renders the HTML body using the given source

func RenderHTMLFromFile

func RenderHTMLFromFile(filename string, settings ...configuration.Setting) (string, types.Metadata, error)

RenderHTML renders the HTML body using the given source

func RenderHTMLWithMetadata

func RenderHTMLWithMetadata(actual string, settings ...configuration.Setting) (string, types.Metadata, error)

RenderHTML renders the HTML body using the given source

Types

type Console

type Console interface {
	Content() io.Reader
}

type ConsoleOutput

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

func ConfigureLogger

func ConfigureLogger(level log.Level, opts ...TeeOption) (*ConsoleOutput, func())

func NewConsoleOutput

func NewConsoleOutput() *ConsoleOutput

func (ConsoleOutput) Content

func (t ConsoleOutput) Content() io.Reader

func (*ConsoleOutput) Write

func (t *ConsoleOutput) Write(p []byte) (n int, err error)

type TeeOption

type TeeOption func(*ConsoleOutput)