forked from consensus-shipyard/mir
-
Notifications
You must be signed in to change notification settings - Fork 0
/
node_test.go
279 lines (233 loc) · 8.74 KB
/
node_test.go
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
package mir
import (
"context"
"fmt"
"sync"
"sync/atomic"
"testing"
"time"
"github.com/golang/mock/gomock"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"go.uber.org/goleak"
"github.com/filecoin-project/mir/pkg/events"
"github.com/filecoin-project/mir/pkg/logging"
"github.com/filecoin-project/mir/pkg/modules"
"github.com/filecoin-project/mir/pkg/modules/mockmodules"
eventpbtypes "github.com/filecoin-project/mir/pkg/pb/eventpb/types"
"github.com/filecoin-project/mir/pkg/types"
"github.com/filecoin-project/mir/pkg/util/sliceutil"
)
func TestNode_Config(t *testing.T) {
defer goleak.VerifyNone(t,
// Problems with this started occurring after an update to a new version of the quic implementation.
// Assuming it has nothing to do with Mir or Trantor.
goleak.IgnoreTopFunction("github.com/libp2p/go-libp2p/p2p/transport/quicreuse.(*reuse).gc"),
)
// Convenience variable
noModules := make(map[types.ModuleID]modules.Module)
c := DefaultNodeConfig()
assert.NoError(t, c.Validate(), "default config is not valid")
c.Logger = nil
_, err := NewNode("testnode", c, noModules, nil)
assert.NoError(t, err, "must support nil logger")
faultyConfig := &NodeConfig{
Logger: nil,
MaxEventBatchSize: 0,
PauseInputThreshold: 10,
ResumeInputThreshold: 5,
}
assert.Error(t, faultyConfig.Validate(), "invalid config (event batch size) not recognized")
faultyConfig.PauseInputThreshold = 5
faultyConfig.ResumeInputThreshold = 10
assert.Error(t, faultyConfig.Validate(), "invalid config (pause input threshold) not recognized")
_, err = NewNode("testnode", faultyConfig, noModules, nil)
assert.Error(t, err, "node must not be created with invalid config")
}
func TestNode_Run(t *testing.T) {
defer goleak.VerifyNone(t,
// Problems with this started occurring after an update to a new version of the quic implementation.
// Assuming it has nothing to do with Mir or Trantor.
goleak.IgnoreTopFunction("github.com/libp2p/go-libp2p/p2p/transport/quicreuse.(*reuse).gc"),
)
testCases := map[string]func(t *testing.T) (m modules.Modules, done <-chan struct{}){
"InitEvents": func(t *testing.T) (modules.Modules, <-chan struct{}) {
ctrl := gomock.NewController(t)
mockModule1 := mockmodules.NewMockPassiveModule(ctrl)
mockModule2 := mockmodules.NewMockPassiveModule(ctrl)
var wg sync.WaitGroup
wg.Add(2)
mockModule1.EXPECT().Event(events.Init("mock1")).
Do(func(_ any) { wg.Done() }).
Return(events.EmptyList(), nil)
mockModule2.EXPECT().Event(events.Init("mock2")).
Do(func(_ any) { wg.Done() }).
Return(events.EmptyList(), nil)
done := make(chan struct{})
go func() {
wg.Wait()
close(done)
}()
m := map[types.ModuleID]modules.Module{
"mock1": mockModule1,
"mock2": mockModule2,
}
return m, done
},
}
for testName, tc := range testCases {
tc := tc
t.Run(testName, func(t *testing.T) {
m, tcDone := tc(t)
logger := logging.ConsoleWarnLogger
n, err := NewNode(
"testnode",
DefaultNodeConfig().WithLogger(logger),
m,
nil,
)
assert.Nil(t, err)
ctx, stopNode := context.WithCancel(context.Background())
nodeStopped := make(chan struct{})
go func() {
err := n.Run(ctx)
assert.Equal(t, ErrStopped, err)
close(nodeStopped)
}()
// Wait until either the test case is done or a 2 seconds deadline
select {
case <-tcDone:
case <-time.After(2 * time.Second):
}
stopNode()
<-nodeStopped
})
}
}
func TestNode_Backpressure(t *testing.T) {
defer goleak.VerifyNone(t,
// Problems with this started occurring after an update to a new version of the quic implementation.
// Assuming it has nothing to do with Mir or Trantor.
goleak.IgnoreTopFunction("github.com/libp2p/go-libp2p/p2p/transport/quicreuse.(*reuse).gc"),
)
ctx := context.Background()
nodeConfig := DefaultNodeConfig().WithLogger(logging.ConsoleDebugLogger)
nodeConfig.Stats.Period = 100 * time.Millisecond
// Set an input event rate that would fill the node's event buffers in one second in 10 batches.
blabberModule := newBlabber(uint64(nodeConfig.PauseInputThreshold/10), 100*time.Millisecond)
// Set the event consumption rate to 1/2 of the input rate (i.e., draining the buffer in 2 seconds)
// and create the consumer module.
consumerDelay := 2 * time.Second / time.Duration(nodeConfig.PauseInputThreshold)
consumerModule := newConsumer(consumerDelay)
// Instantiate node with a fast blabber module and a slow consumer module.
n, err := NewNode(
"testnode",
nodeConfig,
map[types.ModuleID]modules.Module{
"blabber": blabberModule,
"consumer": consumerModule,
},
nil,
)
assert.Nil(t, err)
// Start a flood of dummy events.
blabberModule.Go()
defer blabberModule.Close()
// Start the node.
nodeError := make(chan error)
go func() {
nodeError <- n.Run(ctx)
}()
// Run for 5 seconds, then stop the node.
time.Sleep(5 * time.Second)
n.Stop()
err = <-nodeError
fmt.Printf("node error: %v\n", err)
assert.True(t, errors.Is(err, ErrStopped), "unexpected node error: \"%v\", expected \"%v\"", err, ErrStopped)
// The number of submitted events must not exceed the number of consumed events by too much
// (accounting for events still in the buffer and the overshooting caused by batched adding of events).
fmt.Printf("Total submitted events: %d\n", atomic.LoadUint64(&blabberModule.totalSubmitted))
totalSubmitted := atomic.LoadUint64(&blabberModule.totalSubmitted)
expectSubmitted := atomic.LoadUint64(&consumerModule.numProcessed) +
uint64(nodeConfig.PauseInputThreshold) + // Events left in the buffer
uint64(nodeConfig.MaxEventBatchSize) + // Events in the consumer's processing queue
2*blabberModule.batchSize // one batch of overshooting, one batch waiting in the babbler's output channel.
assert.LessOrEqual(t, totalSubmitted, expectSubmitted, "too many events submitted (node event buffer overflow)")
}
// =================================================================================================
// Blabber module (for testing event backpressure)
// =================================================================================================
// The babbler is a simple ActiveModule that just produces batches of dummy events at a given rate.
type blabber struct {
flood chan events.EventList // Output channel for batches of dummy events.
batchSize uint64 // Number of events output at once.
period time.Duration // Time between batches.
totalSubmitted uint64 // Counter for total number of submitted events.
stop chan struct{} // Stop channel.
wg sync.WaitGroup // WaitGroup to control stopping of the goroutine.
}
func newBlabber(batchSize uint64, period time.Duration) *blabber {
return &blabber{
flood: make(chan events.EventList),
batchSize: batchSize,
period: period,
stop: make(chan struct{}),
}
}
// Go starts babbling, i.e., producing batches of dummy events at the rate configured at instantiation.
// Once started, the babbler keeps babbling until it stops via the stop channel.
func (b *blabber) Go() {
b.wg.Add(1)
go func() {
defer b.wg.Done()
for {
select {
case <-b.stop:
return
default:
}
evts := events.ListOf(sliceutil.Repeat(events.TestingUint("consumer", 0), int(b.batchSize))...)
select {
case <-b.stop:
return
case b.flood <- evts:
}
atomic.AddUint64(&b.totalSubmitted, b.batchSize)
time.Sleep(b.period)
}
}()
}
func (b *blabber) Close() {
close(b.stop)
b.wg.Wait()
}
func (b *blabber) ImplementsModule() {}
func (b *blabber) ApplyEvents(_ context.Context, _ events.EventList) error {
return nil
}
func (b *blabber) EventsOut() <-chan events.EventList {
return b.flood
}
// =================================================================================================
// Consumer module (for testing event backpressure)
// =================================================================================================
// The consumer is a simple passive module that consumes events at a given rate.
// It treats each event as a noop and just counts the number of events it has processed.
type consumer struct {
delay time.Duration
numProcessed uint64
}
func newConsumer(delay time.Duration) *consumer {
return &consumer{delay: delay}
}
func (c *consumer) ImplementsModule() {}
// ApplyEvents increments a counter and sleeps for a given duration (set at module instantiation)
// for each event in the given list.
func (c *consumer) ApplyEvents(evts events.EventList) (events.EventList, error) {
evtsOut, err := modules.ApplyEventsSequentially(evts, func(event *eventpbtypes.Event) (events.EventList, error) {
atomic.AddUint64(&c.numProcessed, 1)
time.Sleep(c.delay)
return events.EmptyList(), nil
})
return evtsOut, err
}