-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
RaftReplicatorTest.java
426 lines (358 loc) · 15.9 KB
/
RaftReplicatorTest.java
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j Enterprise Edition. The included source
* code can be redistributed and/or modified under the terms of the
* GNU AFFERO GENERAL PUBLIC LICENSE Version 3
* (http://www.fsf.org/licensing/licenses/agpl-3.0.html) with the
* Commons Clause, as found in the associated LICENSE.txt file.
*
* This program 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 Affero General Public License for more details.
*
* Neo4j object code can be licensed independently from the source
* under separate terms from the AGPL. Inquiries can be directed to:
* licensing@neo4j.com
*
* More information is also available at:
* https://neo4j.com/licensing/
*/
package org.neo4j.causalclustering.core.replication;
import org.hamcrest.Matchers;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import java.util.UUID;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import org.neo4j.causalclustering.core.consensus.LeaderInfo;
import org.neo4j.causalclustering.core.consensus.LeaderLocator;
import org.neo4j.causalclustering.core.consensus.RaftMessages;
import org.neo4j.causalclustering.core.consensus.ReplicatedInteger;
import org.neo4j.causalclustering.core.replication.monitoring.ReplicationMonitor;
import org.neo4j.causalclustering.core.replication.session.GlobalSession;
import org.neo4j.causalclustering.core.replication.session.LocalSessionPool;
import org.neo4j.causalclustering.core.state.Result;
import org.neo4j.causalclustering.helper.ConstantTimeTimeoutStrategy;
import org.neo4j.causalclustering.helper.TimeoutStrategy;
import org.neo4j.causalclustering.identity.MemberId;
import org.neo4j.causalclustering.messaging.Message;
import org.neo4j.causalclustering.messaging.Outbound;
import org.neo4j.kernel.availability.DatabaseAvailabilityGuard;
import org.neo4j.kernel.availability.UnavailableException;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.NullLog;
import org.neo4j.logging.NullLogProvider;
import org.neo4j.time.Clocks;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.Matchers.greaterThan;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.neo4j.graphdb.factory.GraphDatabaseSettings.DEFAULT_DATABASE_NAME;
import static org.neo4j.test.assertion.Assert.assertEventually;
public class RaftReplicatorTest
{
@Rule
public ExpectedException expectedException = ExpectedException.none();
private static final int DEFAULT_TIMEOUT_MS = 15_000;
private LeaderLocator leaderLocator = mock( LeaderLocator.class );
private MemberId myself = new MemberId( UUID.randomUUID() );
private LeaderInfo leaderInfo = new LeaderInfo( new MemberId( UUID.randomUUID() ), 1 );
private GlobalSession session = new GlobalSession( UUID.randomUUID(), myself );
private LocalSessionPool sessionPool = new LocalSessionPool( session );
private TimeoutStrategy noWaitTimeoutStrategy = new ConstantTimeTimeoutStrategy( 0, MILLISECONDS );
private DatabaseAvailabilityGuard databaseAvailabilityGuard =
new DatabaseAvailabilityGuard( DEFAULT_DATABASE_NAME, Clocks.systemClock(), NullLog.getInstance() );
@Test
public void shouldSendReplicatedContentToLeader() throws Exception
{
// given
Monitors monitors = new Monitors();
ReplicationMonitor replicationMonitor = mock( ReplicationMonitor.class );
monitors.addMonitorListener( replicationMonitor );
CapturingProgressTracker capturedProgress = new CapturingProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, monitors );
replicator.onLeaderSwitch( leaderInfo );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
Thread replicatingThread = replicatingThread( replicator, content, false );
// when
replicatingThread.start();
// then
assertEventually( "making progress", () -> capturedProgress.last, not( equalTo( null ) ), DEFAULT_TIMEOUT_MS, MILLISECONDS );
// when
capturedProgress.last.setReplicated();
// then
replicatingThread.join( DEFAULT_TIMEOUT_MS );
assertEquals( leaderInfo.memberId(), outbound.lastTo );
verify( replicationMonitor, times( 1 ) ).startReplication();
verify( replicationMonitor, atLeast( 1 ) ).replicationAttempt();
verify( replicationMonitor, times( 1 ) ).successfulReplication();
verify( replicationMonitor, never() ).failedReplication( any() );
}
@Test
public void shouldResendAfterTimeout() throws Exception
{
// given
Monitors monitors = new Monitors();
ReplicationMonitor replicationMonitor = mock( ReplicationMonitor.class );
monitors.addMonitorListener( replicationMonitor );
CapturingProgressTracker capturedProgress = new CapturingProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, monitors );
replicator.onLeaderSwitch( leaderInfo );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
Thread replicatingThread = replicatingThread( replicator, content, false );
// when
replicatingThread.start();
// then
assertEventually( "send count", () -> outbound.count, greaterThan( 2 ), DEFAULT_TIMEOUT_MS, MILLISECONDS );
// cleanup
capturedProgress.last.setReplicated();
replicatingThread.join( DEFAULT_TIMEOUT_MS );
verify( replicationMonitor, times( 1 ) ).startReplication();
verify( replicationMonitor, atLeast( 2 ) ).replicationAttempt();
verify( replicationMonitor, times( 1 ) ).successfulReplication();
verify( replicationMonitor, never() ).failedReplication( any() );
}
@Test
public void shouldReleaseSessionWhenFinished() throws Exception
{
// given
CapturingProgressTracker capturedProgress = new CapturingProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, new Monitors() );
replicator.onLeaderSwitch( leaderInfo );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
Thread replicatingThread = replicatingThread( replicator, content, true );
// when
replicatingThread.start();
// then
assertEventually( "making progress", () -> capturedProgress.last, not( equalTo( null ) ),
DEFAULT_TIMEOUT_MS, MILLISECONDS );
assertEquals( 1, sessionPool.openSessionCount() );
// when
capturedProgress.last.setReplicated();
capturedProgress.last.futureResult().complete( 5 );
replicatingThread.join( DEFAULT_TIMEOUT_MS );
// then
assertEquals( 0, sessionPool.openSessionCount() );
}
@Test
public void stopReplicationOnShutdown() throws InterruptedException
{
// given
Monitors monitors = new Monitors();
ReplicationMonitor replicationMonitor = mock( ReplicationMonitor.class );
monitors.addMonitorListener( replicationMonitor );
CapturingProgressTracker capturedProgress = new CapturingProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, monitors );
replicator.onLeaderSwitch( leaderInfo );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
ReplicatingThread replicatingThread = replicatingThread( replicator, content, true );
// when
replicatingThread.start();
databaseAvailabilityGuard.shutdown();
replicatingThread.join();
assertThat( replicatingThread.getReplicationException().getCause(), Matchers.instanceOf( UnavailableException.class ) );
verify( replicationMonitor, times( 1 ) ).startReplication();
verify( replicationMonitor, atLeast( 1 ) ).replicationAttempt();
verify( replicationMonitor, never() ).successfulReplication();
verify( replicationMonitor, times( 1 ) ).failedReplication( any() );
}
@Test
public void stopReplicationWhenUnavailable() throws InterruptedException
{
CapturingProgressTracker capturedProgress = new CapturingProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, new Monitors() );
replicator.onLeaderSwitch( leaderInfo );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
ReplicatingThread replicatingThread = replicatingThread( replicator, content, true );
// when
replicatingThread.start();
databaseAvailabilityGuard.require( () -> "Database not unavailable" );
replicatingThread.join();
assertThat( replicatingThread.getReplicationException().getCause(), Matchers.instanceOf( UnavailableException.class ) );
}
@Test
public void shouldFailIfNoLeaderIsAvailable()
{
// given
CapturingProgressTracker capturedProgress = new CapturingProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, new Monitors() );
// when
try
{
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
replicator.replicate( content, true );
fail( "should have thrown" );
}
catch ( ReplicationFailureException ignored )
{
// expected
}
}
@Test
public void shouldListenToLeaderUpdates() throws ReplicationFailureException
{
OneProgressTracker oneProgressTracker = new OneProgressTracker();
oneProgressTracker.last.setReplicated();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, oneProgressTracker, new Monitors() );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
LeaderInfo lastLeader = leaderInfo;
// set initial leader, sens to that leader
replicator.onLeaderSwitch( lastLeader );
replicator.replicate( content, false );
assertEquals( outbound.lastTo, lastLeader.memberId() );
// update with valid new leader, sends to new leader
lastLeader = new LeaderInfo( new MemberId( UUID.randomUUID() ), 1 );
replicator.onLeaderSwitch( lastLeader );
replicator.replicate( content, false );
assertEquals( outbound.lastTo, lastLeader.memberId() );
}
@Test
public void shouldSuccefulltSendIfLeaderIsLostAndFound() throws InterruptedException
{
OneProgressTracker capturedProgress = new OneProgressTracker();
CapturingOutbound<RaftMessages.RaftMessage> outbound = new CapturingOutbound<>();
RaftReplicator replicator = getReplicator( outbound, capturedProgress, new Monitors() );
replicator.onLeaderSwitch( leaderInfo );
ReplicatedInteger content = ReplicatedInteger.valueOf( 5 );
ReplicatingThread replicatingThread = replicatingThread( replicator, content, false );
// when
replicatingThread.start();
// then
assertEventually( "send count", () -> outbound.count, greaterThan( 1 ), DEFAULT_TIMEOUT_MS, MILLISECONDS );
replicator.onLeaderSwitch( new LeaderInfo( null, 1 ) );
capturedProgress.last.setReplicated();
replicator.onLeaderSwitch( leaderInfo );
replicatingThread.join( DEFAULT_TIMEOUT_MS );
}
private RaftReplicator getReplicator( CapturingOutbound<RaftMessages.RaftMessage> outbound, ProgressTracker progressTracker, Monitors monitors )
{
return new RaftReplicator( leaderLocator, myself, outbound, sessionPool, progressTracker, noWaitTimeoutStrategy, 10, databaseAvailabilityGuard,
NullLogProvider.getInstance(), monitors );
}
private ReplicatingThread replicatingThread( RaftReplicator replicator, ReplicatedInteger content, boolean trackResult )
{
return new ReplicatingThread( replicator, content, trackResult );
}
private class ReplicatingThread extends Thread
{
private final RaftReplicator replicator;
private final ReplicatedInteger content;
private final boolean trackResult;
private volatile Exception replicationException;
ReplicatingThread( RaftReplicator replicator, ReplicatedInteger content, boolean trackResult )
{
this.replicator = replicator;
this.content = content;
this.trackResult = trackResult;
}
@Override
public void run()
{
try
{
Future<Object> futureResult = replicator.replicate( content, trackResult );
if ( trackResult )
{
try
{
futureResult.get();
}
catch ( ExecutionException e )
{
replicationException = e;
throw new IllegalStateException();
}
}
}
catch ( Exception e )
{
replicationException = e;
}
}
Exception getReplicationException()
{
return replicationException;
}
}
private class OneProgressTracker extends ProgressTrackerAdaptor
{
OneProgressTracker()
{
last = new Progress();
}
@Override
public Progress start( DistributedOperation operation )
{
return last;
}
}
private class CapturingProgressTracker extends ProgressTrackerAdaptor
{
@Override
public Progress start( DistributedOperation operation )
{
last = new Progress();
return last;
}
}
private abstract class ProgressTrackerAdaptor implements ProgressTracker
{
protected Progress last;
@Override
public void trackReplication( DistributedOperation operation )
{
throw new UnsupportedOperationException();
}
@Override
public void trackResult( DistributedOperation operation, Result result )
{
throw new UnsupportedOperationException();
}
@Override
public void abort( DistributedOperation operation )
{
throw new UnsupportedOperationException();
}
@Override
public void triggerReplicationEvent()
{
// do nothing
}
@Override
public int inProgressCount()
{
throw new UnsupportedOperationException();
}
}
private static class CapturingOutbound<MESSAGE extends Message> implements Outbound<MemberId, MESSAGE>
{
private MemberId lastTo;
private int count;
@Override
public void send( MemberId to, MESSAGE message, boolean block )
{
this.lastTo = to;
this.count++;
}
}
}