https://github.com/jimeh/go-goldsert
A suite of Go test helpers which uses golden files to assert marshaling and unmarshaling of given objects.
https://github.com/jimeh/go-goldsert
assertions go go-test go-test-helper go-testing golang golden-file gotest json marshal marshaling unmarshal unmarshaling xml yaml
Last synced: about 2 months ago
JSON representation
A suite of Go test helpers which uses golden files to assert marshaling and unmarshaling of given objects.
- Host: GitHub
- URL: https://github.com/jimeh/go-goldsert
- Owner: jimeh
- License: mit
- Created: 2021-10-28T01:50:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-28T02:23:47.000Z (over 3 years ago)
- Last Synced: 2025-04-02T00:09:55.035Z (about 2 months ago)
- Topics: assertions, go, go-test, go-test-helper, go-testing, golang, golden-file, gotest, json, marshal, marshaling, unmarshal, unmarshaling, xml, yaml
- Language: Go
- Homepage: https://pkg.go.dev/github.com/jimeh/go-goldsert
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
go-goldsert
A suite of Go test helpers which uses golden files to assert marshaling and unmarshaling of given objects.
Each test helper operates in two stages:
1. Marshal the provided object to a byte slice and reads the corresponding
golden file from disk, follow by verifying both byte slices are identical.
2. Unmarshal the content from the golden file and verify that the result is
identical to the original object.
## Import
```go
import "github.com/jimeh/go-goldsert"
```
## Usage
Typical usage should look something like this in a tabular test:
```go
type MyStruct struct {
FooBar string `json:"foo_bar" yaml:"fooBar" xml:"Foo_Bar"`
}
func TestMyStructMarshaling(t *testing.T) {
tests := []struct {
name string
obj *MyStruct
}{
{name: "empty", obj: &MyStruct{}},
{name: "full", obj: &MyStruct{FooBar: "Hello World!"}},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
goldsert.JSONMarshaling(t, tt.obj)
goldsert.YAMLMarshaling(t, tt.obj)
goldsert.XMLMarshaling(t, tt.obj)
})
}
}
```
The above example will read from the following golden files:
- `testdata/TestMyStructMarshaling/empty/goldsert_json.golden`
- `testdata/TestMyStructMarshaling/empty/goldsert_yaml.golden`
- `testdata/TestMyStructMarshaling/empty/goldsert_xml.golden`
- `testdata/TestMyStructMarshaling/full/goldsert_json.golden`
- `testdata/TestMyStructMarshaling/full/goldsert_yaml.golden`
- `testdata/TestMyStructMarshaling/full/goldsert_xml.golden`
If a corresponding golden file cannot be found on disk, the test will fail. To
create/update golden files, simply set the `GOLDEN_UPDATE` environment variable
to one of `1`, `y`, `t`, `yes`, `on`, or `true` when running tests.
It is highly recommended that golden files are committed to source control, as
it allow tests to fail when the marshal results for an object changes.
## Documentation
Please see the
[Go Reference](https://pkg.go.dev/github.com/jimeh/go-goldsert#section-documentation)
for documentation and examples.
## License
[MIT](https://github.com/jimeh/go-goldsert/blob/main/LICENSE)