Repository navigation
Expand file tree
/
Copy pathtestdata.go
More file actions
419 lines (339 loc) · 10.3 KB
/
Copy pathtestdata.go
File metadata and controls
419 lines (339 loc) · 10.3 KB
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
package got
import (
"errors"
"flag"
"fmt"
"io"
"os"
"path/filepath"
"reflect"
"sort"
"strconv"
"github.com/dominicbarnes/got/v2/codec"
"github.com/fatih/structtag"
"github.com/google/go-cmp/cmp"
)
var updateGolden bool
func init() {
flag.BoolVar(&updateGolden, "update-golden", false, "instruct got.Assert to update golden files")
}
const tagName = "testdata"
// Load extracts the contents of dir into values which are structs annotated
// with the "testdata" struct tag.
//
// The main parameter of the struct tag will be a path to a file relative to the
// input directory.
//
// Fields with string or []byte as their types will be populated with the raw
// contents of the file.
//
// Struct values will be decoded using the file extension to map to a [Codec].
// For example, ".json" files can be processed using [JSONCodec] if it has been
// registered. Additional codecs (eg: YAML, TOML) can be registered if desired.
//
// Map values, by default, are decoded using the relevant [Codec].
//
// There is also a special mode that works files more dynamically, which is
// useful for highly variable outputs and is enabled with the "explode" option.
// When enabled, the struct tag name is treated as a glob pattern. The map is
// populated with a key corresponding to a relative filepath while the value can
// be any of the types described above.
func Load(t tester, dir string, values ...any) {
t.Helper()
log := &logger{
t: t,
prefix: "[GoT] Load: ",
}
if err := loadDirs(log, []string{dir}, values...); err != nil {
t.Fatalf("[GoT] Load: %s", err.Error())
}
}
// LoadDirs is the same as Load but accepts multiple input directories, which
// can be used to set up test cases from a common/shared location while allowing
// an individual test-case to include it's own specific configuration.
func LoadDirs(t tester, dirs []string, values ...any) {
t.Helper()
log := &logger{
t: t,
prefix: "[GoT] Load: ",
}
if err := loadDirs(log, dirs, values...); err != nil {
t.Fatalf("[GoT] LoadDirs: %s", err.Error())
}
}
// Assert ensures that all the fields within the struct values match what is on
// disk, using reflection to Load a fresh copy and then comparing the 2 structs
// using go-cmp to perform the equality check.
//
// When the "test.update-golden" flag is provided, the contents of each value
// struct will be persisted to disk instead. This allows any test to easily
// update their "golden files" and also do the assertion transparently.
func Assert(t tester, dir string, values ...any) {
t.Helper()
log := &logger{
t: t,
prefix: "[GoT] Assert: ",
}
if err := assert(log, dir, nil, values...); err != nil {
t.Fatalf("[GoT] Assert: %s", err.Error())
}
}
func AssertWithOptions(t tester, dir string, options cmp.Options, values ...any) {
t.Helper()
log := &logger{
t: t,
prefix: "[GoT] Assert: ",
}
if err := assert(log, dir, options, values...); err != nil {
t.Fatalf("[GoT] Assert: %s", err.Error())
}
}
func assert(log *logger, dir string, opts cmp.Options, values ...any) error {
if len(values) == 0 {
return errors.New("at least 1 value required")
}
for _, actual := range values {
if updateGolden {
if err := saveDir(log, dir, actual); err != nil {
return err
}
continue
}
expected := reflect.New(reflect.TypeOf(actual).Elem()).Interface()
if err := loadDirs(log, []string{dir}, expected); err != nil {
return err
}
if !cmp.Equal(expected, actual, opts...) {
return fmt.Errorf("test of %s failed: %s", getTypeName(expected), cmp.Diff(expected, actual, opts...))
}
}
return nil
}
func loadDirs(log *logger, inputs []string, outputs ...any) error {
if len(outputs) == 0 {
return errors.New("at least 1 output required")
}
for _, output := range outputs {
if output == nil {
return errors.New("output cannot be nil")
}
vlog := log.WithPrefix(getTypeName(output))
if err := loadDir(vlog, inputs, output); err != nil {
return err
}
}
return nil
}
func loadDir(log *logger, inputs []string, output any) error {
if k := reflect.TypeOf(output).Kind(); k != reflect.Ptr {
return fmt.Errorf("output must be a pointer, but got %s", k)
}
typ := reflect.TypeOf(output).Elem()
val := reflect.ValueOf(output).Elem()
for i := 0; i < typ.NumField(); i++ {
field := typ.Field(i)
value := val.Field(i)
tags, err := structtag.Parse(string(field.Tag))
if err != nil {
return fmt.Errorf("%s.%s: failed to parse struct tags: %w", getTypeName(output), field.Name, err)
}
tag, err := tags.Get(tagName)
if err != nil {
continue
} else if tag.Name == "" || tag.Name == "-" {
continue
}
for _, input := range inputs {
if err := loadDirInput(log, input, tag, field, value); err != nil {
return fmt.Errorf("%s.%s: %w", getTypeName(output), field.Name, err)
}
}
}
return nil
}
func loadDirInput(log *logger, input string, tag *structtag.Tag, field reflect.StructField, value reflect.Value) error {
file := filepath.Join(input, tag.Name)
if isMap(field.Type) && tag.HasOption("explode") {
matches, err := filepath.Glob(file)
if err != nil {
return fmt.Errorf("failed to list files %s: %w", file, err)
}
m := reflect.MakeMap(field.Type)
for _, match := range matches {
rel, err := filepath.Rel(input, match)
if err != nil {
return fmt.Errorf("failed to resolve file %s: %w", match, err)
}
key := reflect.ValueOf(rel)
val := reflect.New(m.Type().Elem()).Elem()
prefix := "." + field.Name + "[" + strconv.Quote(key.String()) + "]"
if err := loadFile(log.WithPrefix(prefix), match, val); err != nil {
return fmt.Errorf("%s: %w", field.Name, err)
}
m.SetMapIndex(key, val)
}
if m.Len() > 0 {
value.Set(m)
} else {
log.WithPrefix("." + field.Name).Log("no matches found")
}
return nil
}
if err := loadFile(log.WithPrefix("."+field.Name), file, value); err != nil {
return err
}
return nil
}
func loadFile(log *logger, file string, value reflect.Value) error {
f, err := openTagFile(file)
if err != nil {
return err
} else if f == nil {
log.Log("skipped: file %q not found", file)
return nil
}
data, err := io.ReadAll(f)
if err != nil {
return fmt.Errorf("file %q read error: %w", file, err)
}
// raw types
if isBytes(value.Type()) {
value.SetBytes(data)
log.Log("loaded file %q as bytes (size %d)", file, len(data))
return nil
} else if isString(value.Type()) {
value.SetString(string(data))
log.Log("loaded file %q as string (size %d)", file, len(data))
return nil
}
ext := filepath.Ext(file)
codec, err := codec.Get(ext)
if err != nil {
return fmt.Errorf("failed to get codec for file extension %q", ext)
}
p := reflect.New(value.Type())
p.Elem().Set(value) // preserve any prior values
if err := codec.Unmarshal(data, p.Interface()); err != nil {
return fmt.Errorf("file %q decode error: %w", file, err)
}
value.Set(p.Elem()) // overwrite with the updated value
log.Log("loaded file %q as %s (size %d)", file, codec.Name(), len(data))
return nil
}
func saveDir(log *logger, dir string, input any) error {
if input == nil {
return errors.New("input cannot be nil")
}
if k := reflect.TypeOf(input).Kind(); k != reflect.Ptr {
return fmt.Errorf("input must be a pointer, instead got %s", k)
}
typ := reflect.TypeOf(input).Elem()
val := reflect.ValueOf(input).Elem()
for i := 0; i < typ.NumField(); i++ {
field := typ.Field(i)
value := val.Field(i)
tags, err := structtag.Parse(string(field.Tag))
if err != nil {
return fmt.Errorf("%s.%s: failed to parse struct tags: %w", getTypeName(input), field.Name, err)
}
tag, err := tags.Get(tagName)
if err != nil {
continue
} else if tag.Name == "" || tag.Name == "-" {
continue
}
if err := saveDirField(log.WithPrefix(fmt.Sprintf("%s.%s", getTypeName(input), field.Name)), dir, tag, field, value); err != nil {
return fmt.Errorf("%s.%s error: %w", getTypeName(input), field.Name, err)
}
}
return nil
}
func saveDirField(log *logger, dir string, tag *structtag.Tag, field reflect.StructField, value reflect.Value) error {
if isMap(field.Type) && tag.HasOption("explode") {
keys := value.MapKeys()
sort.Slice(keys, func(i, j int) bool {
return keys[i].String() < keys[j].String()
})
for _, k := range keys {
v := value.MapIndex(k)
file := filepath.Join(dir, k.String())
if err := saveFile(log, file, v); err != nil {
return err
}
}
return nil
}
file := filepath.Join(dir, tag.Name)
if err := saveFile(log, file, value); err != nil {
return err
}
return nil
}
func saveFile(log *logger, file string, val reflect.Value) error {
data, err := encode(file, val)
if err != nil {
return fmt.Errorf("failed to encode file %q: %w", file, err)
}
if len(data) == 0 {
if err := os.Remove(file); err != nil {
if !os.IsNotExist(err) {
return fmt.Errorf("failed to delete file %s: %w", file, err)
}
}
log.Log("removed file %q: empty", file)
} else {
dir := filepath.Dir(file)
if err := os.MkdirAll(dir, 0755); err != nil {
return fmt.Errorf("failed to create dir %s: %w", dir, err)
}
if err := os.WriteFile(file, data, 0644); err != nil {
return fmt.Errorf("failed to write file %s: %w", file, err)
}
log.Log("saved file %q (size %d)", file, len(data))
}
return nil
}
func encode(file string, val reflect.Value) ([]byte, error) {
switch {
case val.IsZero():
return nil, nil
case isBytes(val.Type()):
return val.Bytes(), nil
case isString(val.Type()):
return []byte(val.String()), nil
}
ext := filepath.Ext(file)
codec, err := codec.Get(ext)
if err != nil {
return nil, fmt.Errorf("failed to get codec for file extension %q", ext)
}
return codec.Marshal(val.Interface())
}
func openTagFile(file string) (*os.File, error) {
f, err := os.Open(file)
if err != nil {
// suppress "not found" errors
if os.IsNotExist(err) {
return nil, nil
}
return nil, err
}
return f, nil
}
func isString(targetType reflect.Type) bool {
return targetType.Kind() == reflect.String
}
func isBytes(targetType reflect.Type) bool {
return targetType.Kind() == reflect.Slice && targetType.Elem().Kind() == reflect.Uint8
}
func isMap(targetType reflect.Type) bool {
return targetType.Kind() == reflect.Map && isString(targetType.Key())
}
func getTypeName(input any) string {
t := reflect.TypeOf(input)
if t.Kind() == reflect.Ptr && t.Elem().PkgPath() == "" {
return "<anonymous>"
} else {
return t.String()
}
}