aboutsummaryrefslogtreecommitdiffstats
path: root/eth/protocol_test.go
blob: d5ac21755878b6f263eaaaecc5330a2f69b71c86 (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
package eth

import (
    "fmt"
    "log"
    "math/big"
    "os"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/errs"
    ethlogger "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/discover"
)

var logsys = ethlogger.NewStdLogSystem(os.Stdout, log.LstdFlags, ethlogger.LogLevel(ethlogger.DebugDetailLevel))

var ini = false

func logInit() {
    if !ini {
        ethlogger.AddLogSystem(logsys)
        ini = true
    }
}

type testTxPool struct {
    getTransactions func() []*types.Transaction
    addTransactions func(txs []*types.Transaction)
}

type testChainManager struct {
    getBlockHashes func(hash common.Hash, amount uint64) (hashes []common.Hash)
    getBlock       func(hash common.Hash) *types.Block
    status         func() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash)
}

type testBlockPool struct {
    addBlockHashes func(next func() (common.Hash, bool), peerId string)
    addBlock       func(block *types.Block, peerId string) (err error)
    addPeer        func(td *big.Int, currentBlock common.Hash, peerId string, requestHashes func(common.Hash) error, requestBlocks func([]common.Hash) error, peerError func(*errs.Error)) (best bool, suspended bool)
    removePeer     func(peerId string)
}

func (self *testTxPool) AddTransactions(txs []*types.Transaction) {
    if self.addTransactions != nil {
        self.addTransactions(txs)
    }
}

func (self *testTxPool) GetTransactions() types.Transactions { return nil }

func (self *testChainManager) GetBlockHashesFromHash(hash common.Hash, amount uint64) (hashes []common.Hash) {
    if self.getBlockHashes != nil {
        hashes = self.getBlockHashes(hash, amount)
    }
    return
}

func (self *testChainManager) Status() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash) {
    if self.status != nil {
        td, currentBlock, genesisBlock = self.status()
    } else {
        td = common.Big1
        currentBlock = common.Hash{1}
        genesisBlock = common.Hash{2}
    }
    return
}

func (self *testChainManager) GetBlock(hash common.Hash) (block *types.Block) {
    if self.getBlock != nil {
        block = self.getBlock(hash)
    }
    return
}

func (self *testBlockPool) AddBlockHashes(next func() (common.Hash, bool), peerId string) {
    if self.addBlockHashes != nil {
        self.addBlockHashes(next, peerId)
    }
}

func (self *testBlockPool) AddBlock(block *types.Block, peerId string) {
    if self.addBlock != nil {
        self.addBlock(block, peerId)
    }
}

func (self *testBlockPool) AddPeer(td *big.Int, currentBlock common.Hash, peerId string, requestBlockHashes func(common.Hash) error, requestBlocks func([]common.Hash) error, peerError func(*errs.Error)) (best bool, suspended bool) {
    if self.addPeer != nil {
        best, suspended = self.addPeer(td, currentBlock, peerId, requestBlockHashes, requestBlocks, peerError)
    }
    return
}

func (self *testBlockPool) RemovePeer(peerId string) {
    if self.removePeer != nil {
        self.removePeer(peerId)
    }
}

func testPeer() *p2p.Peer {
    var id discover.NodeID
    pk := crypto.GenerateNewKeyPair().PublicKey
    copy(id[:], pk)
    return p2p.NewPeer(id, "test peer", []p2p.Cap{})
}

type ethProtocolTester struct {
    p2p.MsgReadWriter // writing to the tester feeds the protocol

    quit         chan error
    pipe         *p2p.MsgPipeRW    // the protocol read/writes on this end
    txPool       *testTxPool       // txPool
    chainManager *testChainManager // chainManager
    blockPool    *testBlockPool    // blockPool
    t            *testing.T
}

func newEth(t *testing.T) *ethProtocolTester {
    p1, p2 := p2p.MsgPipe()
    return &ethProtocolTester{
        MsgReadWriter: p1,
        quit:          make(chan error, 1),
        pipe:          p2,
        txPool:        &testTxPool{},
        chainManager:  &testChainManager{},
        blockPool:     &testBlockPool{},
        t:             t,
    }
}

func (self *ethProtocolTester) reset() {
    self.pipe.Close()

    p1, p2 := p2p.MsgPipe()
    self.MsgReadWriter = p1
    self.pipe = p2
    self.quit = make(chan error, 1)
}

func (self *ethProtocolTester) checkError(expCode int, delay time.Duration) (err error) {
    var timer = time.After(delay)
    select {
    case err = <-self.quit:
    case <-timer:
        self.t.Errorf("no error after %v, expected %v", delay, expCode)
        return
    }
    perr, ok := err.(*errs.Error)
    if ok && perr != nil {
        if code := perr.Code; code != expCode {
            self.t.Errorf("expected protocol error (code %v), got %v (%v)", expCode, code, err)
        }
    } else {
        self.t.Errorf("expected protocol error (code %v), got %v", expCode, err)
    }
    return
}

func (self *ethProtocolTester) run() {
    err := runEthProtocol(ProtocolVersion, NetworkId, self.txPool, self.chainManager, self.blockPool, testPeer(), self.pipe)
    self.quit <- err
}

