aboutsummaryrefslogtreecommitdiffstats
path: root/swarm/network/simulation/simulation_test.go
blob: eed09bf508d5314a7161cfbff105bceec2f564eb (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
// 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

import (
    "context"
    "errors"
    "flag"
    "sync"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/node"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
    "github.com/ethereum/go-ethereum/rpc"
    colorable "github.com/mattn/go-colorable"
)

var (
    loglevel = flag.Int("loglevel", 2, "verbosity of logs")
)

func init() {
    flag.Parse()
    log.PrintOrigins(true)
    log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(*loglevel), log.StreamHandler(colorable.NewColorableStderr(), log.TerminalFormat(true))))
}

// TestRun tests if Run method calls RunFunc and if it handles context properly.
func TestRun(t *testing.T) {
    sim := New(noopServiceFuncMap)
    defer sim.Close()

    t.Run("call", func(t *testing.T) {
        expect := "something"
        var got string
        r := sim.Run(context.Background(), func(ctx context.Context, sim *Simulation) error {
            got = expect
            return nil
        })

        if r.Error != nil {
            t.Errorf("unexpected error: %v", r.Error)
        }
        if got != expect {
            t.Errorf("expected %q, got %q", expect, got)
        }
    })

    t.Run("cancellation", func(t *testing.T) {
        ctx, cancel := context.WithTimeout(context.Background(), 50*time.Millisecond)
        defer cancel()

        r := sim.Run(ctx, func(ctx context.Context, sim *Simulation) error {
            time.Sleep(time.Second)
            return nil
        })

        if r.Error != context.DeadlineExceeded {
            t.Errorf("unexpected error: %v", r.Error)
        }
    })

    t.Run("context value and duration", func(t *testing.T) {
        ctx := context.WithValue(context.Background(), "hey", "there")
        sleep := 50 * time.Millisecond

        r := sim.Run(ctx, func(ctx context.Context, sim *Simulation) error {
            if ctx.Value("hey") != "there" {
                return errors.New("expected context value not passed")
            }
            time.Sleep(sleep)
            return nil
        })

        if r.Error != nil {
            t.Errorf("unexpected error: %v", r.Error)
        }
        if r.Duration < sleep {
            t.Errorf("reported run duration less then expected: %s", r.Duration)
        }
    })
}

// TestClose tests are Close method triggers all close functions and are all nodes not up anymore.
func TestClose(t *testing.T) {
    var mu sync.Mutex
    var cleanupCount int

    sleep := 50 * time.Millisecond

    sim := New(map[string]ServiceFunc{
        "noop": func(ctx *adapters.ServiceContext, b *sync.Map) (node.Service, func(), error) {
            return newNoopService(), func() {
                time.Sleep(sleep)
                mu.Lock()
                defer mu.Unlock()
                cleanupCount++
            }, nil
        },
    })

    nodeCount := 30

    _, err := sim.AddNodes(nodeCount)
    if err != nil {
        t.Fatal(err)
    }

    var upNodeCount int
    for _, n := range sim.Net.GetNodes() {
        if n.Up {
            upNodeCount++
        }
    }
    if upNodeCount != nodeCount {
        t.Errorf("all nodes should be up, insted only %v are up", upNodeCount)
    }

    sim.Close()

    if cleanupCount != nodeCount {
        t.Errorf("number of cleanups expected %v, got %v", nodeCount, cleanupCount)
    }

    upNodeCount = 0
    for _, n := range sim.Net.GetNodes() {
        if n.Up {
            upNodeCount++
        }
    }
    if upNodeCount != 0 {
        t.Errorf("all nodes should be down, insted %v are up", upNodeCount)
    }
}

// TestDone checks if Close method triggers the closing of done channel.
func TestDone(t *testing.T) {
    sim := New(noopServiceFuncMap)
    sleep := 50 * time.Millisecond
    timeout := 2 * time.Second

    start := time.Now()
    go func() {
        time.Sleep(sleep)
        sim.Close()
    }()

    select {
    case <-time.After(timeout):
        t.Error("done channel closing timed out")
    case <-sim.Done():
        if d := time.Since(start); d < sleep {
            t.Errorf("done channel closed sooner then expected: %s", d)
        }
    }
}

// a helper map for usual services that do not do anything
var noopServiceFuncMap = map[string]ServiceFunc{
    "noop": noopServiceFunc,
}

// a helper function for most basic noop service
func noopServiceFunc(ctx *adapters.ServiceContext, b *sync.Map) (node.Service, func(), error) {
    return newNoopService(), nil, nil
}

// noopService is the service that does not do anything
// but implements node.Service interface.
type noopService struct{}

func newNoopService() node.Service {
    return &noopService{}
}

func (t *noopService) Protocols() []p2p.Protocol {
    return []p2p.Protocol{}
}

func (t *noopService) APIs() []rpc.API {
    return []rpc.API{}
}

func (t *noopService) Start(server *p2p.Server) error {
    return nil
}

func (t *noopService) Stop() error {
    return nil
}