aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/dial_test.go
blob: 986b6be491cbc6bf64c811e237cbc212349bbd4f (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
// Copyright 2015 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum 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.
//
// go-ethereum 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 go-ethereum.  If not, see <http://www.gnu.org/licenses/>.

package p2p

import (
    "encoding/binary"
    "reflect"
    "testing"
    "time"

    "github.com/davecgh/go-spew/spew"
    "github.com/ethereum/go-ethereum/p2p/discover"
)

func init() {
    spew.Config.Indent = "\t"
}

type dialtest struct {
    init   *dialstate // state before and after the test.
    rounds []round
}

type round struct {
    peers []*Peer // current peer set
    done  []task  // tasks that got done this round
    new   []task  // the result must match this one
}

func runDialTest(t *testing.T, test dialtest) {
    var (
        vtime   time.Time
        running int
    )
    pm := func(ps []*Peer) map[discover.NodeID]*Peer {
        m := make(map[discover.NodeID]*Peer)
        for _, p := range ps {
            m[p.rw.id] = p
        }
        return m
    }
    for i, round := range test.rounds {
        for _, task := range round.done {
            running--
            if running < 0 {
                panic("running task counter underflow")
            }
            test.init.taskDone(task, vtime)
        }

        new := test.init.newTasks(running, pm(round.peers), vtime)
        if !sametasks(new, round.new) {
            t.Errorf("round %d: new tasks mismatch:\ngot %v\nwant %v\nstate: %v\nrunning: %v\n",
                i, spew.Sdump(new), spew.Sdump(round.new), spew.Sdump(test.init), spew.Sdump(running))
        }

        // Time advances by 16 seconds on every round.
        vtime = vtime.Add(16 * time.Second)
        running += len(new)
    }
}

type fakeTable []*discover.Node

func (t fakeTable) Self() *discover.Node       { return new(discover.Node) }
func (t fakeTable) Close()                     {}
func (t fakeTable) Bootstrap([]*discover.Node) {}
func (t fakeTable) Lookup(target discover.NodeID) []*discover.Node {
    return nil
}
func (t fakeTable) ReadRandomNodes(buf []*discover.Node) int {
    return copy(buf, t)
}

// This test checks that dynamic dials are launched from discovery results.
func TestDialStateDynDial(t *testing.T) {
    runDialTest(t, dialtest{
        init: newDialState(nil, fakeTable{}, 5),
        rounds: []round{
            // A discovery query is launched.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
                new: []task{&discoverTask{bootstrap: true}},
            },
            // Dynamic dials are launched when it completes.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
                done: []task{
                    &discoverTask{bootstrap: true, results: []*discover.Node{
                        {ID: uintID(2)}, // this one is already connected and not dialed.
                        {ID: uintID(3)},
                        {ID: uintID(4)},
                        {ID: uintID(5)},
                        {ID: uintID(6)}, // these are not tried because max dyn dials is 5
                        {ID: uintID(7)}, // ...
                    }},
                },
                new: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(3)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(4)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(5)}},
                },
            },
            // Some of the dials complete but no new ones are launched yet because
            // the sum of active dial count and dynamic peer count is == maxDynDials.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(3)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(4)}},
                },
                done: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(3)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(4)}},
                },
            },
            // No new dial tasks are launched in the this round because
            // maxDynDials has been reached.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(3)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(4)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(5)}},
                },
                done: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(5)}},
                },
                new: []task{
                    &waitExpireTask{Duration: 14 * time.Second},
                },
            },
            // In this round, the peer with id 2 drops off. The query
            // results from last discovery lookup are reused.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(3)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(4)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(5)}},
                },
                new: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(6)}},
                },
            },
            // More peers (3,4) drop off and dial for ID 6 completes.
            // The last query result from the discovery lookup is reused
            // and a new one is spawned because more candidates are needed.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(5)}},
                },
                done: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(6)}},
                },
                new: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(7)}},
                    &discoverTask{},
                },
            },
            // Peer 7 is connected, but there still aren't enough dynamic peers
            // (4 out of 5). However, a discovery is already running, so ensure
            // no new is started.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(5)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(7)}},
                },
                done: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(7)}},
                },
            },
            // Finish the running node discovery with an empty set. A new lookup
            // should be immediately requested.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(0)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(5)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(7)}},
                },
                done: []task{
                    &discoverTask{},
                },
                new: []task{
                    &discoverTask{},
                },
            },
        },
    })
}