func (self *ethProtocolTester) handshake(t *testing.T, mock bool) {
    td, currentBlock, genesis := self.chainManager.Status()
    // first outgoing msg should be StatusMsg.
    err := p2p.ExpectMsg(self, StatusMsg, &statusMsgData{
        ProtocolVersion: ProtocolVersion,
        NetworkId:       NetworkId,
        TD:              *td,
        CurrentBlock:    currentBlock,
        GenesisBlock:    genesis,
    })
    if err != nil {
        t.Fatalf("incorrect outgoing status: %v", err)
    }
    if mock {
        go p2p.Send(self, StatusMsg, &statusMsgData{ProtocolVersion, NetworkId, *td, currentBlock, genesis})
    }
}

func TestStatusMsgErrors(t *testing.T) {
    logInit()
    eth := newEth(t)
    go eth.run()
    td, currentBlock, genesis := eth.chainManager.Status()

    tests := []struct {
        code          uint64
        data          interface{}
        wantErrorCode int
    }{
        {
            code: TxMsg, data: []interface{}{},
            wantErrorCode: ErrNoStatusMsg,
        },
        {
            code: StatusMsg, data: statusMsgData{10, NetworkId, *td, currentBlock, genesis},
            wantErrorCode: ErrProtocolVersionMismatch,
        },
        {
            code: StatusMsg, data: statusMsgData{ProtocolVersion, 999, *td, currentBlock, genesis},
            wantErrorCode: ErrNetworkIdMismatch,
        },
        {
            code: StatusMsg, data: statusMsgData{ProtocolVersion, NetworkId, *td, currentBlock, common.Hash{3}},
            wantErrorCode: ErrGenesisBlockMismatch,
        },
    }
    for _, test := range tests {
        eth.handshake(t, false)
        // the send call might hang until reset because
        // the protocol might not read the payload.
        go p2p.Send(eth, test.code, test.data)
        eth.checkError(test.wantErrorCode, 1*time.Second)

        eth.reset()
        go eth.run()
    }
}

func TestNewBlockMsg(t *testing.T) {
    logInit()
    eth := newEth(t)

    var disconnected bool
    eth.blockPool.removePeer = func(peerId string) {
        fmt.Printf("peer <%s> is disconnected\n", peerId)
        disconnected = true
    }

    go eth.run()

    eth.handshake(t, true)
    err := p2p.ExpectMsg(eth, TxMsg, []interface{}{})
    if err != nil {
        t.Errorf("transactions expected, got %v", err)
    }

    var tds = make(chan *big.Int)
    eth.blockPool.addPeer = func(td *big.Int, currentBlock common.Hash, peerId string, requestHashes func(common.Hash) error, requestBlocks func([]common.Hash) error, peerError func(*errs.Error)) (best bool, suspended bool) {
        tds <- td
        return
    }

    var delay = 1 * time.Second
    // eth.reset()
    block := types.NewBlock(common.Hash{1}, common.Address{1}, common.Hash{1}, common.Big1, 1, "extra")

    go p2p.Send(eth, NewBlockMsg, &newBlockMsgData{Block: block})
    timer := time.After(delay)

    select {
    case td := <-tds:
        if td.Cmp(common.Big0) != 0 {
            t.Errorf("incorrect td %v, expected %v", td, common.Big0)
        }
    case <-timer:
        t.Errorf("no td recorded after %v", delay)
        return
    case err := <-eth.quit:
        t.Errorf("no error expected, got %v", err)
        return
    }

    go p2p.Send(eth, NewBlockMsg, &newBlockMsgData{block, common.Big2})
    timer = time.After(delay)

    select {
    case td := <-tds:
        if td.Cmp(common.Big2) != 0 {
            t.Errorf("incorrect td %v, expected %v", td, common.Big2)
        }
    case <-timer:
        t.Errorf("no td recorded after %v", delay)
        return
    case err := <-eth.quit:
        t.Errorf("no error expected, got %v", err)
        return
    }

    go p2p.Send(eth, NewBlockMsg, []interface{}{})
    // Block.DecodeRLP: validation failed: header is nil
    eth.checkError(ErrDecode, delay)

}

func TestBlockMsg(t *testing.T) {
    logInit()
    eth := newEth(t)
    blocks := make(chan *types.Block)
    eth.blockPool.addBlock = func(block *types.Block, peerId string) (err error) {
        blocks <- block
        return
    }

    var disconnected bool
    eth.blockPool.removePeer = func(peerId string) {
        fmt.Printf("peer <%s> is disconnected\n", peerId)
        disconnected = true
    }

    go eth.run()

    eth.handshake(t, true)
    err := p2p.ExpectMsg(eth, TxMsg, []interface{}{})
    if err != nil {
        t.Errorf("transactions expected, got %v", err)
    }

    var delay = 3 * time.Second
    // eth.reset()
    newblock := func(i int64) *types.Block {
        return types.NewBlock(common.Hash{byte(i)}, common.Address{byte(i)}, common.Hash{byte(i)}, big.NewInt(i), uint64(i), string(i))
    }
    go p2p.Send(eth, BlocksMsg, types.Blocks{newblock(0), newblock(1), newblock(2)})
    timer := time.After(delay)
    for i := int64(0); i < 3; i++ {
        select {
        case block := <-blocks:
            if (block.ParentHash() != common.Hash{byte(i)}) {
                t.Errorf("incorrect block %v, expected %v", block.ParentHash(), common.Hash{byte(i)})
            }
        case <-timer:
            t.Errorf("no td recorded after %v", delay)
            return
        case err := <-eth.quit:
            t.Errorf("no error expected, got %v", err)
            return
        }
    }
}