https://github.com/xorcare/golden

Package golden testing with golden files in Go. A golden file is the expected output of test, stored as a separate file rather than as a string literal inside the test code.
https://github.com/xorcare/golden

go go-library go-package golang golden golden-tests mit testdata testing tests

Last synced: 3 days ago
JSON representation

Package golden testing with golden files in Go. A golden file is the expected output of test, stored as a separate file rather than as a string literal inside the test code.

• Host: GitHub
• URL: https://github.com/xorcare/golden
• Owner: xorcare
• License: bsd-3-clause
• Created: 2019-02-20T09:58:17.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-03T10:45:52.000Z (8 months ago)
• Last Synced: 2024-06-18T17:11:21.111Z (5 months ago)
• Topics: go, go-library, go-package, golang, golden, golden-tests, mit, testdata, testing, tests
• Language: Go
• Homepage: https://pkg.go.dev/github.com/xorcare/golden
• Size: 262 KB
• Stars: 29
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - xorcare/golden - Package golden testing with golden files in Go. A golden file is the expected output of test, stored as a separate file rather than as a string literal inside the test code. (Go)

README

        
# Golden

[![codecov](https://codecov.io/gh/xorcare/golden/badge.svg)](https://codecov.io/gh/xorcare/golden)

[![Go Report Card](https://goreportcard.com/badge/github.com/xorcare/golden)](https://goreportcard.com/report/github.com/xorcare/golden)

[![GoDoc](https://godoc.org/github.com/xorcare/golden?status.svg)](https://godoc.org/github.com/xorcare/golden)

Package golden testing with golden files in Go. A golden file is the expected

output of test, stored as a separate file rather than as a string literal inside

the test code. So when the test is executed, it will read data from the file and

compare it to the output produced by the functionality under test.

When writing unit tests, there comes a point when you need to check that the

complex output of a function matches your expectations. This could be binary

data (like an Image, JSON, HTML etc). Golden files are a way of ensuring your

function output matches its .golden file. It’s a pattern used in the Go standard

library.

One of the advantages of the gold files approach is that you can easily update

the test data using the command line flag without copying the data into the text

variables of go this is very convenient in case of  significant changes in the

behavior of the system but also requires attention to the changed test data and

checking the correctness of the new golden results.

A special cli is provided in the package. The special flag `-update` is

provided in the package for conveniently updating ethos files, for example,

using the following command:

	go test ./... -update

Golden files are placed in directory `testdata` this directory is ignored by

the standard tools go, and it can accommodate a variety of data used in test or

samples.

## Installation

```bash

go get github.com/xorcare/golden

```

## Examples

 * [golden.Assert](https://godoc.org/github.com/xorcare/golden#example-Assert)

 * [golden.Read](https://godoc.org/github.com/xorcare/golden#example-Read)

 * [golden.Run](https://godoc.org/github.com/xorcare/golden#example-Run)

## Inspiration

 * [Golden Files—Why you should use them](https://medium.com/@jarifibrahim/golden-files-why-you-should-use-them-47087ec994bf)

 * [Testing with golden files in Go](https://medium.com/soon-london/testing-with-golden-files-in-go-7fccc71c43d3)

 * [Go advanced testing tips & tricks](https://medium.com/@povilasve/go-advanced-tips-tricks-a872503ac859)