aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/protocols/protocol_test.go
blob: 80a221c7477fd9276279fe71f733c87094ae6208 (plain) (blame)
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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package protocols

import (
    "bytes"
    "context"
    "errors"
    "fmt"
    "testing"
    "time"

    "github.com/dexon-foundation/dexon/rlp"

    "github.com/dexon-foundation/dexon/p2p"
    "github.com/dexon-foundation/dexon/p2p/enode"
    "github.com/dexon-foundation/dexon/p2p/simulations/adapters"
    p2ptest "github.com/dexon-foundation/dexon/p2p/testing"
)

// handshake message type
type hs0 struct {
    C uint
}

// message to kill/drop the peer with nodeID
type kill struct {
    C enode.ID
}

// message to drop connection
type drop struct {
}

/// protoHandshake represents module-independent aspects of the protocol and is
// the first message peers send and receive as part the initial exchange
type protoHandshake struct {
    Version   uint   // local and remote peer should have identical version
    NetworkID string // local and remote peer should have identical network id
}

// checkProtoHandshake verifies local and remote protoHandshakes match
func checkProtoHandshake(testVersion uint, testNetworkID string) func(interface{}) error {
    return func(rhs interface{}) error {
        remote := rhs.(*protoHandshake)
        if remote.NetworkID != testNetworkID {
            return fmt.Errorf("%s (!= %s)", remote.NetworkID, testNetworkID)
        }

        if remote.Version != testVersion {
            return fmt.Errorf("%d (!= %d)", remote.Version, testVersion)
        }
        return nil
    }
}

// newProtocol sets up a protocol
// the run function here demonstrates a typical protocol using peerPool, handshake
// and messages registered to handlers
func newProtocol(pp *p2ptest.TestPeerPool) func(*p2p.Peer, p2p.MsgReadWriter) error {
    spec := &Spec{
        Name:       "test",
        Version:    42,
        MaxMsgSize: 10 * 1024,
        Messages: []interface{}{
            protoHandshake{},
            hs0{},
            kill{},
            drop{},
        },
    }
    return func(p *p2p.Peer, rw p2p.MsgReadWriter) error {
        peer := NewPeer(p, rw, spec)

        // initiate one-off protohandshake and check validity
        ctx, cancel := context.WithTimeout(context.Background(), time.Second)
        defer cancel()
        phs := &protoHandshake{42, "420"}
        hsCheck := checkProtoHandshake(phs.Version, phs.NetworkID)
        _, err := peer.Handshake(ctx, phs, hsCheck)
        if err != nil {
            return err
        }

        lhs := &hs0{42}
        // module handshake demonstrating a simple repeatable exchange of same-type message
        hs, err := peer.Handshake(ctx, lhs, nil)
        if err != nil {
            return err
        }

        if rmhs := hs.(*hs0); rmhs.C > lhs.C {
            return fmt.Errorf("handshake mismatch remote %v > local %v", rmhs.C, lhs.C)
        }

        handle := func(ctx context.Context, msg interface{}) error {
            switch msg := msg.(type) {

            case *protoHandshake:
                return errors.New("duplicate handshake")

            case *hs0:
                rhs := msg
                if rhs.C > lhs.C {
                    return fmt.Errorf("handshake mismatch remote %v > local %v", rhs.C, lhs.C)
                }
                lhs.C += rhs.C
                return peer.Send(ctx, lhs)

            case *kill:
                // demonstrates use of peerPool, killing another peer connection as a response to a message
                id := msg.C
                pp.Get(id).Drop(errors.New("killed"))
                return nil

            case *drop:
                // for testing we can trigger self induced disconnect upon receiving drop message
                return errors.New("dropped")

            default:
                return fmt.Errorf("unknown message type: %T", msg)
            }
        }

        pp.Add(peer)
        defer pp.Remove(peer)
        return peer.Run(handle)
    }
}

func protocolTester(pp *p2ptest.TestPeerPool) *p2ptest.ProtocolTester {
    conf := adapters.RandomNodeConfig()
    return p2ptest.NewProtocolTester(conf.ID, 2, newProtocol(pp))
}

func protoHandshakeExchange(id enode.ID, proto *protoHandshake) []p2ptest.Exchange {

    return []p2ptest.Exchange{
        {
            Expects: []p2ptest.Expect{
                {
                    Code: 0,
                    Msg:  &protoHandshake{42, "420"},
                    Peer: id,
                },
            },
        },
        {
            Triggers: []p2ptest.Trigger{
                {
                    Code: 0,
                    Msg:  proto,
                    Peer: id,
                },
            },
        },
    }
}

