aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/network/simulation/example_test.go
blob: 9d1492979563e340c48077879ce18f8dc7c247c1 (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
// Copyright 2018 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 simulation_test

import (
    "context"
    "fmt"
    "sync"
    "time"

    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/node"
    "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
    "github.com/ethereum/go-ethereum/swarm/network"
    "github.com/ethereum/go-ethereum/swarm/network/simulation"
)

// Every node can have a Kademlia associated using the node bucket under
// BucketKeyKademlia key. This allows to use WaitTillHealthy to block until
// all nodes have the their Kademlias healthy.
func ExampleSimulation_WaitTillHealthy() {

    sim := simulation.New(map[string]simulation.ServiceFunc{
        "bzz": func(ctx *adapters.ServiceContext, b *sync.Map) (node.Service, func(), error) {
            addr := network.NewAddr(ctx.Config.Node())
            hp := network.NewHiveParams()
            hp.Discovery = false
            config := &network.BzzConfig{
                OverlayAddr:  addr.Over(),
                UnderlayAddr: addr.Under(),
                HiveParams:   hp,
            }
            kad := network.NewKademlia(addr.Over(), network.NewKadParams())
            // store kademlia in node's bucket under BucketKeyKademlia
            // so that it can be found by WaitTillHealthy method.
            b.Store(simulation.BucketKeyKademlia, kad)
            return network.NewBzz(config, kad, nil, nil, nil), nil, nil
        },
    })
    defer sim.Close()

    _, err := sim.AddNodesAndConnectRing(10)
    if err != nil {
        // handle error properly...
        panic(err)
    }

    ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
    defer cancel()
    ill, err := sim.WaitTillHealthy(ctx)
    if err != nil {
        // inspect the latest detected not healthy kademlias
        for id, kad := range ill {
            fmt.Println("Node", id)
            fmt.Println(kad.String())
        }
        // handle error...
    }

    // continue with the test

}

// Watch all peer events in the simulation network, buy receiving from a channel.
func ExampleSimulation_PeerEvents() {
    sim := simulation.New(nil)
    defer sim.Close()

    events := sim.PeerEvents(context.Background(), sim.NodeIDs())

    go func() {
        for e := range events {
            if e.Error != nil {
                log.Error("peer event", "err", e.Error)
                continue
            }
            log.Info("peer event", "node", e.NodeID, "peer", e.PeerID, "type", e.Event.Type)
        }
    }()
}

// Detect when a nodes drop a peer.
func ExampleSimulation_PeerEvents_disconnections() {
    sim := simulation.New(nil)
    defer sim.Close()

    disconnections := sim.PeerEvents(
        context.Background(),
        sim.NodeIDs(),
        simulation.NewPeerEventsFilter().Drop(),
    )

    go func() {
        for d := range disconnections {
            if d.Error != nil {
                log.Error("peer drop", "err", d.Error)
                continue
            }
            log.Warn("peer drop", "node", d.NodeID, "peer", d.PeerID)
        }
    }()
}

// Watch multiple types of events or messages. In this case, they differ only
// by MsgCode, but filters can be set for different types or protocols, too.
func ExampleSimulation_PeerEvents_multipleFilters() {
    sim := simulation.New(nil)
    defer sim.Close()

    msgs := sim.PeerEvents(
        context.Background(),
        sim.NodeIDs(),
        // Watch when bzz messages 1 and 4 are received.
        simulation.NewPeerEventsFilter().ReceivedMessages().Protocol("bzz").MsgCode(1),
        simulation.NewPeerEventsFilter().ReceivedMessages().Protocol("bzz").MsgCode(4),
    )

    go func() {
        for m := range msgs {
            if m.Error != nil {
                log.Error("bzz message", "err", m.Error)
                continue
            }
            log.Info("bzz message", "node", m.NodeID, "peer", m.PeerID)
        }
    }()
}