aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/network/simulations/overlay_test.go
blob: 4d4eb6c371dec6abdcca63ef23e633168eab943d (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
// 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 main

import (
    "context"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
    "net/http/httptest"
    "net/url"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/p2p/discover"
    "github.com/ethereum/go-ethereum/p2p/simulations"
    "github.com/ethereum/go-ethereum/swarm/log"
)

var (
    nodeCount = 16
)

//This test is used to test the overlay simulation.
//As the simulation is executed via a main, it is easily missed on changes
//An automated test will prevent that
//The test just connects to the simulations, starts the network,
//starts the mocker, gets the number of nodes, and stops it again.
//It also provides a documentation on the steps needed by frontends
//to use the simulations
func TestOverlaySim(t *testing.T) {
    t.Skip("Test is flaky, see: https://github.com/ethersphere/go-ethereum/issues/592")
    //start the simulation
    log.Info("Start simulation backend")
    //get the simulation networ; needed to subscribe for up events
    net := newSimulationNetwork()
    //create the overlay simulation
    sim := newOverlaySim(net)
    //create a http test server with it
    srv := httptest.NewServer(sim)
    defer srv.Close()

    log.Debug("Http simulation server started. Start simulation network")
    //start the simulation network (initialization of simulation)
    resp, err := http.Post(srv.URL+"/start", "application/json", nil)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("Expected Status Code %d, got %d", http.StatusOK, resp.StatusCode)
    }

    log.Debug("Start mocker")
    //start the mocker, needs a node count and an ID
    resp, err = http.PostForm(srv.URL+"/mocker/start",
        url.Values{
            "node-count":  {fmt.Sprintf("%d", nodeCount)},
            "mocker-type": {simulations.GetMockerList()[0]},
        })
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        reason, err := ioutil.ReadAll(resp.Body)
        if err != nil {
            t.Fatal(err)
        }
        t.Fatalf("Expected Status Code %d, got %d, response body %s", http.StatusOK, resp.StatusCode, string(reason))
    }

    //variables needed to wait for nodes being up
    var upCount int
    trigger := make(chan discover.NodeID)

    //wait for all nodes to be up
    ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
    defer cancel()

    //start watching node up events...
    go watchSimEvents(net, ctx, trigger)

    //...and wait until all expected up events (nodeCount) have been received
LOOP:
    for {
        select {
        case <-trigger:
            //new node up event received, increase counter
            upCount++
            //all expected node up events received
            if upCount == nodeCount {
                break LOOP
            }
        case <-ctx.Done():
            t.Fatalf("Timed out waiting for up events")
        }

    }

    //at this point we can query the server
    log.Info("Get number of nodes")
    //get the number of nodes
    resp, err = http.Get(srv.URL + "/nodes")
    if err != nil {
        t.Fatal(err)
    }

    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
    b, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        t.Fatal(err)
    }

    //unmarshal number of nodes from JSON response
    var nodesArr []simulations.Node
    err = json.Unmarshal(b, &nodesArr)
    if err != nil {
        t.Fatal(err)
    }

    //check if number of nodes received is same as sent
    if len(nodesArr) != nodeCount {
        t.Fatal(fmt.Errorf("Expected %d number of nodes, got %d", nodeCount, len(nodesArr)))
    }

    //need to let it run for a little while, otherwise stopping it immediately can crash due running nodes
    //wanting to connect to already stopped nodes
    time.Sleep(1 * time.Second)

    log.Info("Stop the network")
    //stop the network
    resp, err = http.Post(srv.URL+"/stop", "application/json", nil)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }

    log.Info("Reset the network")
    //reset the network (removes all nodes and connections)
    resp, err = http.Post(srv.URL+"/reset", "application/json", nil)
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()
    if resp.StatusCode != http.StatusOK {
        t.Fatalf("err %s", resp.Status)
    }
}

//watch for events so we know when all nodes are up
func watchSimEvents(net *simulations.Network, ctx context.Context, trigger chan discover.NodeID) {
    events := make(chan *simulations.Event)
    sub := net.Events().Subscribe(events)
    defer sub.Unsubscribe()

    for {
        select {
        case ev := <-events:
            //only catch node up events
            if ev.Type == simulations.EventTypeNode {
                if ev.Node.Up {
                    log.Debug("got node up event", "event", ev, "node", ev.Node.Config.ID)
                    select {
                    case trigger <- ev.Node.Config.ID:
                    case <-ctx.Done():
                        return
                    }
                }
            }
        case <-ctx.Done():
            return
        }
    }
}