aboutsummaryrefslogtreecommitdiffstats
path: root/les/clientpool_test.go
blob: 225f828ec6236a733a8544c25e73e937a5bf296d (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
// Copyright 2019 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 les

import (
    "fmt"
    "math/rand"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/common/mclock"
    "github.com/ethereum/go-ethereum/core/rawdb"
    "github.com/ethereum/go-ethereum/p2p/enode"
)

func TestClientPoolL10C100Free(t *testing.T) {
    testClientPool(t, 10, 100, 0, true)
}

func TestClientPoolL40C200Free(t *testing.T) {
    testClientPool(t, 40, 200, 0, true)
}

func TestClientPoolL100C300Free(t *testing.T) {
    testClientPool(t, 100, 300, 0, true)
}

func TestClientPoolL10C100P4(t *testing.T) {
    testClientPool(t, 10, 100, 4, false)
}

func TestClientPoolL40C200P30(t *testing.T) {
    testClientPool(t, 40, 200, 30, false)
}

func TestClientPoolL100C300P20(t *testing.T) {
    testClientPool(t, 100, 300, 20, false)
}

const testClientPoolTicks = 500000

type poolTestPeer int

func (i poolTestPeer) ID() enode.ID {
    return enode.ID{byte(i % 256), byte(i >> 8)}
}

func (i poolTestPeer) freeClientId() string {
    return fmt.Sprintf("addr #%d", i)
}

func (i poolTestPeer) updateCapacity(uint64) {}

func testClientPool(t *testing.T, connLimit, clientCount, paidCount int, randomDisconnect bool) {
    rand.Seed(time.Now().UnixNano())
    var (
        clock     mclock.Simulated
        db        = rawdb.NewMemoryDatabase()
        connected = make([]bool, clientCount)
        connTicks = make([]int, clientCount)
        disconnCh = make(chan int, clientCount)
        disconnFn = func(id enode.ID) {
            disconnCh <- int(id[0]) + int(id[1])<<8
        }
        pool = newClientPool(db, 1, 10000, &clock, disconnFn)
    )
    pool.setLimits(connLimit, uint64(connLimit))
    pool.setPriceFactors(priceFactors{1, 0, 1}, priceFactors{1, 0, 1})

    // pool should accept new peers up to its connected limit
    for i := 0; i < connLimit; i++ {
        if pool.connect(poolTestPeer(i), 0) {
            connected[i] = true
        } else {
            t.Fatalf("Test peer #%d rejected", i)
        }
    }
    // since all accepted peers are new and should not be kicked out, the next one should be rejected
    if pool.connect(poolTestPeer(connLimit), 0) {
        connected[connLimit] = true
        t.Fatalf("Peer accepted over connected limit")
    }

    // randomly connect and disconnect peers, expect to have a similar total connection time at the end
    for tickCounter := 0; tickCounter < testClientPoolTicks; tickCounter++ {
        clock.Run(1 * time.Second)
        //time.Sleep(time.Microsecond * 100)

        if tickCounter == testClientPoolTicks/4 {
            // give a positive balance to some of the peers
            amount := uint64(testClientPoolTicks / 2 * 1000000000) // enough for half of the simulation period
            for i := 0; i < paidCount; i++ {
                pool.addBalance(poolTestPeer(i).ID(), amount, false)
            }
        }

        i := rand.Intn(clientCount)
        if connected[i] {
            if randomDisconnect {
                pool.disconnect(poolTestPeer(i))
                connected[i] = false
                connTicks[i] += tickCounter
            }
        } else {
            if pool.connect(poolTestPeer(i), 0) {
                connected[i] = true
                connTicks[i] -= tickCounter
            }
        }
    pollDisconnects:
        for {
            select {
            case i := <-disconnCh:
                pool.disconnect(poolTestPeer(i))
                if connected[i] {
                    connTicks[i] += tickCounter
                    connected[i] = false
                }
            default:
                break pollDisconnects
            }
        }
    }

    expTicks := testClientPoolTicks/2*connLimit/clientCount + testClientPoolTicks/2*(connLimit-paidCount)/(clientCount-paidCount)
    expMin := expTicks - expTicks/10
    expMax := expTicks + expTicks/10
    paidTicks := testClientPoolTicks/2*connLimit/clientCount + testClientPoolTicks/2
    paidMin := paidTicks - paidTicks/10
    paidMax := paidTicks + paidTicks/10

    // check if the total connected time of peers are all in the expected range
    for i, c := range connected {
        if c {
            connTicks[i] += testClientPoolTicks
        }
        min, max := expMin, expMax
        if i < paidCount {
            // expect a higher amount for clients with a positive balance
            min, max = paidMin, paidMax
        }
        if connTicks[i] < min || connTicks[i] > max {
            t.Errorf("Total connected time of test node #%d (%d) outside expected range (%d to %d)", i, connTicks[i], min, max)
        }
    }

    // a previously unknown peer should be accepted now
    if !pool.connect(poolTestPeer(54321), 0) {
        t.Fatalf("Previously unknown peer rejected")
    }

    // close and restart pool
    pool.stop()
    pool = newClientPool(db, 1, 10000, &clock, func(id enode.ID) {})
    pool.setLimits(connLimit, uint64(connLimit))

    // try connecting all known peers (connLimit should be filled up)
    for i := 0; i < clientCount; i++ {
        pool.connect(poolTestPeer(i), 0)
    }
    // expect pool to remember known nodes and kick out one of them to accept a new one
    if !pool.connect(poolTestPeer(54322), 0) {
        t.Errorf("Previously unknown peer rejected after restarting pool")
    }
    pool.stop()
}