func TestDialStateDynDialFromTable(t *testing.T) {
    // This table always returns the same random nodes
    // in the order given below.
    table := fakeTable{
        {ID: uintID(1)},
        {ID: uintID(2)},
        {ID: uintID(3)},
        {ID: uintID(4)},
        {ID: uintID(5)},
        {ID: uintID(6)},
        {ID: uintID(7)},
        {ID: uintID(8)},
    }

    runDialTest(t, dialtest{
        init: newDialState(nil, table, 10),
        rounds: []round{
            // Discovery bootstrap is launched.
            {
                new: []task{&discoverTask{bootstrap: true}},
            },
            // 5 out of 8 of the nodes returned by ReadRandomNodes are dialed.
            {
                done: []task{
                    &discoverTask{bootstrap: true},
                },
                new: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(1)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(2)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(3)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(4)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(5)}},
                    &discoverTask{bootstrap: false},
                },
            },
            // Dialing nodes 1,2 succeeds. Dials from the lookup are launched.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
                done: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(1)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(2)}},
                    &discoverTask{results: []*discover.Node{
                        {ID: uintID(10)},
                        {ID: uintID(11)},
                        {ID: uintID(12)},
                    }},
                },
                new: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(10)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(11)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(12)}},
                    &discoverTask{bootstrap: false},
                },
            },
            // Dialing nodes 3,4,5 fails. The dials from the lookup succeed.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(10)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(11)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(12)}},
                },
                done: []task{
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(3)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(4)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(5)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(10)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(11)}},
                    &dialTask{dynDialedConn, &discover.Node{ID: uintID(12)}},
                },
            },
            // Waiting for expiry. No waitExpireTask is launched because the
            // discovery query is still running.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(10)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(11)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(12)}},
                },
            },
            // Nodes 3,4 are not tried again because only the first two
            // returned random nodes (nodes 1,2) are tried and they're
            // already connected.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(10)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(11)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(12)}},
                },
            },
        },
    })
}

// This test checks that static dials are launched.
func TestDialStateStaticDial(t *testing.T) {
    wantStatic := []*discover.Node{
        {ID: uintID(1)},
        {ID: uintID(2)},
        {ID: uintID(3)},
        {ID: uintID(4)},
        {ID: uintID(5)},
    }

    runDialTest(t, dialtest{
        init: newDialState(wantStatic, fakeTable{}, 0),
        rounds: []round{
            // Static dials are launched for the nodes that
            // aren't yet connected.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
                new: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(3)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(4)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(5)}},
                },
            },
            // No new tasks are launched in this round because all static
            // nodes are either connected or still being dialed.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(3)}},
                },
                done: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(3)}},
                },
            },
            // No new dial tasks are launched because all static
            // nodes are now connected.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(3)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(4)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(5)}},
                },
                done: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(4)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(5)}},
                },
                new: []task{
                    &waitExpireTask{Duration: 14 * time.Second},
                },
            },
            // Wait a round for dial history to expire, no new tasks should spawn.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(3)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(4)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(5)}},
                },
            },
            // If a static node is dropped, it should be immediately redialed,
            // irrespective whether it was originally static or dynamic.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(3)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(5)}},
                },
                new: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(2)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(4)}},
                },
            },
        },
    })
}

// This test checks that past dials are not retried for some time.
func TestDialStateCache(t *testing.T) {
    wantStatic := []*discover.Node{
        {ID: uintID(1)},
        {ID: uintID(2)},
        {ID: uintID(3)},
    }

    runDialTest(t, dialtest{
        init: newDialState(wantStatic, fakeTable{}, 0),
        rounds: []round{
            // Static dials are launched for the nodes that
            // aren't yet connected.
            {
                peers: nil,
                new: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(1)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(2)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(3)}},
                },
            },
            // No new tasks are launched in this round because all static
            // nodes are either connected or still being dialed.
            {
                peers: []*Peer{
                    {rw: &conn{flags: staticDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: staticDialedConn, id: uintID(2)}},
                },
                done: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(1)}},
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(2)}},
                },
            },
            // A salvage task is launched to wait for node 3's history
            // entry to expire.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
                done: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(3)}},
                },
                new: []task{
                    &waitExpireTask{Duration: 14 * time.Second},
                },
            },
            // Still waiting for node 3's entry to expire in the cache.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
            },
            // The cache entry for node 3 has expired and is retried.
            {
                peers: []*Peer{
                    {rw: &conn{flags: dynDialedConn, id: uintID(1)}},
                    {rw: &conn{flags: dynDialedConn, id: uintID(2)}},
                },
                new: []task{
                    &dialTask{staticDialedConn, &discover.Node{ID: uintID(3)}},
                },
            },
        },
    })
}

// compares task lists but doesn't care about the order.
func sametasks(a, b []task) bool {
    if len(a) != len(b) {
        return false
    }
next:
    for _, ta := range a {
        for _, tb := range b {
            if reflect.DeepEqual(ta, tb) {
                continue next
            }
        }
        return false
    }
    return true
}

func uintID(i uint32) discover.NodeID {
    var id discover.NodeID
    binary.BigEndian.PutUint32(id[:], i)
    return id
}