golden

Documentation

Index

• func Setup()
• func Test(t testing.TB, output string)
• func TestAgainst(t testing.TB, goldenFileName string, output string)
• func TestMain(m *testing.M)

Functions

func Setup

func Setup()

Setup sets up the golden testing functionality for the package. It can be called instead of TestMain if a package wants to do multiple main function handling.

func Test

func Test(t testing.TB, output string)

Test checks the test output against the golden file where the path to the golden file is based on the test name; i.e. `testName.golden` within the `testdata` folder. If -golden-update was passed to "go test", it writes new golden files instead.

func TestAgainst

func TestAgainst(t testing.TB, goldenFileName string, output string)

TestAgainst checks the test output against the golden file. If -golden-update was passed to "go test", it writes new golden files instead.

func TestMain

func TestMain(m *testing.M)

TestMain sets up the golden testing functionality for the package. Packages that want to integrate golden testing should themselves implement TestMain and call this function.