-
Notifications
You must be signed in to change notification settings - Fork 10
/
testdata_test.go
549 lines (517 loc) · 13.6 KB
/
testdata_test.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
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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
package wit
import (
"bytes"
"flag"
"fmt"
"os"
"os/exec"
"strings"
"sync"
"testing"
"github.com/bytecodealliance/wasm-tools-go/internal/relpath"
"github.com/sergi/go-diff/diffmatchpatch"
)
var (
update = flag.Bool("update", false, "update golden files")
debug = flag.Bool("debug", false, "debug errors by writing files")
)
func compareOrWrite(t *testing.T, path, golden, data string) {
if *update {
err := os.WriteFile(golden, []byte(data), 0o644)
if err != nil {
t.Error(err)
}
return
}
want, err := os.ReadFile(golden)
if err != nil {
t.Error(err)
return
}
if string(want) != data {
dmp := diffmatchpatch.New()
dmp.PatchMargin = 3
diffs := dmp.DiffMain(string(want), data, false)
t.Errorf("value for %s did not match golden value %s:\n%v", path, golden, dmp.DiffPrettyText(diffs))
}
}
const testdataPath = "../testdata"
func loadTestdata(f func(path string, res *Resolve) error) error {
return relpath.Walk(testdataPath, func(path string) error {
res, err := LoadJSON(path)
if err != nil {
return err
}
return f(path, res)
}, "*.wit.json", "*.wit.md.json")
}
func TestGoldenWITFiles(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
data := res.WIT(nil, "")
compareOrWrite(t, path, path+".golden.wit", data)
})
return nil
})
if err != nil {
t.Error(err)
}
}
var canWasmTools = sync.OnceValue[bool](func() bool {
// This is explicitly NOT using exec.LookPath so itfails to run on WebAssembly.
// This disables tests that require wasm-tools.
err := exec.Command("wasm-tools", "--version").Run()
return err == nil
})
func TestGoldenWITRoundTrip(t *testing.T) {
if testing.Short() {
// t.Skip is not available in TinyGo, requires runtime.Goexit()
return
}
if !canWasmTools() {
t.Log("skipping test: wasm-tools not installed or cannot fork/exec (TinyGo)")
return
}
err := loadTestdata(func(path string, res *Resolve) error {
data := res.WIT(nil, "")
t.Run(path, func(t *testing.T) {
// Run the generated WIT through wasm-tools to generate JSON.
cmd := exec.Command("wasm-tools", "component", "wit", "-j", "--all-features")
cmd.Stdin = strings.NewReader(data)
stdout := &bytes.Buffer{}
stderr := &bytes.Buffer{}
cmd.Stdout = stdout
cmd.Stderr = stderr
err := cmd.Run()
if err != nil {
t.Error(err, stderr.String())
return
}
// Parse the JSON into a Resolve.
res2, err := DecodeJSON(stdout)
if err != nil {
t.Error(err)
return
}
// Convert back to WIT.
data2 := res2.WIT(nil, "")
if string(data2) != data {
if *debug {
os.WriteFile(path+".fail.wit", []byte(data2), os.ModePerm)
}
dmp := diffmatchpatch.New()
dmp.PatchMargin = 3
diffs := dmp.DiffMain(data, data2, false)
t.Errorf("round-trip WIT for %s through wasm-tools did not match:\n%v", path, dmp.DiffPrettyText(diffs))
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
func TestSizeAndAlign(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, td := range res.TypeDefs {
name := fmt.Sprintf("TypeDefs[%d]", i)
if td.Name != nil {
name += "#" + *td.Name
}
t.Run(name, func(t *testing.T) {
defer func() {
err := recover()
if err != nil {
t.Fatalf("panic: %v", err)
}
}()
got, want := td.Size(), td.Kind.Size()
if got != want {
t.Errorf("(*TypeDef).Size(): got %d, expected %d", got, want)
}
got, want = td.Align(), td.Kind.Align()
if got != want {
t.Errorf("(*TypeDef).Align(): got %d, expected %d", got, want)
}
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestFunctionReturnsBorrow validates that no functions in the test data return borrowed handles.
func TestFunctionReturnsBorrow(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
// Skip two fixtures:
// testdata/wit-parser/resources-multiple-returns-borrow.wit.json
// testdata/wit-parser/resources-return-borrow.wit.json
if strings.Contains(path, "-return") && strings.Contains(path, "-borrow") {
return nil
}
t.Run(path, func(t *testing.T) {
// TODO: when GOEXPERIMENT=rangefunc lands:
// for f := range res.AllFunctions() {
res.AllFunctions()(func(f *Function) bool {
t.Run(f.Name, func(t *testing.T) {
got, want := f.ReturnsBorrow(), false
if got != want {
t.Errorf("(*Function).ReturnsBorrow(): got %t, expected %t", got, want)
}
})
return true
})
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestFunctionBaseName tests the [Function] BaseName method.
func TestFunctionBaseName(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
// TODO: when GOEXPERIMENT=rangefunc lands:
// for f := range res.AllFunctions() {
res.AllFunctions()(func(f *Function) bool {
t.Run(f.Name, func(t *testing.T) {
want, after, found := strings.Cut(f.Name, ".")
if found {
want = after
}
if f.IsConstructor() {
want = "constructor"
}
got := f.BaseName()
if got != want {
t.Errorf("(*Function).BaseName(): got %s, expected %s", got, want)
}
if strings.Contains(got, ".") {
t.Errorf("(*Function).BaseName(): %s contains \".\"", got)
}
})
return true
})
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestFunctionNameConsistency tests to see if the names in the map[string]*Function in
// each [Interface] in a [Resolve] is identical to its Name field.
func TestFunctionNameConsistency(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, face := range res.Interfaces {
if face.Functions.Len() == 0 {
continue
}
name := fmt.Sprintf("Interfaces[%d]", i)
if face.Name != nil {
name += "#" + *face.Name
}
t.Run(name, func(t *testing.T) {
face.Functions.All()(func(name string, f *Function) bool {
t.Run(name, func(t *testing.T) {
if name != f.Name {
t.Errorf("Interface.Functions[%q] != %q", name, f.Name)
}
})
return true
})
})
}
for i, w := range res.Worlds {
if w.Imports.Len() == 0 && w.Exports.Len() == 0 {
continue
}
name := fmt.Sprintf("Worlds[%d]#%s", i, w.Name)
t.Run(name, func(t *testing.T) {
// A world can rename an imported function, so disable this
// for name, item := range w.Imports {
// f, ok := item.(*Function)
// if !ok {
// continue
// }
// t.Run(fmt.Sprintf("Imports[%q]==%q", name, f.Name), func(t *testing.T) {
// if name != f.Name {
// t.Errorf("Imports[%q] != %q", name, f.Name)
// }
// })
// }
// TODO: can a world rename an exported function?
w.Exports.All()(func(name string, item WorldItem) bool {
f, ok := item.(*Function)
if !ok {
return true
}
t.Run(fmt.Sprintf("Exports[%q]==%q", name, f.Name), func(t *testing.T) {
if name != f.Name {
t.Errorf("Exports[%q] != %q", name, f.Name)
}
})
return true
})
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestConstructorResult validates that constructors return own<t>.
func TestConstructorResult(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
res.AllFunctions()(func(f *Function) bool {
if !f.IsConstructor() {
return true
}
t.Run(f.Name, func(t *testing.T) {
want := f.Kind.(*Constructor).Type
switch typ := f.Results[0].Type.(type) {
default:
t.Errorf("result[0].Type is not a *TypeDef")
case *TypeDef:
switch kind := typ.Kind.(type) {
default:
t.Errorf("result[0].Type.Kind is not a *Own")
case *Own:
got := kind.Type
if want != got {
t.Errorf("constructor result type own<%T> != %T", got, want)
}
}
}
})
return true
})
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestPackageFieldIsNotNil tests to ensure the Package field of all [World] and [Interface]
// values in a [Resolve] are non-nil.
func TestPackageFieldIsNotNil(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, face := range res.Interfaces {
name := fmt.Sprintf("Interfaces[%d]", i)
if face.Name != nil {
name += "#" + *face.Name
}
t.Run(name, func(t *testing.T) {
if face.Package == nil {
t.Error("Package is nil")
}
})
}
for i, w := range res.Worlds {
name := fmt.Sprintf("Worlds[%d]#%s", i, w.Name)
t.Run(name, func(t *testing.T) {
if w.Package == nil {
t.Error("Package is nil")
}
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestInterfaceNameIsNotNil tests to ensure a non-nil Name field in all [Interface] values in each [Package].
func TestInterfaceNameIsNotNil(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for _, pkg := range res.Packages {
t.Run(pkg.Name.String(), func(t *testing.T) {
pkg.Interfaces.All()(func(name string, face *Interface) bool {
t.Run(name, func(t *testing.T) {
if face.Name == nil {
t.Error("nil name")
}
})
return true
})
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestTypeDefNamesNotNil verifies that all [Record], [Variant], [Enum], and [Flags]
// types have a non-nil Name.
func TestTypeDefNamesNotNil(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, td := range res.TypeDefs {
switch td.Kind.(type) {
case *Record, *Variant, *Enum, *Flags:
default:
continue
}
name := fmt.Sprintf("TypeDefs[%d]", i)
if td.Name != nil {
name += "#" + *td.Name
}
t.Run(name, func(t *testing.T) {
if td.Name == nil {
t.Error("Name is nil")
}
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestTypeDefRootOwnersHaveNames verifies that all root [TypeDef] owners have a name, if non-nil.
func TestTypeDefRootOwnersHaveNames(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, td := range res.TypeDefs {
name := fmt.Sprintf("TypeDefs[%d]", i)
if td.Name != nil {
name += "#" + *td.Name
}
t.Run(name, func(t *testing.T) {
td = td.Root()
switch owner := td.Owner.(type) {
case *World:
if owner.Name == "" {
t.Error("Owner.Name is empty")
}
case *Interface:
if owner.Name != nil && *owner.Name == "" {
t.Error("*Owner.Name is empty")
}
}
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestNoExportedTypeDefs verifies that any [TypeDef] instances in a [World] are
// referenced in Imports, and not Exports.
func TestNoExportedTypeDefs(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, w := range res.Worlds {
if w.Imports.Len() == 0 && w.Exports.Len() == 0 {
continue
}
name := fmt.Sprintf("Worlds[%d]#%s", i, w.Name)
t.Run(name, func(t *testing.T) {
w.Exports.All()(func(name string, item WorldItem) bool {
if _, ok := item.(*TypeDef); ok {
t.Errorf("found TypeDef in World.Exports: %s", name)
}
return true
})
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestHasPointer verifies that the hasPointer method and HasPointer function return the same result.
func TestHasPointer(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for _, td := range res.TypeDefs {
a := td.hasPointer()
b := HasPointer(td)
if a != b {
t.Errorf("td.hasPointer(): %t != HasPointer(td): %t (%s)", a, b, td.WIT(nil, td.TypeName()))
}
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestHasBorrowOnNamedTypes verifies that HasBorrow returns true for all named WIT types that contain a borrow<T>.
func TestHasBorrowOnNamedTypes(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for _, td := range res.TypeDefs {
if td.Name == nil {
// Skip anonymous types here. This is tested on `TestHasBorrow`.
// https://github.com/bytecodealliance/wasm-tools-go/issues/167
continue
}
wit := td.Kind.WIT(nil, "")
a := strings.Contains(wit, "borrow<")
b := HasBorrow(td)
if a != b {
t.Errorf("has \"borrow<\": %t != HasBorrow(td): %t (%s)", a, b, wit)
}
}
})
return nil
})
if err != nil {
t.Error(err)
}
}
// TestHandlesAreResources verifies that all [Handle] types have an underlying [Resource] type.
func TestHandlesAreResources(t *testing.T) {
err := loadTestdata(func(path string, res *Resolve) error {
t.Run(path, func(t *testing.T) {
for i, td := range res.TypeDefs {
var handleType *TypeDef
switch kind := td.Kind.(type) {
case *Own:
handleType = kind.Type
case *Borrow:
handleType = kind.Type
default:
continue
}
name := fmt.Sprintf("TypeDefs[%d]", i)
if td.Name != nil {
name += "#" + *td.Name
}
t.Run(name, func(t *testing.T) {
switch kind := handleType.Root().Kind.(type) {
case *Resource:
// ok
default:
t.Errorf("non-resource type in handle: %s", kind.WIT(nil, ""))
}
})
}
})
return nil
})
if err != nil {
t.Error(err)
}
}