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
|
package grpctool_test
import (
"testing"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/grpctool/test"
"gitlab.com/gitlab-org/cluster-integration/gitlab-agent/v16/internal/tool/testing/mock_rpc"
"google.golang.org/grpc/codes"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
)
const (
scalarNumber protoreflect.FieldNumber = 1
x1Number protoreflect.FieldNumber = 2
dataNumber protoreflect.FieldNumber = 3
lastNumber protoreflect.FieldNumber = 4
)
// Test *test.Response as callback parameter type
func TestStreamVisitorMessageHappyPath(t *testing.T) {
stream := setupStream(t)
var (
scalarCalled int
x1Called int
dataCalled int
lastCalled int
eofCalled int
)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream,
grpctool.WithEOFCallback(func() error {
eofCalled++
return nil
}),
grpctool.WithCallback(scalarNumber, func(message *test.Response) error {
scalarCalled++
return nil
}),
grpctool.WithCallback(x1Number, func(message *test.Response) error {
x1Called++
return nil
}),
grpctool.WithCallback(dataNumber, func(message *test.Response) error {
dataCalled++
return nil
}),
grpctool.WithCallback(lastNumber, func(message *test.Response) error {
lastCalled++
return nil
}),
)
require.NoError(t, err)
assert.Equal(t, 1, scalarCalled)
assert.Equal(t, 1, x1Called)
assert.Equal(t, 2, dataCalled)
assert.Equal(t, 1, lastCalled)
assert.Equal(t, 1, eofCalled)
}
// Test field types as callback parameter type.
func TestStreamVisitorFieldHappyPath(t *testing.T) {
stream := setupStream(t)
var (
scalarCalled int
x1Called int
dataCalled int
lastCalled int
eofCalled int
)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream,
grpctool.WithEOFCallback(func() error {
eofCalled++
return nil
}),
grpctool.WithCallback(scalarNumber, func(scalar int64) error {
scalarCalled++
return nil
}),
grpctool.WithCallback(x1Number, func(x1 test.Enum1) error {
x1Called++
return nil
}),
grpctool.WithCallback(dataNumber, func(data *test.Response_Data) error {
dataCalled++
return nil
}),
grpctool.WithCallback(lastNumber, func(last *test.Response_Last) error {
lastCalled++
return nil
}),
)
require.NoError(t, err)
assert.Equal(t, 1, scalarCalled)
assert.Equal(t, 1, x1Called)
assert.Equal(t, 2, dataCalled)
assert.Equal(t, 1, lastCalled)
assert.Equal(t, 1, eofCalled)
}
// Test mixed types as callback parameter type.
func TestStreamVisitorMixedHappyPath(t *testing.T) {
stream := setupStream(t)
var (
scalarCalled int
x1Called int
dataCalled int
lastCalled int
eofCalled int
)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream,
grpctool.WithEOFCallback(func() error {
eofCalled++
return nil
}),
grpctool.WithCallback(scalarNumber, func(message proto.Message) error {
scalarCalled++
return nil
}),
grpctool.WithCallback(x1Number, func(x1 test.Enum1) error {
x1Called++
return nil
}),
grpctool.WithCallback(dataNumber, func(data interface{ GetData() []byte }) error {
dataCalled++
return nil
}),
grpctool.WithCallback(lastNumber, func(last interface{}) error {
lastCalled++
return nil
}),
)
require.NoError(t, err)
assert.Equal(t, 1, scalarCalled)
assert.Equal(t, 1, x1Called)
assert.Equal(t, 2, dataCalled)
assert.Equal(t, 1, lastCalled)
assert.Equal(t, 1, eofCalled)
}
func TestStreamVisitorCustomStartState(t *testing.T) {
ctrl := gomock.NewController(t)
stream, calls := mock_rpc.InitMockClientStream(ctrl, true,
&test.Response{
Message: &test.Response_Last_{
Last: &test.Response_Last{},
},
},
)
gomock.InOrder(calls...)
var (
scalarCalled int
x1Called int
dataCalled int
lastCalled int
eofCalled int
)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream,
grpctool.WithEOFCallback(func() error {
eofCalled++
return nil
}),
grpctool.WithCallback(scalarNumber, func(message proto.Message) error {
scalarCalled++
return nil
}),
grpctool.WithCallback(x1Number, func(x1 test.Enum1) error {
x1Called++
return nil
}),
grpctool.WithCallback(dataNumber, func(data interface{ GetData() []byte }) error {
dataCalled++
return nil
}),
grpctool.WithCallback(lastNumber, func(last interface{}) error {
lastCalled++
return nil
}),
grpctool.WithStartState(dataNumber),
)
require.NoError(t, err)
assert.Zero(t, scalarCalled)
assert.Zero(t, x1Called)
assert.Zero(t, dataCalled)
assert.Equal(t, 1, lastCalled)
assert.Equal(t, 1, eofCalled)
}
func setupStream(t *testing.T) *mock_rpc.MockClientStream {
ctrl := gomock.NewController(t)
stream, calls := mock_rpc.InitMockClientStream(ctrl, true,
&test.Response{
Message: &test.Response_Scalar{
Scalar: 123,
},
},
&test.Response{
Message: &test.Response_X1{
X1: test.Enum1_v1,
},
},
&test.Response{
Message: &test.Response_Data_{
Data: &test.Response_Data{},
},
},
&test.Response{
Message: &test.Response_Data_{
Data: &test.Response_Data{},
},
},
&test.Response{
Message: &test.Response_Last_{
Last: &test.Response_Last{},
},
},
)
gomock.InOrder(calls...)
return stream
}
func TestStreamVisitorHappyPathNoEof(t *testing.T) {
ctrl := gomock.NewController(t)
stream, calls := mock_rpc.InitMockClientStream(ctrl, true,
&test.Response{
Message: &test.Response_Scalar{
Scalar: 234,
},
},
&test.Response{
Message: &test.Response_X1{
X1: test.Enum1_v1,
},
},
&test.Response{
Message: &test.Response_Data_{
Data: &test.Response_Data{},
},
},
&test.Response{
Message: &test.Response_Last_{
Last: &test.Response_Last{},
},
},
)
gomock.InOrder(calls...)
var (
scalarCalled int
x1Called int
dataCalled int
lastCalled int
)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream,
grpctool.WithCallback(scalarNumber, func(message *test.Response) error {
scalarCalled++
return nil
}),
grpctool.WithCallback(x1Number, func(x1 test.Enum1) error {
x1Called++
return nil
}),
grpctool.WithCallback(dataNumber, func(message *test.Response) error {
dataCalled++
return nil
}),
grpctool.WithCallback(lastNumber, func(message *test.Response) error {
lastCalled++
return nil
}),
)
require.NoError(t, err)
assert.Equal(t, 1, scalarCalled)
assert.Equal(t, 1, x1Called)
assert.Equal(t, 1, dataCalled)
assert.Equal(t, 1, lastCalled)
}
func TestStreamVisitorReachableMissingCallback(t *testing.T) {
ctrl := gomock.NewController(t)
stream := mock_rpc.NewMockClientStream(ctrl)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream)
require.EqualError(t, err, "rpc error: code = Internal desc = no callback defined for field gitlab.agent.grpctool.test.Response.scalar (1)")
}
func TestStreamingVisitorUnreachableMissingCallback(t *testing.T) {
ctrl := gomock.NewController(t)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
// we will use start state x1Number, comment out "missing" start state entries for clarity
stream, calls := mock_rpc.InitMockClientStream(ctrl, true,
// /* skip (pretend it is already processed) */ &test.Response{Message: &test.Response_Scalar{Scalar: 123}},
// /* skip (pretend it is already processed) */ &test.Response{Message: &test.Response_X1{X1: test.Enum1_v1}},
&test.Response{Message: &test.Response_Data_{Data: &test.Response_Data{}}},
&test.Response{Message: &test.Response_Last_{Last: &test.Response_Last{}}},
)
gomock.InOrder(calls...)
err = v.Visit(stream,
grpctool.WithStartState(x1Number),
// /* skip (because unreachable) */ grpctool.WithCallback(scalarNumber, func(message *test.Response) error { return nil }),
// /* skip (because unreachable) */ grpctool.WithCallback(x1Number, func(message *test.Response) error { return nil }),
grpctool.WithCallback(dataNumber, func(message *test.Response) error { return nil }),
grpctool.WithCallback(lastNumber, func(message *test.Response) error { return nil }),
)
require.NoError(t, err)
}
func TestStreamVisitor_UnexpectedFieldReceived(t *testing.T) {
ctrl := gomock.NewController(t)
stream, calls := mock_rpc.InitMockClientStream(ctrl, false,
&test.Response{
Message: &test.Response_Scalar{},
},
)
gomock.InOrder(calls...)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream, grpctool.WithNotExpectingToGet(codes.DataLoss, scalarNumber, x1Number, dataNumber, lastNumber))
require.EqualError(t, err, "rpc error: code = DataLoss desc = unexpected field number received: 1")
}
func TestStreamVisitor_WithNotExpectingToGet_HappyPath(t *testing.T) {
ctrl := gomock.NewController(t)
stream, calls := mock_rpc.InitMockClientStream(ctrl, true,
&test.Response{
Message: &test.Response_Last_{},
},
)
gomock.InOrder(calls...)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
err = v.Visit(stream,
grpctool.WithStartState(dataNumber),
// even though WithStartState(dataNumber), dataNumber is still required because there is dataNumber -> dataNumber transition
grpctool.WithNotExpectingToGet(codes.DataLoss, dataNumber),
grpctool.WithCallback(lastNumber, func(l *test.Response_Last) error { return nil }))
require.NoError(t, err)
}
func TestStreamVisitorNoOneofs(t *testing.T) {
_, err := grpctool.NewStreamVisitor(&test.NoOneofs{})
require.EqualError(t, err, "one oneof group is expected in gitlab.agent.grpctool.test.NoOneofs, 0 defined")
}
func TestStreamVisitorTwoOneofs(t *testing.T) {
_, err := grpctool.NewStreamVisitor(&test.TwoOneofs{})
require.EqualError(t, err, "one oneof group is expected in gitlab.agent.grpctool.test.TwoOneofs, 2 defined")
}
func TestStreamVisitorTwoValidOneofs(t *testing.T) {
_, err := grpctool.NewStreamVisitor(&test.TwoValidOneofs{})
require.EqualError(t, err, "one oneof group is expected in gitlab.agent.grpctool.test.TwoValidOneofs, 2 defined")
}
func TestStreamVisitorNumberOutOfOneof(t *testing.T) {
_, err := grpctool.NewStreamVisitor(&test.OutOfOneof{})
require.EqualError(t, err, "field number 1 is not part of oneof gitlab.agent.grpctool.test.OutOfOneof.message")
}
func TestStreamVisitorNotAllFieldsReachable(t *testing.T) {
_, err := grpctool.NewStreamVisitor(&test.NotAllReachable{})
require.EqualError(t, err, "unreachable fields in oneof gitlab.agent.grpctool.test.NotAllReachable.message: [1 2]")
}
func TestStreamVisitorInvalidNumber(t *testing.T) {
ctrl := gomock.NewController(t)
stream := mock_rpc.NewMockClientStream(ctrl)
v, err := grpctool.NewStreamVisitor(&test.Response{})
require.NoError(t, err)
cb := func(message *test.Response) error {
return nil
}
err = v.Visit(stream,
grpctool.WithCallback(scalarNumber, cb),
grpctool.WithCallback(x1Number, cb),
grpctool.WithCallback(dataNumber, cb),
grpctool.WithCallback(lastNumber, cb),
grpctool.WithCallback(20, cb),
)
require.EqualError(t, err, "rpc error: code = Internal desc = oneof gitlab.agent.grpctool.test.Response.message does not have a field 20")
}
|
