go-golden/example_test.go

package golden_test

import (
	"encoding/json"
	"encoding/xml"
	"testing"

	"github.com/jimeh/go-golden"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

type MyStruct struct {
	Foo string `json:"foo,omitempty"`
}

// TestExampleMyStruct reads/writes the following golden file:
//
//	testdata/TestExampleMyStruct.golden
func TestExampleMyStruct(t *testing.T) {
	got, err := json.Marshal(&MyStruct{Foo: "Bar"})
	require.NoError(t, err)

	if golden.Update() {
		golden.Set(t, got)
	}
	want := golden.Get(t)

	assert.Equal(t, want, got)
}

// TestExampleMyStructTabular reads/writes the following golden files:
//
//	testdata/TestExampleMyStructTabular/empty_struct.golden
//	testdata/TestExampleMyStructTabular/full_struct.golden
func TestExampleMyStructTabular(t *testing.T) {
	tests := []struct {
		name string
		obj  *MyStruct
	}{
		{name: "empty struct", obj: &MyStruct{}},
		{name: "full struct", obj: &MyStruct{Foo: "Bar"}},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := json.Marshal(tt.obj)
			require.NoError(t, err)

			if golden.Update() {
				golden.Set(t, got)
			}
			want := golden.Get(t)

			assert.Equal(t, want, got)
		})
	}
}

// TestExampleMyStructP reads/writes the following golden file:
//
//	testdata/TestExampleMyStructP/json.golden
//	testdata/TestExampleMyStructP/xml.golden
func TestExampleMyStructP(t *testing.T) {
	gotJSON, _ := json.Marshal(&MyStruct{Foo: "Bar"})
	gotXML, _ := xml.Marshal(&MyStruct{Foo: "Bar"})

	if golden.Update() {
		golden.SetP(t, "json", gotJSON)
		golden.SetP(t, "xml", gotXML)
	}

	assert.Equal(t, golden.GetP(t, "json"), gotJSON)
	assert.Equal(t, golden.GetP(t, "xml"), gotXML)
}

// TestExampleMyStructTabularP reads/writes the following golden file:
//
//	testdata/TestExampleMyStructTabularP/empty_struct/json.golden
//	testdata/TestExampleMyStructTabularP/empty_struct/xml.golden
//	testdata/TestExampleMyStructTabularP/full_struct/json.golden
//	testdata/TestExampleMyStructTabularP/full_struct/xml.golden
func TestExampleMyStructTabularP(t *testing.T) {
	tests := []struct {
		name string
		obj  *MyStruct
	}{
		{name: "empty struct", obj: &MyStruct{}},
		{name: "full struct", obj: &MyStruct{Foo: "Bar"}},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			gotJSON, _ := json.Marshal(tt.obj)
			gotXML, _ := xml.Marshal(tt.obj)

			if golden.Update() {
				golden.SetP(t, "json", gotJSON)
				golden.SetP(t, "xml", gotXML)
			}

			assert.Equal(t, golden.GetP(t, "json"), gotJSON)
			assert.Equal(t, golden.GetP(t, "xml"), gotXML)
		})
	}
}