1 // Copyright (c) 2017 Cisco and/or its affiliates.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at:
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
21 "git.fd.io/govpp.git/adapter/mock"
22 "git.fd.io/govpp.git/api"
23 "git.fd.io/govpp.git/core"
24 "git.fd.io/govpp.git/core/bin_api/vpe"
25 "git.fd.io/govpp.git/examples/bin_api/interfaces"
26 "git.fd.io/govpp.git/examples/bin_api/memif"
27 "git.fd.io/govpp.git/examples/bin_api/tap"
29 . "github.com/onsi/gomega"
33 mockVpp *mock.VppAdapter
38 func setupTest(t *testing.T) *testCtx {
42 mockVpp: &mock.VppAdapter{},
46 ctx.conn, err = core.Connect(ctx.mockVpp)
47 Expect(err).ShouldNot(HaveOccurred())
49 ctx.ch, err = ctx.conn.NewAPIChannel()
50 Expect(err).ShouldNot(HaveOccurred())
55 func (ctx *testCtx) teardownTest() {
60 func TestRequestReplyTapConnect(t *testing.T) {
62 defer ctx.teardownTest()
64 ctx.mockVpp.MockReply(&tap.TapConnectReply{
68 request := &tap.TapConnect{
69 TapName: []byte("test-tap-name"),
72 reply := &tap.TapConnectReply{}
74 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
75 Expect(err).ShouldNot(HaveOccurred())
76 Expect(reply.Retval).To(BeEquivalentTo(10), "Incorrect retval value for TapConnectReply")
77 Expect(reply.SwIfIndex).To(BeEquivalentTo(1), "Incorrect SwIfIndex value for TapConnectReply")
80 func TestRequestReplyTapModify(t *testing.T) {
82 defer ctx.teardownTest()
84 ctx.mockVpp.MockReply(&tap.TapModifyReply{
88 request := &tap.TapModify{
89 TapName: []byte("test-tap-modify"),
93 reply := &tap.TapModifyReply{}
95 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
96 Expect(err).ShouldNot(HaveOccurred())
97 Expect(reply.Retval).To(BeEquivalentTo(15), "Incorrect retval value for TapModifyReply")
98 Expect(reply.SwIfIndex).To(BeEquivalentTo(2), "Incorrect SwIfIndex value for TapModifyReply")
101 func TestRequestReplyTapDelete(t *testing.T) {
103 defer ctx.teardownTest()
105 ctx.mockVpp.MockReply(&tap.TapDeleteReply{
108 request := &tap.TapDelete{
111 reply := &tap.TapDeleteReply{}
113 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
114 Expect(err).ShouldNot(HaveOccurred())
115 Expect(reply.Retval).To(BeEquivalentTo(20), "Incorrect retval value for TapDeleteReply")
118 func TestRequestReplySwInterfaceTapDump(t *testing.T) {
120 defer ctx.teardownTest()
122 byteName := []byte("dev-name-test")
123 ctx.mockVpp.MockReply(&tap.SwInterfaceTapDetails{
127 request := &tap.SwInterfaceTapDump{}
128 reply := &tap.SwInterfaceTapDetails{}
130 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
131 Expect(err).ShouldNot(HaveOccurred())
132 Expect(reply.SwIfIndex).To(BeEquivalentTo(25), "Incorrect SwIfIndex value for SwInterfaceTapDetails")
133 Expect(reply.DevName).ToNot(BeNil(), "Incorrect DevName value for SwInterfaceTapDetails")
136 func TestRequestReplyMemifCreate(t *testing.T) {
138 defer ctx.teardownTest()
140 ctx.mockVpp.MockReply(&memif.MemifCreateReply{
144 request := &memif.MemifCreate{
150 reply := &memif.MemifCreateReply{}
152 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
153 Expect(err).ShouldNot(HaveOccurred())
154 Expect(reply.Retval).To(BeEquivalentTo(22), "Incorrect Retval value for MemifCreate")
155 Expect(reply.SwIfIndex).To(BeEquivalentTo(4), "Incorrect SwIfIndex value for MemifCreate")
158 func TestRequestReplyMemifDelete(t *testing.T) {
160 defer ctx.teardownTest()
162 ctx.mockVpp.MockReply(&memif.MemifDeleteReply{
165 request := &memif.MemifDelete{
168 reply := &memif.MemifDeleteReply{}
170 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
171 Expect(err).ShouldNot(HaveOccurred())
172 Expect(reply.Retval).To(BeEquivalentTo(24), "Incorrect Retval value for MemifDelete")
175 func TestRequestReplyMemifDetails(t *testing.T) {
177 defer ctx.teardownTest()
179 ctx.mockVpp.MockReply(&memif.MemifDetails{
181 IfName: []byte("memif-name"),
184 request := &memif.MemifDump{}
185 reply := &memif.MemifDetails{}
187 err := ctx.ch.SendRequest(request).ReceiveReply(reply)
188 Expect(err).ShouldNot(HaveOccurred())
189 Expect(reply.SwIfIndex).To(BeEquivalentTo(25), "Incorrect SwIfIndex value for MemifDetails")
190 Expect(reply.IfName).ToNot(BeEmpty(), "MemifDetails IfName is empty byte array")
191 Expect(reply.Role).To(BeEquivalentTo(0), "Incorrect Role value for MemifDetails")
194 func TestMultiRequestReplySwInterfaceTapDump(t *testing.T) {
196 defer ctx.teardownTest()
199 for i := 1; i <= 10; i++ {
200 ctx.mockVpp.MockReply(&tap.SwInterfaceTapDetails{
201 SwIfIndex: uint32(i),
202 DevName: []byte("dev-name-test"),
205 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
207 reqCtx := ctx.ch.SendMultiRequest(&tap.SwInterfaceTapDump{})
210 msg := &tap.SwInterfaceTapDetails{}
211 stop, err := reqCtx.ReceiveReply(msg)
213 break // break out of the loop
215 Expect(err).ShouldNot(HaveOccurred())
218 Expect(cnt).To(BeEquivalentTo(10))
221 func TestMultiRequestReplySwInterfaceMemifDump(t *testing.T) {
223 defer ctx.teardownTest()
226 for i := 1; i <= 10; i++ {
227 ctx.mockVpp.MockReply(&memif.MemifDetails{
228 SwIfIndex: uint32(i),
231 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
233 reqCtx := ctx.ch.SendMultiRequest(&memif.MemifDump{})
236 msg := &memif.MemifDetails{}
237 stop, err := reqCtx.ReceiveReply(msg)
239 break // break out of the loop
241 Expect(err).ShouldNot(HaveOccurred())
244 Expect(cnt).To(BeEquivalentTo(10))
247 func TestNotifications(t *testing.T) {
249 defer ctx.teardownTest()
251 // subscribe for notification
252 notifChan := make(chan api.Message, 1)
253 subs, err := ctx.ch.SubscribeNotification(notifChan, interfaces.NewSwInterfaceSetFlags)
254 Expect(err).ShouldNot(HaveOccurred())
256 // mock the notification and force its delivery
257 ctx.mockVpp.MockReply(&interfaces.SwInterfaceSetFlags{
261 ctx.mockVpp.SendMsg(0, []byte(""))
263 // receive the notification
264 var notif *interfaces.SwInterfaceSetFlags
265 Eventually(func() *interfaces.SwInterfaceSetFlags {
267 case n := <-notifChan:
268 notif = n.(*interfaces.SwInterfaceSetFlags)
273 }).ShouldNot(BeNil())
275 // verify the received notifications
276 Expect(notif.SwIfIndex).To(BeEquivalentTo(3), "Incorrect SwIfIndex value for SwInterfaceSetFlags")
277 Expect(notif.AdminUpDown).To(BeEquivalentTo(1), "Incorrect AdminUpDown value for SwInterfaceSetFlags")
279 ctx.ch.UnsubscribeNotification(subs)
282 func TestNotificationEvent(t *testing.T) {
284 defer ctx.teardownTest()
286 // subscribe for notification
287 notifChan := make(chan api.Message, 1)
288 subs, err := ctx.ch.SubscribeNotification(notifChan, interfaces.NewSwInterfaceEvent)
289 Expect(err).ShouldNot(HaveOccurred())
291 // mock the notification and force its delivery
292 ctx.mockVpp.MockReply(&interfaces.SwInterfaceEvent{
296 ctx.mockVpp.SendMsg(0, []byte(""))
298 // receive the notification
299 var notif *interfaces.SwInterfaceEvent
300 Eventually(func() *interfaces.SwInterfaceEvent {
302 case n := <-notifChan:
303 notif = n.(*interfaces.SwInterfaceEvent)
308 }).ShouldNot(BeNil())
310 // verify the received notifications
311 Expect(notif.SwIfIndex).To(BeEquivalentTo(2), "Incorrect SwIfIndex value for SwInterfaceSetFlags")
312 Expect(notif.LinkUpDown).To(BeEquivalentTo(1), "Incorrect LinkUpDown value for SwInterfaceSetFlags")
314 ctx.ch.UnsubscribeNotification(subs)
317 func TestCheckMessageCompatibility(t *testing.T) {
319 defer ctx.teardownTest()
321 err := ctx.ch.CheckMessageCompatibility(&interfaces.SwInterfaceSetFlags{})
322 Expect(err).ShouldNot(HaveOccurred())
324 func TestSetReplyTimeout(t *testing.T) {
326 defer ctx.teardownTest()
328 ctx.ch.SetReplyTimeout(time.Millisecond)
330 // first one request should work
331 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
332 err := ctx.ch.SendRequest(&vpe.ControlPing{}).ReceiveReply(&vpe.ControlPingReply{})
333 Expect(err).ShouldNot(HaveOccurred())
335 // no other reply ready - expect timeout
336 err = ctx.ch.SendRequest(&vpe.ControlPing{}).ReceiveReply(&vpe.ControlPingReply{})
337 Expect(err).Should(HaveOccurred())
338 Expect(err.Error()).To(ContainSubstring("timeout"))
341 func TestSetReplyTimeoutMultiRequest(t *testing.T) {
343 defer ctx.teardownTest()
345 ctx.ch.SetReplyTimeout(time.Millisecond)
347 for i := 1; i <= 3; i++ {
348 ctx.mockVpp.MockReply(&interfaces.SwInterfaceDetails{
349 SwIfIndex: uint32(i),
350 InterfaceName: []byte("if-name-test"),
353 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
356 sendMultiRequest := func() error {
357 reqCtx := ctx.ch.SendMultiRequest(&interfaces.SwInterfaceDump{})
359 msg := &interfaces.SwInterfaceDetails{}
360 stop, err := reqCtx.ReceiveReply(msg)
362 break // break out of the loop
372 // first one request should work
373 err := sendMultiRequest()
374 Expect(err).ShouldNot(HaveOccurred())
376 // no other reply ready - expect timeout
377 err = sendMultiRequest()
378 Expect(err).Should(HaveOccurred())
379 Expect(err.Error()).To(ContainSubstring("timeout"))
381 Expect(cnt).To(BeEquivalentTo(3))
384 func TestReceiveReplyNegative(t *testing.T) {
386 defer ctx.teardownTest()
389 reqCtx1 := &api.RequestCtx{}
390 err := reqCtx1.ReceiveReply(&vpe.ControlPingReply{})
391 Expect(err).Should(HaveOccurred())
392 Expect(err.Error()).To(ContainSubstring("invalid request context"))
395 reqCtx2 := &api.MultiRequestCtx{}
396 _, err = reqCtx2.ReceiveReply(&vpe.ControlPingReply{})
397 Expect(err).Should(HaveOccurred())
398 Expect(err.Error()).To(ContainSubstring("invalid request context"))
401 reqCtx3 := &api.RequestCtx{}
402 err = reqCtx3.ReceiveReply(nil)
403 Expect(err).Should(HaveOccurred())
404 Expect(err.Error()).To(ContainSubstring("invalid request context"))
407 func TestMultiRequestDouble(t *testing.T) {
409 defer ctx.teardownTest()
412 for i := 1; i <= 3; i++ {
413 ctx.mockVpp.MockReply(&interfaces.SwInterfaceDetails{
414 SwIfIndex: uint32(i),
415 InterfaceName: []byte("if-name-test"),
418 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
419 for i := 1; i <= 3; i++ {
420 ctx.mockVpp.MockReply(&interfaces.SwInterfaceDetails{
421 SwIfIndex: uint32(i),
422 InterfaceName: []byte("if-name-test"),
425 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
428 var sendMultiRequest = func() error {
429 reqCtx := ctx.ch.SendMultiRequest(&interfaces.SwInterfaceDump{})
431 msg := &interfaces.SwInterfaceDetails{}
432 stop, err := reqCtx.ReceiveReply(msg)
434 break // break out of the loop
444 err := sendMultiRequest()
445 Expect(err).ShouldNot(HaveOccurred())
447 err = sendMultiRequest()
448 Expect(err).ShouldNot(HaveOccurred())
450 Expect(cnt).To(BeEquivalentTo(6))
453 func TestReceiveReplyAfterTimeout(t *testing.T) {
455 defer ctx.teardownTest()
457 ctx.ch.SetReplyTimeout(time.Millisecond)
459 // first one request should work
460 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
461 err := ctx.ch.SendRequest(&vpe.ControlPing{}).ReceiveReply(&vpe.ControlPingReply{})
462 Expect(err).ShouldNot(HaveOccurred())
464 err = ctx.ch.SendRequest(&vpe.ControlPing{}).ReceiveReply(&vpe.ControlPingReply{})
465 Expect(err).Should(HaveOccurred())
466 Expect(err.Error()).To(ContainSubstring("timeout"))
468 // simulating late reply
469 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
471 // normal reply for next request
472 ctx.mockVpp.MockReply(&tap.TapConnectReply{})
474 req := &tap.TapConnect{
475 TapName: []byte("test-tap-name"),
478 reply := &tap.TapConnectReply{}
481 err = ctx.ch.SendRequest(req).ReceiveReply(reply)
482 Expect(err).ShouldNot(HaveOccurred())
485 func TestReceiveReplyAfterTimeoutMultiRequest(t *testing.T) {
487 TODO: fix mock adapter
488 This test will fail because mock adapter will stop sending replies
489 when it encounters control_ping_reply from multi request,
490 thus never sending reply for next request
495 defer ctx.teardownTest()
497 ctx.ch.SetReplyTimeout(time.Millisecond * 100)
499 // first one request should work
500 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
501 err := ctx.ch.SendRequest(&vpe.ControlPing{}).ReceiveReply(&vpe.ControlPingReply{})
502 Expect(err).ShouldNot(HaveOccurred())
505 var sendMultiRequest = func() error {
506 reqCtx := ctx.ch.SendMultiRequest(&interfaces.SwInterfaceDump{})
508 msg := &interfaces.SwInterfaceDetails{}
509 stop, err := reqCtx.ReceiveReply(msg)
511 break // break out of the loop
521 err = sendMultiRequest()
522 Expect(err).Should(HaveOccurred())
523 Expect(err.Error()).To(ContainSubstring("timeout"))
524 Expect(cnt).To(BeEquivalentTo(0))
526 // simulating late replies
527 for i := 1; i <= 3; i++ {
528 ctx.mockVpp.MockReply(&interfaces.SwInterfaceDetails{
529 SwIfIndex: uint32(i),
530 InterfaceName: []byte("if-name-test"),
533 ctx.mockVpp.MockReply(&vpe.ControlPingReply{})
535 // normal reply for next request
536 ctx.mockVpp.MockReply(&tap.TapConnectReply{})
538 req := &tap.TapConnect{
539 TapName: []byte("test-tap-name"),
542 reply := &tap.TapConnectReply{}
545 err = ctx.ch.SendRequest(req).ReceiveReply(reply)
546 Expect(err).ShouldNot(HaveOccurred())
549 func TestInvalidMessageID(t *testing.T) {
551 defer ctx.teardownTest()
553 // first one request should work
554 ctx.mockVpp.MockReply(&vpe.ShowVersionReply{})
555 err := ctx.ch.SendRequest(&vpe.ShowVersion{}).ReceiveReply(&vpe.ShowVersionReply{})
556 Expect(err).ShouldNot(HaveOccurred())
558 // second should fail with error invalid message ID
559 ctx.mockVpp.MockReply(&vpe.ShowVersionReply{})
560 err = ctx.ch.SendRequest(&vpe.ControlPing{}).ReceiveReply(&vpe.ControlPingReply{})
561 Expect(err).Should(HaveOccurred())
562 Expect(err.Error()).To(ContainSubstring("invalid message ID"))