1 package org.opendaylight.controller.cluster.raft.behaviors;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertNotNull;
5 import static org.junit.Assert.assertTrue;
6 import akka.actor.ActorRef;
7 import akka.actor.PoisonPill;
8 import akka.actor.Props;
9 import akka.actor.Terminated;
10 import akka.testkit.JavaTestKit;
11 import akka.testkit.TestActorRef;
12 import com.google.common.base.Optional;
13 import com.google.common.collect.ImmutableMap;
14 import com.google.common.util.concurrent.Uninterruptibles;
15 import com.google.protobuf.ByteString;
16 import java.util.HashMap;
17 import java.util.List;
19 import java.util.concurrent.TimeUnit;
20 import org.junit.After;
21 import org.junit.Assert;
22 import org.junit.Test;
23 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
24 import org.opendaylight.controller.cluster.raft.FollowerLogInformation;
25 import org.opendaylight.controller.cluster.raft.MockRaftActorContext;
26 import org.opendaylight.controller.cluster.raft.RaftActorContext;
27 import org.opendaylight.controller.cluster.raft.RaftState;
28 import org.opendaylight.controller.cluster.raft.ReplicatedLogImplEntry;
29 import org.opendaylight.controller.cluster.raft.SerializationUtils;
30 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
31 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
32 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
33 import org.opendaylight.controller.cluster.raft.base.messages.IsolatedLeaderCheck;
34 import org.opendaylight.controller.cluster.raft.base.messages.Replicate;
35 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
36 import org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot;
37 import org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader.FollowerToSnapshot;
38 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
39 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
40 import org.opendaylight.controller.cluster.raft.messages.InstallSnapshot;
41 import org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply;
42 import org.opendaylight.controller.cluster.raft.messages.RaftRPC;
43 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
44 import org.opendaylight.controller.cluster.raft.utils.ForwardMessageToBehaviorActor;
45 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
46 import scala.concurrent.duration.FiniteDuration;
48 public class LeaderTest extends AbstractLeaderTest {
50 static final String FOLLOWER_ID = "follower";
51 public static final String LEADER_ID = "leader";
53 private final TestActorRef<ForwardMessageToBehaviorActor> leaderActor = actorFactory.createTestActor(
54 Props.create(ForwardMessageToBehaviorActor.class), actorFactory.generateActorId("leader"));
56 private final TestActorRef<ForwardMessageToBehaviorActor> followerActor = actorFactory.createTestActor(
57 Props.create(ForwardMessageToBehaviorActor.class), actorFactory.generateActorId("follower"));
59 private Leader leader;
63 public void tearDown() throws Exception {
72 public void testHandleMessageForUnknownMessage() throws Exception {
73 logStart("testHandleMessageForUnknownMessage");
75 leader = new Leader(createActorContext());
77 // handle message should return the Leader state when it receives an
79 RaftActorBehavior behavior = leader.handleMessage(followerActor, "foo");
80 Assert.assertTrue(behavior instanceof Leader);
84 public void testThatLeaderSendsAHeartbeatMessageToAllFollowers() throws Exception {
85 logStart("testThatLeaderSendsAHeartbeatMessageToAllFollowers");
87 MockRaftActorContext actorContext = createActorContextWithFollower();
90 actorContext.getTermInformation().update(term, "");
92 leader = new Leader(actorContext);
94 // Leader should send an immediate heartbeat with no entries as follower is inactive.
95 long lastIndex = actorContext.getReplicatedLog().lastIndex();
96 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
97 assertEquals("getTerm", term, appendEntries.getTerm());
98 assertEquals("getPrevLogIndex", -1, appendEntries.getPrevLogIndex());
99 assertEquals("getPrevLogTerm", -1, appendEntries.getPrevLogTerm());
100 assertEquals("Entries size", 0, appendEntries.getEntries().size());
102 // The follower would normally reply - simulate that explicitly here.
103 leader.handleMessage(followerActor, new AppendEntriesReply(
104 FOLLOWER_ID, term, true, lastIndex - 1, term));
105 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
107 followerActor.underlyingActor().clear();
109 // Sleep for the heartbeat interval so AppendEntries is sent.
110 Uninterruptibles.sleepUninterruptibly(actorContext.getConfigParams().
111 getHeartBeatInterval().toMillis(), TimeUnit.MILLISECONDS);
113 leader.handleMessage(leaderActor, new SendHeartBeat());
115 appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
116 assertEquals("getPrevLogIndex", lastIndex - 1, appendEntries.getPrevLogIndex());
117 assertEquals("getPrevLogTerm", term, appendEntries.getPrevLogTerm());
118 assertEquals("Entries size", 1, appendEntries.getEntries().size());
119 assertEquals("Entry getIndex", lastIndex, appendEntries.getEntries().get(0).getIndex());
120 assertEquals("Entry getTerm", term, appendEntries.getEntries().get(0).getTerm());
124 private RaftActorBehavior sendReplicate(MockRaftActorContext actorContext, long index){
125 MockRaftActorContext.MockPayload payload = new MockRaftActorContext.MockPayload("foo");
126 MockRaftActorContext.MockReplicatedLogEntry newEntry = new MockRaftActorContext.MockReplicatedLogEntry(
128 actorContext.getReplicatedLog().append(newEntry);
129 return leader.handleMessage(leaderActor, new Replicate(null, null, newEntry));
133 public void testHandleReplicateMessageSendAppendEntriesToFollower() throws Exception {
134 logStart("testHandleReplicateMessageSendAppendEntriesToFollower");
136 MockRaftActorContext actorContext = createActorContextWithFollower();
139 actorContext.getTermInformation().update(term, "");
141 leader = new Leader(actorContext);
143 // Leader will send an immediate heartbeat - ignore it.
144 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
146 // The follower would normally reply - simulate that explicitly here.
147 long lastIndex = actorContext.getReplicatedLog().lastIndex();
148 leader.handleMessage(followerActor, new AppendEntriesReply(
149 FOLLOWER_ID, term, true, lastIndex, term));
150 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
152 followerActor.underlyingActor().clear();
154 MockRaftActorContext.MockPayload payload = new MockRaftActorContext.MockPayload("foo");
155 MockRaftActorContext.MockReplicatedLogEntry newEntry = new MockRaftActorContext.MockReplicatedLogEntry(
156 1, lastIndex + 1, payload);
157 actorContext.getReplicatedLog().append(newEntry);
158 RaftActorBehavior raftBehavior = sendReplicate(actorContext, lastIndex+1);
160 // State should not change
161 assertTrue(raftBehavior instanceof Leader);
163 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
164 assertEquals("getPrevLogIndex", lastIndex, appendEntries.getPrevLogIndex());
165 assertEquals("getPrevLogTerm", term, appendEntries.getPrevLogTerm());
166 assertEquals("Entries size", 1, appendEntries.getEntries().size());
167 assertEquals("Entry getIndex", lastIndex + 1, appendEntries.getEntries().get(0).getIndex());
168 assertEquals("Entry getTerm", term, appendEntries.getEntries().get(0).getTerm());
169 assertEquals("Entry payload", payload, appendEntries.getEntries().get(0).getData());
173 public void testMultipleReplicateShouldNotCauseDuplicateAppendEntriesToBeSent() throws Exception {
174 logStart("testHandleReplicateMessageSendAppendEntriesToFollower");
176 MockRaftActorContext actorContext = createActorContextWithFollower();
177 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
179 public FiniteDuration getHeartBeatInterval() {
180 return FiniteDuration.apply(5, TimeUnit.SECONDS);
185 actorContext.getTermInformation().update(term, "");
187 leader = new Leader(actorContext);
189 // Leader will send an immediate heartbeat - ignore it.
190 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
192 // The follower would normally reply - simulate that explicitly here.
193 long lastIndex = actorContext.getReplicatedLog().lastIndex();
194 leader.handleMessage(followerActor, new AppendEntriesReply(
195 FOLLOWER_ID, term, true, lastIndex, term));
196 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
198 followerActor.underlyingActor().clear();
200 for(int i=0;i<5;i++) {
201 sendReplicate(actorContext, lastIndex+i+1);
204 List<AppendEntries> allMessages = MessageCollectorActor.getAllMatching(followerActor, AppendEntries.class);
205 // We expect only 1 message to be sent because of two reasons,
206 // - an append entries reply was not received
207 // - the heartbeat interval has not expired
208 // In this scenario if multiple messages are sent they would likely be duplicates
209 assertEquals("The number of append entries collected should be 1", 1, allMessages.size());
213 public void testMultipleReplicateWithReplyShouldResultInAppendEntries() throws Exception {
214 logStart("testMultipleReplicateWithReplyShouldResultInAppendEntries");
216 MockRaftActorContext actorContext = createActorContextWithFollower();
217 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
219 public FiniteDuration getHeartBeatInterval() {
220 return FiniteDuration.apply(5, TimeUnit.SECONDS);
225 actorContext.getTermInformation().update(term, "");
227 leader = new Leader(actorContext);
229 // Leader will send an immediate heartbeat - ignore it.
230 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
232 // The follower would normally reply - simulate that explicitly here.
233 long lastIndex = actorContext.getReplicatedLog().lastIndex();
234 leader.handleMessage(followerActor, new AppendEntriesReply(
235 FOLLOWER_ID, term, true, lastIndex, term));
236 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
238 followerActor.underlyingActor().clear();
240 for(int i=0;i<3;i++) {
241 sendReplicate(actorContext, lastIndex+i+1);
242 leader.handleMessage(followerActor, new AppendEntriesReply(
243 FOLLOWER_ID, term, true, lastIndex + i + 1, term));
247 for(int i=3;i<5;i++) {
248 sendReplicate(actorContext, lastIndex + i + 1);
251 List<AppendEntries> allMessages = MessageCollectorActor.getAllMatching(followerActor, AppendEntries.class);
252 // We expect 4 here because the first 3 replicate got a reply and so the 4th entry would
253 // get sent to the follower - but not the 5th
254 assertEquals("The number of append entries collected should be 4", 4, allMessages.size());
256 for(int i=0;i<4;i++) {
257 long expected = allMessages.get(i).getEntries().get(0).getIndex();
258 assertEquals(expected, i+2);
263 public void testDuplicateAppendEntriesWillBeSentOnHeartBeat() throws Exception {
264 logStart("testDuplicateAppendEntriesWillBeSentOnHeartBeat");
266 MockRaftActorContext actorContext = createActorContextWithFollower();
267 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
269 public FiniteDuration getHeartBeatInterval() {
270 return FiniteDuration.apply(500, TimeUnit.MILLISECONDS);
275 actorContext.getTermInformation().update(term, "");
277 leader = new Leader(actorContext);
279 // Leader will send an immediate heartbeat - ignore it.
280 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
282 // The follower would normally reply - simulate that explicitly here.
283 long lastIndex = actorContext.getReplicatedLog().lastIndex();
284 leader.handleMessage(followerActor, new AppendEntriesReply(
285 FOLLOWER_ID, term, true, lastIndex, term));
286 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
288 followerActor.underlyingActor().clear();
290 sendReplicate(actorContext, lastIndex+1);
292 // Wait slightly longer than heartbeat duration
293 Uninterruptibles.sleepUninterruptibly(750, TimeUnit.MILLISECONDS);
295 leader.handleMessage(leaderActor, new SendHeartBeat());
297 List<AppendEntries> allMessages = MessageCollectorActor.getAllMatching(followerActor, AppendEntries.class);
298 assertEquals("The number of append entries collected should be 2", 2, allMessages.size());
300 assertEquals(1, allMessages.get(0).getEntries().size());
301 assertEquals(lastIndex+1, allMessages.get(0).getEntries().get(0).getIndex());
302 assertEquals(1, allMessages.get(1).getEntries().size());
303 assertEquals(lastIndex+1, allMessages.get(0).getEntries().get(0).getIndex());
308 public void testHeartbeatsAreAlwaysSentIfTheHeartbeatIntervalHasElapsed() throws Exception {
309 logStart("testHeartbeatsAreAlwaysSentIfTheHeartbeatIntervalHasElapsed");
311 MockRaftActorContext actorContext = createActorContextWithFollower();
312 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
314 public FiniteDuration getHeartBeatInterval() {
315 return FiniteDuration.apply(100, TimeUnit.MILLISECONDS);
320 actorContext.getTermInformation().update(term, "");
322 leader = new Leader(actorContext);
324 // Leader will send an immediate heartbeat - ignore it.
325 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
327 // The follower would normally reply - simulate that explicitly here.
328 long lastIndex = actorContext.getReplicatedLog().lastIndex();
329 leader.handleMessage(followerActor, new AppendEntriesReply(
330 FOLLOWER_ID, term, true, lastIndex, term));
331 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
333 followerActor.underlyingActor().clear();
335 for(int i=0;i<3;i++) {
336 Uninterruptibles.sleepUninterruptibly(150, TimeUnit.MILLISECONDS);
337 leader.handleMessage(leaderActor, new SendHeartBeat());
340 List<AppendEntries> allMessages = MessageCollectorActor.getAllMatching(followerActor, AppendEntries.class);
341 assertEquals("The number of append entries collected should be 3", 3, allMessages.size());
345 public void testSendingReplicateImmediatelyAfterHeartbeatDoesReplicate() throws Exception {
346 logStart("testSendingReplicateImmediatelyAfterHeartbeatDoesReplicate");
348 MockRaftActorContext actorContext = createActorContextWithFollower();
349 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
351 public FiniteDuration getHeartBeatInterval() {
352 return FiniteDuration.apply(100, TimeUnit.MILLISECONDS);
357 actorContext.getTermInformation().update(term, "");
359 leader = new Leader(actorContext);
361 // Leader will send an immediate heartbeat - ignore it.
362 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
364 // The follower would normally reply - simulate that explicitly here.
365 long lastIndex = actorContext.getReplicatedLog().lastIndex();
366 leader.handleMessage(followerActor, new AppendEntriesReply(
367 FOLLOWER_ID, term, true, lastIndex, term));
368 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
370 followerActor.underlyingActor().clear();
372 Uninterruptibles.sleepUninterruptibly(150, TimeUnit.MILLISECONDS);
373 leader.handleMessage(leaderActor, new SendHeartBeat());
374 sendReplicate(actorContext, lastIndex+1);
376 List<AppendEntries> allMessages = MessageCollectorActor.getAllMatching(followerActor, AppendEntries.class);
377 assertEquals("The number of append entries collected should be 2", 2, allMessages.size());
379 assertEquals(0, allMessages.get(0).getEntries().size());
380 assertEquals(1, allMessages.get(1).getEntries().size());
385 public void testHandleReplicateMessageWhenThereAreNoFollowers() throws Exception {
386 logStart("testHandleReplicateMessageWhenThereAreNoFollowers");
388 MockRaftActorContext actorContext = createActorContext();
390 leader = new Leader(actorContext);
392 actorContext.setLastApplied(0);
394 long newLogIndex = actorContext.getReplicatedLog().lastIndex() + 1;
395 long term = actorContext.getTermInformation().getCurrentTerm();
396 MockRaftActorContext.MockReplicatedLogEntry newEntry = new MockRaftActorContext.MockReplicatedLogEntry(
397 term, newLogIndex, new MockRaftActorContext.MockPayload("foo"));
399 actorContext.getReplicatedLog().append(newEntry);
401 RaftActorBehavior raftBehavior = leader.handleMessage(leaderActor,
402 new Replicate(leaderActor, "state-id", newEntry));
404 // State should not change
405 assertTrue(raftBehavior instanceof Leader);
407 assertEquals("getCommitIndex", newLogIndex, actorContext.getCommitIndex());
409 // We should get 2 ApplyState messages - 1 for new log entry and 1 for the previous
410 // one since lastApplied state is 0.
411 List<ApplyState> applyStateList = MessageCollectorActor.getAllMatching(
412 leaderActor, ApplyState.class);
413 assertEquals("ApplyState count", newLogIndex, applyStateList.size());
415 for(int i = 0; i <= newLogIndex - 1; i++ ) {
416 ApplyState applyState = applyStateList.get(i);
417 assertEquals("getIndex", i + 1, applyState.getReplicatedLogEntry().getIndex());
418 assertEquals("getTerm", term, applyState.getReplicatedLogEntry().getTerm());
421 ApplyState last = applyStateList.get((int) newLogIndex - 1);
422 assertEquals("getData", newEntry.getData(), last.getReplicatedLogEntry().getData());
423 assertEquals("getIdentifier", "state-id", last.getIdentifier());
427 public void testSendAppendEntriesOnAnInProgressInstallSnapshot() throws Exception {
428 logStart("testSendAppendEntriesOnAnInProgressInstallSnapshot");
430 MockRaftActorContext actorContext = createActorContextWithFollower();
432 Map<String, String> leadersSnapshot = new HashMap<>();
433 leadersSnapshot.put("1", "A");
434 leadersSnapshot.put("2", "B");
435 leadersSnapshot.put("3", "C");
438 actorContext.getReplicatedLog().removeFrom(0);
440 final int followersLastIndex = 2;
441 final int snapshotIndex = 3;
442 final int newEntryIndex = 4;
443 final int snapshotTerm = 1;
444 final int currentTerm = 2;
446 // set the snapshot variables in replicatedlog
447 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
448 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
449 actorContext.setCommitIndex(followersLastIndex);
450 //set follower timeout to 2 mins, helps during debugging
451 actorContext.setConfigParams(new MockConfigParamsImpl(120000L, 10));
453 leader = new Leader(actorContext);
456 ReplicatedLogImplEntry entry =
457 new ReplicatedLogImplEntry(newEntryIndex, currentTerm,
458 new MockRaftActorContext.MockPayload("D"));
460 //update follower timestamp
461 leader.markFollowerActive(FOLLOWER_ID);
463 ByteString bs = toByteString(leadersSnapshot);
464 leader.setSnapshot(Optional.of(bs));
465 FollowerToSnapshot fts = leader.new FollowerToSnapshot(bs);
466 leader.setFollowerSnapshot(FOLLOWER_ID, fts);
468 //send first chunk and no InstallSnapshotReply received yet
470 fts.incrementChunkIndex();
472 Uninterruptibles.sleepUninterruptibly(actorContext.getConfigParams().getHeartBeatInterval().toMillis(),
473 TimeUnit.MILLISECONDS);
475 leader.handleMessage(leaderActor, new SendHeartBeat());
477 AppendEntries aeproto = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
479 AppendEntries ae = (AppendEntries) SerializationUtils.fromSerializable(aeproto);
481 assertTrue("AppendEntries should be sent with empty entries", ae.getEntries().isEmpty());
483 //InstallSnapshotReply received
484 fts.markSendStatus(true);
486 leader.handleMessage(leaderActor, new SendHeartBeat());
488 InstallSnapshot is = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
490 assertEquals(snapshotIndex, is.getLastIncludedIndex());
494 public void testSendAppendEntriesSnapshotScenario() throws Exception {
495 logStart("testSendAppendEntriesSnapshotScenario");
497 MockRaftActorContext actorContext = createActorContextWithFollower();
499 Map<String, String> leadersSnapshot = new HashMap<>();
500 leadersSnapshot.put("1", "A");
501 leadersSnapshot.put("2", "B");
502 leadersSnapshot.put("3", "C");
505 actorContext.getReplicatedLog().removeFrom(0);
507 final int followersLastIndex = 2;
508 final int snapshotIndex = 3;
509 final int newEntryIndex = 4;
510 final int snapshotTerm = 1;
511 final int currentTerm = 2;
513 // set the snapshot variables in replicatedlog
514 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
515 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
516 actorContext.setCommitIndex(followersLastIndex);
518 leader = new Leader(actorContext);
520 // Leader will send an immediate heartbeat - ignore it.
521 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
524 ReplicatedLogImplEntry entry =
525 new ReplicatedLogImplEntry(newEntryIndex, currentTerm,
526 new MockRaftActorContext.MockPayload("D"));
528 actorContext.getReplicatedLog().append(entry);
530 //update follower timestamp
531 leader.markFollowerActive(FOLLOWER_ID);
533 // this should invoke a sendinstallsnapshot as followersLastIndex < snapshotIndex
534 RaftActorBehavior raftBehavior = leader.handleMessage(
535 leaderActor, new Replicate(null, "state-id", entry));
537 assertTrue(raftBehavior instanceof Leader);
539 assertEquals("isCapturing", true, actorContext.getSnapshotManager().isCapturing());
543 public void testInitiateInstallSnapshot() throws Exception {
544 logStart("testInitiateInstallSnapshot");
546 MockRaftActorContext actorContext = createActorContextWithFollower();
548 Map<String, String> leadersSnapshot = new HashMap<>();
549 leadersSnapshot.put("1", "A");
550 leadersSnapshot.put("2", "B");
551 leadersSnapshot.put("3", "C");
554 actorContext.getReplicatedLog().removeFrom(0);
556 final int followersLastIndex = 2;
557 final int snapshotIndex = 3;
558 final int newEntryIndex = 4;
559 final int snapshotTerm = 1;
560 final int currentTerm = 2;
562 // set the snapshot variables in replicatedlog
563 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
564 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
565 actorContext.setLastApplied(3);
566 actorContext.setCommitIndex(followersLastIndex);
568 leader = new Leader(actorContext);
570 // Leader will send an immediate heartbeat - ignore it.
571 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
573 // set the snapshot as absent and check if capture-snapshot is invoked.
574 leader.setSnapshot(Optional.<ByteString>absent());
577 ReplicatedLogImplEntry entry = new ReplicatedLogImplEntry(newEntryIndex, currentTerm,
578 new MockRaftActorContext.MockPayload("D"));
580 actorContext.getReplicatedLog().append(entry);
582 //update follower timestamp
583 leader.markFollowerActive(FOLLOWER_ID);
585 leader.handleMessage(leaderActor, new Replicate(null, "state-id", entry));
587 assertEquals("isCapturing", true, actorContext.getSnapshotManager().isCapturing());
589 CaptureSnapshot cs = actorContext.getSnapshotManager().getCaptureSnapshot();
591 assertTrue(cs.isInstallSnapshotInitiated());
592 assertEquals(3, cs.getLastAppliedIndex());
593 assertEquals(1, cs.getLastAppliedTerm());
594 assertEquals(4, cs.getLastIndex());
595 assertEquals(2, cs.getLastTerm());
597 // if an initiate is started again when first is in progress, it shouldnt initiate Capture
598 leader.handleMessage(leaderActor, new Replicate(null, "state-id", entry));
600 Assert.assertSame("CaptureSnapshot instance", cs, actorContext.getSnapshotManager().getCaptureSnapshot());
604 public void testInstallSnapshot() throws Exception {
605 logStart("testInstallSnapshot");
607 MockRaftActorContext actorContext = createActorContextWithFollower();
609 Map<String, String> leadersSnapshot = new HashMap<>();
610 leadersSnapshot.put("1", "A");
611 leadersSnapshot.put("2", "B");
612 leadersSnapshot.put("3", "C");
615 actorContext.getReplicatedLog().removeFrom(0);
617 final int followersLastIndex = 2;
618 final int snapshotIndex = 3;
619 final int snapshotTerm = 1;
620 final int currentTerm = 2;
622 // set the snapshot variables in replicatedlog
623 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
624 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
625 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
626 actorContext.setCommitIndex(followersLastIndex);
628 leader = new Leader(actorContext);
630 // Ignore initial heartbeat.
631 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
633 RaftActorBehavior raftBehavior = leader.handleMessage(leaderActor,
634 new SendInstallSnapshot(toByteString(leadersSnapshot)));
636 assertTrue(raftBehavior instanceof Leader);
638 // check if installsnapshot gets called with the correct values.
640 InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
642 assertNotNull(installSnapshot.getData());
643 assertEquals(snapshotIndex, installSnapshot.getLastIncludedIndex());
644 assertEquals(snapshotTerm, installSnapshot.getLastIncludedTerm());
646 assertEquals(currentTerm, installSnapshot.getTerm());
650 public void testHandleInstallSnapshotReplyLastChunk() throws Exception {
651 logStart("testHandleInstallSnapshotReplyLastChunk");
653 MockRaftActorContext actorContext = createActorContextWithFollower();
655 final int followersLastIndex = 2;
656 final int snapshotIndex = 3;
657 final int snapshotTerm = 1;
658 final int currentTerm = 2;
660 actorContext.setCommitIndex(followersLastIndex);
662 leader = new Leader(actorContext);
664 // Ignore initial heartbeat.
665 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
667 Map<String, String> leadersSnapshot = new HashMap<>();
668 leadersSnapshot.put("1", "A");
669 leadersSnapshot.put("2", "B");
670 leadersSnapshot.put("3", "C");
672 // set the snapshot variables in replicatedlog
674 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
675 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
676 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
678 ByteString bs = toByteString(leadersSnapshot);
679 leader.setSnapshot(Optional.of(bs));
680 FollowerToSnapshot fts = leader.new FollowerToSnapshot(bs);
681 leader.setFollowerSnapshot(FOLLOWER_ID, fts);
682 while(!fts.isLastChunk(fts.getChunkIndex())) {
684 fts.incrementChunkIndex();
688 actorContext.getReplicatedLog().removeFrom(0);
690 RaftActorBehavior raftBehavior = leader.handleMessage(followerActor,
691 new InstallSnapshotReply(currentTerm, FOLLOWER_ID, fts.getChunkIndex(), true));
693 assertTrue(raftBehavior instanceof Leader);
695 assertEquals(0, leader.followerSnapshotSize());
696 assertEquals(1, leader.followerLogSize());
697 FollowerLogInformation fli = leader.getFollower(FOLLOWER_ID);
699 assertEquals(snapshotIndex, fli.getMatchIndex());
700 assertEquals(snapshotIndex, fli.getMatchIndex());
701 assertEquals(snapshotIndex + 1, fli.getNextIndex());
705 public void testSendSnapshotfromInstallSnapshotReply() throws Exception {
706 logStart("testSendSnapshotfromInstallSnapshotReply");
708 MockRaftActorContext actorContext = createActorContextWithFollower();
710 final int followersLastIndex = 2;
711 final int snapshotIndex = 3;
712 final int snapshotTerm = 1;
713 final int currentTerm = 2;
715 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl(){
717 public int getSnapshotChunkSize() {
721 configParams.setHeartBeatInterval(new FiniteDuration(9, TimeUnit.SECONDS));
722 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(10, TimeUnit.SECONDS));
724 actorContext.setConfigParams(configParams);
725 actorContext.setCommitIndex(followersLastIndex);
727 leader = new Leader(actorContext);
729 Map<String, String> leadersSnapshot = new HashMap<>();
730 leadersSnapshot.put("1", "A");
731 leadersSnapshot.put("2", "B");
732 leadersSnapshot.put("3", "C");
734 // set the snapshot variables in replicatedlog
735 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
736 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
737 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
739 ByteString bs = toByteString(leadersSnapshot);
740 leader.setSnapshot(Optional.of(bs));
742 leader.handleMessage(leaderActor, new SendInstallSnapshot(bs));
744 InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
746 assertEquals(1, installSnapshot.getChunkIndex());
747 assertEquals(3, installSnapshot.getTotalChunks());
749 followerActor.underlyingActor().clear();
750 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
751 FOLLOWER_ID, installSnapshot.getChunkIndex(), true));
753 installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
755 assertEquals(2, installSnapshot.getChunkIndex());
756 assertEquals(3, installSnapshot.getTotalChunks());
758 followerActor.underlyingActor().clear();
759 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
760 FOLLOWER_ID, installSnapshot.getChunkIndex(), true));
762 installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
764 // Send snapshot reply one more time and make sure that a new snapshot message should not be sent to follower
765 followerActor.underlyingActor().clear();
766 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
767 FOLLOWER_ID, installSnapshot.getChunkIndex(), true));
769 installSnapshot = MessageCollectorActor.getFirstMatching(followerActor, InstallSnapshot.class);
771 Assert.assertNull(installSnapshot);
776 public void testHandleInstallSnapshotReplyWithInvalidChunkIndex() throws Exception{
777 logStart("testHandleInstallSnapshotReplyWithInvalidChunkIndex");
779 MockRaftActorContext actorContext = createActorContextWithFollower();
781 final int followersLastIndex = 2;
782 final int snapshotIndex = 3;
783 final int snapshotTerm = 1;
784 final int currentTerm = 2;
786 actorContext.setConfigParams(new DefaultConfigParamsImpl(){
788 public int getSnapshotChunkSize() {
793 actorContext.setCommitIndex(followersLastIndex);
795 leader = new Leader(actorContext);
797 Map<String, String> leadersSnapshot = new HashMap<>();
798 leadersSnapshot.put("1", "A");
799 leadersSnapshot.put("2", "B");
800 leadersSnapshot.put("3", "C");
802 // set the snapshot variables in replicatedlog
803 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
804 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
805 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
807 ByteString bs = toByteString(leadersSnapshot);
808 leader.setSnapshot(Optional.of(bs));
810 Uninterruptibles.sleepUninterruptibly(1, TimeUnit.SECONDS);
811 leader.handleMessage(leaderActor, new SendInstallSnapshot(bs));
813 InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
815 assertEquals(1, installSnapshot.getChunkIndex());
816 assertEquals(3, installSnapshot.getTotalChunks());
818 followerActor.underlyingActor().clear();
820 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
821 FOLLOWER_ID, -1, false));
823 Uninterruptibles.sleepUninterruptibly(actorContext.getConfigParams().getHeartBeatInterval().toMillis(),
824 TimeUnit.MILLISECONDS);
826 leader.handleMessage(leaderActor, new SendHeartBeat());
828 installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
830 assertEquals(1, installSnapshot.getChunkIndex());
831 assertEquals(3, installSnapshot.getTotalChunks());
835 public void testHandleSnapshotSendsPreviousChunksHashCodeWhenSendingNextChunk() throws Exception {
836 logStart("testHandleSnapshotSendsPreviousChunksHashCodeWhenSendingNextChunk");
838 MockRaftActorContext actorContext = createActorContextWithFollower();
840 final int followersLastIndex = 2;
841 final int snapshotIndex = 3;
842 final int snapshotTerm = 1;
843 final int currentTerm = 2;
845 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
847 public int getSnapshotChunkSize() {
852 actorContext.setCommitIndex(followersLastIndex);
854 leader = new Leader(actorContext);
856 Map<String, String> leadersSnapshot = new HashMap<>();
857 leadersSnapshot.put("1", "A");
858 leadersSnapshot.put("2", "B");
859 leadersSnapshot.put("3", "C");
861 // set the snapshot variables in replicatedlog
862 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
863 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
864 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
866 ByteString bs = toByteString(leadersSnapshot);
867 leader.setSnapshot(Optional.of(bs));
869 leader.handleMessage(leaderActor, new SendInstallSnapshot(bs));
871 InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
873 assertEquals(1, installSnapshot.getChunkIndex());
874 assertEquals(3, installSnapshot.getTotalChunks());
875 assertEquals(AbstractLeader.INITIAL_LAST_CHUNK_HASH_CODE, installSnapshot.getLastChunkHashCode().get().intValue());
877 int hashCode = installSnapshot.getData().hashCode();
879 followerActor.underlyingActor().clear();
881 leader.handleMessage(followerActor, new InstallSnapshotReply(installSnapshot.getTerm(),
882 FOLLOWER_ID, 1, true));
884 installSnapshot = MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshot.class);
886 assertEquals(2, installSnapshot.getChunkIndex());
887 assertEquals(3, installSnapshot.getTotalChunks());
888 assertEquals(hashCode, installSnapshot.getLastChunkHashCode().get().intValue());
892 public void testFollowerToSnapshotLogic() {
893 logStart("testFollowerToSnapshotLogic");
895 MockRaftActorContext actorContext = createActorContext();
897 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
899 public int getSnapshotChunkSize() {
904 leader = new Leader(actorContext);
906 Map<String, String> leadersSnapshot = new HashMap<>();
907 leadersSnapshot.put("1", "A");
908 leadersSnapshot.put("2", "B");
909 leadersSnapshot.put("3", "C");
911 ByteString bs = toByteString(leadersSnapshot);
912 byte[] barray = bs.toByteArray();
914 FollowerToSnapshot fts = leader.new FollowerToSnapshot(bs);
915 leader.setFollowerSnapshot(FOLLOWER_ID, fts);
917 assertEquals(bs.size(), barray.length);
920 for (int i=0; i < barray.length; i = i + 50) {
924 if (i + 50 > barray.length) {
928 ByteString chunk = fts.getNextChunk();
929 assertEquals("bytestring size not matching for chunk:"+ chunkIndex, j-i, chunk.size());
930 assertEquals("chunkindex not matching", chunkIndex, fts.getChunkIndex());
932 fts.markSendStatus(true);
933 if (!fts.isLastChunk(chunkIndex)) {
934 fts.incrementChunkIndex();
938 assertEquals("totalChunks not matching", chunkIndex, fts.getTotalChunks());
941 @Override protected RaftActorBehavior createBehavior(
942 RaftActorContext actorContext) {
943 return new Leader(actorContext);
947 protected MockRaftActorContext createActorContext() {
948 return createActorContext(leaderActor);
952 protected MockRaftActorContext createActorContext(ActorRef actorRef) {
953 return createActorContext(LEADER_ID, actorRef);
956 private MockRaftActorContext createActorContextWithFollower() {
957 MockRaftActorContext actorContext = createActorContext();
958 actorContext.setPeerAddresses(ImmutableMap.<String, String>builder().put(FOLLOWER_ID,
959 followerActor.path().toString()).build());
963 private MockRaftActorContext createActorContext(String id, ActorRef actorRef) {
964 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
965 configParams.setHeartBeatInterval(new FiniteDuration(50, TimeUnit.MILLISECONDS));
966 configParams.setElectionTimeoutFactor(100000);
967 MockRaftActorContext context = new MockRaftActorContext(id, getSystem(), actorRef);
968 context.setConfigParams(configParams);
973 public void testLeaderCreatedWithCommitIndexLessThanLastIndex() throws Exception {
974 logStart("testLeaderCreatedWithCommitIndexLessThanLastIndex");
976 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
978 MockRaftActorContext followerActorContext = createActorContext(FOLLOWER_ID, followerActor);
980 Follower follower = new Follower(followerActorContext);
981 followerActor.underlyingActor().setBehavior(follower);
983 Map<String, String> peerAddresses = new HashMap<>();
984 peerAddresses.put(FOLLOWER_ID, followerActor.path().toString());
986 leaderActorContext.setPeerAddresses(peerAddresses);
988 leaderActorContext.getReplicatedLog().removeFrom(0);
991 leaderActorContext.setReplicatedLog(
992 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
994 leaderActorContext.setCommitIndex(1);
996 followerActorContext.getReplicatedLog().removeFrom(0);
998 // follower too has the exact same log entries and has the same commit index
999 followerActorContext.setReplicatedLog(
1000 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
1002 followerActorContext.setCommitIndex(1);
1004 leader = new Leader(leaderActorContext);
1006 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1008 assertEquals(1, appendEntries.getLeaderCommit());
1009 assertEquals(0, appendEntries.getEntries().size());
1010 assertEquals(0, appendEntries.getPrevLogIndex());
1012 AppendEntriesReply appendEntriesReply = MessageCollectorActor.expectFirstMatching(
1013 leaderActor, AppendEntriesReply.class);
1015 assertEquals(2, appendEntriesReply.getLogLastIndex());
1016 assertEquals(1, appendEntriesReply.getLogLastTerm());
1018 // follower returns its next index
1019 assertEquals(2, appendEntriesReply.getLogLastIndex());
1020 assertEquals(1, appendEntriesReply.getLogLastTerm());
1026 public void testLeaderCreatedWithCommitIndexLessThanFollowersCommitIndex() throws Exception {
1027 logStart("testLeaderCreatedWithCommitIndexLessThanFollowersCommitIndex");
1029 MockRaftActorContext leaderActorContext = createActorContext();
1031 MockRaftActorContext followerActorContext = createActorContext(FOLLOWER_ID, followerActor);
1032 followerActorContext.setPeerAddresses(ImmutableMap.of(LEADER_ID, leaderActor.path().toString()));
1034 Follower follower = new Follower(followerActorContext);
1035 followerActor.underlyingActor().setBehavior(follower);
1037 Map<String, String> leaderPeerAddresses = new HashMap<>();
1038 leaderPeerAddresses.put(FOLLOWER_ID, followerActor.path().toString());
1040 leaderActorContext.setPeerAddresses(leaderPeerAddresses);
1042 leaderActorContext.getReplicatedLog().removeFrom(0);
1044 leaderActorContext.setReplicatedLog(
1045 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
1047 leaderActorContext.setCommitIndex(1);
1049 followerActorContext.getReplicatedLog().removeFrom(0);
1051 followerActorContext.setReplicatedLog(
1052 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
1054 // follower has the same log entries but its commit index > leaders commit index
1055 followerActorContext.setCommitIndex(2);
1057 leader = new Leader(leaderActorContext);
1059 // Initial heartbeat
1060 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1062 assertEquals(1, appendEntries.getLeaderCommit());
1063 assertEquals(0, appendEntries.getEntries().size());
1064 assertEquals(0, appendEntries.getPrevLogIndex());
1066 AppendEntriesReply appendEntriesReply = MessageCollectorActor.expectFirstMatching(
1067 leaderActor, AppendEntriesReply.class);
1069 assertEquals(2, appendEntriesReply.getLogLastIndex());
1070 assertEquals(1, appendEntriesReply.getLogLastTerm());
1072 leaderActor.underlyingActor().setBehavior(follower);
1073 leader.handleMessage(followerActor, appendEntriesReply);
1075 leaderActor.underlyingActor().clear();
1076 followerActor.underlyingActor().clear();
1078 Uninterruptibles.sleepUninterruptibly(leaderActorContext.getConfigParams().getHeartBeatInterval().toMillis(),
1079 TimeUnit.MILLISECONDS);
1081 leader.handleMessage(leaderActor, new SendHeartBeat());
1083 appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1085 assertEquals(2, appendEntries.getLeaderCommit());
1086 assertEquals(0, appendEntries.getEntries().size());
1087 assertEquals(2, appendEntries.getPrevLogIndex());
1089 appendEntriesReply = MessageCollectorActor.expectFirstMatching(leaderActor, AppendEntriesReply.class);
1091 assertEquals(2, appendEntriesReply.getLogLastIndex());
1092 assertEquals(1, appendEntriesReply.getLogLastTerm());
1094 assertEquals(2, followerActorContext.getCommitIndex());
1100 public void testHandleAppendEntriesReplyFailure(){
1101 logStart("testHandleAppendEntriesReplyFailure");
1103 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
1105 leader = new Leader(leaderActorContext);
1107 // Send initial heartbeat reply with last index.
1108 leader.handleAppendEntriesReply(followerActor, new AppendEntriesReply(FOLLOWER_ID, 1, true, 10, 1));
1110 FollowerLogInformation followerInfo = leader.getFollower(FOLLOWER_ID);
1111 assertEquals("getNextIndex", 11, followerInfo.getNextIndex());
1113 AppendEntriesReply reply = new AppendEntriesReply(FOLLOWER_ID, 1, false, 10, 1);
1115 RaftActorBehavior raftActorBehavior = leader.handleAppendEntriesReply(followerActor, reply);
1117 assertEquals(RaftState.Leader, raftActorBehavior.state());
1119 assertEquals("getNextIndex", 10, followerInfo.getNextIndex());
1123 public void testHandleAppendEntriesReplySuccess() throws Exception {
1124 logStart("testHandleAppendEntriesReplySuccess");
1126 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
1128 leaderActorContext.setReplicatedLog(
1129 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
1131 leaderActorContext.setCommitIndex(1);
1132 leaderActorContext.setLastApplied(1);
1133 leaderActorContext.getTermInformation().update(1, "leader");
1135 leader = new Leader(leaderActorContext);
1137 AppendEntriesReply reply = new AppendEntriesReply(FOLLOWER_ID, 1, true, 2, 1);
1139 RaftActorBehavior raftActorBehavior = leader.handleAppendEntriesReply(followerActor, reply);
1141 assertEquals(RaftState.Leader, raftActorBehavior.state());
1143 assertEquals(2, leaderActorContext.getCommitIndex());
1145 ApplyJournalEntries applyJournalEntries = MessageCollectorActor.expectFirstMatching(
1146 leaderActor, ApplyJournalEntries.class);
1148 assertEquals(2, leaderActorContext.getLastApplied());
1150 assertEquals(2, applyJournalEntries.getToIndex());
1152 List<ApplyState> applyStateList = MessageCollectorActor.getAllMatching(leaderActor,
1155 assertEquals(1,applyStateList.size());
1157 ApplyState applyState = applyStateList.get(0);
1159 assertEquals(2, applyState.getReplicatedLogEntry().getIndex());
1163 public void testHandleAppendEntriesReplyUnknownFollower(){
1164 logStart("testHandleAppendEntriesReplyUnknownFollower");
1166 MockRaftActorContext leaderActorContext = createActorContext();
1168 leader = new Leader(leaderActorContext);
1170 AppendEntriesReply reply = new AppendEntriesReply("unkown-follower", 1, false, 10, 1);
1172 RaftActorBehavior raftActorBehavior = leader.handleAppendEntriesReply(followerActor, reply);
1174 assertEquals(RaftState.Leader, raftActorBehavior.state());
1178 public void testHandleRequestVoteReply(){
1179 logStart("testHandleRequestVoteReply");
1181 MockRaftActorContext leaderActorContext = createActorContext();
1183 leader = new Leader(leaderActorContext);
1185 // Should be a no-op.
1186 RaftActorBehavior raftActorBehavior = leader.handleRequestVoteReply(followerActor,
1187 new RequestVoteReply(1, true));
1189 assertEquals(RaftState.Leader, raftActorBehavior.state());
1191 raftActorBehavior = leader.handleRequestVoteReply(followerActor, new RequestVoteReply(1, false));
1193 assertEquals(RaftState.Leader, raftActorBehavior.state());
1197 public void testIsolatedLeaderCheckNoFollowers() {
1198 logStart("testIsolatedLeaderCheckNoFollowers");
1200 MockRaftActorContext leaderActorContext = createActorContext();
1202 leader = new Leader(leaderActorContext);
1203 RaftActorBehavior behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1204 Assert.assertTrue(behavior instanceof Leader);
1208 public void testIsolatedLeaderCheckTwoFollowers() throws Exception {
1209 logStart("testIsolatedLeaderCheckTwoFollowers");
1211 new JavaTestKit(getSystem()) {{
1213 ActorRef followerActor1 = getTestActor();
1214 ActorRef followerActor2 = getTestActor();
1216 MockRaftActorContext leaderActorContext = createActorContext();
1218 Map<String, String> peerAddresses = new HashMap<>();
1219 peerAddresses.put("follower-1", followerActor1.path().toString());
1220 peerAddresses.put("follower-2", followerActor2.path().toString());
1222 leaderActorContext.setPeerAddresses(peerAddresses);
1224 leader = new Leader(leaderActorContext);
1226 leader.markFollowerActive("follower-1");
1227 leader.markFollowerActive("follower-2");
1228 RaftActorBehavior behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1229 Assert.assertTrue("Behavior not instance of Leader when all followers are active",
1230 behavior instanceof Leader);
1232 // kill 1 follower and verify if that got killed
1233 final JavaTestKit probe = new JavaTestKit(getSystem());
1234 probe.watch(followerActor1);
1235 followerActor1.tell(PoisonPill.getInstance(), ActorRef.noSender());
1236 final Terminated termMsg1 = probe.expectMsgClass(Terminated.class);
1237 assertEquals(termMsg1.getActor(), followerActor1);
1239 leader.markFollowerInActive("follower-1");
1240 leader.markFollowerActive("follower-2");
1241 behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1242 Assert.assertTrue("Behavior not instance of Leader when majority of followers are active",
1243 behavior instanceof Leader);
1245 // kill 2nd follower and leader should change to Isolated leader
1246 followerActor2.tell(PoisonPill.getInstance(), null);
1247 probe.watch(followerActor2);
1248 followerActor2.tell(PoisonPill.getInstance(), ActorRef.noSender());
1249 final Terminated termMsg2 = probe.expectMsgClass(Terminated.class);
1250 assertEquals(termMsg2.getActor(), followerActor2);
1252 leader.markFollowerInActive("follower-2");
1253 behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1254 Assert.assertTrue("Behavior not instance of IsolatedLeader when majority followers are inactive",
1255 behavior instanceof IsolatedLeader);
1261 public void testAppendEntryCallAtEndofAppendEntryReply() throws Exception {
1262 logStart("testAppendEntryCallAtEndofAppendEntryReply");
1264 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
1266 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
1267 //configParams.setHeartBeatInterval(new FiniteDuration(9, TimeUnit.SECONDS));
1268 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(10, TimeUnit.SECONDS));
1270 leaderActorContext.setConfigParams(configParams);
1272 MockRaftActorContext followerActorContext = createActorContext(FOLLOWER_ID, followerActor);
1274 followerActorContext.setConfigParams(configParams);
1275 followerActorContext.setPeerAddresses(ImmutableMap.of(LEADER_ID, leaderActor.path().toString()));
1277 Follower follower = new Follower(followerActorContext);
1278 followerActor.underlyingActor().setBehavior(follower);
1280 leaderActorContext.getReplicatedLog().removeFrom(0);
1281 leaderActorContext.setCommitIndex(-1);
1282 leaderActorContext.setLastApplied(-1);
1284 followerActorContext.getReplicatedLog().removeFrom(0);
1285 followerActorContext.setCommitIndex(-1);
1286 followerActorContext.setLastApplied(-1);
1288 leader = new Leader(leaderActorContext);
1290 AppendEntriesReply appendEntriesReply = MessageCollectorActor.expectFirstMatching(
1291 leaderActor, AppendEntriesReply.class);
1293 leader.handleMessage(followerActor, appendEntriesReply);
1295 // Clear initial heartbeat messages
1297 leaderActor.underlyingActor().clear();
1298 followerActor.underlyingActor().clear();
1301 leaderActorContext.setReplicatedLog(
1302 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
1303 leaderActorContext.setCommitIndex(1);
1304 leaderActorContext.setLastApplied(1);
1306 Uninterruptibles.sleepUninterruptibly(leaderActorContext.getConfigParams().getHeartBeatInterval().toMillis(),
1307 TimeUnit.MILLISECONDS);
1309 leader.handleMessage(leaderActor, new SendHeartBeat());
1311 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1313 // Should send first log entry
1314 assertEquals(1, appendEntries.getLeaderCommit());
1315 assertEquals(0, appendEntries.getEntries().get(0).getIndex());
1316 assertEquals(-1, appendEntries.getPrevLogIndex());
1318 appendEntriesReply = MessageCollectorActor.expectFirstMatching(leaderActor, AppendEntriesReply.class);
1320 assertEquals(1, appendEntriesReply.getLogLastTerm());
1321 assertEquals(0, appendEntriesReply.getLogLastIndex());
1323 followerActor.underlyingActor().clear();
1325 leader.handleAppendEntriesReply(followerActor, appendEntriesReply);
1327 appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1329 // Should send second log entry
1330 assertEquals(1, appendEntries.getLeaderCommit());
1331 assertEquals(1, appendEntries.getEntries().get(0).getIndex());
1337 public void testLaggingFollowerStarvation() throws Exception {
1338 logStart("testLaggingFollowerStarvation");
1339 new JavaTestKit(getSystem()) {{
1340 String leaderActorId = actorFactory.generateActorId("leader");
1341 String follower1ActorId = actorFactory.generateActorId("follower");
1342 String follower2ActorId = actorFactory.generateActorId("follower");
1344 TestActorRef<ForwardMessageToBehaviorActor> leaderActor =
1345 actorFactory.createTestActor(ForwardMessageToBehaviorActor.props(), leaderActorId);
1346 ActorRef follower1Actor = actorFactory.createActor(MessageCollectorActor.props(), follower1ActorId);
1347 ActorRef follower2Actor = actorFactory.createActor(MessageCollectorActor.props(), follower2ActorId);
1349 MockRaftActorContext leaderActorContext =
1350 new MockRaftActorContext(leaderActorId, getSystem(), leaderActor);
1352 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
1353 configParams.setHeartBeatInterval(new FiniteDuration(200, TimeUnit.MILLISECONDS));
1354 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(10, TimeUnit.SECONDS));
1356 leaderActorContext.setConfigParams(configParams);
1358 leaderActorContext.setReplicatedLog(
1359 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(1,5,1).build());
1361 Map<String, String> peerAddresses = new HashMap<>();
1362 peerAddresses.put(follower1ActorId,
1363 follower1Actor.path().toString());
1364 peerAddresses.put(follower2ActorId,
1365 follower2Actor.path().toString());
1367 leaderActorContext.setPeerAddresses(peerAddresses);
1368 leaderActorContext.getTermInformation().update(1, leaderActorId);
1370 RaftActorBehavior leader = createBehavior(leaderActorContext);
1372 leaderActor.underlyingActor().setBehavior(leader);
1374 for(int i=1;i<6;i++) {
1375 // Each AppendEntriesReply could end up rescheduling the heartbeat (without the fix for bug 2733)
1376 RaftActorBehavior newBehavior = leader.handleMessage(follower1Actor, new AppendEntriesReply(follower1ActorId, 1, true, i, 1));
1377 assertTrue(newBehavior == leader);
1378 Uninterruptibles.sleepUninterruptibly(200, TimeUnit.MILLISECONDS);
1381 // Check if the leader has been receiving SendHeartbeat messages despite getting AppendEntriesReply
1382 List<SendHeartBeat> heartbeats = MessageCollectorActor.getAllMatching(leaderActor, SendHeartBeat.class);
1384 assertTrue(String.format("%s heartbeat(s) is less than expected", heartbeats.size()),
1385 heartbeats.size() > 1);
1387 // Check if follower-2 got AppendEntries during this time and was not starved
1388 List<AppendEntries> appendEntries = MessageCollectorActor.getAllMatching(follower2Actor, AppendEntries.class);
1390 assertTrue(String.format("%s append entries is less than expected", appendEntries.size()),
1391 appendEntries.size() > 1);
1397 protected void assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(RaftActorContext actorContext,
1398 ActorRef actorRef, RaftRPC rpc) throws Exception {
1399 super.assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(actorContext, actorRef, rpc);
1400 assertEquals("New votedFor", null, actorContext.getTermInformation().getVotedFor());
1403 private class MockConfigParamsImpl extends DefaultConfigParamsImpl {
1405 private final long electionTimeOutIntervalMillis;
1406 private final int snapshotChunkSize;
1408 public MockConfigParamsImpl(long electionTimeOutIntervalMillis, int snapshotChunkSize) {
1410 this.electionTimeOutIntervalMillis = electionTimeOutIntervalMillis;
1411 this.snapshotChunkSize = snapshotChunkSize;
1415 public FiniteDuration getElectionTimeOutInterval() {
1416 return new FiniteDuration(electionTimeOutIntervalMillis, TimeUnit.MILLISECONDS);
1420 public int getSnapshotChunkSize() {
1421 return snapshotChunkSize;