aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/simulations/network_test.go
blob: 8b644ffb0fc636e801988f34bd53a509393d37d0 (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
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
// 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 simulations

import (
    "context"
    "encoding/json"
    "fmt"
    "reflect"
    "strconv"
    "strings"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/node"
    "github.com/ethereum/go-ethereum/p2p/enode"
    "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
)

// Tests that a created snapshot with a minimal service only contains the expected connections
// and that a network when loaded with this snapshot only contains those same connections
func TestSnapshot(t *testing.T) {

    // PART I
    // create snapshot from ring network

    // this is a minimal service, whose protocol will take exactly one message OR close of connection before quitting
    adapter := adapters.NewSimAdapter(adapters.Services{
        "noopwoop": func(ctx *adapters.ServiceContext) (node.Service, error) {
            return NewNoopService(nil), nil
        },
    })

    // create network
    network := NewNetwork(adapter, &NetworkConfig{
        DefaultService: "noopwoop",
    })
    // \todo consider making a member of network, set to true threadsafe when shutdown
    runningOne := true
    defer func() {
        if runningOne {
            network.Shutdown()
        }
    }()

    // create and start nodes
    nodeCount := 20
    ids := make([]enode.ID, nodeCount)
    for i := 0; i < nodeCount; i++ {
        conf := adapters.RandomNodeConfig()
        node, err := network.NewNodeWithConfig(conf)
        if err != nil {
            t.Fatalf("error creating node: %s", err)
        }
        if err := network.Start(node.ID()); err != nil {
            t.Fatalf("error starting node: %s", err)
        }
        ids[i] = node.ID()
    }

    // subscribe to peer events
    evC := make(chan *Event)
    sub := network.Events().Subscribe(evC)
    defer sub.Unsubscribe()

    // connect nodes in a ring
    // spawn separate thread to avoid deadlock in the event listeners
    go func() {
        for i, id := range ids {
            peerID := ids[(i+1)%len(ids)]
            if err := network.Connect(id, peerID); err != nil {
                t.Fatal(err)
            }
        }
    }()

    // collect connection events up to expected number
    ctx, cancel := context.WithTimeout(context.TODO(), time.Second)
    defer cancel()
    checkIds := make(map[enode.ID][]enode.ID)
    connEventCount := nodeCount
OUTER:
    for {
        select {
        case <-ctx.Done():
            t.Fatal(ctx.Err())
        case ev := <-evC:
            if ev.Type == EventTypeConn && !ev.Control {

                // fail on any disconnect
                if !ev.Conn.Up {
                    t.Fatalf("unexpected disconnect: %v -> %v", ev.Conn.One, ev.Conn.Other)
                }
                checkIds[ev.Conn.One] = append(checkIds[ev.Conn.One], ev.Conn.Other)
                checkIds[ev.Conn.Other] = append(checkIds[ev.Conn.Other], ev.Conn.One)
                connEventCount--
                log.Debug("ev", "count", connEventCount)
                if connEventCount == 0 {
                    break OUTER
                }
            }
        }
    }

    // create snapshot of current network
    snap, err := network.Snapshot()
    if err != nil {
        t.Fatal(err)
    }
    j, err := json.Marshal(snap)
    if err != nil {
        t.Fatal(err)
    }
    log.Debug("snapshot taken", "nodes", len(snap.Nodes), "conns", len(snap.Conns), "json", string(j))

    // verify that the snap element numbers check out
    if len(checkIds) != len(snap.Conns) || len(checkIds) != len(snap.Nodes) {
        t.Fatalf("snapshot wrong node,conn counts %d,%d != %d", len(snap.Nodes), len(snap.Conns), len(checkIds))
    }

    // shut down sim network
    runningOne = false
    sub.Unsubscribe()
    network.Shutdown()

    // check that we have all the expected connections in the snapshot
    for nodid, nodConns := range checkIds {
        for _, nodConn := range nodConns {
            var match bool
            for _, snapConn := range snap.Conns {
                if snapConn.One == nodid && snapConn.Other == nodConn {
                    match = true
                    break
                } else if snapConn.Other == nodid && snapConn.One == nodConn {
                    match = true
                    break
                }
            }
            if !match {
                t.Fatalf("snapshot missing conn %v -> %v", nodid, nodConn)
            }
        }
    }
    log.Info("snapshot checked")

    // PART II
    // load snapshot and verify that exactly same connections are formed

    adapter = adapters.NewSimAdapter(adapters.Services{
        "noopwoop": func(ctx *adapters.ServiceContext) (node.Service, error) {
            return NewNoopService(nil), nil
        },
    })
    network = NewNetwork(adapter, &NetworkConfig{
        DefaultService: "noopwoop",
    })
    defer func() {
        network.Shutdown()
    }()

    // subscribe to peer events
    // every node up and conn up event will generate one additional control event
    // therefore multiply the count by two
    evC = make(chan *Event, (len(snap.Conns)*2)+(len(snap.Nodes)*2))
    sub = network.Events().Subscribe(evC)
    defer sub.Unsubscribe()

    // load the snapshot
    // spawn separate thread to avoid deadlock in the event listeners
    err = network.Load(snap)
    if err != nil {
        t.Fatal(err)
    }

    // collect connection events up to expected number
    ctx, cancel = context.WithTimeout(context.TODO(), time.Second*3)
    defer cancel()

    connEventCount = nodeCount

OUTER_TWO:
    for {
        select {
        case <-ctx.Done():
            t.Fatal(ctx.Err())
        case ev := <-evC:
            if ev.Type == EventTypeConn && !ev.Control {

                // fail on any disconnect
                if !ev.Conn.Up {
                    t.Fatalf("unexpected disconnect: %v -> %v", ev.Conn.One, ev.Conn.Other)
                }
                log.Debug("conn", "on", ev.Conn.One, "other", ev.Conn.Other)
                checkIds[ev.Conn.One] = append(checkIds[ev.Conn.One], ev.Conn.Other)
                checkIds[ev.Conn.Other] = append(checkIds[ev.Conn.Other], ev.Conn.One)
                connEventCount--
                log.Debug("ev", "count", connEventCount)
                if connEventCount == 0 {
                    break OUTER_TWO
                }
            }
        }
    }

    // check that we have all expected connections in the network
    for _, snapConn := range snap.Conns {
        var match bool
        for nodid, nodConns := range checkIds {
            for _, nodConn := range nodConns {
                if snapConn.One == nodid && snapConn.Other == nodConn {
                    match = true
                    break
                } else if snapConn.Other == nodid && snapConn.One == nodConn {
                    match = true
                    break
                }
            }
        }
        if !match {
            t.Fatalf("network missing conn %v -> %v", snapConn.One, snapConn.Other)
        }
    }

    // verify that network didn't generate any other additional connection events after the ones we have collected within a reasonable period of time
    ctx, cancel = context.WithTimeout(context.TODO(), time.Second)
    defer cancel()
    select {
    case <-ctx.Done():
    case ev := <-evC:
        if ev.Type == EventTypeConn {
            t.Fatalf("Superfluous conn found %v -> %v", ev.Conn.One, ev.Conn.Other)
        }
    }

    // This test validates if all connections from the snapshot
    // are created in the network.
    t.Run("conns after load", func(t *testing.T) {
        // Create new network.
        n := NewNetwork(
            adapters.NewSimAdapter(adapters.Services{
                "noopwoop": func(ctx *adapters.ServiceContext) (node.Service, error) {
                    return NewNoopService(nil), nil
                },
            }),
            &NetworkConfig{
                DefaultService: "noopwoop",
            },
        )
        defer n.Shutdown()

        // Load the same snapshot.
        err := n.Load(snap)
        if err != nil {
            t.Fatal(err)
        }

        // Check every connection from the snapshot
        // if it is in the network, too.
        for _, c := range snap.Conns {
            if n.GetConn(c.One, c.Other) == nil {
                t.Errorf("missing connection: %s -> %s", c.One, c.Other)
            }
        }
    })
}

// TestNetworkSimulation creates a multi-node simulation network with each node
// connected in a ring topology, checks that all nodes successfully handshake
// with each other and that a snapshot fully represents the desired topology
func TestNetworkSimulation(t *testing.T) {
    // create simulation network with 20 testService nodes
    adapter := adapters.NewSimAdapter(adapters.Services{
        "test": newTestService,
    })
    network := NewNetwork(adapter, &NetworkConfig{
        DefaultService: "test",
    })
    defer network.Shutdown()
    nodeCount := 20
    ids := make([]enode.ID, nodeCount)
    for i := 0; i < nodeCount; i++ {
        conf := adapters.RandomNodeConfig()
        node, err := network.NewNodeWithConfig(conf)
        if err != nil {
            t.Fatalf("error creating node: %s", err)
        }
        if err := network.Start(node.ID()); err != nil {
            t.Fatalf("error starting node: %s", err)
        }
        ids[i] = node.ID()
    }

    // perform a check which connects the nodes in a ring (so each node is
    // connected to exactly two peers) and then checks that all nodes
    // performed two handshakes by checking their peerCount
    action := func(_ context.Context) error {
        for i, id := range ids {
            peerID := ids[(i+1)%len(ids)]
            if err := network.Connect(id, peerID); err != nil {
                return err
            }
        }
        return nil
    }
    check := func(ctx context.Context, id enode.ID) (bool, error) {
        // check we haven't run out of time
        select {
        case <-ctx.Done():
            return false, ctx.Err()
        default:
        }

        // get the node
        node := network.GetNode(id)
        if node == nil {
            return false, fmt.Errorf("unknown node: %s", id)
        }

        // check it has exactly two peers
        client, err := node.Client()
        if err != nil {
            return false, err
        }
        var peerCount int64
        if err := client.CallContext(ctx, &peerCount, "test_peerCount"); err != nil {
            return false, err
        }
        switch {
        case peerCount < 2:
            return false, nil
        case peerCount == 2:
            return true, nil
        default:
            return false, fmt.Errorf("unexpected peerCount: %d", peerCount)
        }
    }

    timeout := 30 * time.Second
    ctx, cancel := context.WithTimeout(context.Background(), timeout)
    defer cancel()

    // trigger a check every 100ms
    trigger := make(chan enode.ID)
    go triggerChecks(ctx, ids, trigger, 100*time.Millisecond)

    result := NewSimulation(network).Run(ctx, &Step{
        Action:  action,
        Trigger: trigger,
        Expect: &Expectation{
            Nodes: ids,
            Check: check,
        },
    })
    if result.Error != nil {
        t.Fatalf("simulation failed: %s", result.Error)
    }

    // take a network snapshot and check it contains the correct topology
    snap, err := network.Snapshot()
    if err != nil {
        t.Fatal(err)
    }
    if len(snap.Nodes) != nodeCount {
        t.Fatalf("expected snapshot to contain %d nodes, got %d", nodeCount, len(snap.Nodes))
    }
    if len(snap.Conns) != nodeCount {
        t.Fatalf("expected snapshot to contain %d connections, got %d", nodeCount, len(snap.Conns))
    }
    for i, id := range ids {
        conn := snap.Conns[i]
        if conn.One != id {
            t.Fatalf("expected conn[%d].One to be %s, got %s", i, id, conn.One)
        }
        peerID := ids[(i+1)%len(ids)]
        if conn.Other != peerID {
            t.Fatalf("expected conn[%d].Other to be %s, got %s", i, peerID, conn.Other)
        }
    }
}

func triggerChecks(ctx context.Context, ids []enode.ID, trigger chan enode.ID, interval time.Duration) {
    tick := time.NewTicker(interval)
    defer tick.Stop()
    for {
        select {
        case <-tick.C:
            for _, id := range ids {
                select {
                case trigger <- id:
                case <-ctx.Done():
                    return
                }
            }
        case <-ctx.Done():
            return
        }
    }
}

// \todo: refactor to implement shapshots
// and connect configuration methods once these are moved from
// swarm/network/simulations/connect.go
func BenchmarkMinimalService(b *testing.B) {
    b.Run("ring/32", benchmarkMinimalServiceTmp)
}

func benchmarkMinimalServiceTmp(b *testing.B) {

    // stop timer to discard setup time pollution
    args := strings.Split(b.Name(), "/")
    nodeCount, err := strconv.ParseInt(args[2], 10, 16)
    if err != nil {
        b.Fatal(err)
    }

    for i := 0; i < b.N; i++ {
        // this is a minimal service, whose protocol will close a channel upon run of protocol
        // making it possible to bench the time it takes for the service to start and protocol actually to be run
        protoCMap := make(map[enode.ID]map[enode.ID]chan struct{})
        adapter := adapters.NewSimAdapter(adapters.Services{
            "noopwoop": func(ctx *adapters.ServiceContext) (node.Service, error) {
                protoCMap[ctx.Config.ID] = make(map[enode.ID]chan struct{})
                svc := NewNoopService(protoCMap[ctx.Config.ID])
                return svc, nil
            },
        })

        // create network
        network := NewNetwork(adapter, &NetworkConfig{
            DefaultService: "noopwoop",
        })
        defer network.Shutdown()

        // create and start nodes
        ids := make([]enode.ID, nodeCount)
        for i := 0; i < int(nodeCount); i++ {
            conf := adapters.RandomNodeConfig()
            node, err := network.NewNodeWithConfig(conf)
            if err != nil {
                b.Fatalf("error creating node: %s", err)
            }
            if err := network.Start(node.ID()); err != nil {
                b.Fatalf("error starting node: %s", err)
            }
            ids[i] = node.ID()
        }

        // ready, set, go
        b.ResetTimer()

        // connect nodes in a ring
        for i, id := range ids {
            peerID := ids[(i+1)%len(ids)]
            if err := network.Connect(id, peerID); err != nil {
                b.Fatal(err)
            }
        }

        // wait for all protocols to signal to close down
        ctx, cancel := context.WithTimeout(context.TODO(), time.Second)
        defer cancel()
        for nodid, peers := range protoCMap {
            for peerid, peerC := range peers {
                log.Debug("getting ", "node", nodid, "peer", peerid)
                select {
                case <-ctx.Done():
                    b.Fatal(ctx.Err())
                case <-peerC:
                }
            }
        }
    }
}

func TestNode_UnmarshalJSON(t *testing.T) {
    t.Run(
        "test unmarshal of Node up field",
        func(t *testing.T) {
            runNodeUnmarshalJSON(t, casesNodeUnmarshalJSONUpField())
        },
    )
    t.Run(
        "test unmarshal of Node Config field",
        func(t *testing.T) {
            runNodeUnmarshalJSON(t, casesNodeUnmarshalJSONConfigField())
        },
    )
}

func runNodeUnmarshalJSON(t *testing.T, tests []nodeUnmarshalTestCase) {
    t.Helper()
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            var got Node
            if err := got.UnmarshalJSON([]byte(tt.marshaled)); err != nil {
                expectErrorMessageToContain(t, err, tt.wantErr)
            }
            expectNodeEquality(t, got, tt.want)
        })
    }
}

