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
|
// Copyright 2019 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package gomarshal
import (
"fmt"
"go/ast"
"io"
"strings"
)
var standardImports = []string{
"bytes",
"fmt",
"reflect",
"testing",
"gvisor.dev/gvisor/tools/go_marshal/analysis",
}
var sliceAPIImports = []string{
"encoding/binary",
"gvisor.dev/gvisor/pkg/hostarch",
}
type testGenerator struct {
sourceBuffer
// The type we're serializing.
t *ast.TypeSpec
// Receiver argument for generated methods.
r string
// Imports used by generated code.
imports *importTable
// Import statement for the package declaring the type we generated code
// for. We need this to construct test instances for the type, since the
// tests aren't written in the same package.
decl *importStmt
}
func newTestGenerator(t *ast.TypeSpec, r string) *testGenerator {
g := &testGenerator{
t: t,
r: r,
imports: newImportTable(),
}
for _, i := range standardImports {
g.imports.add(i).markUsed()
}
// These imports are used if a type requests the slice API. Don't
// mark them as used by default.
for _, i := range sliceAPIImports {
g.imports.add(i)
}
return g
}
func (g *testGenerator) typeName() string {
return g.t.Name.Name
}
func (g *testGenerator) testFuncName(base string) string {
return fmt.Sprintf("%s%s", base, strings.Title(g.t.Name.Name))
}
func (g *testGenerator) inTestFunction(name string, body func()) {
g.emit("func %s(t *testing.T) {\n", g.testFuncName(name))
g.inIndent(body)
g.emit("}\n\n")
}
func (g *testGenerator) emitTestNonZeroSize() {
g.inTestFunction("TestSizeNonZero", func() {
g.emit("var x %v\n", g.typeName())
g.emit("if x.SizeBytes() == 0 {\n")
g.inIndent(func() {
g.emit("t.Fatal(\"Marshallable.SizeBytes() should not return zero\")\n")
})
g.emit("}\n")
})
}
func (g *testGenerator) emitTestSuspectAlignment() {
g.inTestFunction("TestSuspectAlignment", func() {
g.emit("var x %v\n", g.typeName())
g.emit("analysis.AlignmentCheck(t, reflect.TypeOf(x))\n")
})
}
func (g *testGenerator) emitTestMarshalUnmarshalPreservesData() {
g.inTestFunction("TestSafeMarshalUnmarshalPreservesData", func() {
g.emit("var x, y, z, yUnsafe, zUnsafe %s\n", g.typeName())
g.emit("analysis.RandomizeValue(&x)\n\n")
g.emit("buf := make([]byte, x.SizeBytes())\n")
g.emit("x.MarshalBytes(buf)\n")
g.emit("bufUnsafe := make([]byte, x.SizeBytes())\n")
g.emit("x.MarshalUnsafe(bufUnsafe)\n\n")
g.emit("y.UnmarshalBytes(buf)\n")
g.emit("if !reflect.DeepEqual(x, y) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across MarshalBytes/UnmarshalBytes cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, y))\n")
})
g.emit("}\n")
g.emit("yUnsafe.UnmarshalBytes(bufUnsafe)\n")
g.emit("if !reflect.DeepEqual(x, yUnsafe) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across MarshalUnsafe/UnmarshalBytes cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, yUnsafe))\n")
})
g.emit("}\n\n")
g.emit("z.UnmarshalUnsafe(buf)\n")
g.emit("if !reflect.DeepEqual(x, z) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across MarshalBytes/UnmarshalUnsafe cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, z))\n")
})
g.emit("}\n")
g.emit("zUnsafe.UnmarshalUnsafe(bufUnsafe)\n")
g.emit("if !reflect.DeepEqual(x, zUnsafe) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across MarshalUnsafe/UnmarshalUnsafe cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, zUnsafe))\n")
})
g.emit("}\n")
})
}
func (g *testGenerator) emitTestMarshalUnmarshalSlicePreservesData(slice *sliceAPI) {
for _, name := range []string{"binary", "hostarch"} {
if !g.imports.markUsed(name) {
panic(fmt.Sprintf("Generated test for '%s' referenced a non-existent import with local name '%s'", g.typeName(), name))
}
}
g.inTestFunction("TestSafeMarshalUnmarshalSlicePreservesData", func() {
g.emit("var x, y, yUnsafe [8]%s\n", g.typeName())
g.emit("analysis.RandomizeValue(&x)\n\n")
g.emit("size := (*%s)(nil).SizeBytes() * len(x)\n", g.typeName())
g.emit("buf := bytes.NewBuffer(make([]byte, size))\n")
g.emit("buf.Reset()\n")
g.emit("if err := binary.Write(buf, hostarch.ByteOrder, x[:]); err != nil {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"binary.Write failed: %v\", err))\n")
})
g.emit("}\n")
g.emit("bufUnsafe := make([]byte, size)\n")
g.emit("MarshalUnsafe%s(x[:], bufUnsafe)\n\n", slice.ident)
g.emit("UnmarshalUnsafe%s(y[:], buf.Bytes())\n", slice.ident)
g.emit("if !reflect.DeepEqual(x, y) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across binary.Write/UnmarshalUnsafeSlice cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, y))\n")
})
g.emit("}\n")
g.emit("UnmarshalUnsafe%s(yUnsafe[:], bufUnsafe)\n", slice.ident)
g.emit("if !reflect.DeepEqual(x, yUnsafe) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across MarshalUnsafeSlice/UnmarshalUnsafeSlice cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, yUnsafe))\n")
})
g.emit("}\n\n")
})
}
func (g *testGenerator) emitTestWriteToUnmarshalPreservesData() {
g.inTestFunction("TestWriteToUnmarshalPreservesData", func() {
g.emit("var x, y, yUnsafe %s\n", g.typeName())
g.emit("analysis.RandomizeValue(&x)\n\n")
g.emit("var buf bytes.Buffer\n\n")
g.emit("x.WriteTo(&buf)\n")
g.emit("y.UnmarshalBytes(buf.Bytes())\n\n")
g.emit("yUnsafe.UnmarshalUnsafe(buf.Bytes())\n\n")
g.emit("if !reflect.DeepEqual(x, y) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across WriteTo/UnmarshalBytes cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, y))\n")
})
g.emit("}\n")
g.emit("if !reflect.DeepEqual(x, yUnsafe) {\n")
g.inIndent(func() {
g.emit("t.Fatal(fmt.Sprintf(\"Data corrupted across WriteTo/UnmarshalUnsafe cycle:\\nBefore: %+v\\nAfter: %+v\\n\", x, yUnsafe))\n")
})
g.emit("}\n")
})
}
func (g *testGenerator) emitTestSizeBytesOnTypedNilPtr() {
g.inTestFunction("TestSizeBytesOnTypedNilPtr", func() {
g.emit("var x %s\n", g.typeName())
g.emit("sizeFromConcrete := x.SizeBytes()\n")
g.emit("sizeFromTypedNilPtr := (*%s)(nil).SizeBytes()\n\n", g.typeName())
g.emit("if sizeFromTypedNilPtr != sizeFromConcrete {\n")
g.inIndent(func() {
g.emit("t.Fatalf(\"SizeBytes() on typed nil pointer (%v) doesn't match size returned by a concrete object (%v).\\n\", sizeFromTypedNilPtr, sizeFromConcrete)\n")
})
g.emit("}\n")
})
}
func (g *testGenerator) emitTestBoundCheck() {
g.inTestFunction("TestCheckedMethods", func() {
g.emit("var x %s\n", g.typeName())
g.emit("size := x.SizeBytes()\n")
g.emit("b := make([]byte, size)\n\n")
g.emit("if _, ok := x.CheckedMarshal(b[:size-1]); ok {\n")
g.inIndent(func() {
g.emit("t.Errorf(\"CheckedMarshal should have failed because buffer is small\")\n")
})
g.emit("}\n")
g.emit("if _, ok := x.CheckedMarshal(b); !ok {\n")
g.inIndent(func() {
g.emit("t.Errorf(\"CheckedMarshal should have succeeded because buffer size is okay\")\n")
})
g.emit("}\n\n")
g.emit("if _, ok := x.CheckedUnmarshal(b[:size-1]); ok {\n")
g.inIndent(func() {
g.emit("t.Errorf(\"CheckedUnmarshal should have failed because buffer is small\")\n")
})
g.emit("}\n")
g.emit("if _, ok := x.CheckedUnmarshal(b); !ok {\n")
g.inIndent(func() {
g.emit("t.Errorf(\"CheckedUnmarshal should have succeeded because buffer size is okay\")\n")
})
g.emit("}\n")
})
}
func (g *testGenerator) emitTests(slice *sliceAPI, boundCheck bool) {
g.emitTestNonZeroSize()
g.emitTestSuspectAlignment()
g.emitTestMarshalUnmarshalPreservesData()
g.emitTestWriteToUnmarshalPreservesData()
g.emitTestSizeBytesOnTypedNilPtr()
if slice != nil {
g.emitTestMarshalUnmarshalSlicePreservesData(slice)
}
if boundCheck {
g.emitTestBoundCheck()
}
}
func (g *testGenerator) write(out io.Writer) error {
return g.sourceBuffer.write(out)
}
|
