Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/approvals/go-approval-tests
https://github.com/approvals/go-approval-tests
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/approvals/go-approval-tests
- Owner: approvals
- License: apache-2.0
- Created: 2016-07-05T14:26:32.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T15:25:56.000Z (5 months ago)
- Last Synced: 2024-06-28T08:39:31.867Z (3 months ago)
- Language: Go
- Size: 123 KB
- Stars: 86
- Watchers: 4
- Forks: 21
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ApprovalTests.go
ApprovalTests for [go](https://golang.org/)
[](https://godoc.org/github.com/approvals/go-approval-tests)
[](https://goreportcard.com/report/github.com/approvals/go-approval-tests)
[](https://codecov.io/gh/approvals/go-approval-tests)
[](https://github.com/approvals/go-approval-tests/actions/workflows/test.yml)
# Golden master Verification Library
ApprovalTests allows for easy testing of larger objects, strings and anything else that can be saved to a file (images, sounds, csv, etc...)
# Examples
## Basic string verification
```go
func TestHelloWorld(t *testing.T) {
approvals.VerifyString(t, "Hello World!")
}
```
## Store approved files in testdata subfolder
Some people prefer to store their approved files in a subfolder "testdata" instead of in the same folder as the
production code. To configure this, add a call to UseFolder to your TestMain:
```go
func TestMain(m *testing.M) {
UseFolder("testdata")
os.Exit(m.Run())
}
```
## In Project
Note: ApprovalTests uses approvals to test itself. Therefore there are many examples in the code itself.
- [approvals_test.go](approvals_test.go)
## JSON
VerifyJSONBytes - Simple Formatting for easy comparison. Also uses the .json file extension
```go
func TestVerifyJSON(t *testing.T) {
jsonb := []byte("{ \"foo\": \"bar\", \"age\": 42, \"bark\": \"woof\" }")
VerifyJSONBytes(t, jsonb)
}
```
Matches file: approvals_test.TestVerifyJSON.received.json
```json
{
"age": 42,
"bark": "woof",
"foo": "bar"
}
```
## Reporters
ApprovalTests becomes _much_ more powerful with reporters. Reporters launch programs on failure to help you understand, fix and approve results.
You can make your own easily, [here's an example](reporters/beyond_compare.go)
You can also declare which one to use. Either at the
### Method level
```go
r := UseReporter(reporters.NewIntelliJ())
defer r.Close()
```
### Test Level
```go
func TestMain(m *testing.M) {
r := UseReporter(reporters.NewBeyondCompareReporter())
defer r.Close()
UseFolder("testdata")
os.Exit(m.Run())
}
```