Repository navigation
Expand file tree
/
Copy pathtestdata_test.go
More file actions
496 lines (409 loc) · 10.9 KB
/
Copy pathtestdata_test.go
File metadata and controls
496 lines (409 loc) · 10.9 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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
package got
import (
"context"
"encoding/json"
"fmt"
"os"
"path/filepath"
"reflect"
"testing"
"time"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/require"
)
func TestLoad(t *testing.T) {
t.Run("nil value", func(t *testing.T) {
testLoadError(t, "text", nil, "output cannot be nil")
})
t.Run("unsupported types", func(t *testing.T) {
spec := []struct {
output any
typ string
}{
{output: true, typ: "bool"},
{output: 3.14, typ: "float64"},
{output: 123, typ: "int"},
{output: time.Minute, typ: "int64"},
{output: struct{}{}, typ: "struct"},
{output: time.Now(), typ: "struct"},
}
for _, test := range spec {
t.Run(test.typ, func(t *testing.T) {
testLoadError(t, "text", test.output, fmt.Sprintf("output must be a pointer, instead got %s", test.typ))
})
}
})
t.Run("struct tags", func(t *testing.T) {
// FIXME: go vet will not allow code with invalid struct tags, even if
// we are intentionally testing this behavior
// t.Run("invalid", func(t
// *testing.T) {
// type test struct {
// Invalid string `this is not valid`
// }
// testLoadError(t, "text", new(test), "Invalid: failed to parse struct tags: bad syntax for struct tag pair")
// })
t.Run("missing", func(t *testing.T) {
type test struct {
Input string `testdata:"input.txt"`
Missing string // intentionally missing testdata struct tag
}
testLoadOne(t, "text", new(test), &test{Input: "hello world"})
})
t.Run("empty", func(t *testing.T) {
type test struct {
Input string `testdata:"input.txt"`
Missing string `testdata:""`
}
testLoadOne(t, "text", new(test), &test{Input: "hello world"})
})
t.Run("dashed", func(t *testing.T) {
type test struct {
Input string `testdata:"input.txt"`
Missing string `testdata:"-"`
}
testLoadOne(t, "text", new(test), &test{Input: "hello world"})
})
})
t.Run("empty struct", func(t *testing.T) {
type test struct{}
testLoadOne(t, "text", new(test), new(test))
})
t.Run("string", func(t *testing.T) {
type test struct {
Input string `testdata:"input.txt"`
}
testLoadOne(t, "text", new(test), &test{Input: "hello world"})
})
t.Run("bytes", func(t *testing.T) {
type test struct {
Input []byte `testdata:"input.txt"`
}
testLoadOne(t, "text", new(test), &test{Input: []byte("hello world")})
})
t.Run("raw json", func(t *testing.T) {
type test struct {
Input json.RawMessage `testdata:"input.json"`
}
testLoadOne(t, "json", new(test), &test{Input: json.RawMessage("{\n \"hello\": \"world\"\n}")})
})
t.Run("multiple", func(t *testing.T) {
type test struct {
A string `testdata:"a.txt"`
B string `testdata:"b.txt"`
}
testLoadOne(t, "multiple", new(test), &test{A: "A", B: "B"})
})
t.Run("maps", func(t *testing.T) {
t.Run("expand glob", func(t *testing.T) {
type test struct {
Multiple map[string]string `testdata:"*.txt"`
}
testLoadOne(t, "multiple", new(test), &test{
Multiple: map[string]string{
"a.txt": "A",
"b.txt": "B",
},
})
})
t.Run("single file", func(t *testing.T) {
type test struct {
Multiple map[string]string `testdata:"a.txt"`
}
testLoadOne(t, "multiple", new(test), &test{
Multiple: map[string]string{
"a.txt": "A",
},
})
})
t.Run("bytes", func(t *testing.T) {
type test struct {
Multiple map[string][]byte `testdata:"a.txt"`
}
testLoadOne(t, "multiple", new(test), &test{
Multiple: map[string][]byte{
"a.txt": []byte("A"),
},
})
})
t.Run("glob without matches", func(t *testing.T) {
type test struct {
Multiple map[string]string `testdata:"*.log"`
}
testLoadOne(t, "multiple", new(test), &test{
Multiple: map[string]string{},
})
})
})
t.Run("json codec", func(t *testing.T) {
type JSONInput struct {
Hello string `json:"hello"`
}
type JSONComplex struct {
String string `json:"example_string"`
Number float64 `json:"example_number"`
Bool bool `json:"example_boolean"`
Null any `json:"example_null"`
Array []string `json:"example_array"`
Object map[string]int `json:"example_object"`
}
t.Run("simple", func(t *testing.T) {
type test struct {
Input JSONInput `testdata:"input.json"`
}
testLoadOne(t, "json", new(test), &test{
Input: JSONInput{Hello: "world"},
})
})
t.Run("complex", func(t *testing.T) {
type test struct {
Complex JSONComplex `testdata:"complex.json"`
}
testLoadOne(t, "json", new(test), &test{
Complex: JSONComplex{
String: "hello world",
Number: 3.14,
Bool: true,
Null: nil,
Array: []string{"a", "b", "c", "d"},
Object: map[string]int{"abc": 123, "def": 456},
},
})
})
t.Run("unmarshal error", func(t *testing.T) {
type test struct {
Input struct {
Hello int `json:"hello"` // string "hello world" is not a valid int
} `testdata:"input.json"`
}
testLoadError(t, "json", new(test), "Input: failed to unmarshal testdata/json/input.json: json: cannot unmarshal string into Go struct field .hello of type int")
})
})
t.Run("unknown codec", func(t *testing.T) {
type test struct {
Input struct{ Hello string } `testdata:"input.unknown"`
}
testLoadError(t, "unknown", new(test), `Input: failed to get codec for file extension ".unknown"`)
})
t.Run("no outputs", func(t *testing.T) {
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
mockT.EXPECT().Fatal("at least 1 output required")
Load(mockT, filepath.Join("testdata", "text"))
})
t.Run("multiple outputs", func(t *testing.T) {
type test1 struct {
A string `testdata:"a.txt"`
}
type test2 struct {
B string `testdata:"b.txt"`
}
testLoadMany(t, "multiple",
[]any{new(test1), new(test2)},
[]any{&test1{A: "A"}, &test2{B: "B"}},
)
})
}
func TestLoadDirs(t *testing.T) {
t.Run("success", func(t *testing.T) {
type test struct {
A string `testdata:"a.txt"`
B string `testdata:"b.txt"`
}
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
var actual test
LoadDirs(mockT, []string{"testdata/multiple-dirs/dir1", "testdata/multiple-dirs/dir2", "testdata/unknown"}, &actual)
require.EqualValues(t, test{A: "A", B: "B"}, actual)
})
t.Run("missing arguments", func(t *testing.T) {
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
mockT.EXPECT().Fatal("at least 1 output required")
LoadDirs(mockT, []string{"testdata/multiple-dirs/dir1", "testdata/multiple-dirs/dir2"})
})
}
func TestAssert(t *testing.T) {
t.Run("success", func(t *testing.T) {
type test struct {
Input string `testdata:"input.txt"`
}
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
Assert(mockT, "testdata/text", &test{Input: "hello world"})
})
t.Run("fail", func(t *testing.T) {
type test struct {
Input string `testdata:"input.txt"`
}
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
mockT.EXPECT().Fatal(gomock.Any())
Assert(mockT, "testdata/text", &test{Input: "foo bar"})
})
t.Run("missing arguments", func(t *testing.T) {
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
mockT.EXPECT().Fatal("at least 1 value required")
Assert(mockT, "testdata/text")
})
t.Run("update", func(t *testing.T) {
spec := []struct {
name string
expected any
fail bool
}{
{
name: "string",
expected: &struct {
Input string `testdata:"input.txt"`
}{
Input: "hello world",
},
},
{
name: "bytes",
expected: &struct {
Input []byte `testdata:"input.txt"`
}{
Input: []byte("hello world"),
},
},
{
name: "json raw",
expected: &struct {
Input json.RawMessage `testdata:"input.json"`
}{
Input: json.RawMessage(`{}`),
},
},
{
name: "json struct",
expected: &struct {
Input struct {
Hello string `json:"hello"`
} `testdata:"input.json"`
}{
Input: struct {
Hello string `json:"hello"`
}{
Hello: "world",
},
},
},
{
name: "map",
expected: &struct {
Files map[string]string `testdata:"*.txt"`
}{
Files: map[string]string{"a.txt": "A", "b.txt": "B"},
},
},
{
name: "unknown codec",
expected: &struct {
Unknown struct {
Input int
} `testdata:"expected.unknown"`
}{
Unknown: struct {
Input int
}{
Input: 42,
},
},
fail: true,
},
{
name: "empty",
expected: &struct {
Output string `testdata:"output.txt"`
Empty string `testdata:"-"`
}{},
},
{
name: "struct tag empty",
expected: &struct {
Output string `testdata:"output.txt"`
Empty string `testdata:""`
}{
Output: "hello world",
},
},
{
name: "struct tag dash",
expected: &struct {
Output string `testdata:"output.txt"`
Empty string `testdata:"-"`
}{
Output: "hello world",
},
},
// FIXME: go vet will not allow code with invalid struct tags, even
// if we are intentionally testing this behavior
// {
// name: "struct tag invalid",
// expected: &struct {
// Output string `testdata:"invalid...`
// }{},
// fail: true,
// },
{
name: "struct tag missing",
expected: &struct {
Output string
Empty string
}{},
},
}
for _, test := range spec {
t.Run(test.name, func(t *testing.T) {
updateGolden = true
t.Cleanup(func() { updateGolden = false })
ctx := context.TODO()
dir, err := os.MkdirTemp("", test.name)
require.NoError(t, err)
t.Cleanup(func() { os.RemoveAll(dir) })
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
if test.fail {
mockT.EXPECT().Fatal(gomock.Any())
Assert(mockT, dir, test.expected)
} else {
Assert(mockT, dir, test.expected)
actual := reflect.New(reflect.TypeOf(test.expected).Elem()).Interface()
require.NoError(t, loadDir(ctx, []string{dir}, actual))
require.EqualValues(t, test.expected, actual)
}
})
}
})
}
func testLoadOne(t *testing.T, input string, output, expected any) {
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
Load(mockT, filepath.Join("testdata", input), output)
require.EqualValues(t, expected, output)
}
func testLoadMany(t *testing.T, input string, output, expected []any) {
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
Load(mockT, filepath.Join("testdata", input), output...)
require.EqualValues(t, expected, output)
}
func testLoadError(t *testing.T, input string, output any, expectedErr string) {
ctrl := gomock.NewController(t)
mockT := NewMockT(ctrl)
mockT.EXPECT().Helper()
mockT.EXPECT().Fatal(expectedErr)
Load(mockT, filepath.Join("testdata", input), output)
}