aboutsummaryrefslogtreecommitdiffstats
path: root/core/channel_test.go
blob: b8d07b549ce3f9716c247468c73d6c207b9e7bb3 (plain)
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
// Copyright (c) 2017 Cisco and/or its affiliates.
//
// 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 core

import (
	"testing"
	"time"

	. "github.com/onsi/gomega"

	"git.fd.io/govpp.git/adapter/mock"
	"git.fd.io/govpp.git/api"
	"git.fd.io/govpp.git/examples/binapi/interface_types"
	"git.fd.io/govpp.git/examples/binapi/interfaces"
	"git.fd.io/govpp.git/examples/binapi/memif"
	"git.fd.io/govpp.git/examples/binapi/vpe"
)

type testCtx struct {
	mockVpp *mock.VppAdapter
	conn    *Connection
	ch      api.Channel
}

func setupTest(t *testing.T) *testCtx {
	RegisterTestingT(t)

	ctx := &testCtx{
		mockVpp: mock.NewVppAdapter(),
	}

	var err error
	ctx.conn, err = Connect(ctx.mockVpp)
	Expect(err).ShouldNot(HaveOccurred())

	ctx.ch, err = ctx.conn.NewAPIChannel()
	Expect(err).ShouldNot(HaveOccurred())

	return ctx
}

func (ctx *testCtx) teardownTest() {
	ctx.ch.Close()
	ctx.conn.Disconnect()
}

func TestRequestReplyMemifCreate(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// mock reply
	ctx.mockVpp.MockReply(&memif.MemifCreateReply{
		SwIfIndex: 4,
	})

	request := &memif.MemifCreate{
		Role:       10,
		ID:         12,
		RingSize:   8000,
		BufferSize: 50,
	}
	reply := &memif.MemifCreateReply{}

	err := ctx.ch.SendRequest(request).ReceiveReply(reply)
	Expect(err).ShouldNot(HaveOccurred())
	Expect(reply.Retval).To(BeEquivalentTo(0),
		"Incorrect Retval value for MemifCreate")
	Expect(reply.SwIfIndex).To(BeEquivalentTo(4),
		"Incorrect SwIfIndex value for MemifCreate")
}

func TestRequestReplyMemifDelete(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// mock reply
	ctx.mockVpp.MockReply(&memif.MemifDeleteReply{})

	request := &memif.MemifDelete{
		SwIfIndex: 15,
	}
	reply := &memif.MemifDeleteReply{}

	err := ctx.ch.SendRequest(request).ReceiveReply(reply)
	Expect(err).ShouldNot(HaveOccurred())
}

func TestRequestReplyMemifDetails(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// mock reply
	ctx.mockVpp.MockReply(&memif.MemifDetails{
		SwIfIndex: 25,
		IfName:    "memif-name",
		Role:      0,
	})

	request := &memif.MemifDump{}
	reply := &memif.MemifDetails{}

	err := ctx.ch.SendRequest(request).ReceiveReply(reply)
	Expect(err).ShouldNot(HaveOccurred())
	Expect(reply.SwIfIndex).To(BeEquivalentTo(25),
		"Incorrect SwIfIndex value for MemifDetails")
	Expect(reply.IfName).ToNot(BeEmpty(),
		"MemifDetails IfName is empty byte array")
	Expect(reply.Role).To(BeEquivalentTo(0),
		"Incorrect Role value for MemifDetails")
}

func TestMultiRequestReplySwInterfaceMemifDump(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// mock reply
	var msgs []api.Message
	for i := 1; i <= 10; i++ {
		msgs = append(msgs, &memif.MemifDetails{
			SwIfIndex: interfaces.InterfaceIndex(i),
		})
	}
	ctx.mockVpp.MockReply(msgs...)
	ctx.mockVpp.MockReply(&ControlPingReply{})

	reqCtx := ctx.ch.SendMultiRequest(&memif.MemifDump{})
	cnt := 0
	for {
		msg := &memif.MemifDetails{}
		stop, err := reqCtx.ReceiveReply(msg)
		if stop {
			break
		}
		Expect(err).ShouldNot(HaveOccurred())
		cnt++
	}
	Expect(cnt).To(BeEquivalentTo(10))
}