func runProtoHandshake(t *testing.T, proto *protoHandshake, errs ...error) {
    pp := p2ptest.NewTestPeerPool()
    s := protocolTester(pp)
    // TODO: make this more than one handshake
    node := s.Nodes[0]
    if err := s.TestExchanges(protoHandshakeExchange(node.ID(), proto)...); err != nil {
        t.Fatal(err)
    }
    var disconnects []*p2ptest.Disconnect
    for i, err := range errs {
        disconnects = append(disconnects, &p2ptest.Disconnect{Peer: s.Nodes[i].ID(), Error: err})
    }
    if err := s.TestDisconnected(disconnects...); err != nil {
        t.Fatal(err)
    }
}

type dummyHook struct {
    peer  *Peer
    size  uint32
    msg   interface{}
    send  bool
    err   error
    waitC chan struct{}
}

type dummyMsg struct {
    Content string
}

func (d *dummyHook) Send(peer *Peer, size uint32, msg interface{}) error {
    d.peer = peer
    d.size = size
    d.msg = msg
    d.send = true
    return d.err
}

func (d *dummyHook) Receive(peer *Peer, size uint32, msg interface{}) error {
    d.peer = peer
    d.size = size
    d.msg = msg
    d.send = false
    d.waitC <- struct{}{}
    return d.err
}

func TestProtocolHook(t *testing.T) {
    testHook := &dummyHook{
        waitC: make(chan struct{}, 1),
    }
    spec := &Spec{
        Name:       "test",
        Version:    42,
        MaxMsgSize: 10 * 1024,
        Messages: []interface{}{
            dummyMsg{},
        },
        Hook: testHook,
    }

    runFunc := func(p *p2p.Peer, rw p2p.MsgReadWriter) error {
        peer := NewPeer(p, rw, spec)
        ctx := context.TODO()
        err := peer.Send(ctx, &dummyMsg{
            Content: "handshake"})

        if err != nil {
            t.Fatal(err)
        }

        handle := func(ctx context.Context, msg interface{}) error {
            return nil
        }

        return peer.Run(handle)
    }

    conf := adapters.RandomNodeConfig()
    tester := p2ptest.NewProtocolTester(conf.ID, 2, runFunc)
    err := tester.TestExchanges(p2ptest.Exchange{
        Expects: []p2ptest.Expect{
            {
                Code: 0,
                Msg:  &dummyMsg{Content: "handshake"},
                Peer: tester.Nodes[0].ID(),
            },
        },
    })
    if err != nil {
        t.Fatal(err)
    }
    if testHook.msg == nil || testHook.msg.(*dummyMsg).Content != "handshake" {
        t.Fatal("Expected msg to be set, but it is not")
    }
    if !testHook.send {
        t.Fatal("Expected a send message, but it is not")
    }
    if testHook.peer == nil || testHook.peer.ID() != tester.Nodes[0].ID() {
        t.Fatal("Expected peer ID to be set correctly, but it is not")
    }
    if testHook.size != 11 { //11 is the length of the encoded message
        t.Fatalf("Expected size to be %d, but it is %d ", 1, testHook.size)
    }

    err = tester.TestExchanges(p2ptest.Exchange{
        Triggers: []p2ptest.Trigger{
            {
                Code: 0,
                Msg:  &dummyMsg{Content: "response"},
                Peer: tester.Nodes[1].ID(),
            },
        },
    })

    <-testHook.waitC

    if err != nil {
        t.Fatal(err)
    }
    if testHook.msg == nil || testHook.msg.(*dummyMsg).Content != "response" {
        t.Fatal("Expected msg to be set, but it is not")
    }
    if testHook.send {
        t.Fatal("Expected a send message, but it is not")
    }
    if testHook.peer == nil || testHook.peer.ID() != tester.Nodes[1].ID() {
        t.Fatal("Expected peer ID to be set correctly, but it is not")
    }
    if testHook.size != 10 { //11 is the length of the encoded message
        t.Fatalf("Expected size to be %d, but it is %d ", 1, testHook.size)
    }

    testHook.err = fmt.Errorf("dummy error")
    err = tester.TestExchanges(p2ptest.Exchange{
        Triggers: []p2ptest.Trigger{
            {
                Code: 0,
                Msg:  &dummyMsg{Content: "response"},
                Peer: tester.Nodes[1].ID(),
            },
        },
    })

    <-testHook.waitC

    time.Sleep(100 * time.Millisecond)
    err = tester.TestDisconnected(&p2ptest.Disconnect{Peer: tester.Nodes[1].ID(), Error: testHook.err})
    if err != nil {
        t.Fatalf("Expected a specific disconnect error, but got different one: %v", err)
    }

}

