-
Notifications
You must be signed in to change notification settings - Fork 0
/
assert.go
287 lines (242 loc) · 8.65 KB
/
assert.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
package goldsert
import (
"bytes"
"encoding/json"
"encoding/xml"
"io"
"reflect"
"testing"
"github.com/jimeh/go-golden"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v3"
)
// Assert is the core of goldsert, holding both configuration and implementation
// of all assertion methods.
//
// You can customize serialization by setting any of the encoder/decoder
// function fields to a custom function that returns an encoder/decoder
// configured as you need.
//
// You can also customize golden file generation by setting the Golden field to
// a custom *golden.Golden instance. See the github.com/jimeh/go-golden package
// for details about what can be configured.
type Assert struct {
JSONEncoderFunc func(io.Writer) *json.Encoder
JSONDecoderFunc func(io.Reader) *json.Decoder
YAMLEncoderFunc func(io.Writer) *yaml.Encoder
YAMLDecoderFunc func(io.Reader) *yaml.Decoder
XMLEncoderFunc func(io.Writer) *xml.Encoder
XMLDecoderFunc func(io.Reader) *xml.Decoder
Golden *golden.Golden
// NormalizeLineBreaks enables line-break normalization which replaces
// Windows' CRLF (\r\n) and Mac Classic CR (\r) line breaks with Unix's LF
// (\n) line breaks.
NormalizeLineBreaks bool
}
// New returns a new *Assert instance configured with default settings.
//
// The default encoders all specify indentation of two spaces, essentially
// enforcing pretty formatting for JSON and XML.
//
// The default decoders for JSON and YAML prohibit unknown fields which are not
// present on the provided struct.
func New() *Assert {
return &Assert{
JSONEncoderFunc: newJSONEncoder,
JSONDecoderFunc: newJSONDecoder,
YAMLEncoderFunc: newYAMLEncoder,
YAMLDecoderFunc: newYAMLDecoder,
XMLEncoderFunc: newXMLEncoder,
XMLDecoderFunc: newXMLDecoder,
Golden: golden.New(),
NormalizeLineBreaks: true,
}
}
// JSONMarshaling asserts that the given "v" value JSON marshals to an expected
// value fetched from a golden file on disk, and then verifies that the
// marshaled result produces a value that is equal to "v" when unmarshaled.
//
// Used for objects that do NOT change when they are marshaled and unmarshaled.
func (s *Assert) JSONMarshaling(t *testing.T, v interface{}) {
t.Helper()
s.JSONMarshalingP(t, v, v)
}
// JSONMarshalingP asserts that the given "v" value JSON marshals to an expected
// value fetched from a golden file on disk, and then verifies that the
// marshaled result produces a value that is equal to "want" when unmarshaled.
//
// Used for objects that change when they are marshaled and unmarshaled.
func (s *Assert) JSONMarshalingP(t *testing.T, v, want interface{}) {
t.Helper()
var buf bytes.Buffer
err := s.JSONEncoderFunc(&buf).Encode(v)
require.NoErrorf(t, err, "failed to JSON marshal %T: %+v", v, v)
marshaled := buf.Bytes()
if s.NormalizeLineBreaks {
marshaled = normalizeLineBreaks(marshaled)
}
if s.Golden.Update() {
s.Golden.SetP(t, "goldsert_json", marshaled)
}
gold := s.Golden.GetP(t, "goldsert_json")
if s.NormalizeLineBreaks {
gold = normalizeLineBreaks(gold)
}
assert.JSONEq(t, string(gold), string(marshaled))
if reflect.ValueOf(want).Kind() != reflect.Ptr {
require.FailNowf(t,
"only pointer types can be asserted",
"%T is not a pointer type", want,
)
}
got := reflect.New(reflect.TypeOf(want).Elem()).Interface()
err = s.JSONDecoderFunc(bytes.NewBuffer(gold)).Decode(got)
require.NoErrorf(t, err,
"failed to JSON unmarshal %T from %s",
got, s.Golden.FileP(t, "goldsert_json"),
)
assert.Equal(t, want, got,
"unmarshaling from golden file does not match expected object",
)
}
// YAMLMarshaling asserts that the given "v" value YAML marshals to an expected
// value fetched from a golden file on disk, and then verifies that the
// marshaled result produces a value that is equal to "v" when unmarshaled.
//
// Used for objects that do NOT change when they are marshaled and unmarshaled.
func (s *Assert) YAMLMarshaling(t *testing.T, v interface{}) {
t.Helper()
s.YAMLMarshalingP(t, v, v)
}
// YAMLMarshalingP asserts that the given "v" value YAML marshals to an expected
// value fetched from a golden file on disk, and then verifies that the
// marshaled result produces a value that is equal to "want" when unmarshaled.
//
// Used for objects that change when they are marshaled and unmarshaled.
func (s *Assert) YAMLMarshalingP(t *testing.T, v, want interface{}) {
t.Helper()
var buf bytes.Buffer
err := s.YAMLEncoderFunc(&buf).Encode(v)
require.NoErrorf(t, err, "failed to YAML marshal %T: %+v", v, v)
marshaled := buf.Bytes()
if s.NormalizeLineBreaks {
marshaled = normalizeLineBreaks(marshaled)
}
if s.Golden.Update() {
s.Golden.SetP(t, "goldsert_yaml", marshaled)
}
gold := s.Golden.GetP(t, "goldsert_yaml")
if s.NormalizeLineBreaks {
gold = normalizeLineBreaks(gold)
}
assert.YAMLEq(t, string(gold), string(marshaled))
if reflect.ValueOf(want).Kind() != reflect.Ptr {
require.FailNowf(t,
"only pointer types can be asserted",
"%T is not a pointer type", want,
)
}
got := reflect.New(reflect.TypeOf(want).Elem()).Interface()
err = s.YAMLDecoderFunc(bytes.NewBuffer(gold)).Decode(got)
require.NoErrorf(t, err,
"failed to YAML unmarshal %T from %s",
got, s.Golden.FileP(t, "goldsert_yaml"),
)
assert.Equal(t, want, got,
"unmarshaling from golden file does not match expected object",
)
}
// XMLMarshaling asserts that the given "v" value XML marshals to an expected
// value fetched from a golden file on disk, and then verifies that the
// marshaled result produces a value that is equal to "v" when unmarshaled.
//
// Used for objects that do NOT change when they are marshaled and unmarshaled.
func (s *Assert) XMLMarshaling(t *testing.T, v interface{}) {
t.Helper()
s.XMLMarshalingP(t, v, v)
}
// XMLMarshalingP asserts that the given "v" value XML marshals to an expected
// value fetched from a golden file on disk, and then verifies that the
// marshaled result produces a value that is equal to "want" when unmarshaled.
//
// Used for objects that change when they are marshaled and unmarshaled.
func (s *Assert) XMLMarshalingP(t *testing.T, v, want interface{}) {
t.Helper()
var buf bytes.Buffer
err := s.XMLEncoderFunc(&buf).Encode(v)
require.NoErrorf(t, err, "failed to XML marshal %T: %+v", v, v)
marshaled := buf.Bytes()
if s.NormalizeLineBreaks {
marshaled = normalizeLineBreaks(marshaled)
}
if s.Golden.Update() {
s.Golden.SetP(t, "goldsert_xml", marshaled)
}
gold := s.Golden.GetP(t, "goldsert_xml")
if s.NormalizeLineBreaks {
gold = normalizeLineBreaks(gold)
}
assert.Equal(t, string(gold), string(marshaled))
if reflect.ValueOf(want).Kind() != reflect.Ptr {
require.FailNowf(t,
"only pointer types can be asserted",
"%T is not a pointer type", want,
)
}
got := reflect.New(reflect.TypeOf(want).Elem()).Interface()
err = s.XMLDecoderFunc(bytes.NewBuffer(gold)).Decode(got)
require.NoErrorf(t, err,
"failed to XML unmarshal %T from %s",
got, s.Golden.FileP(t, "goldsert_xml"),
)
assert.Equal(t, want, got,
"unmarshaling from golden file does not match expected object",
)
}
// newJSONEncoder is the default JSONEncoderFunc used by Assert. It returns a
// *json.Encoder which is set to indent with two spaces.
func newJSONEncoder(w io.Writer) *json.Encoder {
enc := json.NewEncoder(w)
enc.SetIndent("", " ")
return enc
}
// newJSONDecoder is the default JSONDecoderFunc used by Assert. It returns a
// *json.Decoder which disallows unknown fields.
func newJSONDecoder(r io.Reader) *json.Decoder {
dec := json.NewDecoder(r)
dec.DisallowUnknownFields()
return dec
}
// newYAMLEncoder is the default YAMLEncoderFunc used by Assert. It returns a
// *yaml.Encoder which is set to indent with two spaces.
func newYAMLEncoder(w io.Writer) *yaml.Encoder {
enc := yaml.NewEncoder(w)
enc.SetIndent(2)
return enc
}
// newYAMLDecoder is the default YAMLDecoderFunc used by Assert. It returns a
// *yaml.Decoder which disallows unknown fields.
func newYAMLDecoder(r io.Reader) *yaml.Decoder {
dec := yaml.NewDecoder(r)
dec.KnownFields(true)
return dec
}
// newXMLEncoder is the default XMLEncoderFunc used by Assert. It returns a
// *xml.Encoder which is set to indent with two spaces.
func newXMLEncoder(w io.Writer) *xml.Encoder {
enc := xml.NewEncoder(w)
enc.Indent("", " ")
return enc
}
// newXMLDecoder is the default XMLDecoderFunc used by Assert.
func newXMLDecoder(r io.Reader) *xml.Decoder {
return xml.NewDecoder(r)
}
func normalizeLineBreaks(data []byte) []byte {
// Replace CRLF (\r\n, windows) with LF (\n, unix)
result := bytes.ReplaceAll(data, []byte{13, 10}, []byte{10})
// Replace CR (\r, mac) with LF (\n, unix)
result = bytes.ReplaceAll(result, []byte{13}, []byte{10})
return result
}