func TestNotificationEvent(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// subscribe for notification
	notifChan := make(chan api.Message, 1)
	sub, err := ctx.ch.SubscribeNotification(notifChan, &interfaces.SwInterfaceEvent{})
	Expect(err).ShouldNot(HaveOccurred())

	// mock event and force its delivery
	ctx.mockVpp.MockReply(&interfaces.SwInterfaceEvent{
		SwIfIndex: 2,
		Flags:     interface_types.IF_STATUS_API_FLAG_LINK_UP,
	})
	ctx.mockVpp.SendMsg(0, []byte(""))

	// receive the notification
	var notif *interfaces.SwInterfaceEvent
	Eventually(func() *interfaces.SwInterfaceEvent {
		select {
		case n := <-notifChan:
			notif = n.(*interfaces.SwInterfaceEvent)
			return notif
		default:
			return nil
		}
	}).ShouldNot(BeNil())

	// verify the received notifications
	Expect(notif.SwIfIndex).To(BeEquivalentTo(2), "Incorrect SwIfIndex value for SwInterfaceSetFlags")
	Expect(notif.Flags).To(BeEquivalentTo(interface_types.IF_STATUS_API_FLAG_LINK_UP), "Incorrect LinkUpDown value for SwInterfaceSetFlags")

	err = sub.Unsubscribe()
	Expect(err).ShouldNot(HaveOccurred())
}

func TestSetReplyTimeout(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	ctx.ch.SetReplyTimeout(time.Millisecond)

	// mock reply
	ctx.mockVpp.MockReply(&ControlPingReply{})

	// first one request should work
	err := ctx.ch.SendRequest(&ControlPing{}).ReceiveReply(&ControlPingReply{})
	Expect(err).ShouldNot(HaveOccurred())

	// no other reply ready - expect timeout
	err = ctx.ch.SendRequest(&ControlPing{}).ReceiveReply(&ControlPingReply{})
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("timeout"))
}

func TestSetReplyTimeoutMultiRequest(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	ctx.ch.SetReplyTimeout(time.Millisecond * 100)

	// mock reply
	ctx.mockVpp.MockReply(
		&interfaces.SwInterfaceDetails{
			SwIfIndex:     1,
			InterfaceName: "if-name-test",
		},
		&interfaces.SwInterfaceDetails{
			SwIfIndex:     2,
			InterfaceName: "if-name-test",
		},
		&interfaces.SwInterfaceDetails{
			SwIfIndex:     3,
			InterfaceName: "if-name-test",
		},
	)
	ctx.mockVpp.MockReply(&ControlPingReply{})

	cnt := 0
	sendMultiRequest := func() error {
		reqCtx := ctx.ch.SendMultiRequest(&interfaces.SwInterfaceDump{})
		for {
			msg := &interfaces.SwInterfaceDetails{}
			stop, err := reqCtx.ReceiveReply(msg)
			if err != nil {
				return err
			}
			if stop {
				break
			}
			cnt++
		}
		return nil
	}

	// first one request should work
	err := sendMultiRequest()
	Expect(err).ShouldNot(HaveOccurred())

	// no other reply ready - expect timeout
	err = sendMultiRequest()
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("timeout"))

	Expect(cnt).To(BeEquivalentTo(3))
}

func TestReceiveReplyNegative(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// invalid context 1
	reqCtx1 := &requestCtx{}
	err := reqCtx1.ReceiveReply(&ControlPingReply{})
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("invalid request context"))

	// invalid context 2
	reqCtx2 := &multiRequestCtx{}
	_, err = reqCtx2.ReceiveReply(&ControlPingReply{})
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("invalid request context"))

	// NU
	reqCtx3 := &requestCtx{}
	err = reqCtx3.ReceiveReply(nil)
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("invalid request context"))
}

func TestMultiRequestDouble(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// mock reply
	var msgs []mock.MsgWithContext
	for i := 1; i <= 3; i++ {
		msgs = append(msgs, mock.MsgWithContext{
			Msg: &interfaces.SwInterfaceDetails{
				SwIfIndex:     interfaces.InterfaceIndex(i),
				InterfaceName: "if-name-test",
			},
			Multipart: true,
			SeqNum:    1,
		})
	}
	msgs = append(msgs, mock.MsgWithContext{Msg: &ControlPingReply{}, Multipart: true, SeqNum: 1})

	for i := 1; i <= 3; i++ {
		msgs = append(msgs,
			mock.MsgWithContext{
				Msg: &interfaces.SwInterfaceDetails{
					SwIfIndex:     interfaces.InterfaceIndex(i),
					InterfaceName: "if-name-test",
				},
				Multipart: true,
				SeqNum:    2,
			})
	}
	msgs = append(msgs, mock.MsgWithContext{Msg: &ControlPingReply{}, Multipart: true, SeqNum: 2})

	ctx.mockVpp.MockReplyWithContext(msgs...)

	cnt := 0
	var sendMultiRequest = func() error {
		reqCtx := ctx.ch.SendMultiRequest(&interfaces.SwInterfaceDump{})
		for {
			msg := &interfaces.SwInterfaceDetails{}
			stop, err := reqCtx.ReceiveReply(msg)
			if stop {
				break
			}
			if err != nil {
				return err
			}
			cnt++
		}
		return nil
	}

	err := sendMultiRequest()
	Expect(err).ShouldNot(HaveOccurred())

	err = sendMultiRequest()
	Expect(err).ShouldNot(HaveOccurred())

	Expect(cnt).To(BeEquivalentTo(6))
}