//We need to test that if the hook is not defined, then message infrastructure
//(send,receive) still works
func TestNoHook(t *testing.T) {
    //create a test spec
    spec := createTestSpec()
    //a random node
    id := adapters.RandomNodeConfig().ID
    //a peer
    p := p2p.NewPeer(id, "testPeer", nil)
    rw := &dummyRW{}
    peer := NewPeer(p, rw, spec)
    ctx := context.TODO()
    msg := &perBytesMsgSenderPays{Content: "testBalance"}
    //send a message
    err := peer.Send(ctx, msg)
    if err != nil {
        t.Fatal(err)
    }
    //simulate receiving a message
    rw.msg = msg
    peer.handleIncoming(func(ctx context.Context, msg interface{}) error {
        return nil
    })
    //all should just work and not result in any error
}

func TestProtoHandshakeVersionMismatch(t *testing.T) {
    runProtoHandshake(t, &protoHandshake{41, "420"}, errorf(ErrHandshake, errorf(ErrHandler, "(msg code 0): 41 (!= 42)").Error()))
}

func TestProtoHandshakeNetworkIDMismatch(t *testing.T) {
    runProtoHandshake(t, &protoHandshake{42, "421"}, errorf(ErrHandshake, errorf(ErrHandler, "(msg code 0): 421 (!= 420)").Error()))
}

func TestProtoHandshakeSuccess(t *testing.T) {
    runProtoHandshake(t, &protoHandshake{42, "420"})
}

func moduleHandshakeExchange(id enode.ID, resp uint) []p2ptest.Exchange {

    return []p2ptest.Exchange{
        {
            Expects: []p2ptest.Expect{
                {
                    Code: 1,
                    Msg:  &hs0{42},
                    Peer: id,
                },
            },
        },
        {
            Triggers: []p2ptest.Trigger{
                {
                    Code: 1,
                    Msg:  &hs0{resp},
                    Peer: id,
                },
            },
        },
    }
}

func runModuleHandshake(t *testing.T, resp uint, errs ...error) {
    pp := p2ptest.NewTestPeerPool()
    s := protocolTester(pp)
    node := s.Nodes[0]
    if err := s.TestExchanges(protoHandshakeExchange(node.ID(), &protoHandshake{42, "420"})...); err != nil {
        t.Fatal(err)
    }
    if err := s.TestExchanges(moduleHandshakeExchange(node.ID(), resp)...); err != nil {
        t.Fatal(err)
    }
    var disconnects []*p2ptest.Disconnect
    for i, err := range errs {
        disconnects = append(disconnects, &p2ptest.Disconnect{Peer: s.Nodes[i].ID(), Error: err})
    }
    if err := s.TestDisconnected(disconnects...); err != nil {
        t.Fatal(err)
    }
}

func TestModuleHandshakeError(t *testing.T) {
    runModuleHandshake(t, 43, fmt.Errorf("handshake mismatch remote 43 > local 42"))
}

func TestModuleHandshakeSuccess(t *testing.T) {
    runModuleHandshake(t, 42)
}

// testing complex interactions over multiple peers, relaying, dropping
func testMultiPeerSetup(a, b enode.ID) []p2ptest.Exchange {

    return []p2ptest.Exchange{
        {
            Label: "primary handshake",
            Expects: []p2ptest.Expect{
                {
                    Code: 0,
                    Msg:  &protoHandshake{42, "420"},
                    Peer: a,
                },
                {
                    Code: 0,
                    Msg:  &protoHandshake{42, "420"},
                    Peer: b,
                },
            },
        },
        {
            Label: "module handshake",
            Triggers: []p2ptest.Trigger{
                {
                    Code: 0,
                    Msg:  &protoHandshake{42, "420"},
                    Peer: a,
                },
                {
                    Code: 0,
                    Msg:  &protoHandshake{42, "420"},
                    Peer: b,
                },
            },
            Expects: []p2ptest.Expect{
                {
                    Code: 1,
                    Msg:  &hs0{42},
                    Peer: a,
                },
                {
                    Code: 1,
                    Msg:  &hs0{42},
                    Peer: b,
                },
            },
        },

        {Label: "alternative module handshake", Triggers: []p2ptest.Trigger{{Code: 1, Msg: &hs0{41}, Peer: a},
            {Code: 1, Msg: &hs0{41}, Peer: b}}},
        {Label: "repeated module handshake", Triggers: []p2ptest.Trigger{{Code: 1, Msg: &hs0{1}, Peer: a}}},
        {Label: "receiving repeated module handshake", Expects: []p2ptest.Expect{{Code: 1, Msg: &hs0{43}, Peer: a}}}}
}

