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.TestActorFactory;
31 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
32 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
33 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
34 import org.opendaylight.controller.cluster.raft.base.messages.IsolatedLeaderCheck;
35 import org.opendaylight.controller.cluster.raft.base.messages.Replicate;
36 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
37 import org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot;
38 import org.opendaylight.controller.cluster.raft.behaviors.AbstractLeader.FollowerToSnapshot;
39 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
40 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
41 import org.opendaylight.controller.cluster.raft.messages.InstallSnapshot;
42 import org.opendaylight.controller.cluster.raft.messages.InstallSnapshotReply;
43 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
44 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
45 import org.opendaylight.controller.protobuff.messages.cluster.raft.InstallSnapshotMessages;
46 import scala.concurrent.duration.FiniteDuration;
48 public class LeaderTest extends AbstractRaftActorBehaviorTest {
50 static final String FOLLOWER_ID = "follower";
52 private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
54 private final TestActorRef<ForwardMessageToBehaviorActor> leaderActor = actorFactory.createTestActor(
55 Props.create(ForwardMessageToBehaviorActor.class), actorFactory.generateActorId("leader"));
57 private final TestActorRef<ForwardMessageToBehaviorActor> followerActor = actorFactory.createTestActor(
58 Props.create(ForwardMessageToBehaviorActor.class), actorFactory.generateActorId("follower"));
60 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 public void testHandleReplicateMessageSendAppendEntriesToFollower() throws Exception {
125 logStart("testHandleReplicateMessageSendAppendEntriesToFollower");
127 MockRaftActorContext actorContext = createActorContextWithFollower();
130 actorContext.getTermInformation().update(term, "");
132 leader = new Leader(actorContext);
134 // Leader will send an immediate heartbeat - ignore it.
135 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
137 // The follower would normally reply - simulate that explicitly here.
138 long lastIndex = actorContext.getReplicatedLog().lastIndex();
139 leader.handleMessage(followerActor, new AppendEntriesReply(
140 FOLLOWER_ID, term, true, lastIndex, term));
141 assertEquals("isFollowerActive", true, leader.getFollower(FOLLOWER_ID).isFollowerActive());
143 followerActor.underlyingActor().clear();
145 MockRaftActorContext.MockPayload payload = new MockRaftActorContext.MockPayload("foo");
146 MockRaftActorContext.MockReplicatedLogEntry newEntry = new MockRaftActorContext.MockReplicatedLogEntry(
147 1, lastIndex + 1, payload);
148 actorContext.getReplicatedLog().append(newEntry);
149 RaftActorBehavior raftBehavior = leader.handleMessage(leaderActor,
150 new Replicate(null, null, newEntry));
152 // State should not change
153 assertTrue(raftBehavior instanceof Leader);
155 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
156 assertEquals("getPrevLogIndex", lastIndex, appendEntries.getPrevLogIndex());
157 assertEquals("getPrevLogTerm", term, appendEntries.getPrevLogTerm());
158 assertEquals("Entries size", 1, appendEntries.getEntries().size());
159 assertEquals("Entry getIndex", lastIndex + 1, appendEntries.getEntries().get(0).getIndex());
160 assertEquals("Entry getTerm", term, appendEntries.getEntries().get(0).getTerm());
161 assertEquals("Entry payload", payload, appendEntries.getEntries().get(0).getData());
165 public void testHandleReplicateMessageWhenThereAreNoFollowers() throws Exception {
166 logStart("testHandleReplicateMessageWhenThereAreNoFollowers");
168 MockRaftActorContext actorContext = createActorContext();
170 leader = new Leader(actorContext);
172 actorContext.setLastApplied(0);
174 long newLogIndex = actorContext.getReplicatedLog().lastIndex() + 1;
175 long term = actorContext.getTermInformation().getCurrentTerm();
176 MockRaftActorContext.MockReplicatedLogEntry newEntry = new MockRaftActorContext.MockReplicatedLogEntry(
177 term, newLogIndex, new MockRaftActorContext.MockPayload("foo"));
179 actorContext.getReplicatedLog().append(newEntry);
181 RaftActorBehavior raftBehavior = leader.handleMessage(leaderActor,
182 new Replicate(leaderActor, "state-id", newEntry));
184 // State should not change
185 assertTrue(raftBehavior instanceof Leader);
187 assertEquals("getCommitIndex", newLogIndex, actorContext.getCommitIndex());
189 // We should get 2 ApplyState messages - 1 for new log entry and 1 for the previous
190 // one since lastApplied state is 0.
191 List<ApplyState> applyStateList = MessageCollectorActor.getAllMatching(
192 leaderActor, ApplyState.class);
193 assertEquals("ApplyState count", newLogIndex, applyStateList.size());
195 for(int i = 0; i <= newLogIndex - 1; i++ ) {
196 ApplyState applyState = applyStateList.get(i);
197 assertEquals("getIndex", i + 1, applyState.getReplicatedLogEntry().getIndex());
198 assertEquals("getTerm", term, applyState.getReplicatedLogEntry().getTerm());
201 ApplyState last = applyStateList.get((int) newLogIndex - 1);
202 assertEquals("getData", newEntry.getData(), last.getReplicatedLogEntry().getData());
203 assertEquals("getIdentifier", "state-id", last.getIdentifier());
207 public void testSendAppendEntriesOnAnInProgressInstallSnapshot() throws Exception {
208 logStart("testSendAppendEntriesOnAnInProgressInstallSnapshot");
210 MockRaftActorContext actorContext = createActorContextWithFollower();
212 Map<String, String> leadersSnapshot = new HashMap<>();
213 leadersSnapshot.put("1", "A");
214 leadersSnapshot.put("2", "B");
215 leadersSnapshot.put("3", "C");
218 actorContext.getReplicatedLog().removeFrom(0);
220 final int followersLastIndex = 2;
221 final int snapshotIndex = 3;
222 final int newEntryIndex = 4;
223 final int snapshotTerm = 1;
224 final int currentTerm = 2;
226 // set the snapshot variables in replicatedlog
227 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
228 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
229 actorContext.setCommitIndex(followersLastIndex);
230 //set follower timeout to 2 mins, helps during debugging
231 actorContext.setConfigParams(new MockConfigParamsImpl(120000L, 10));
233 leader = new Leader(actorContext);
236 ReplicatedLogImplEntry entry =
237 new ReplicatedLogImplEntry(newEntryIndex, currentTerm,
238 new MockRaftActorContext.MockPayload("D"));
240 //update follower timestamp
241 leader.markFollowerActive(FOLLOWER_ID);
243 ByteString bs = toByteString(leadersSnapshot);
244 leader.setSnapshot(Optional.of(bs));
245 FollowerToSnapshot fts = leader.new FollowerToSnapshot(bs);
246 leader.setFollowerSnapshot(FOLLOWER_ID, fts);
248 //send first chunk and no InstallSnapshotReply received yet
250 fts.incrementChunkIndex();
252 Uninterruptibles.sleepUninterruptibly(actorContext.getConfigParams().getHeartBeatInterval().toMillis(),
253 TimeUnit.MILLISECONDS);
255 leader.handleMessage(leaderActor, new SendHeartBeat());
257 AppendEntries aeproto = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
259 AppendEntries ae = (AppendEntries) SerializationUtils.fromSerializable(aeproto);
261 assertTrue("AppendEntries should be sent with empty entries", ae.getEntries().isEmpty());
263 //InstallSnapshotReply received
264 fts.markSendStatus(true);
266 leader.handleMessage(leaderActor, new SendHeartBeat());
268 InstallSnapshotMessages.InstallSnapshot isproto = MessageCollectorActor.expectFirstMatching(followerActor,
269 InstallSnapshot.SERIALIZABLE_CLASS);
271 InstallSnapshot is = (InstallSnapshot) SerializationUtils.fromSerializable(isproto);
273 assertEquals(snapshotIndex, is.getLastIncludedIndex());
277 public void testSendAppendEntriesSnapshotScenario() throws Exception {
278 logStart("testSendAppendEntriesSnapshotScenario");
280 MockRaftActorContext actorContext = createActorContextWithFollower();
282 Map<String, String> leadersSnapshot = new HashMap<>();
283 leadersSnapshot.put("1", "A");
284 leadersSnapshot.put("2", "B");
285 leadersSnapshot.put("3", "C");
288 actorContext.getReplicatedLog().removeFrom(0);
290 final int followersLastIndex = 2;
291 final int snapshotIndex = 3;
292 final int newEntryIndex = 4;
293 final int snapshotTerm = 1;
294 final int currentTerm = 2;
296 // set the snapshot variables in replicatedlog
297 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
298 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
299 actorContext.setCommitIndex(followersLastIndex);
301 leader = new Leader(actorContext);
303 // Leader will send an immediate heartbeat - ignore it.
304 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
307 ReplicatedLogImplEntry entry =
308 new ReplicatedLogImplEntry(newEntryIndex, currentTerm,
309 new MockRaftActorContext.MockPayload("D"));
311 //update follower timestamp
312 leader.markFollowerActive(FOLLOWER_ID);
314 // this should invoke a sendinstallsnapshot as followersLastIndex < snapshotIndex
315 RaftActorBehavior raftBehavior = leader.handleMessage(
316 leaderActor, new Replicate(null, "state-id", entry));
318 assertTrue(raftBehavior instanceof Leader);
320 MessageCollectorActor.expectFirstMatching(leaderActor, CaptureSnapshot.class);
324 public void testInitiateInstallSnapshot() throws Exception {
325 logStart("testInitiateInstallSnapshot");
327 MockRaftActorContext actorContext = createActorContextWithFollower();
329 Map<String, String> leadersSnapshot = new HashMap<>();
330 leadersSnapshot.put("1", "A");
331 leadersSnapshot.put("2", "B");
332 leadersSnapshot.put("3", "C");
335 actorContext.getReplicatedLog().removeFrom(0);
337 final int followersLastIndex = 2;
338 final int snapshotIndex = 3;
339 final int newEntryIndex = 4;
340 final int snapshotTerm = 1;
341 final int currentTerm = 2;
343 // set the snapshot variables in replicatedlog
344 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
345 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
346 actorContext.setLastApplied(3);
347 actorContext.setCommitIndex(followersLastIndex);
349 leader = new Leader(actorContext);
351 // Leader will send an immediate heartbeat - ignore it.
352 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
354 // set the snapshot as absent and check if capture-snapshot is invoked.
355 leader.setSnapshot(Optional.<ByteString>absent());
358 ReplicatedLogImplEntry entry = new ReplicatedLogImplEntry(newEntryIndex, currentTerm,
359 new MockRaftActorContext.MockPayload("D"));
361 actorContext.getReplicatedLog().append(entry);
363 //update follower timestamp
364 leader.markFollowerActive(FOLLOWER_ID);
366 leader.handleMessage(leaderActor, new Replicate(null, "state-id", entry));
368 CaptureSnapshot cs = MessageCollectorActor.expectFirstMatching(leaderActor, CaptureSnapshot.class);
370 assertTrue(cs.isInstallSnapshotInitiated());
371 assertEquals(3, cs.getLastAppliedIndex());
372 assertEquals(1, cs.getLastAppliedTerm());
373 assertEquals(4, cs.getLastIndex());
374 assertEquals(2, cs.getLastTerm());
376 // if an initiate is started again when first is in progress, it shouldnt initiate Capture
377 leader.handleMessage(leaderActor, new Replicate(null, "state-id", entry));
379 List<CaptureSnapshot> captureSnapshots = MessageCollectorActor.getAllMatching(leaderActor, CaptureSnapshot.class);
380 assertEquals("CaptureSnapshot should not get invoked when initiate is in progress", 1, captureSnapshots.size());
384 public void testInstallSnapshot() throws Exception {
385 logStart("testInstallSnapshot");
387 MockRaftActorContext actorContext = createActorContextWithFollower();
389 Map<String, String> leadersSnapshot = new HashMap<>();
390 leadersSnapshot.put("1", "A");
391 leadersSnapshot.put("2", "B");
392 leadersSnapshot.put("3", "C");
395 actorContext.getReplicatedLog().removeFrom(0);
397 final int followersLastIndex = 2;
398 final int snapshotIndex = 3;
399 final int snapshotTerm = 1;
400 final int currentTerm = 2;
402 // set the snapshot variables in replicatedlog
403 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
404 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
405 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
406 actorContext.setCommitIndex(followersLastIndex);
408 leader = new Leader(actorContext);
410 // Ignore initial heartbeat.
411 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
413 RaftActorBehavior raftBehavior = leader.handleMessage(leaderActor,
414 new SendInstallSnapshot(toByteString(leadersSnapshot)));
416 assertTrue(raftBehavior instanceof Leader);
418 // check if installsnapshot gets called with the correct values.
420 InstallSnapshot installSnapshot = (InstallSnapshot) SerializationUtils.fromSerializable(
421 MessageCollectorActor.expectFirstMatching(followerActor, InstallSnapshotMessages.InstallSnapshot.class));
423 assertNotNull(installSnapshot.getData());
424 assertEquals(snapshotIndex, installSnapshot.getLastIncludedIndex());
425 assertEquals(snapshotTerm, installSnapshot.getLastIncludedTerm());
427 // FIXME - we don't set the term in the serialized message.
428 //assertEquals(currentTerm, installSnapshot.getTerm());
432 public void testHandleInstallSnapshotReplyLastChunk() throws Exception {
433 logStart("testHandleInstallSnapshotReplyLastChunk");
435 MockRaftActorContext actorContext = createActorContextWithFollower();
437 final int followersLastIndex = 2;
438 final int snapshotIndex = 3;
439 final int snapshotTerm = 1;
440 final int currentTerm = 2;
442 actorContext.setCommitIndex(followersLastIndex);
444 leader = new Leader(actorContext);
446 // Ignore initial heartbeat.
447 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
449 Map<String, String> leadersSnapshot = new HashMap<>();
450 leadersSnapshot.put("1", "A");
451 leadersSnapshot.put("2", "B");
452 leadersSnapshot.put("3", "C");
454 // set the snapshot variables in replicatedlog
456 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
457 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
458 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
460 ByteString bs = toByteString(leadersSnapshot);
461 leader.setSnapshot(Optional.of(bs));
462 FollowerToSnapshot fts = leader.new FollowerToSnapshot(bs);
463 leader.setFollowerSnapshot(FOLLOWER_ID, fts);
464 while(!fts.isLastChunk(fts.getChunkIndex())) {
466 fts.incrementChunkIndex();
470 actorContext.getReplicatedLog().removeFrom(0);
472 RaftActorBehavior raftBehavior = leader.handleMessage(followerActor,
473 new InstallSnapshotReply(currentTerm, FOLLOWER_ID, fts.getChunkIndex(), true));
475 assertTrue(raftBehavior instanceof Leader);
477 assertEquals(0, leader.followerSnapshotSize());
478 assertEquals(1, leader.followerLogSize());
479 FollowerLogInformation fli = leader.getFollower(FOLLOWER_ID);
481 assertEquals(snapshotIndex, fli.getMatchIndex());
482 assertEquals(snapshotIndex, fli.getMatchIndex());
483 assertEquals(snapshotIndex + 1, fli.getNextIndex());
487 public void testSendSnapshotfromInstallSnapshotReply() throws Exception {
488 logStart("testSendSnapshotfromInstallSnapshotReply");
490 MockRaftActorContext actorContext = createActorContextWithFollower();
492 final int followersLastIndex = 2;
493 final int snapshotIndex = 3;
494 final int snapshotTerm = 1;
495 final int currentTerm = 2;
497 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl(){
499 public int getSnapshotChunkSize() {
503 configParams.setHeartBeatInterval(new FiniteDuration(9, TimeUnit.SECONDS));
504 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(10, TimeUnit.SECONDS));
506 actorContext.setConfigParams(configParams);
507 actorContext.setCommitIndex(followersLastIndex);
509 leader = new Leader(actorContext);
511 Map<String, String> leadersSnapshot = new HashMap<>();
512 leadersSnapshot.put("1", "A");
513 leadersSnapshot.put("2", "B");
514 leadersSnapshot.put("3", "C");
516 // set the snapshot variables in replicatedlog
517 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
518 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
519 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
521 ByteString bs = toByteString(leadersSnapshot);
522 leader.setSnapshot(Optional.of(bs));
524 leader.handleMessage(leaderActor, new SendInstallSnapshot(bs));
526 InstallSnapshotMessages.InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(
527 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
529 assertEquals(1, installSnapshot.getChunkIndex());
530 assertEquals(3, installSnapshot.getTotalChunks());
532 followerActor.underlyingActor().clear();
533 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
534 FOLLOWER_ID, installSnapshot.getChunkIndex(), true));
536 installSnapshot = MessageCollectorActor.expectFirstMatching(
537 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
539 assertEquals(2, installSnapshot.getChunkIndex());
540 assertEquals(3, installSnapshot.getTotalChunks());
542 followerActor.underlyingActor().clear();
543 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
544 FOLLOWER_ID, installSnapshot.getChunkIndex(), true));
546 installSnapshot = MessageCollectorActor.expectFirstMatching(
547 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
549 // Send snapshot reply one more time and make sure that a new snapshot message should not be sent to follower
550 followerActor.underlyingActor().clear();
551 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
552 FOLLOWER_ID, installSnapshot.getChunkIndex(), true));
554 installSnapshot = MessageCollectorActor.getFirstMatching(
555 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
557 Assert.assertNull(installSnapshot);
562 public void testHandleInstallSnapshotReplyWithInvalidChunkIndex() throws Exception{
563 logStart("testHandleInstallSnapshotReplyWithInvalidChunkIndex");
565 MockRaftActorContext actorContext = createActorContextWithFollower();
567 final int followersLastIndex = 2;
568 final int snapshotIndex = 3;
569 final int snapshotTerm = 1;
570 final int currentTerm = 2;
572 actorContext.setConfigParams(new DefaultConfigParamsImpl(){
574 public int getSnapshotChunkSize() {
579 actorContext.setCommitIndex(followersLastIndex);
581 leader = new Leader(actorContext);
583 Map<String, String> leadersSnapshot = new HashMap<>();
584 leadersSnapshot.put("1", "A");
585 leadersSnapshot.put("2", "B");
586 leadersSnapshot.put("3", "C");
588 // set the snapshot variables in replicatedlog
589 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
590 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
591 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
593 ByteString bs = toByteString(leadersSnapshot);
594 leader.setSnapshot(Optional.of(bs));
596 leader.handleMessage(leaderActor, new SendInstallSnapshot(bs));
598 InstallSnapshotMessages.InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(
599 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
601 assertEquals(1, installSnapshot.getChunkIndex());
602 assertEquals(3, installSnapshot.getTotalChunks());
604 followerActor.underlyingActor().clear();
606 leader.handleMessage(followerActor, new InstallSnapshotReply(actorContext.getTermInformation().getCurrentTerm(),
607 FOLLOWER_ID, -1, false));
609 Uninterruptibles.sleepUninterruptibly(actorContext.getConfigParams().getHeartBeatInterval().toMillis(),
610 TimeUnit.MILLISECONDS);
612 leader.handleMessage(leaderActor, new SendHeartBeat());
614 installSnapshot = MessageCollectorActor.expectFirstMatching(
615 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
617 assertEquals(1, installSnapshot.getChunkIndex());
618 assertEquals(3, installSnapshot.getTotalChunks());
622 public void testHandleSnapshotSendsPreviousChunksHashCodeWhenSendingNextChunk() throws Exception {
623 logStart("testHandleSnapshotSendsPreviousChunksHashCodeWhenSendingNextChunk");
625 MockRaftActorContext actorContext = createActorContextWithFollower();
627 final int followersLastIndex = 2;
628 final int snapshotIndex = 3;
629 final int snapshotTerm = 1;
630 final int currentTerm = 2;
632 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
634 public int getSnapshotChunkSize() {
639 actorContext.setCommitIndex(followersLastIndex);
641 leader = new Leader(actorContext);
643 Map<String, String> leadersSnapshot = new HashMap<>();
644 leadersSnapshot.put("1", "A");
645 leadersSnapshot.put("2", "B");
646 leadersSnapshot.put("3", "C");
648 // set the snapshot variables in replicatedlog
649 actorContext.getReplicatedLog().setSnapshotIndex(snapshotIndex);
650 actorContext.getReplicatedLog().setSnapshotTerm(snapshotTerm);
651 actorContext.getTermInformation().update(currentTerm, leaderActor.path().toString());
653 ByteString bs = toByteString(leadersSnapshot);
654 leader.setSnapshot(Optional.of(bs));
656 leader.handleMessage(leaderActor, new SendInstallSnapshot(bs));
658 InstallSnapshotMessages.InstallSnapshot installSnapshot = MessageCollectorActor.expectFirstMatching(
659 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
661 assertEquals(1, installSnapshot.getChunkIndex());
662 assertEquals(3, installSnapshot.getTotalChunks());
663 assertEquals(AbstractLeader.INITIAL_LAST_CHUNK_HASH_CODE, installSnapshot.getLastChunkHashCode());
665 int hashCode = installSnapshot.getData().hashCode();
667 followerActor.underlyingActor().clear();
669 leader.handleMessage(followerActor, new InstallSnapshotReply(installSnapshot.getTerm(),
670 FOLLOWER_ID, 1, true));
672 installSnapshot = MessageCollectorActor.expectFirstMatching(
673 followerActor, InstallSnapshotMessages.InstallSnapshot.class);
675 assertEquals(2, installSnapshot.getChunkIndex());
676 assertEquals(3, installSnapshot.getTotalChunks());
677 assertEquals(hashCode, installSnapshot.getLastChunkHashCode());
681 public void testFollowerToSnapshotLogic() {
682 logStart("testFollowerToSnapshotLogic");
684 MockRaftActorContext actorContext = createActorContext();
686 actorContext.setConfigParams(new DefaultConfigParamsImpl() {
688 public int getSnapshotChunkSize() {
693 leader = new Leader(actorContext);
695 Map<String, String> leadersSnapshot = new HashMap<>();
696 leadersSnapshot.put("1", "A");
697 leadersSnapshot.put("2", "B");
698 leadersSnapshot.put("3", "C");
700 ByteString bs = toByteString(leadersSnapshot);
701 byte[] barray = bs.toByteArray();
703 FollowerToSnapshot fts = leader.new FollowerToSnapshot(bs);
704 leader.setFollowerSnapshot(FOLLOWER_ID, fts);
706 assertEquals(bs.size(), barray.length);
709 for (int i=0; i < barray.length; i = i + 50) {
713 if (i + 50 > barray.length) {
717 ByteString chunk = fts.getNextChunk();
718 assertEquals("bytestring size not matching for chunk:"+ chunkIndex, j-i, chunk.size());
719 assertEquals("chunkindex not matching", chunkIndex, fts.getChunkIndex());
721 fts.markSendStatus(true);
722 if (!fts.isLastChunk(chunkIndex)) {
723 fts.incrementChunkIndex();
727 assertEquals("totalChunks not matching", chunkIndex, fts.getTotalChunks());
730 @Override protected RaftActorBehavior createBehavior(
731 RaftActorContext actorContext) {
732 return new Leader(actorContext);
736 protected MockRaftActorContext createActorContext() {
737 return createActorContext(leaderActor);
741 protected MockRaftActorContext createActorContext(ActorRef actorRef) {
742 return createActorContext("leader", actorRef);
745 private MockRaftActorContext createActorContextWithFollower() {
746 MockRaftActorContext actorContext = createActorContext();
747 actorContext.setPeerAddresses(ImmutableMap.<String,String>builder().put(FOLLOWER_ID,
748 followerActor.path().toString()).build());
752 private MockRaftActorContext createActorContext(String id, ActorRef actorRef) {
753 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
754 configParams.setHeartBeatInterval(new FiniteDuration(50, TimeUnit.MILLISECONDS));
755 configParams.setElectionTimeoutFactor(100000);
756 MockRaftActorContext context = new MockRaftActorContext(id, getSystem(), actorRef);
757 context.setConfigParams(configParams);
761 public static class ForwardMessageToBehaviorActor extends MessageCollectorActor {
762 AbstractRaftActorBehavior behavior;
764 @Override public void onReceive(Object message) throws Exception {
765 if(behavior != null) {
766 behavior.handleMessage(sender(), message);
769 super.onReceive(message);
772 public static Props props() {
773 return Props.create(ForwardMessageToBehaviorActor.class);
778 public void testLeaderCreatedWithCommitIndexLessThanLastIndex() throws Exception {
779 logStart("testLeaderCreatedWithCommitIndexLessThanLastIndex");
781 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
783 MockRaftActorContext followerActorContext = createActorContext(FOLLOWER_ID, followerActor);
785 Follower follower = new Follower(followerActorContext);
786 followerActor.underlyingActor().behavior = follower;
788 Map<String, String> peerAddresses = new HashMap<>();
789 peerAddresses.put(FOLLOWER_ID, followerActor.path().toString());
791 leaderActorContext.setPeerAddresses(peerAddresses);
793 leaderActorContext.getReplicatedLog().removeFrom(0);
796 leaderActorContext.setReplicatedLog(
797 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
799 leaderActorContext.setCommitIndex(1);
801 followerActorContext.getReplicatedLog().removeFrom(0);
803 // follower too has the exact same log entries and has the same commit index
804 followerActorContext.setReplicatedLog(
805 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
807 followerActorContext.setCommitIndex(1);
809 leader = new Leader(leaderActorContext);
811 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
813 assertEquals(1, appendEntries.getLeaderCommit());
814 assertEquals(0, appendEntries.getEntries().size());
815 assertEquals(0, appendEntries.getPrevLogIndex());
817 AppendEntriesReply appendEntriesReply = MessageCollectorActor.expectFirstMatching(
818 leaderActor, AppendEntriesReply.class);
820 assertEquals(2, appendEntriesReply.getLogLastIndex());
821 assertEquals(1, appendEntriesReply.getLogLastTerm());
823 // follower returns its next index
824 assertEquals(2, appendEntriesReply.getLogLastIndex());
825 assertEquals(1, appendEntriesReply.getLogLastTerm());
831 public void testLeaderCreatedWithCommitIndexLessThanFollowersCommitIndex() throws Exception {
832 logStart("testLeaderCreatedWithCommitIndexLessThanFollowersCommitIndex");
834 MockRaftActorContext leaderActorContext = createActorContext();
836 MockRaftActorContext followerActorContext = createActorContext(FOLLOWER_ID, followerActor);
838 Follower follower = new Follower(followerActorContext);
839 followerActor.underlyingActor().behavior = follower;
841 Map<String, String> peerAddresses = new HashMap<>();
842 peerAddresses.put(FOLLOWER_ID, followerActor.path().toString());
844 leaderActorContext.setPeerAddresses(peerAddresses);
846 leaderActorContext.getReplicatedLog().removeFrom(0);
848 leaderActorContext.setReplicatedLog(
849 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
851 leaderActorContext.setCommitIndex(1);
853 followerActorContext.getReplicatedLog().removeFrom(0);
855 followerActorContext.setReplicatedLog(
856 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
858 // follower has the same log entries but its commit index > leaders commit index
859 followerActorContext.setCommitIndex(2);
861 leader = new Leader(leaderActorContext);
864 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
866 assertEquals(1, appendEntries.getLeaderCommit());
867 assertEquals(0, appendEntries.getEntries().size());
868 assertEquals(0, appendEntries.getPrevLogIndex());
870 AppendEntriesReply appendEntriesReply = MessageCollectorActor.expectFirstMatching(
871 leaderActor, AppendEntriesReply.class);
873 assertEquals(2, appendEntriesReply.getLogLastIndex());
874 assertEquals(1, appendEntriesReply.getLogLastTerm());
876 leaderActor.underlyingActor().behavior = leader;
877 leader.handleMessage(followerActor, appendEntriesReply);
879 leaderActor.underlyingActor().clear();
880 followerActor.underlyingActor().clear();
882 Uninterruptibles.sleepUninterruptibly(leaderActorContext.getConfigParams().getHeartBeatInterval().toMillis(),
883 TimeUnit.MILLISECONDS);
885 leader.handleMessage(leaderActor, new SendHeartBeat());
887 appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
889 assertEquals(2, appendEntries.getLeaderCommit());
890 assertEquals(0, appendEntries.getEntries().size());
891 assertEquals(2, appendEntries.getPrevLogIndex());
893 appendEntriesReply = MessageCollectorActor.expectFirstMatching(leaderActor, AppendEntriesReply.class);
895 assertEquals(2, appendEntriesReply.getLogLastIndex());
896 assertEquals(1, appendEntriesReply.getLogLastTerm());
898 assertEquals(2, followerActorContext.getCommitIndex());
904 public void testHandleAppendEntriesReplyFailure(){
905 logStart("testHandleAppendEntriesReplyFailure");
907 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
909 leader = new Leader(leaderActorContext);
911 // Send initial heartbeat reply with last index.
912 leader.handleAppendEntriesReply(followerActor, new AppendEntriesReply(FOLLOWER_ID, 1, true, 10, 1));
914 FollowerLogInformation followerInfo = leader.getFollower(FOLLOWER_ID);
915 assertEquals("getNextIndex", 11, followerInfo.getNextIndex());
917 AppendEntriesReply reply = new AppendEntriesReply(FOLLOWER_ID, 1, false, 10, 1);
919 RaftActorBehavior raftActorBehavior = leader.handleAppendEntriesReply(followerActor, reply);
921 assertEquals(RaftState.Leader, raftActorBehavior.state());
923 assertEquals("getNextIndex", 10, followerInfo.getNextIndex());
927 public void testHandleAppendEntriesReplySuccess() throws Exception {
928 logStart("testHandleAppendEntriesReplySuccess");
930 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
932 leaderActorContext.setReplicatedLog(
933 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
935 leaderActorContext.setCommitIndex(1);
936 leaderActorContext.setLastApplied(1);
937 leaderActorContext.getTermInformation().update(1, "leader");
939 leader = new Leader(leaderActorContext);
941 AppendEntriesReply reply = new AppendEntriesReply(FOLLOWER_ID, 1, true, 2, 1);
943 RaftActorBehavior raftActorBehavior = leader.handleAppendEntriesReply(followerActor, reply);
945 assertEquals(RaftState.Leader, raftActorBehavior.state());
947 assertEquals(2, leaderActorContext.getCommitIndex());
949 ApplyLogEntries applyLogEntries = MessageCollectorActor.expectFirstMatching(
950 leaderActor, ApplyLogEntries.class);
952 assertEquals(2, leaderActorContext.getLastApplied());
954 assertEquals(2, applyLogEntries.getToIndex());
956 List<ApplyState> applyStateList = MessageCollectorActor.getAllMatching(leaderActor,
959 assertEquals(1,applyStateList.size());
961 ApplyState applyState = applyStateList.get(0);
963 assertEquals(2, applyState.getReplicatedLogEntry().getIndex());
967 public void testHandleAppendEntriesReplyUnknownFollower(){
968 logStart("testHandleAppendEntriesReplyUnknownFollower");
970 MockRaftActorContext leaderActorContext = createActorContext();
972 leader = new Leader(leaderActorContext);
974 AppendEntriesReply reply = new AppendEntriesReply("unkown-follower", 1, false, 10, 1);
976 RaftActorBehavior raftActorBehavior = leader.handleAppendEntriesReply(followerActor, reply);
978 assertEquals(RaftState.Leader, raftActorBehavior.state());
982 public void testHandleRequestVoteReply(){
983 logStart("testHandleRequestVoteReply");
985 MockRaftActorContext leaderActorContext = createActorContext();
987 leader = new Leader(leaderActorContext);
989 // Should be a no-op.
990 RaftActorBehavior raftActorBehavior = leader.handleRequestVoteReply(followerActor,
991 new RequestVoteReply(1, true));
993 assertEquals(RaftState.Leader, raftActorBehavior.state());
995 raftActorBehavior = leader.handleRequestVoteReply(followerActor, new RequestVoteReply(1, false));
997 assertEquals(RaftState.Leader, raftActorBehavior.state());
1001 public void testIsolatedLeaderCheckNoFollowers() {
1002 logStart("testIsolatedLeaderCheckNoFollowers");
1004 MockRaftActorContext leaderActorContext = createActorContext();
1006 leader = new Leader(leaderActorContext);
1007 RaftActorBehavior behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1008 Assert.assertTrue(behavior instanceof Leader);
1012 public void testIsolatedLeaderCheckTwoFollowers() throws Exception {
1013 logStart("testIsolatedLeaderCheckTwoFollowers");
1015 new JavaTestKit(getSystem()) {{
1017 ActorRef followerActor1 = getTestActor();
1018 ActorRef followerActor2 = getTestActor();
1020 MockRaftActorContext leaderActorContext = createActorContext();
1022 Map<String, String> peerAddresses = new HashMap<>();
1023 peerAddresses.put("follower-1", followerActor1.path().toString());
1024 peerAddresses.put("follower-2", followerActor2.path().toString());
1026 leaderActorContext.setPeerAddresses(peerAddresses);
1028 leader = new Leader(leaderActorContext);
1029 leader.stopIsolatedLeaderCheckSchedule();
1031 leader.markFollowerActive("follower-1");
1032 leader.markFollowerActive("follower-2");
1033 RaftActorBehavior behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1034 Assert.assertTrue("Behavior not instance of Leader when all followers are active",
1035 behavior instanceof Leader);
1037 // kill 1 follower and verify if that got killed
1038 final JavaTestKit probe = new JavaTestKit(getSystem());
1039 probe.watch(followerActor1);
1040 followerActor1.tell(PoisonPill.getInstance(), ActorRef.noSender());
1041 final Terminated termMsg1 = probe.expectMsgClass(Terminated.class);
1042 assertEquals(termMsg1.getActor(), followerActor1);
1044 leader.markFollowerInActive("follower-1");
1045 leader.markFollowerActive("follower-2");
1046 behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1047 Assert.assertTrue("Behavior not instance of Leader when majority of followers are active",
1048 behavior instanceof Leader);
1050 // kill 2nd follower and leader should change to Isolated leader
1051 followerActor2.tell(PoisonPill.getInstance(), null);
1052 probe.watch(followerActor2);
1053 followerActor2.tell(PoisonPill.getInstance(), ActorRef.noSender());
1054 final Terminated termMsg2 = probe.expectMsgClass(Terminated.class);
1055 assertEquals(termMsg2.getActor(), followerActor2);
1057 leader.markFollowerInActive("follower-2");
1058 behavior = leader.handleMessage(leaderActor, new IsolatedLeaderCheck());
1059 Assert.assertTrue("Behavior not instance of IsolatedLeader when majority followers are inactive",
1060 behavior instanceof IsolatedLeader);
1066 public void testAppendEntryCallAtEndofAppendEntryReply() throws Exception {
1067 logStart("testAppendEntryCallAtEndofAppendEntryReply");
1069 MockRaftActorContext leaderActorContext = createActorContextWithFollower();
1071 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
1072 //configParams.setHeartBeatInterval(new FiniteDuration(9, TimeUnit.SECONDS));
1073 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(10, TimeUnit.SECONDS));
1075 leaderActorContext.setConfigParams(configParams);
1077 MockRaftActorContext followerActorContext = createActorContext(FOLLOWER_ID, followerActor);
1079 followerActorContext.setConfigParams(configParams);
1081 Follower follower = new Follower(followerActorContext);
1082 followerActor.underlyingActor().behavior = follower;
1084 leaderActorContext.getReplicatedLog().removeFrom(0);
1085 leaderActorContext.setCommitIndex(-1);
1086 leaderActorContext.setLastApplied(-1);
1088 followerActorContext.getReplicatedLog().removeFrom(0);
1089 followerActorContext.setCommitIndex(-1);
1090 followerActorContext.setLastApplied(-1);
1092 leader = new Leader(leaderActorContext);
1094 AppendEntriesReply appendEntriesReply = MessageCollectorActor.expectFirstMatching(
1095 leaderActor, AppendEntriesReply.class);
1097 leader.handleMessage(followerActor, appendEntriesReply);
1099 // Clear initial heartbeat messages
1101 leaderActor.underlyingActor().clear();
1102 followerActor.underlyingActor().clear();
1105 leaderActorContext.setReplicatedLog(
1106 new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
1107 leaderActorContext.setCommitIndex(1);
1108 leaderActorContext.setLastApplied(1);
1110 Uninterruptibles.sleepUninterruptibly(leaderActorContext.getConfigParams().getHeartBeatInterval().toMillis(),
1111 TimeUnit.MILLISECONDS);
1113 leader.handleMessage(leaderActor, new SendHeartBeat());
1115 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1117 // Should send first log entry
1118 assertEquals(1, appendEntries.getLeaderCommit());
1119 assertEquals(0, appendEntries.getEntries().get(0).getIndex());
1120 assertEquals(-1, appendEntries.getPrevLogIndex());
1122 appendEntriesReply = MessageCollectorActor.expectFirstMatching(leaderActor, AppendEntriesReply.class);
1124 assertEquals(1, appendEntriesReply.getLogLastTerm());
1125 assertEquals(0, appendEntriesReply.getLogLastIndex());
1127 followerActor.underlyingActor().clear();
1129 leader.handleAppendEntriesReply(followerActor, appendEntriesReply);
1131 appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1133 // Should send second log entry
1134 assertEquals(1, appendEntries.getLeaderCommit());
1135 assertEquals(1, appendEntries.getEntries().get(0).getIndex());
1140 private class MockConfigParamsImpl extends DefaultConfigParamsImpl {
1142 private final long electionTimeOutIntervalMillis;
1143 private final int snapshotChunkSize;
1145 public MockConfigParamsImpl(long electionTimeOutIntervalMillis, int snapshotChunkSize) {
1147 this.electionTimeOutIntervalMillis = electionTimeOutIntervalMillis;
1148 this.snapshotChunkSize = snapshotChunkSize;
1152 public FiniteDuration getElectionTimeOutInterval() {
1153 return new FiniteDuration(electionTimeOutIntervalMillis, TimeUnit.MILLISECONDS);
1157 public int getSnapshotChunkSize() {
1158 return snapshotChunkSize;