func TestReceiveReplyAfterTimeout(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	ctx.ch.SetReplyTimeout(time.Millisecond)

	// mock reply
	ctx.mockVpp.MockReplyWithContext(mock.MsgWithContext{Msg: &ControlPingReply{}, SeqNum: 1})
	// first one request should work

	err := ctx.ch.SendRequest(&ControlPing{}).ReceiveReply(&ControlPingReply{})
	Expect(err).ShouldNot(HaveOccurred())

	err = ctx.ch.SendRequest(&ControlPing{}).ReceiveReply(&ControlPingReply{})
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("timeout"))

	ctx.mockVpp.MockReplyWithContext(
		// simulating late reply
		mock.MsgWithContext{
			Msg:    &ControlPingReply{},
			SeqNum: 2,
		},
		// normal reply for next request
		mock.MsgWithContext{
			Msg:    &interfaces.SwInterfaceSetFlagsReply{},
			SeqNum: 3,
		},
	)

	req := &interfaces.SwInterfaceSetFlags{
		SwIfIndex: 1,
		Flags:     interface_types.IF_STATUS_API_FLAG_ADMIN_UP,
	}
	reply := &interfaces.SwInterfaceSetFlagsReply{}

	// should succeed
	err = ctx.ch.SendRequest(req).ReceiveReply(reply)
	Expect(err).ShouldNot(HaveOccurred())
}

func TestReceiveReplyAfterTimeoutMultiRequest(t *testing.T) {
	/*
		TODO: fix mock adapter
		This test will fail because mock adapter will stop sending replies
		when it encounters control_ping_reply from multi request,
		thus never sending reply for next request
	*/
	t.Skip()

	ctx := setupTest(t)
	defer ctx.teardownTest()

	ctx.ch.SetReplyTimeout(time.Millisecond * 100)

	// mock reply
	ctx.mockVpp.MockReplyWithContext(mock.MsgWithContext{Msg: &ControlPingReply{}, SeqNum: 1})

	// first one request should work
	err := ctx.ch.SendRequest(&ControlPing{}).ReceiveReply(&ControlPingReply{})
	Expect(err).ShouldNot(HaveOccurred())

	cnt := 0
	var sendMultiRequest = func() error {
		reqCtx := ctx.ch.SendMultiRequest(&interfaces.SwInterfaceDump{})
		for {
			msg := &interfaces.SwInterfaceDetails{}
			stop, err := reqCtx.ReceiveReply(msg)
			if stop {
				break
			}
			if err != nil {
				return err
			}
			cnt++
		}
		return nil
	}

	err = sendMultiRequest()
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("timeout"))
	Expect(cnt).To(BeEquivalentTo(0))

	// simulating late replies
	var msgs []mock.MsgWithContext
	for i := 1; i <= 3; i++ {
		msgs = append(msgs, mock.MsgWithContext{
			Msg: &interfaces.SwInterfaceDetails{
				SwIfIndex:     interfaces.InterfaceIndex(i),
				InterfaceName: "if-name-test",
			},
			Multipart: true,
			SeqNum:    2,
		})
	}
	msgs = append(msgs, mock.MsgWithContext{Msg: &ControlPingReply{}, Multipart: true, SeqNum: 2})
	ctx.mockVpp.MockReplyWithContext(msgs...)

	// normal reply for next request
	ctx.mockVpp.MockReplyWithContext(mock.MsgWithContext{Msg: &interfaces.SwInterfaceSetFlagsReply{}, SeqNum: 3})

	req := &interfaces.SwInterfaceSetFlags{
		SwIfIndex: 1,
		Flags:     interface_types.IF_STATUS_API_FLAG_ADMIN_UP,
	}
	reply := &interfaces.SwInterfaceSetFlagsReply{}

	// should succeed
	err = ctx.ch.SendRequest(req).ReceiveReply(reply)
	Expect(err).ShouldNot(HaveOccurred())
}

func TestInvalidMessageID(t *testing.T) {
	ctx := setupTest(t)
	defer ctx.teardownTest()

	// mock reply
	ctx.mockVpp.MockReply(&vpe.ShowVersionReply{})
	ctx.mockVpp.MockReply(&vpe.ShowVersionReply{})

	// first one request should work
	err := ctx.ch.SendRequest(&vpe.ShowVersion{}).ReceiveReply(&vpe.ShowVersionReply{})
	Expect(err).ShouldNot(HaveOccurred())

	// second should fail with error invalid message ID
	err = ctx.ch.SendRequest(&ControlPing{}).ReceiveReply(&ControlPingReply{})
	Expect(err).Should(HaveOccurred())
	Expect(err.Error()).To(ContainSubstring("invalid message ID"))
}