aboutsummaryrefslogtreecommitdiffstats
path: root/core/test/transport_test.go
blob: d5032cd5beeb515f58ef9a4f846468f40a5ac215 (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
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus 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 dexon-consensus 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 dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.

package test

import (
    "encoding/json"
    "fmt"
    "net"
    "strconv"
    "sync"
    "testing"
    "time"

    "github.com/dexon-foundation/dexon-consensus/common"
    "github.com/dexon-foundation/dexon-consensus/core/types"
    "github.com/stretchr/testify/suite"
)

type testPeer struct {
    nID               types.NodeID
    trans             TransportClient
    recv              <-chan *TransportEnvelope
    expectedEchoHash  common.Hash
    echoBlock         *types.Block
    myBlock           *types.Block
    myBlockSentTime   time.Time
    blocks            map[types.NodeID]*types.Block
    blocksReceiveTime map[common.Hash]time.Time
}

type testPeerServer struct {
    trans      TransportServer
    recv       chan *TransportEnvelope
    peerBlocks map[types.NodeID]*types.Block
}

type testMarshaller struct{}

func (m *testMarshaller) Unmarshal(
    msgType string, payload []byte) (msg interface{}, err error) {

    switch msgType {
    case "block":
        block := &types.Block{}
        if err = json.Unmarshal(payload, block); err != nil {
            return
        }
        msg = block
    default:
        err = fmt.Errorf("unknown message type: %v", msgType)
    }
    return
}

func (m *testMarshaller) Marshal(
    msg interface{}) (msgType string, payload []byte, err error) {

    switch msg.(type) {
    case *types.Block:
        if payload, err = json.Marshal(msg); err != nil {
            return
        }
        msgType = "block"
    default:
        err = fmt.Errorf("unknown message type: %v", msg)
    }
    return
}

type TransportTestSuite struct {
    suite.Suite
}

func (s *TransportTestSuite) baseTest(
    server *testPeerServer,
    peers map[types.NodeID]*testPeer,
    delay time.Duration) {

    var (
        req = s.Require()
        wg  sync.WaitGroup
    )

    // For each peers, do following stuffs:
    //  - broadcast 1 block.
    //  - report one random block to server, along with its node ID.
    // Server would echo the random block back to the peer.
    handleServer := func(server *testPeerServer) {
        defer wg.Done()
        server.peerBlocks = make(map[types.NodeID]*types.Block)
        for {
            select {
            case e := <-server.recv:
                req.Equal(e.PeerType, TransportPeer)
                switch v := e.Msg.(type) {
                case *types.Block:
                    req.Equal(v.ProposerID, e.From)
                    server.peerBlocks[v.ProposerID] = v
                    // Echo the block back
                    server.trans.Send(v.ProposerID, v)
                }
            }
            // Upon receiving blocks from all peers, stop.
            if len(server.peerBlocks) == len(peers) {
                return
            }
        }
    }
    handlePeer := func(peer *testPeer) {
        defer wg.Done()
        peer.blocks = make(map[types.NodeID]*types.Block)
        peer.blocksReceiveTime = make(map[common.Hash]time.Time)
        for {
            select {
            case e := <-peer.recv:
                switch v := e.Msg.(type) {
                case *types.Block:
                    if v.ProposerID == peer.nID {
                        req.Equal(e.PeerType, TransportPeerServer)
                        peer.echoBlock = v
                    } else {
                        req.Equal(e.PeerType, TransportPeer)
                        req.Equal(e.From, v.ProposerID)
                        peer.blocks[v.ProposerID] = v
                        peer.blocksReceiveTime[v.Hash] = time.Now()
                    }
                }
            }
            // Upon receiving blocks from all other peers, and echoed from
            // server, stop.
            if peer.echoBlock != nil && len(peer.blocks) == len(peers)-1 {
                return
            }
        }
    }
    wg.Add(len(peers) + 1)
    go handleServer(server)
    for nID, peer := range peers {
        go handlePeer(peer)
        // Broadcast a block.
        peer.myBlock = &types.Block{
            ProposerID: nID,
            Hash:       common.NewRandomHash(),
        }
        peer.myBlockSentTime = time.Now()
        peer.trans.Broadcast(peer.myBlock)
        // Report a block to server.
        peer.expectedEchoHash = common.NewRandomHash()
        peer.trans.Report(&types.Block{
            ProposerID: nID,
            Hash:       peer.expectedEchoHash,
        })
    }
    wg.Wait()
    // Make sure each sent block is received.
    for nID, peer := range peers {
        req.NotNil(peer.echoBlock)
        req.Equal(peer.echoBlock.Hash, peer.expectedEchoHash)
        for othernID, otherPeer := range peers {
            if nID == othernID {
                continue
            }
            req.Equal(
                peer.myBlock.Hash,
                otherPeer.blocks[peer.nID].Hash)
        }
    }
    // Make sure the latency is expected.
    for nID, peer := range peers {
        for othernID, otherPeer := range peers {
            if othernID == nID {
                continue
            }
            req.True(otherPeer.blocksReceiveTime[peer.myBlock.Hash].Sub(
                peer.myBlockSentTime) >= delay)
        }
    }
}

func (s *TransportTestSuite) TestFake() {
    var (
        peerCount = 13
        req       = s.Require()
        peers     = make(map[types.NodeID]*testPeer)
        prvKeys   = GenerateRandomPrivateKeys(peerCount)
        err       error
        wg        sync.WaitGroup
        latency   = &FixedLatencyModel{Latency: 300}
        server    = &testPeerServer{trans: NewFakeTransportServer()}
    )
    // Setup PeerServer
    server.recv, err = server.trans.Host()
    req.Nil(err)
    // Setup Peers
    wg.Add(len(prvKeys))
    for _, key := range prvKeys {
        nID := types.NewNodeID(key.PublicKey())
        peer := &testPeer{
            nID:   nID,
            trans: NewFakeTransportClient(key.PublicKey(), latency),
        }
        peers[nID] = peer
        go func() {
            defer wg.Done()
            recv, err := peer.trans.Join(server.recv)
            req.Nil(err)
            peer.recv = recv
        }()
    }
    // Block here until we collect enough peers.
    server.trans.WaitForPeers(peerCount)
    // Make sure all clients are ready.
    wg.Wait()
    s.baseTest(server, peers, 300*time.Millisecond)
    req.Nil(server.trans.Close())
    for _, peer := range peers {
        req.Nil(peer.trans.Close())
    }
}

func (s *TransportTestSuite) TestTCPLocal() {

    var (
        peerCount  = 25
        req        = s.Require()
        peers      = make(map[types.NodeID]*testPeer)
        prvKeys    = GenerateRandomPrivateKeys(peerCount)
        err        error
        wg         sync.WaitGroup
        latency    = &FixedLatencyModel{Latency: 300}
        serverPort = 8080
        serverAddr = net.JoinHostPort("127.0.0.1", strconv.Itoa(serverPort))
        server     = &testPeerServer{
            trans: NewTCPTransportServer(&testMarshaller{}, serverPort)}
    )
    // Setup PeerServer
    server.recv, err = server.trans.Host()
    req.Nil(err)
    // Setup Peers
    wg.Add(len(prvKeys))
    for _, prvKey := range prvKeys {
        nID := types.NewNodeID(prvKey.PublicKey())
        peer := &testPeer{
            nID: nID,
            trans: NewTCPTransportClient(
                prvKey.PublicKey(), latency, &testMarshaller{}, true),
        }
        peers[nID] = peer
        go func() {
            defer wg.Done()

            recv, err := peer.trans.Join(serverAddr)
            req.Nil(err)
            peer.recv = recv
        }()
    }
    // Block here until we collect enough peers.
    server.trans.WaitForPeers(peerCount)
    // Make sure all clients are ready.
    wg.Wait()

    s.baseTest(server, peers, 300*time.Millisecond)
    req.Nil(server.trans.Close())
    for _, peer := range peers {
        req.Nil(peer.trans.Close())
    }
}

func TestTransport(t *testing.T) {
    suite.Run(t, new(TransportTestSuite))
}