golden

Documentation

Overview

Package golden provides tools for comparing large mutli-line strings.

Golden files are files in the ./testdata/ subdirectory of the package under test.

Index

• func Assert(t require.TestingT, actual string, filename string, msgAndArgs ...interface{}) bool
• func AssertBytes(t require.TestingT, actual []byte, filename string, msgAndArgs ...interface{}) bool
• func Get(t require.TestingT, filename string) []byte
• func Path(filename string) string

Examples

• Assert
• AssertBytes

Functions

func Assert

func Assert(t require.TestingT, actual string, filename string, msgAndArgs ...interface{}) bool

Assert compares the actual content to the expected content in the golden file. If the `-test.update-golden` flag is set then the actual content is written to the golden file. Returns whether the assertion was successful (true) or not (false)

Example

Assert(t, "foo", "foo-content.golden")

func AssertBytes

func AssertBytes(t require.TestingT, actual []byte, filename string, msgAndArgs ...interface{}) bool

AssertBytes compares the actual result to the expected result in the golden file. If the `-test.update-golden` flag is set then the actual content is written to the golden file. Returns whether the assertion was successful (true) or not (false) nolint: lll

Example

AssertBytes(t, []byte("foo"), "foo-content.golden")

func Get

func Get(t require.TestingT, filename string) []byte

Get returns the golden file content

func Path

func Path(filename string) string

Path returns the full path to a golden file