testutil

package

v0.14.3 Latest Latest Go to latest Published: May 2, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Package testutil provides utilities for golden file testing.

This section is empty.

View Source

var UpdateGoldens = os.Getenv("UPDATE_GOLDENS") == "true"

UpdateGoldens controls whether to update golden files Set via environment variable: UPDATE_GOLDENS=true go test ./...

func AssertGoldenJSON(t *testing.T, feature, name string, actualJSON []byte)

AssertGoldenJSON compares JSON output with golden file

func CompareWithGolden(t *testing.T, feature, name string, actual interface{})

CompareWithGolden compares actual output with golden file

func CreateGoldenTest(t *testing.T, feature string, tests []struct {
	Name string
	Data interface{}
})

CreateGoldenTest creates a test that compares with golden files

func DiffJSON(expected, actual interface{}) string

DiffJSON returns a string showing the differences between two JSON values

func GetGoldenPath(feature, name string) string

GetGoldenPath returns the path to a golden file

func LoadGoldenFile(t *testing.T, feature, name string) interface{}

LoadGoldenFile loads and returns a golden file's data

type GoldenFile struct {
	Meta GoldenMeta  `json:"meta"`
	Data interface{} `json:"data"`
}

GoldenFile represents a golden test file with metadata

type GoldenMeta struct {
	GoVersion string `json:"go_version"`
	OS        string `json:"os"`
	Arch      string `json:"arch"`
}

GoldenMeta captures platform information for reproducibility