aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/peer_test.go
blob: 6f96a823b4c03d8861c5b9cd857988783b0bf2c3 (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
// Copyright 2014 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 p2p

import (
    "errors"
    "fmt"
    "math/rand"
    "net"
    "reflect"
    "testing"
    "time"
)

var discard = Protocol{
    Name:   "discard",
    Length: 1,
    Run: func(p *Peer, rw MsgReadWriter) error {
        for {
            msg, err := rw.ReadMsg()
            if err != nil {
                return err
            }
            fmt.Printf("discarding %d\n", msg.Code)
            if err = msg.Discard(); err != nil {
                return err
            }
        }
    },
}

func testPeer(protos []Protocol) (func(), *conn, *Peer, <-chan DiscReason) {
    fd1, fd2 := net.Pipe()
    c1 := &conn{fd: fd1, transport: newTestTransport(randomID(), fd1)}
    c2 := &conn{fd: fd2, transport: newTestTransport(randomID(), fd2)}
    for _, p := range protos {
        c1.caps = append(c1.caps, p.cap())
        c2.caps = append(c2.caps, p.cap())
    }

    peer := newPeer(c1, protos)
    errc := make(chan DiscReason, 1)
    go func() { errc <- peer.run() }()

    closer := func() { c2.close(errors.New("close func called")) }
    return closer, c2, peer, errc
}

func TestPeerProtoReadMsg(t *testing.T) {
    done := make(chan struct{})
    proto := Protocol{
        Name:   "a",
        Length: 5,
        Run: func(peer *Peer, rw MsgReadWriter) error {
            if err := ExpectMsg(rw, 2, []uint{1}); err != nil {
                t.Error(err)
            }
            if err := ExpectMsg(rw, 3, []uint{2}); err != nil {
                t.Error(err)
            }
            if err := ExpectMsg(rw, 4, []uint{3}); err != nil {
                t.Error(err)
            }
            close(done)
            return nil
        },
    }

    closer, rw, _, errc := testPeer([]Protocol{proto})
    defer closer()

    Send(rw, baseProtocolLength+2, []uint{1})
    Send(rw, baseProtocolLength+3, []uint{2})
    Send(rw, baseProtocolLength+4, []uint{3})

    select {
    case <-done:
    case err := <-errc:
        t.Errorf("peer returned: %v", err)
    case <-time.After(2 * time.Second):
        t.Errorf("receive timeout")
    }
}

func TestPeerProtoEncodeMsg(t *testing.T) {
    proto := Protocol{
        Name:   "a",
        Length: 2,
        Run: func(peer *Peer, rw MsgReadWriter) error {
            if err := SendItems(rw, 2); err == nil {
                t.Error("expected error for out-of-range msg code, got nil")
            }
            if err := SendItems(rw, 1, "foo", "bar"); err != nil {
                t.Errorf("write error: %v", err)
            }
            return nil
        },
    }
    closer, rw, _, _ := testPeer([]Protocol{proto})
    defer closer()

    if err := ExpectMsg(rw, 17, []string{"foo", "bar"}); err != nil {
        t.Error(err)
    }
}

func TestPeerPing(t *testing.T) {
    closer, rw, _, _ := testPeer(nil)
    defer closer()
    if err := SendItems(rw, pingMsg); err != nil {
        t.Fatal(err)
    }
    if err := ExpectMsg(rw, pongMsg, nil); err != nil {
        t.Error(err)
    }
}

func TestPeerDisconnect(t *testing.T) {
    closer, rw, _, disc := testPeer(nil)
    defer closer()
    if err := SendItems(rw, discMsg, DiscQuitting); err != nil {
        t.Fatal(err)
    }
    select {
    case reason := <-disc:
        if reason != DiscRequested {
            t.Errorf("run returned wrong reason: got %v, want %v", reason, DiscRequested)
        }
    case <-time.After(500 * time.Millisecond):
        t.Error("peer did not return")
    }
}

// This test is supposed to verify that Peer can reliably handle
// multiple causes of disconnection occurring at the same time.
func TestPeerDisconnectRace(t *testing.T) {
    maybe := func() bool { return rand.Intn(1) == 1 }

    for i := 0; i < 1000; i++ {
        protoclose := make(chan error)
        protodisc := make(chan DiscReason)
        closer, rw, p, disc := testPeer([]Protocol{
            {
                Name:   "closereq",
                Run:    func(p *Peer, rw MsgReadWriter) error { return <-protoclose },
                Length: 1,
            },
            {
                Name:   "disconnect",
                Run:    func(p *Peer, rw MsgReadWriter) error { p.Disconnect(<-protodisc); return nil },
                Length: 1,
            },
        })

        // Simulate incoming messages.
        go SendItems(rw, baseProtocolLength+1)
        go SendItems(rw, baseProtocolLength+2)
        // Close the network connection.
        go closer()
        // Make protocol "closereq" return.
        protoclose <- errors.New("protocol closed")
        // Make protocol "disconnect" call peer.Disconnect
        protodisc <- DiscAlreadyConnected
        // In some cases, simulate something else calling peer.Disconnect.
        if maybe() {
            go p.Disconnect(DiscInvalidIdentity)
        }
        // In some cases, simulate remote requesting a disconnect.
        if maybe() {
            go SendItems(rw, discMsg, DiscQuitting)
        }

        select {
        case <-disc:
        case <-time.After(2 * time.Second):
            // Peer.run should return quickly. If it doesn't the Peer
            // goroutines are probably deadlocked. Call panic in order to
            // show the stacks.
            panic("Peer.run took to long to return.")
        }
    }
}

func TestNewPeer(t *testing.T) {
    name := "nodename"
    caps := []Cap{{"foo", 2}, {"bar", 3}}
    id := randomID()
    p := NewPeer(id, name, caps)
    if p.ID() != id {
        t.Errorf("ID mismatch: got %v, expected %v", p.ID(), id)
    }
    if p.Name() != name {
        t.Errorf("Name mismatch: got %v, expected %v", p.Name(), name)
    }
    if !reflect.DeepEqual(p.Caps(), caps) {
        t.Errorf("Caps mismatch: got %v, expected %v", p.Caps(), caps)
    }

    p.Disconnect(DiscAlreadyConnected) // Should not hang
}

func TestMatchProtocols(t *testing.T) {
    tests := []struct {
        Remote []Cap
        Local  []Protocol
        Match  map[string]protoRW
    }{
        {
            // No remote capabilities
            Local: []Protocol{{Name: "a"}},
        },
        {
            // No local protocols
            Remote: []Cap{{Name: "a"}},
        },
        {
            // No mutual protocols
            Remote: []Cap{{Name: "a"}},
            Local:  []Protocol{{Name: "b"}},
        },
        {
            // Some matches, some differences
            Remote: []Cap{{Name: "local"}, {Name: "match1"}, {Name: "match2"}},
            Local:  []Protocol{{Name: "match1"}, {Name: "match2"}, {Name: "remote"}},
            Match:  map[string]protoRW{"match1": {Protocol: Protocol{Name: "match1"}}, "match2": {Protocol: Protocol{Name: "match2"}}},
        },
        {
            // Various alphabetical ordering
            Remote: []Cap{{Name: "aa"}, {Name: "ab"}, {Name: "bb"}, {Name: "ba"}},
            Local:  []Protocol{{Name: "ba"}, {Name: "bb"}, {Name: "ab"}, {Name: "aa"}},
            Match:  map[string]protoRW{"aa": {Protocol: Protocol{Name: "aa"}}, "ab": {Protocol: Protocol{Name: "ab"}}, "ba": {Protocol: Protocol{Name: "ba"}}, "bb": {Protocol: Protocol{Name: "bb"}}},
        },
        {
            // No mutual versions
            Remote: []Cap{{Version: 1}},
            Local:  []Protocol{{Version: 2}},
        },
        {
            // Multiple versions, single common
            Remote: []Cap{{Version: 1}, {Version: 2}},
            Local:  []Protocol{{Version: 2}, {Version: 3}},
            Match:  map[string]protoRW{"": {Protocol: Protocol{Version: 2}}},
        },
        {
            // Multiple versions, multiple common
            Remote: []Cap{{Version: 1}, {Version: 2}, {Version: 3}, {Version: 4}},
            Local:  []Protocol{{Version: 2}, {Version: 3}},
            Match:  map[string]protoRW{"": {Protocol: Protocol{Version: 3}}},
        },
        {
            // Various version orderings
            Remote: []Cap{{Version: 4}, {Version: 1}, {Version: 3}, {Version: 2}},
            Local:  []Protocol{{Version: 2}, {Version: 3}, {Version: 1}},
            Match:  map[string]protoRW{"": {Protocol: Protocol{Version: 3}}},
        },
        {
            // Versions overriding sub-protocol lengths
            Remote: []Cap{{Version: 1}, {Version: 2}, {Version: 3}, {Name: "a"}},
            Local:  []Protocol{{Version: 1, Length: 1}, {Version: 2, Length: 2}, {Version: 3, Length: 3}, {Name: "a"}},
            Match:  map[string]protoRW{"": {Protocol: Protocol{Version: 3}}, "a": {Protocol: Protocol{Name: "a"}, offset: 3}},
        },
    }

    for i, tt := range tests {
        result := matchProtocols(tt.Local, tt.Remote, nil)
        if len(result) != len(tt.Match) {
            t.Errorf("test %d: negotiation mismatch: have %v, want %v", i, len(result), len(tt.Match))
            continue
        }
        // Make sure all negotiated protocols are needed and correct
        for name, proto := range result {
            match, ok := tt.Match[name]
            if !ok {
                t.Errorf("test %d, proto '%s': negotiated but shouldn't have", i, name)
                continue
            }
            if proto.Name != match.Name {
                t.Errorf("test %d, proto '%s': name mismatch: have %v, want %v", i, name, proto.Name, match.Name)
            }
            if proto.Version != match.Version {
                t.Errorf("test %d, proto '%s': version mismatch: have %v, want %v", i, name, proto.Version, match.Version)
            }
            if proto.offset-baseProtocolLength != match.offset {
                t.Errorf("test %d, proto '%s': offset mismatch: have %v, want %v", i, name, proto.offset-baseProtocolLength, match.offset)
            }
        }
        // Make sure no protocols missed negotiation
        for name, _ := range tt.Match {
            if _, ok := result[name]; !ok {
                t.Errorf("test %d, proto '%s': not negotiated, should have", i, name)
                continue
            }
        }
    }
}