1 package org.opendaylight.controller.cluster.raft;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertFalse;
5 import static org.junit.Assert.assertNotNull;
6 import static org.junit.Assert.assertNull;
7 import static org.mockito.Matchers.any;
8 import static org.mockito.Matchers.anyObject;
9 import static org.mockito.Matchers.eq;
10 import static org.mockito.Matchers.same;
11 import static org.mockito.Mockito.doReturn;
12 import static org.mockito.Mockito.mock;
13 import static org.mockito.Mockito.times;
14 import static org.mockito.Mockito.verify;
15 import akka.actor.ActorRef;
16 import akka.actor.PoisonPill;
17 import akka.actor.Props;
18 import akka.actor.Terminated;
19 import akka.japi.Procedure;
20 import akka.persistence.SaveSnapshotFailure;
21 import akka.persistence.SaveSnapshotSuccess;
22 import akka.persistence.SnapshotMetadata;
23 import akka.persistence.SnapshotOffer;
24 import akka.testkit.JavaTestKit;
25 import akka.testkit.TestActorRef;
26 import com.google.common.base.Optional;
27 import com.google.common.collect.ImmutableMap;
28 import com.google.common.util.concurrent.Uninterruptibles;
29 import com.google.protobuf.ByteString;
30 import java.io.ByteArrayOutputStream;
31 import java.io.ObjectOutputStream;
32 import java.util.ArrayList;
33 import java.util.Arrays;
34 import java.util.Collections;
35 import java.util.HashMap;
36 import java.util.List;
38 import java.util.concurrent.TimeUnit;
39 import org.junit.After;
40 import org.junit.Before;
41 import org.junit.Test;
42 import org.opendaylight.controller.cluster.DataPersistenceProvider;
43 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
44 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
45 import org.opendaylight.controller.cluster.notifications.RoleChanged;
46 import org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm;
47 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
48 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
49 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
50 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
51 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
52 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
53 import org.opendaylight.controller.cluster.raft.base.messages.DeleteEntries;
54 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
55 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
56 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
57 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
58 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
59 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
60 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
61 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
62 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
63 import scala.concurrent.duration.FiniteDuration;
65 public class RaftActorTest extends AbstractActorTest {
67 private TestActorFactory factory;
71 factory = new TestActorFactory(getSystem());
75 public void tearDown() throws Exception {
77 InMemoryJournal.clear();
78 InMemorySnapshotStore.clear();
82 public void testConstruction() {
83 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
87 public void testFindLeaderWhenLeaderIsSelf(){
88 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
89 kit.waitUntilLeader();
93 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
94 new JavaTestKit(getSystem()) {{
95 String persistenceId = factory.generateActorId("follower-");
97 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
99 // Set the heartbeat interval high to essentially disable election otherwise the test
100 // may fail if the actor is switched to Leader and the commitIndex is set to the last
102 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
104 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
105 ImmutableMap.<String, String>builder().put("member1", "address").build(),
106 Optional.<ConfigParams>of(config)), persistenceId);
108 watch(followerActor);
110 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
111 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
112 new MockRaftActorContext.MockPayload("E"));
113 snapshotUnappliedEntries.add(entry1);
115 int lastAppliedDuringSnapshotCapture = 3;
116 int lastIndexDuringSnapshotCapture = 4;
118 // 4 messages as part of snapshot, which are applied to state
119 ByteString snapshotBytes = fromObject(Arrays.asList(
120 new MockRaftActorContext.MockPayload("A"),
121 new MockRaftActorContext.MockPayload("B"),
122 new MockRaftActorContext.MockPayload("C"),
123 new MockRaftActorContext.MockPayload("D")));
125 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
126 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
127 lastAppliedDuringSnapshotCapture, 1);
128 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
130 // add more entries after snapshot is taken
131 List<ReplicatedLogEntry> entries = new ArrayList<>();
132 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
133 new MockRaftActorContext.MockPayload("F", 2));
134 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
135 new MockRaftActorContext.MockPayload("G", 3));
136 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
137 new MockRaftActorContext.MockPayload("H", 4));
142 int lastAppliedToState = 5;
145 InMemoryJournal.addEntry(persistenceId, 5, entry2);
146 // 2 entries are applied to state besides the 4 entries in snapshot
147 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
148 InMemoryJournal.addEntry(persistenceId, 7, entry3);
149 InMemoryJournal.addEntry(persistenceId, 8, entry4);
152 followerActor.tell(PoisonPill.getInstance(), null);
153 expectMsgClass(duration("5 seconds"), Terminated.class);
155 unwatch(followerActor);
157 //reinstate the actor
158 TestActorRef<MockRaftActor> ref = factory.createTestActor(
159 MockRaftActor.props(persistenceId, Collections.<String, String>emptyMap(),
160 Optional.<ConfigParams>of(config)));
162 MockRaftActor mockRaftActor = ref.underlyingActor();
164 mockRaftActor.waitForRecoveryComplete();
166 RaftActorContext context = mockRaftActor.getRaftActorContext();
167 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
168 context.getReplicatedLog().size());
169 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
170 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
171 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
172 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
173 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
175 mockRaftActor.waitForInitializeBehaviorComplete();
177 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
182 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
183 new JavaTestKit(getSystem()) {{
184 String persistenceId = factory.generateActorId("follower-");
186 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
188 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
190 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
191 ImmutableMap.<String, String>builder().put("member1", "address").build(),
192 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()), persistenceId);
194 MockRaftActor mockRaftActor = ref.underlyingActor();
196 mockRaftActor.waitForRecoveryComplete();
198 mockRaftActor.waitForInitializeBehaviorComplete();
200 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
205 public void testRaftActorForwardsToRaftActorRecoverySupport() {
206 String persistenceId = factory.generateActorId("leader-");
208 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
210 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
212 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
213 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config)), persistenceId);
215 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
217 // Wait for akka's recovery to complete so it doesn't interfere.
218 mockRaftActor.waitForRecoveryComplete();
220 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
221 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
223 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
224 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
225 mockRaftActor.handleRecover(snapshotOffer);
227 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
228 1, new MockRaftActorContext.MockPayload("1", 5));
229 mockRaftActor.handleRecover(logEntry);
231 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
232 mockRaftActor.handleRecover(applyJournalEntries);
234 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
235 mockRaftActor.handleRecover(applyLogEntries);
237 DeleteEntries deleteEntries = new DeleteEntries(1);
238 mockRaftActor.handleRecover(deleteEntries);
240 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
241 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
242 mockRaftActor.handleRecover(deprecatedDeleteEntries);
244 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
245 mockRaftActor.handleRecover(updateElectionTerm);
247 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer));
248 verify(mockSupport).handleRecoveryMessage(same(logEntry));
249 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries));
250 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries));
251 verify(mockSupport).handleRecoveryMessage(same(deleteEntries));
252 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries));
253 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm));
257 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
258 String persistenceId = factory.generateActorId("leader-");
260 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
262 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
264 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
266 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
267 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), mockSupport), persistenceId);
269 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
271 // Wait for akka's recovery to complete so it doesn't interfere.
272 mockRaftActor.waitForRecoveryComplete();
274 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
275 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot));
276 mockRaftActor.handleCommand(applySnapshot);
278 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1);
279 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot));
280 mockRaftActor.handleCommand(captureSnapshot);
282 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
283 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
284 mockRaftActor.handleCommand(captureSnapshotReply);
286 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
287 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
288 mockRaftActor.handleCommand(saveSnapshotSuccess);
290 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
291 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
292 mockRaftActor.handleCommand(saveSnapshotFailure);
294 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
295 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
297 verify(mockSupport).handleSnapshotMessage(same(applySnapshot));
298 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot));
299 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
300 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
301 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
302 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
306 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
307 new JavaTestKit(getSystem()) {
309 String persistenceId = factory.generateActorId("leader-");
311 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
313 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
315 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
317 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
318 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
320 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
322 mockRaftActor.waitForInitializeBehaviorComplete();
324 mockRaftActor.waitUntilLeader();
326 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
328 verify(dataPersistenceProvider, times(2)).persist(anyObject(), any(Procedure.class));
336 public void testApplyState() throws Exception {
338 new JavaTestKit(getSystem()) {
340 String persistenceId = factory.generateActorId("leader-");
342 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
344 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
346 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
348 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
349 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
351 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
353 mockRaftActor.waitForInitializeBehaviorComplete();
355 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
356 new MockRaftActorContext.MockPayload("F"));
358 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
360 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
367 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
368 new JavaTestKit(getSystem()) {{
369 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
370 Props.create(MessageCollectorActor.class));
371 MessageCollectorActor.waitUntilReady(notifierActor);
373 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
374 long heartBeatInterval = 100;
375 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
376 config.setElectionTimeoutFactor(20);
378 String persistenceId = factory.generateActorId("notifier-");
380 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
381 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), notifierActor,
382 new NonPersistentDataProvider()), persistenceId);
384 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
387 // check if the notifier got a role change from null to Follower
388 RoleChanged raftRoleChanged = matches.get(0);
389 assertEquals(persistenceId, raftRoleChanged.getMemberId());
390 assertNull(raftRoleChanged.getOldRole());
391 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
393 // check if the notifier got a role change from Follower to Candidate
394 raftRoleChanged = matches.get(1);
395 assertEquals(persistenceId, raftRoleChanged.getMemberId());
396 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
397 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
399 // check if the notifier got a role change from Candidate to Leader
400 raftRoleChanged = matches.get(2);
401 assertEquals(persistenceId, raftRoleChanged.getMemberId());
402 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
403 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
405 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
406 notifierActor, LeaderStateChanged.class);
408 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
410 notifierActor.underlyingActor().clear();
412 MockRaftActor raftActor = raftActorRef.underlyingActor();
413 final String newLeaderId = "new-leader";
414 Follower follower = new Follower(raftActor.getRaftActorContext()) {
416 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
417 leaderId = newLeaderId;
422 raftActor.changeCurrentBehavior(follower);
424 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
425 assertEquals(persistenceId, leaderStateChange.getMemberId());
426 assertEquals(null, leaderStateChange.getLeaderId());
428 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
429 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
430 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
432 notifierActor.underlyingActor().clear();
434 raftActor.handleCommand("any");
436 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
437 assertEquals(persistenceId, leaderStateChange.getMemberId());
438 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
443 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
444 new JavaTestKit(getSystem()) {{
445 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
446 MessageCollectorActor.waitUntilReady(notifierActor);
448 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
449 long heartBeatInterval = 100;
450 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
451 config.setElectionTimeoutFactor(1);
453 String persistenceId = factory.generateActorId("notifier-");
455 factory.createActor(MockRaftActor.props(persistenceId,
456 ImmutableMap.of("leader", "fake/path"), Optional.<ConfigParams>of(config), notifierActor), persistenceId);
458 List<RoleChanged> matches = null;
459 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
460 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
461 assertNotNull(matches);
462 if(matches.size() == 3) {
465 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
468 assertEquals(2, matches.size());
470 // check if the notifier got a role change from null to Follower
471 RoleChanged raftRoleChanged = matches.get(0);
472 assertEquals(persistenceId, raftRoleChanged.getMemberId());
473 assertNull(raftRoleChanged.getOldRole());
474 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
476 // check if the notifier got a role change from Follower to Candidate
477 raftRoleChanged = matches.get(1);
478 assertEquals(persistenceId, raftRoleChanged.getMemberId());
479 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
480 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
486 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
487 new JavaTestKit(getSystem()) {
489 String persistenceId = factory.generateActorId("leader-");
490 String follower1Id = factory.generateActorId("follower-");
492 ActorRef followerActor1 =
493 factory.createActor(Props.create(MessageCollectorActor.class));
495 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
496 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
497 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
499 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
501 Map<String, String> peerAddresses = new HashMap<>();
502 peerAddresses.put(follower1Id, followerActor1.path().toString());
504 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
505 MockRaftActor.props(persistenceId, peerAddresses,
506 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
508 MockRaftActor leaderActor = mockActorRef.underlyingActor();
510 leaderActor.getRaftActorContext().setCommitIndex(4);
511 leaderActor.getRaftActorContext().setLastApplied(4);
512 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
514 leaderActor.waitForInitializeBehaviorComplete();
516 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
518 Leader leader = new Leader(leaderActor.getRaftActorContext());
519 leaderActor.setCurrentBehavior(leader);
520 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
522 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
523 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
525 assertEquals(8, leaderActor.getReplicatedLog().size());
527 leaderActor.getRaftActorContext().getSnapshotManager()
528 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
529 new MockRaftActorContext.MockPayload("x")), 4);
531 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
533 assertEquals(8, leaderActor.getReplicatedLog().size());
535 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
536 //fake snapshot on index 5
537 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1));
539 assertEquals(8, leaderActor.getReplicatedLog().size());
541 //fake snapshot on index 6
542 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
543 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1));
544 assertEquals(8, leaderActor.getReplicatedLog().size());
546 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
548 assertEquals(8, leaderActor.getReplicatedLog().size());
550 ByteString snapshotBytes = fromObject(Arrays.asList(
551 new MockRaftActorContext.MockPayload("foo-0"),
552 new MockRaftActorContext.MockPayload("foo-1"),
553 new MockRaftActorContext.MockPayload("foo-2"),
554 new MockRaftActorContext.MockPayload("foo-3"),
555 new MockRaftActorContext.MockPayload("foo-4")));
557 leaderActor.getRaftActorContext().getSnapshotManager().persist(new NonPersistentDataProvider()
558 , snapshotBytes.toByteArray(), leader, Runtime.getRuntime().totalMemory());
560 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
562 // The commit is needed to complete the snapshot creation process
563 leaderActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
565 // capture snapshot reply should remove the snapshotted entries only
566 assertEquals(3, leaderActor.getReplicatedLog().size());
567 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
569 // add another non-replicated entry
570 leaderActor.getReplicatedLog().append(
571 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
573 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
574 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1));
575 assertEquals(2, leaderActor.getReplicatedLog().size());
576 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
583 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
584 new JavaTestKit(getSystem()) {
586 String persistenceId = factory.generateActorId("follower-");
587 String leaderId = factory.generateActorId("leader-");
590 ActorRef leaderActor1 =
591 factory.createActor(Props.create(MessageCollectorActor.class));
593 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
594 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
595 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
597 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
599 Map<String, String> peerAddresses = new HashMap<>();
600 peerAddresses.put(leaderId, leaderActor1.path().toString());
602 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
603 MockRaftActor.props(persistenceId, peerAddresses,
604 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
606 MockRaftActor followerActor = mockActorRef.underlyingActor();
607 followerActor.getRaftActorContext().setCommitIndex(4);
608 followerActor.getRaftActorContext().setLastApplied(4);
609 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
611 followerActor.waitForInitializeBehaviorComplete();
614 Follower follower = new Follower(followerActor.getRaftActorContext());
615 followerActor.setCurrentBehavior(follower);
616 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
618 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
619 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
620 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
622 // log has indices 0-5
623 assertEquals(6, followerActor.getReplicatedLog().size());
626 followerActor.getRaftActorContext().getSnapshotManager().capture(
627 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
628 new MockRaftActorContext.MockPayload("D")), 4);
630 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
632 assertEquals(6, followerActor.getReplicatedLog().size());
634 //fake snapshot on index 6
635 List<ReplicatedLogEntry> entries =
637 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
638 new MockRaftActorContext.MockPayload("foo-6"))
640 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5));
641 assertEquals(7, followerActor.getReplicatedLog().size());
643 //fake snapshot on index 7
644 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
648 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
649 new MockRaftActorContext.MockPayload("foo-7"))
651 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6));
652 assertEquals(8, followerActor.getReplicatedLog().size());
654 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
657 ByteString snapshotBytes = fromObject(Arrays.asList(
658 new MockRaftActorContext.MockPayload("foo-0"),
659 new MockRaftActorContext.MockPayload("foo-1"),
660 new MockRaftActorContext.MockPayload("foo-2"),
661 new MockRaftActorContext.MockPayload("foo-3"),
662 new MockRaftActorContext.MockPayload("foo-4")));
663 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
664 assertFalse(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
666 // The commit is needed to complete the snapshot creation process
667 followerActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
669 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
670 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
671 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
675 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
676 new MockRaftActorContext.MockPayload("foo-7"))
678 // send an additional entry 8 with leaderCommit = 7
679 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7));
681 // 7 and 8, as lastapplied is 7
682 assertEquals(2, followerActor.getReplicatedLog().size());
689 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
690 new JavaTestKit(getSystem()) {
692 String persistenceId = factory.generateActorId("leader-");
693 String follower1Id = factory.generateActorId("follower-");
694 String follower2Id = factory.generateActorId("follower-");
696 ActorRef followerActor1 =
697 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
698 ActorRef followerActor2 =
699 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
701 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
702 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
703 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
705 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
707 Map<String, String> peerAddresses = new HashMap<>();
708 peerAddresses.put(follower1Id, followerActor1.path().toString());
709 peerAddresses.put(follower2Id, followerActor2.path().toString());
711 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
712 MockRaftActor.props(persistenceId, peerAddresses,
713 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
715 MockRaftActor leaderActor = mockActorRef.underlyingActor();
716 leaderActor.getRaftActorContext().setCommitIndex(9);
717 leaderActor.getRaftActorContext().setLastApplied(9);
718 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
720 leaderActor.waitForInitializeBehaviorComplete();
722 Leader leader = new Leader(leaderActor.getRaftActorContext());
723 leaderActor.setCurrentBehavior(leader);
724 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
726 // create 5 entries in the log
727 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
728 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
730 //set the snapshot index to 4 , 0 to 4 are snapshotted
731 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
732 //setting replicatedToAllIndex = 9, for the log to clear
733 leader.setReplicatedToAllIndex(9);
734 assertEquals(5, leaderActor.getReplicatedLog().size());
735 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
737 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1));
738 assertEquals(5, leaderActor.getReplicatedLog().size());
739 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
741 // set the 2nd follower nextIndex to 1 which has been snapshotted
742 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1));
743 assertEquals(5, leaderActor.getReplicatedLog().size());
744 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
746 // simulate a real snapshot
747 leaderActor.onReceiveCommand(new SendHeartBeat());
748 assertEquals(5, leaderActor.getReplicatedLog().size());
749 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
750 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
751 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
754 //reply from a slow follower does not initiate a fake snapshot
755 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1));
756 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
758 ByteString snapshotBytes = fromObject(Arrays.asList(
759 new MockRaftActorContext.MockPayload("foo-0"),
760 new MockRaftActorContext.MockPayload("foo-1"),
761 new MockRaftActorContext.MockPayload("foo-2"),
762 new MockRaftActorContext.MockPayload("foo-3"),
763 new MockRaftActorContext.MockPayload("foo-4")));
764 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
765 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
767 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
769 //reply from a slow follower after should not raise errors
770 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1));
771 assertEquals(0, leaderActor.getReplicatedLog().size());
777 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
778 new JavaTestKit(getSystem()) {{
779 String persistenceId = factory.generateActorId("leader-");
780 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
781 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
782 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
783 config.setSnapshotBatchCount(5);
785 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
787 Map<String, String> peerAddresses = new HashMap<>();
789 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
790 MockRaftActor.props(persistenceId, peerAddresses,
791 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
793 MockRaftActor leaderActor = mockActorRef.underlyingActor();
794 leaderActor.getRaftActorContext().setCommitIndex(3);
795 leaderActor.getRaftActorContext().setLastApplied(3);
796 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
798 leaderActor.waitForInitializeBehaviorComplete();
799 for(int i=0;i< 4;i++) {
800 leaderActor.getReplicatedLog()
801 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
802 new MockRaftActorContext.MockPayload("A")));
805 Leader leader = new Leader(leaderActor.getRaftActorContext());
806 leaderActor.setCurrentBehavior(leader);
807 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
809 // Persist another entry (this will cause a CaptureSnapshot to be triggered
810 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
812 // Now send a CaptureSnapshotReply
813 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
815 // Trimming log in this scenario is a no-op
816 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
817 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
818 assertEquals(-1, leader.getReplicatedToAllIndex());
824 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
825 new JavaTestKit(getSystem()) {{
826 String persistenceId = factory.generateActorId("leader-");
827 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
828 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
829 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
830 config.setSnapshotBatchCount(5);
832 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
834 Map<String, String> peerAddresses = new HashMap<>();
836 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
837 MockRaftActor.props(persistenceId, peerAddresses,
838 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
840 MockRaftActor leaderActor = mockActorRef.underlyingActor();
841 leaderActor.getRaftActorContext().setCommitIndex(3);
842 leaderActor.getRaftActorContext().setLastApplied(3);
843 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
844 leaderActor.getReplicatedLog().setSnapshotIndex(3);
846 leaderActor.waitForInitializeBehaviorComplete();
847 Leader leader = new Leader(leaderActor.getRaftActorContext());
848 leaderActor.setCurrentBehavior(leader);
849 leader.setReplicatedToAllIndex(3);
850 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
852 // Persist another entry (this will cause a CaptureSnapshot to be triggered
853 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
855 // Now send a CaptureSnapshotReply
856 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
858 // Trimming log in this scenario is a no-op
859 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
860 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
861 assertEquals(3, leader.getReplicatedToAllIndex());
866 private ByteString fromObject(Object snapshot) throws Exception {
867 ByteArrayOutputStream b = null;
868 ObjectOutputStream o = null;
870 b = new ByteArrayOutputStream();
871 o = new ObjectOutputStream(b);
872 o.writeObject(snapshot);
873 byte[] snapshotBytes = b.toByteArray();
874 return ByteString.copyFrom(snapshotBytes);