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 org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
65 import scala.concurrent.duration.FiniteDuration;
67 public class RaftActorTest extends AbstractActorTest {
69 static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
71 private TestActorFactory factory;
75 factory = new TestActorFactory(getSystem());
79 public void tearDown() throws Exception {
81 InMemoryJournal.clear();
82 InMemorySnapshotStore.clear();
86 public void testConstruction() {
87 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
91 public void testFindLeaderWhenLeaderIsSelf(){
92 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
93 kit.waitUntilLeader();
97 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
98 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
100 new JavaTestKit(getSystem()) {{
101 String persistenceId = factory.generateActorId("follower-");
103 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
105 // Set the heartbeat interval high to essentially disable election otherwise the test
106 // may fail if the actor is switched to Leader and the commitIndex is set to the last
108 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
110 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
111 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
112 peerAddresses, Optional.<ConfigParams>of(config)), persistenceId);
114 watch(followerActor);
116 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
117 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
118 new MockRaftActorContext.MockPayload("E"));
119 snapshotUnappliedEntries.add(entry1);
121 int lastAppliedDuringSnapshotCapture = 3;
122 int lastIndexDuringSnapshotCapture = 4;
124 // 4 messages as part of snapshot, which are applied to state
125 ByteString snapshotBytes = fromObject(Arrays.asList(
126 new MockRaftActorContext.MockPayload("A"),
127 new MockRaftActorContext.MockPayload("B"),
128 new MockRaftActorContext.MockPayload("C"),
129 new MockRaftActorContext.MockPayload("D")));
131 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
132 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
133 lastAppliedDuringSnapshotCapture, 1);
134 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
136 // add more entries after snapshot is taken
137 List<ReplicatedLogEntry> entries = new ArrayList<>();
138 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
139 new MockRaftActorContext.MockPayload("F", 2));
140 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
141 new MockRaftActorContext.MockPayload("G", 3));
142 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
143 new MockRaftActorContext.MockPayload("H", 4));
148 int lastAppliedToState = 5;
151 InMemoryJournal.addEntry(persistenceId, 5, entry2);
152 // 2 entries are applied to state besides the 4 entries in snapshot
153 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
154 InMemoryJournal.addEntry(persistenceId, 7, entry3);
155 InMemoryJournal.addEntry(persistenceId, 8, entry4);
158 followerActor.tell(PoisonPill.getInstance(), null);
159 expectMsgClass(duration("5 seconds"), Terminated.class);
161 unwatch(followerActor);
163 //reinstate the actor
164 TestActorRef<MockRaftActor> ref = factory.createTestActor(
165 MockRaftActor.props(persistenceId, peerAddresses, Optional.<ConfigParams>of(config)));
167 MockRaftActor mockRaftActor = ref.underlyingActor();
169 mockRaftActor.waitForRecoveryComplete();
171 RaftActorContext context = mockRaftActor.getRaftActorContext();
172 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
173 context.getReplicatedLog().size());
174 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
175 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
176 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
177 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
178 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
180 mockRaftActor.waitForInitializeBehaviorComplete();
182 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
185 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
189 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
190 new JavaTestKit(getSystem()) {{
191 String persistenceId = factory.generateActorId("follower-");
193 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
195 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
197 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
198 ImmutableMap.<String, String>builder().put("member1", "address").build(),
199 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()), persistenceId);
201 MockRaftActor mockRaftActor = ref.underlyingActor();
203 mockRaftActor.waitForRecoveryComplete();
205 mockRaftActor.waitForInitializeBehaviorComplete();
207 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
212 public void testRaftActorForwardsToRaftActorRecoverySupport() {
213 String persistenceId = factory.generateActorId("leader-");
215 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
217 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
219 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
220 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config)), persistenceId);
222 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
224 // Wait for akka's recovery to complete so it doesn't interfere.
225 mockRaftActor.waitForRecoveryComplete();
227 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
228 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
230 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
231 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
232 mockRaftActor.handleRecover(snapshotOffer);
234 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
235 1, new MockRaftActorContext.MockPayload("1", 5));
236 mockRaftActor.handleRecover(logEntry);
238 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
239 mockRaftActor.handleRecover(applyJournalEntries);
241 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
242 mockRaftActor.handleRecover(applyLogEntries);
244 DeleteEntries deleteEntries = new DeleteEntries(1);
245 mockRaftActor.handleRecover(deleteEntries);
247 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
248 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
249 mockRaftActor.handleRecover(deprecatedDeleteEntries);
251 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
252 mockRaftActor.handleRecover(updateElectionTerm);
254 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer));
255 verify(mockSupport).handleRecoveryMessage(same(logEntry));
256 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries));
257 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries));
258 verify(mockSupport).handleRecoveryMessage(same(deleteEntries));
259 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries));
260 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm));
264 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
265 String persistenceId = factory.generateActorId("leader-");
267 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
269 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
271 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
273 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
274 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), mockSupport), persistenceId);
276 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
278 // Wait for akka's recovery to complete so it doesn't interfere.
279 mockRaftActor.waitForRecoveryComplete();
281 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
282 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot));
283 mockRaftActor.handleCommand(applySnapshot);
285 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1, null);
286 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot));
287 mockRaftActor.handleCommand(captureSnapshot);
289 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
290 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
291 mockRaftActor.handleCommand(captureSnapshotReply);
293 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
294 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
295 mockRaftActor.handleCommand(saveSnapshotSuccess);
297 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
298 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
299 mockRaftActor.handleCommand(saveSnapshotFailure);
301 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
302 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
304 verify(mockSupport).handleSnapshotMessage(same(applySnapshot));
305 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot));
306 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
307 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
308 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
309 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
313 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
314 new JavaTestKit(getSystem()) {
316 String persistenceId = factory.generateActorId("leader-");
318 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
320 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
322 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
324 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
325 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
327 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
329 mockRaftActor.waitForInitializeBehaviorComplete();
331 mockRaftActor.waitUntilLeader();
333 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
335 verify(dataPersistenceProvider, times(2)).persist(anyObject(), any(Procedure.class));
343 public void testApplyState() throws Exception {
345 new JavaTestKit(getSystem()) {
347 String persistenceId = factory.generateActorId("leader-");
349 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
351 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
353 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
355 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
356 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
358 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
360 mockRaftActor.waitForInitializeBehaviorComplete();
362 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
363 new MockRaftActorContext.MockPayload("F"));
365 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
367 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
374 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
375 new JavaTestKit(getSystem()) {{
376 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
377 Props.create(MessageCollectorActor.class));
378 MessageCollectorActor.waitUntilReady(notifierActor);
380 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
381 long heartBeatInterval = 100;
382 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
383 config.setElectionTimeoutFactor(20);
385 String persistenceId = factory.generateActorId("notifier-");
387 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
388 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), notifierActor,
389 new NonPersistentDataProvider()), persistenceId);
391 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
394 // check if the notifier got a role change from null to Follower
395 RoleChanged raftRoleChanged = matches.get(0);
396 assertEquals(persistenceId, raftRoleChanged.getMemberId());
397 assertNull(raftRoleChanged.getOldRole());
398 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
400 // check if the notifier got a role change from Follower to Candidate
401 raftRoleChanged = matches.get(1);
402 assertEquals(persistenceId, raftRoleChanged.getMemberId());
403 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
404 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
406 // check if the notifier got a role change from Candidate to Leader
407 raftRoleChanged = matches.get(2);
408 assertEquals(persistenceId, raftRoleChanged.getMemberId());
409 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
410 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
412 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
413 notifierActor, LeaderStateChanged.class);
415 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
417 notifierActor.underlyingActor().clear();
419 MockRaftActor raftActor = raftActorRef.underlyingActor();
420 final String newLeaderId = "new-leader";
421 Follower follower = new Follower(raftActor.getRaftActorContext()) {
423 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
424 leaderId = newLeaderId;
429 raftActor.changeCurrentBehavior(follower);
431 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
432 assertEquals(persistenceId, leaderStateChange.getMemberId());
433 assertEquals(null, leaderStateChange.getLeaderId());
435 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
436 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
437 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
439 notifierActor.underlyingActor().clear();
441 raftActor.handleCommand("any");
443 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
444 assertEquals(persistenceId, leaderStateChange.getMemberId());
445 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
450 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
451 new JavaTestKit(getSystem()) {{
452 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
453 MessageCollectorActor.waitUntilReady(notifierActor);
455 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
456 long heartBeatInterval = 100;
457 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
458 config.setElectionTimeoutFactor(1);
460 String persistenceId = factory.generateActorId("notifier-");
462 factory.createActor(MockRaftActor.props(persistenceId,
463 ImmutableMap.of("leader", "fake/path"), Optional.<ConfigParams>of(config), notifierActor), persistenceId);
465 List<RoleChanged> matches = null;
466 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
467 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
468 assertNotNull(matches);
469 if(matches.size() == 3) {
472 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
475 assertEquals(2, matches.size());
477 // check if the notifier got a role change from null to Follower
478 RoleChanged raftRoleChanged = matches.get(0);
479 assertEquals(persistenceId, raftRoleChanged.getMemberId());
480 assertNull(raftRoleChanged.getOldRole());
481 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
483 // check if the notifier got a role change from Follower to Candidate
484 raftRoleChanged = matches.get(1);
485 assertEquals(persistenceId, raftRoleChanged.getMemberId());
486 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
487 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
493 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
494 new JavaTestKit(getSystem()) {
496 String persistenceId = factory.generateActorId("leader-");
497 String follower1Id = factory.generateActorId("follower-");
499 ActorRef followerActor1 =
500 factory.createActor(Props.create(MessageCollectorActor.class));
502 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
503 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
504 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
506 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
508 Map<String, String> peerAddresses = new HashMap<>();
509 peerAddresses.put(follower1Id, followerActor1.path().toString());
511 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
512 MockRaftActor.props(persistenceId, peerAddresses,
513 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
515 MockRaftActor leaderActor = mockActorRef.underlyingActor();
517 leaderActor.getRaftActorContext().setCommitIndex(4);
518 leaderActor.getRaftActorContext().setLastApplied(4);
519 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
521 leaderActor.waitForInitializeBehaviorComplete();
523 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
525 Leader leader = new Leader(leaderActor.getRaftActorContext());
526 leaderActor.setCurrentBehavior(leader);
527 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
529 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
530 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
532 assertEquals(8, leaderActor.getReplicatedLog().size());
534 leaderActor.getRaftActorContext().getSnapshotManager()
535 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
536 new MockRaftActorContext.MockPayload("x")), 4);
538 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
540 assertEquals(8, leaderActor.getReplicatedLog().size());
542 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
543 //fake snapshot on index 5
544 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1));
546 assertEquals(8, leaderActor.getReplicatedLog().size());
548 //fake snapshot on index 6
549 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
550 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1));
551 assertEquals(8, leaderActor.getReplicatedLog().size());
553 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
555 assertEquals(8, leaderActor.getReplicatedLog().size());
557 ByteString snapshotBytes = fromObject(Arrays.asList(
558 new MockRaftActorContext.MockPayload("foo-0"),
559 new MockRaftActorContext.MockPayload("foo-1"),
560 new MockRaftActorContext.MockPayload("foo-2"),
561 new MockRaftActorContext.MockPayload("foo-3"),
562 new MockRaftActorContext.MockPayload("foo-4")));
564 leaderActor.getRaftActorContext().getSnapshotManager().persist(new NonPersistentDataProvider()
565 , snapshotBytes.toByteArray(), leader, Runtime.getRuntime().totalMemory());
567 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
569 // The commit is needed to complete the snapshot creation process
570 leaderActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
572 // capture snapshot reply should remove the snapshotted entries only
573 assertEquals(3, leaderActor.getReplicatedLog().size());
574 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
576 // add another non-replicated entry
577 leaderActor.getReplicatedLog().append(
578 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
580 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
581 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1));
582 assertEquals(2, leaderActor.getReplicatedLog().size());
583 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
590 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
591 new JavaTestKit(getSystem()) {
593 String persistenceId = factory.generateActorId("follower-");
594 String leaderId = factory.generateActorId("leader-");
597 ActorRef leaderActor1 =
598 factory.createActor(Props.create(MessageCollectorActor.class));
600 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
601 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
602 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
604 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
606 Map<String, String> peerAddresses = new HashMap<>();
607 peerAddresses.put(leaderId, leaderActor1.path().toString());
609 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
610 MockRaftActor.props(persistenceId, peerAddresses,
611 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
613 MockRaftActor followerActor = mockActorRef.underlyingActor();
614 followerActor.getRaftActorContext().setCommitIndex(4);
615 followerActor.getRaftActorContext().setLastApplied(4);
616 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
618 followerActor.waitForInitializeBehaviorComplete();
621 Follower follower = new Follower(followerActor.getRaftActorContext());
622 followerActor.setCurrentBehavior(follower);
623 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
625 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
626 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
627 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
629 // log has indices 0-5
630 assertEquals(6, followerActor.getReplicatedLog().size());
633 followerActor.getRaftActorContext().getSnapshotManager().capture(
634 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
635 new MockRaftActorContext.MockPayload("D")), 4);
637 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
639 assertEquals(6, followerActor.getReplicatedLog().size());
641 //fake snapshot on index 6
642 List<ReplicatedLogEntry> entries =
644 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
645 new MockRaftActorContext.MockPayload("foo-6"))
647 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5));
648 assertEquals(7, followerActor.getReplicatedLog().size());
650 //fake snapshot on index 7
651 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
655 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
656 new MockRaftActorContext.MockPayload("foo-7"))
658 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6));
659 assertEquals(8, followerActor.getReplicatedLog().size());
661 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
664 ByteString snapshotBytes = fromObject(Arrays.asList(
665 new MockRaftActorContext.MockPayload("foo-0"),
666 new MockRaftActorContext.MockPayload("foo-1"),
667 new MockRaftActorContext.MockPayload("foo-2"),
668 new MockRaftActorContext.MockPayload("foo-3"),
669 new MockRaftActorContext.MockPayload("foo-4")));
670 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
671 assertFalse(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
673 // The commit is needed to complete the snapshot creation process
674 followerActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
676 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
677 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
678 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
682 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
683 new MockRaftActorContext.MockPayload("foo-7"))
685 // send an additional entry 8 with leaderCommit = 7
686 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7));
688 // 7 and 8, as lastapplied is 7
689 assertEquals(2, followerActor.getReplicatedLog().size());
696 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
697 new JavaTestKit(getSystem()) {
699 String persistenceId = factory.generateActorId("leader-");
700 String follower1Id = factory.generateActorId("follower-");
701 String follower2Id = factory.generateActorId("follower-");
703 ActorRef followerActor1 =
704 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
705 ActorRef followerActor2 =
706 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
708 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
709 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
710 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
712 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
714 Map<String, String> peerAddresses = new HashMap<>();
715 peerAddresses.put(follower1Id, followerActor1.path().toString());
716 peerAddresses.put(follower2Id, followerActor2.path().toString());
718 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
719 MockRaftActor.props(persistenceId, peerAddresses,
720 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
722 MockRaftActor leaderActor = mockActorRef.underlyingActor();
723 leaderActor.getRaftActorContext().setCommitIndex(9);
724 leaderActor.getRaftActorContext().setLastApplied(9);
725 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
727 leaderActor.waitForInitializeBehaviorComplete();
729 Leader leader = new Leader(leaderActor.getRaftActorContext());
730 leaderActor.setCurrentBehavior(leader);
731 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
733 // create 5 entries in the log
734 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
735 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
737 //set the snapshot index to 4 , 0 to 4 are snapshotted
738 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
739 //setting replicatedToAllIndex = 9, for the log to clear
740 leader.setReplicatedToAllIndex(9);
741 assertEquals(5, leaderActor.getReplicatedLog().size());
742 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
744 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1));
745 assertEquals(5, leaderActor.getReplicatedLog().size());
746 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
748 // set the 2nd follower nextIndex to 1 which has been snapshotted
749 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1));
750 assertEquals(5, leaderActor.getReplicatedLog().size());
751 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
753 // simulate a real snapshot
754 leaderActor.onReceiveCommand(new SendHeartBeat());
755 assertEquals(5, leaderActor.getReplicatedLog().size());
756 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
757 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
758 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
761 //reply from a slow follower does not initiate a fake snapshot
762 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1));
763 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
765 ByteString snapshotBytes = fromObject(Arrays.asList(
766 new MockRaftActorContext.MockPayload("foo-0"),
767 new MockRaftActorContext.MockPayload("foo-1"),
768 new MockRaftActorContext.MockPayload("foo-2"),
769 new MockRaftActorContext.MockPayload("foo-3"),
770 new MockRaftActorContext.MockPayload("foo-4")));
771 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
772 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
774 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
776 //reply from a slow follower after should not raise errors
777 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1));
778 assertEquals(0, leaderActor.getReplicatedLog().size());
784 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
785 new JavaTestKit(getSystem()) {{
786 String persistenceId = factory.generateActorId("leader-");
787 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
788 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
789 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
790 config.setSnapshotBatchCount(5);
792 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
794 Map<String, String> peerAddresses = new HashMap<>();
796 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
797 MockRaftActor.props(persistenceId, peerAddresses,
798 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
800 MockRaftActor leaderActor = mockActorRef.underlyingActor();
801 leaderActor.getRaftActorContext().setCommitIndex(3);
802 leaderActor.getRaftActorContext().setLastApplied(3);
803 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
805 leaderActor.waitForInitializeBehaviorComplete();
806 for(int i=0;i< 4;i++) {
807 leaderActor.getReplicatedLog()
808 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
809 new MockRaftActorContext.MockPayload("A")));
812 Leader leader = new Leader(leaderActor.getRaftActorContext());
813 leaderActor.setCurrentBehavior(leader);
814 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
816 // Persist another entry (this will cause a CaptureSnapshot to be triggered
817 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
819 // Now send a CaptureSnapshotReply
820 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
822 // Trimming log in this scenario is a no-op
823 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
824 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
825 assertEquals(-1, leader.getReplicatedToAllIndex());
831 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
832 new JavaTestKit(getSystem()) {{
833 String persistenceId = factory.generateActorId("leader-");
834 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
835 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
836 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
837 config.setSnapshotBatchCount(5);
839 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
841 Map<String, String> peerAddresses = new HashMap<>();
843 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
844 MockRaftActor.props(persistenceId, peerAddresses,
845 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
847 MockRaftActor leaderActor = mockActorRef.underlyingActor();
848 leaderActor.getRaftActorContext().setCommitIndex(3);
849 leaderActor.getRaftActorContext().setLastApplied(3);
850 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
851 leaderActor.getReplicatedLog().setSnapshotIndex(3);
853 leaderActor.waitForInitializeBehaviorComplete();
854 Leader leader = new Leader(leaderActor.getRaftActorContext());
855 leaderActor.setCurrentBehavior(leader);
856 leader.setReplicatedToAllIndex(3);
857 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
859 // Persist another entry (this will cause a CaptureSnapshot to be triggered
860 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
862 // Now send a CaptureSnapshotReply
863 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
865 // Trimming log in this scenario is a no-op
866 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
867 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
868 assertEquals(3, leader.getReplicatedToAllIndex());
873 public static ByteString fromObject(Object snapshot) throws Exception {
874 ByteArrayOutputStream b = null;
875 ObjectOutputStream o = null;
877 b = new ByteArrayOutputStream();
878 o = new ObjectOutputStream(b);
879 o.writeObject(snapshot);
880 byte[] snapshotBytes = b.toByteArray();
881 return ByteString.copyFrom(snapshotBytes);