aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/testing/protocoltester.go
blob: afc03b009fa56bee3b023f26d5ef00c984fae8b1 (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
// Copyright 2017 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/>.

/*
the p2p/testing package provides a unit test scheme to check simple
protocol message exchanges with one pivot node and a number of dummy peers
The pivot test node runs a node.Service, the dummy peers run a mock node
that can be used to send and receive messages
*/

package testing

import (
    "bytes"
    "fmt"
    "io"
    "io/ioutil"
    "strings"
    "sync"
    "testing"

    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/node"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/enode"
    "github.com/ethereum/go-ethereum/p2p/simulations"
    "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
    "github.com/ethereum/go-ethereum/rlp"
    "github.com/ethereum/go-ethereum/rpc"
)

// ProtocolTester is the tester environment used for unit testing protocol
// message exchanges. It uses p2p/simulations framework
type ProtocolTester struct {
    *ProtocolSession
    network *simulations.Network
}

// NewProtocolTester constructs a new ProtocolTester
// it takes as argument the pivot node id, the number of dummy peers and the
// protocol run function called on a peer connection by the p2p server
func NewProtocolTester(t *testing.T, id enode.ID, n int, run func(*p2p.Peer, p2p.MsgReadWriter) error) *ProtocolTester {
    services := adapters.Services{
        "test": func(ctx *adapters.ServiceContext) (node.Service, error) {
            return &testNode{run}, nil
        },
        "mock": func(ctx *adapters.ServiceContext) (node.Service, error) {
            return newMockNode(), nil
        },
    }
    adapter := adapters.NewSimAdapter(services)
    net := simulations.NewNetwork(adapter, &simulations.NetworkConfig{})
    if _, err := net.NewNodeWithConfig(&adapters.NodeConfig{
        ID:              id,
        EnableMsgEvents: true,
        Services:        []string{"test"},
    }); err != nil {
        panic(err.Error())
    }
    if err := net.Start(id); err != nil {
        panic(err.Error())
    }

    node := net.GetNode(id).Node.(*adapters.SimNode)
    peers := make([]*adapters.NodeConfig, n)
    nodes := make([]*enode.Node, n)
    for i := 0; i < n; i++ {
        peers[i] = adapters.RandomNodeConfig()
        peers[i].Services = []string{"mock"}
        nodes[i] = peers[i].Node()
    }
    events := make(chan *p2p.PeerEvent, 1000)
    node.SubscribeEvents(events)
    ps := &ProtocolSession{
        Server:  node.Server(),
        Nodes:   nodes,
        adapter: adapter,
        events:  events,
    }
    self := &ProtocolTester{
        ProtocolSession: ps,
        network:         net,
    }

    self.Connect(id, peers...)

    return self
}

// Stop stops the p2p server
func (t *ProtocolTester) Stop() error {
    t.Server.Stop()
    return nil
}

// Connect brings up the remote peer node and connects it using the
// p2p/simulations network connection with the in memory network adapter
func (t *ProtocolTester) Connect(selfID enode.ID, peers ...*adapters.NodeConfig) {
    for _, peer := range peers {
        log.Trace(fmt.Sprintf("start node %v", peer.ID))
        if _, err := t.network.NewNodeWithConfig(peer); err != nil {
            panic(fmt.Sprintf("error starting peer %v: %v", peer.ID, err))
        }
        if err := t.network.Start(peer.ID); err != nil {
            panic(fmt.Sprintf("error starting peer %v: %v", peer.ID, err))
        }
        log.Trace(fmt.Sprintf("connect to %v", peer.ID))
        if err := t.network.Connect(selfID, peer.ID); err != nil {
            panic(fmt.Sprintf("error connecting to peer %v: %v", peer.ID, err))
        }
    }

}

// testNode wraps a protocol run function and implements the node.Service
// interface
type testNode struct {
    run func(*p2p.Peer, p2p.MsgReadWriter) error
}

func (t *testNode) Protocols() []p2p.Protocol {
    return []p2p.Protocol{{
        Length: 100,
        Run:    t.run,
    }}
}

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

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

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

// mockNode is a testNode which doesn't actually run a protocol, instead
// exposing channels so that tests can manually trigger and expect certain
// messages
type mockNode struct {
    testNode

    trigger  chan *Trigger
    expect   chan []Expect
    err      chan error
    stop     chan struct{}
    stopOnce sync.Once
}

func newMockNode() *mockNode {
    mock := &mockNode{
        trigger: make(chan *Trigger),
        expect:  make(chan []Expect),
        err:     make(chan error),
        stop:    make(chan struct{}),
    }
    mock.testNode.run = mock.Run
    return mock
}

// Run is a protocol run function which just loops waiting for tests to
// instruct it to either trigger or expect a message from the peer
func (m *mockNode) Run(peer *p2p.Peer, rw p2p.MsgReadWriter) error {
    for {
        select {
        case trig := <-m.trigger:
            wmsg := Wrap(trig.Msg)
            m.err <- p2p.Send(rw, trig.Code, wmsg)
        case exps := <-m.expect:
            m.err <- expectMsgs(rw, exps)
        case <-m.stop:
            return nil
        }
    }
}

func (m *mockNode) Trigger(trig *Trigger) error {
    m.trigger <- trig
    return <-m.err
}

func (m *mockNode) Expect(exp ...Expect) error {
    m.expect <- exp
    return <-m.err
}

func (m *mockNode) Stop() error {
    m.stopOnce.Do(func() { close(m.stop) })
    return nil
}

func expectMsgs(rw p2p.MsgReadWriter, exps []Expect) error {
    matched := make([]bool, len(exps))
    for {
        msg, err := rw.ReadMsg()
        if err != nil {
            if err == io.EOF {
                break
            }
            return err
        }
        actualContent, err := ioutil.ReadAll(msg.Payload)
        if err != nil {
            return err
        }
        var found bool
        for i, exp := range exps {
            if exp.Code == msg.Code && bytes.Equal(actualContent, mustEncodeMsg(Wrap(exp.Msg))) {
                if matched[i] {
                    return fmt.Errorf("message #%d received two times", i)
                }
                matched[i] = true
                found = true
                break
            }
        }
        if !found {
            expected := make([]string, 0)
            for i, exp := range exps {
                if matched[i] {
                    continue
                }
                expected = append(expected, fmt.Sprintf("code %d payload %x", exp.Code, mustEncodeMsg(Wrap(exp.Msg))))
            }
            return fmt.Errorf("unexpected message code %d payload %x, expected %s", msg.Code, actualContent, strings.Join(expected, " or "))
        }
        done := true
        for _, m := range matched {
            if !m {
                done = false
                break
            }
        }
        if done {
            return nil
        }
    }
    for i, m := range matched {
        if !m {
            return fmt.Errorf("expected message #%d not received", i)
        }
    }
    return nil
}

// mustEncodeMsg uses rlp to encode a message.
// In case of error it panics.
func mustEncodeMsg(msg interface{}) []byte {
    contentEnc, err := rlp.EncodeToBytes(msg)
    if err != nil {
        panic("content encode error: " + err.Error())
    }
    return contentEnc
}

type WrappedMsg struct {
    Context []byte
    Size    uint32
    Payload []byte
}

func Wrap(msg interface{}) interface{} {
    data, _ := rlp.EncodeToBytes(msg)
    return &WrappedMsg{
        Size:    uint32(len(data)),
        Payload: data,
    }
}