type nodeUnmarshalTestCase struct {
    name      string
    marshaled string
    want      Node
    wantErr   string
}

func expectErrorMessageToContain(t *testing.T, got error, want string) {
    t.Helper()
    if got == nil && want == "" {
        return
    }

    if got == nil && want != "" {
        t.Errorf("error was expected, got: nil, want: %v", want)
        return
    }

    if !strings.Contains(got.Error(), want) {
        t.Errorf(
            "unexpected error message, got  %v, want: %v",
            want,
            got,
        )
    }
}

func expectNodeEquality(t *testing.T, got Node, want Node) {
    t.Helper()
    if !reflect.DeepEqual(got, want) {
        t.Errorf("Node.UnmarshalJSON() = %v, want %v", got, want)
    }
}

func casesNodeUnmarshalJSONUpField() []nodeUnmarshalTestCase {
    return []nodeUnmarshalTestCase{
        {
            name:      "empty json",
            marshaled: "{}",
            want: Node{
                up: false,
            },
        },
        {
            name:      "a stopped node",
            marshaled: "{\"up\": false}",
            want: Node{
                up: false,
            },
        },
        {
            name:      "a running node",
            marshaled: "{\"up\": true}",
            want: Node{
                up: true,
            },
        },
        {
            name:      "invalid JSON value on valid key",
            marshaled: "{\"up\": foo}",
            wantErr:   "invalid character",
        },
        {
            name:      "invalid JSON key and value",
            marshaled: "{foo: bar}",
            wantErr:   "invalid character",
        },
        {
            name:      "bool value expected but got something else (string)",
            marshaled: "{\"up\": \"true\"}",
            wantErr:   "cannot unmarshal string into Go struct",
        },
    }
}

func casesNodeUnmarshalJSONConfigField() []nodeUnmarshalTestCase {
    // Don't do a big fuss around testing, as adapters.NodeConfig should
    // handle it's own serialization. Just do a sanity check.
    return []nodeUnmarshalTestCase{
        {
            name:      "Config field is omitted",
            marshaled: "{}",
            want: Node{
                Config: nil,
            },
        },
        {
            name:      "Config field is nil",
            marshaled: "{\"config\": nil}",
            want: Node{
                Config: nil,
            },
        },
        {
            name:      "a non default Config field",
            marshaled: "{\"config\":{\"name\":\"node_ecdd0\",\"port\":44665}}",
            want: Node{
                Config: &adapters.NodeConfig{
                    Name: "node_ecdd0",
                    Port: 44665,
                },
            },
        },
    }
}