func runMultiplePeers(t *testing.T, peer int, errs ...error) {
    pp := p2ptest.NewTestPeerPool()
    s := protocolTester(pp)

    if err := s.TestExchanges(testMultiPeerSetup(s.Nodes[0].ID(), s.Nodes[1].ID())...); err != nil {
        t.Fatal(err)
    }
    // after some exchanges of messages, we can test state changes
    // here this is simply demonstrated by the peerPool
    // after the handshake negotiations peers must be added to the pool
    // time.Sleep(1)
    tick := time.NewTicker(10 * time.Millisecond)
    timeout := time.NewTimer(1 * time.Second)
WAIT:
    for {
        select {
        case <-tick.C:
            if pp.Has(s.Nodes[0].ID()) {
                break WAIT
            }
        case <-timeout.C:
            t.Fatal("timeout")
        }
    }
    if !pp.Has(s.Nodes[1].ID()) {
        t.Fatalf("missing peer test-1: %v (%v)", pp, s.Nodes)
    }

    // peer 0 sends kill request for peer with index <peer>
    err := s.TestExchanges(p2ptest.Exchange{
        Triggers: []p2ptest.Trigger{
            {
                Code: 2,
                Msg:  &kill{s.Nodes[peer].ID()},
                Peer: s.Nodes[0].ID(),
            },
        },
    })

    if err != nil {
        t.Fatal(err)
    }

    // the peer not killed sends a drop request
    err = s.TestExchanges(p2ptest.Exchange{
        Triggers: []p2ptest.Trigger{
            {
                Code: 3,
                Msg:  &drop{},
                Peer: s.Nodes[(peer+1)%2].ID(),
            },
        },
    })

    if err != nil {
        t.Fatal(err)
    }

    // check the actual discconnect errors on the individual peers
    var disconnects []*p2ptest.Disconnect
    for i, err := range errs {
        disconnects = append(disconnects, &p2ptest.Disconnect{Peer: s.Nodes[i].ID(), Error: err})
    }
    if err := s.TestDisconnected(disconnects...); err != nil {
        t.Fatal(err)
    }
    // test if disconnected peers have been removed from peerPool
    if pp.Has(s.Nodes[peer].ID()) {
        t.Fatalf("peer test-%v not dropped: %v (%v)", peer, pp, s.Nodes)
    }

}
func XTestMultiplePeersDropSelf(t *testing.T) {
    runMultiplePeers(t, 0,
        fmt.Errorf("subprotocol error"),
        fmt.Errorf("Message handler error: (msg code 3): dropped"),
    )
}

func XTestMultiplePeersDropOther(t *testing.T) {
    runMultiplePeers(t, 1,
        fmt.Errorf("Message handler error: (msg code 3): dropped"),
        fmt.Errorf("subprotocol error"),
    )
}

//dummy implementation of a MsgReadWriter
//this allows for quick and easy unit tests without
//having to build up the complete protocol
type dummyRW struct {
    msg  interface{}
    size uint32
    code uint64
}

func (d *dummyRW) WriteMsg(msg p2p.Msg) error {
    return nil
}

func (d *dummyRW) ReadMsg() (p2p.Msg, error) {
    enc := bytes.NewReader(d.getDummyMsg())
    return p2p.Msg{
        Code:       d.code,
        Size:       d.size,
        Payload:    enc,
        ReceivedAt: time.Now(),
    }, nil
}

func (d *dummyRW) getDummyMsg() []byte {
    r, _ := rlp.EncodeToBytes(d.msg)
    var b bytes.Buffer
    wmsg := WrappedMsg{
        Context: b.Bytes(),
        Size:    uint32(len(r)),
        Payload: r,
    }
    rr, _ := rlp.EncodeToBytes(wmsg)
    d.size = uint32(len(rr))
    return rr
}