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.CountDownLatch;
39 import java.util.concurrent.TimeUnit;
40 import org.junit.After;
41 import org.junit.Before;
42 import org.junit.Test;
43 import org.opendaylight.controller.cluster.DataPersistenceProvider;
44 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
45 import org.opendaylight.controller.cluster.datastore.DataPersistenceProviderMonitor;
46 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
47 import org.opendaylight.controller.cluster.notifications.RoleChanged;
48 import org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries;
49 import org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm;
50 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
51 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
52 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
53 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
54 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
55 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
56 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
57 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
58 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
59 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
60 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
61 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
62 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
63 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
64 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
65 import scala.concurrent.duration.FiniteDuration;
67 public class RaftActorTest extends AbstractActorTest {
69 private TestActorFactory factory;
73 factory = new TestActorFactory(getSystem());
77 public void tearDown() throws Exception {
79 InMemoryJournal.clear();
80 InMemorySnapshotStore.clear();
84 public void testConstruction() {
85 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
89 public void testFindLeaderWhenLeaderIsSelf(){
90 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
91 kit.waitUntilLeader();
95 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
96 new JavaTestKit(getSystem()) {{
97 String persistenceId = factory.generateActorId("follower-");
99 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
101 // Set the heartbeat interval high to essentially disable election otherwise the test
102 // may fail if the actor is switched to Leader and the commitIndex is set to the last
104 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
106 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
107 ImmutableMap.<String, String>builder().put("member1", "address").build(),
108 Optional.<ConfigParams>of(config)), persistenceId);
110 watch(followerActor);
112 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
113 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
114 new MockRaftActorContext.MockPayload("E"));
115 snapshotUnappliedEntries.add(entry1);
117 int lastAppliedDuringSnapshotCapture = 3;
118 int lastIndexDuringSnapshotCapture = 4;
120 // 4 messages as part of snapshot, which are applied to state
121 ByteString snapshotBytes = fromObject(Arrays.asList(
122 new MockRaftActorContext.MockPayload("A"),
123 new MockRaftActorContext.MockPayload("B"),
124 new MockRaftActorContext.MockPayload("C"),
125 new MockRaftActorContext.MockPayload("D")));
127 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
128 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
129 lastAppliedDuringSnapshotCapture, 1);
130 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
132 // add more entries after snapshot is taken
133 List<ReplicatedLogEntry> entries = new ArrayList<>();
134 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
135 new MockRaftActorContext.MockPayload("F", 2));
136 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
137 new MockRaftActorContext.MockPayload("G", 3));
138 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
139 new MockRaftActorContext.MockPayload("H", 4));
144 int lastAppliedToState = 5;
147 InMemoryJournal.addEntry(persistenceId, 5, entry2);
148 // 2 entries are applied to state besides the 4 entries in snapshot
149 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
150 InMemoryJournal.addEntry(persistenceId, 7, entry3);
151 InMemoryJournal.addEntry(persistenceId, 8, entry4);
154 followerActor.tell(PoisonPill.getInstance(), null);
155 expectMsgClass(duration("5 seconds"), Terminated.class);
157 unwatch(followerActor);
159 //reinstate the actor
160 TestActorRef<MockRaftActor> ref = factory.createTestActor(
161 MockRaftActor.props(persistenceId, Collections.<String, String>emptyMap(),
162 Optional.<ConfigParams>of(config)));
164 MockRaftActor mockRaftActor = ref.underlyingActor();
166 mockRaftActor.waitForRecoveryComplete();
168 RaftActorContext context = mockRaftActor.getRaftActorContext();
169 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
170 context.getReplicatedLog().size());
171 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
172 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
173 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
174 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
175 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
177 mockRaftActor.waitForInitializeBehaviorComplete();
179 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
184 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
185 new JavaTestKit(getSystem()) {{
186 String persistenceId = factory.generateActorId("follower-");
188 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
190 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
192 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
193 ImmutableMap.<String, String>builder().put("member1", "address").build(),
194 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()), persistenceId);
196 MockRaftActor mockRaftActor = ref.underlyingActor();
198 mockRaftActor.waitForRecoveryComplete();
200 mockRaftActor.waitForInitializeBehaviorComplete();
202 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
207 public void testRaftActorForwardsToRaftActorRecoverySupport() {
208 String persistenceId = factory.generateActorId("leader-");
210 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
212 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
214 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
215 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config)), persistenceId);
217 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
219 // Wait for akka's recovery to complete so it doesn't interfere.
220 mockRaftActor.waitForRecoveryComplete();
222 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
223 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
225 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
226 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
227 mockRaftActor.handleRecover(snapshotOffer);
229 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
230 1, new MockRaftActorContext.MockPayload("1", 5));
231 mockRaftActor.handleRecover(logEntry);
233 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
234 mockRaftActor.handleRecover(applyJournalEntries);
236 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
237 mockRaftActor.handleRecover(applyLogEntries);
239 DeleteEntries deleteEntries = new DeleteEntries(1);
240 mockRaftActor.handleRecover(deleteEntries);
242 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
243 mockRaftActor.handleRecover(updateElectionTerm);
245 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer));
246 verify(mockSupport).handleRecoveryMessage(same(logEntry));
247 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries));
248 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries));
249 verify(mockSupport).handleRecoveryMessage(same(deleteEntries));
250 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm));
254 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
255 String persistenceId = factory.generateActorId("leader-");
257 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
259 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
261 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
263 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
264 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), mockSupport), persistenceId);
266 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
268 // Wait for akka's recovery to complete so it doesn't interfere.
269 mockRaftActor.waitForRecoveryComplete();
271 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
272 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot));
273 mockRaftActor.handleCommand(applySnapshot);
275 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1);
276 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot));
277 mockRaftActor.handleCommand(captureSnapshot);
279 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
280 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
281 mockRaftActor.handleCommand(captureSnapshotReply);
283 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
284 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
285 mockRaftActor.handleCommand(saveSnapshotSuccess);
287 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
288 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
289 mockRaftActor.handleCommand(saveSnapshotFailure);
291 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
292 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
294 verify(mockSupport).handleSnapshotMessage(same(applySnapshot));
295 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot));
296 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
297 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
298 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
299 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
303 public void testUpdatingElectionTermCallsDataPersistence() throws Exception {
304 new JavaTestKit(getSystem()) {
306 String persistenceId = factory.generateActorId("leader-");
308 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
310 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
312 CountDownLatch persistLatch = new CountDownLatch(1);
313 DataPersistenceProviderMonitor dataPersistenceProviderMonitor = new DataPersistenceProviderMonitor();
314 dataPersistenceProviderMonitor.setPersistLatch(persistLatch);
316 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
317 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProviderMonitor), persistenceId);
319 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
321 mockRaftActor.waitForInitializeBehaviorComplete();
323 mockRaftActor.getRaftActorContext().getTermInformation().updateAndPersist(10, "foobar");
325 assertEquals("Persist called", true, persistLatch.await(5, TimeUnit.SECONDS));
331 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
332 new JavaTestKit(getSystem()) {
334 String persistenceId = factory.generateActorId("leader-");
336 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
338 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
340 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
342 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
343 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
345 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
347 mockRaftActor.waitForInitializeBehaviorComplete();
349 mockRaftActor.waitUntilLeader();
351 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
353 verify(dataPersistenceProvider, times(2)).persist(anyObject(), any(Procedure.class));
361 public void testApplyState() throws Exception {
363 new JavaTestKit(getSystem()) {
365 String persistenceId = factory.generateActorId("leader-");
367 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
369 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
371 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
373 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
374 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
376 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
378 mockRaftActor.waitForInitializeBehaviorComplete();
380 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
381 new MockRaftActorContext.MockPayload("F"));
383 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
385 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
392 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
393 new JavaTestKit(getSystem()) {{
394 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
395 Props.create(MessageCollectorActor.class));
396 MessageCollectorActor.waitUntilReady(notifierActor);
398 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
399 long heartBeatInterval = 100;
400 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
401 config.setElectionTimeoutFactor(20);
403 String persistenceId = factory.generateActorId("notifier-");
405 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
406 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), notifierActor,
407 new NonPersistentDataProvider()), persistenceId);
409 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
412 // check if the notifier got a role change from null to Follower
413 RoleChanged raftRoleChanged = matches.get(0);
414 assertEquals(persistenceId, raftRoleChanged.getMemberId());
415 assertNull(raftRoleChanged.getOldRole());
416 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
418 // check if the notifier got a role change from Follower to Candidate
419 raftRoleChanged = matches.get(1);
420 assertEquals(persistenceId, raftRoleChanged.getMemberId());
421 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
422 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
424 // check if the notifier got a role change from Candidate to Leader
425 raftRoleChanged = matches.get(2);
426 assertEquals(persistenceId, raftRoleChanged.getMemberId());
427 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
428 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
430 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
431 notifierActor, LeaderStateChanged.class);
433 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
435 notifierActor.underlyingActor().clear();
437 MockRaftActor raftActor = raftActorRef.underlyingActor();
438 final String newLeaderId = "new-leader";
439 Follower follower = new Follower(raftActor.getRaftActorContext()) {
441 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
442 leaderId = newLeaderId;
447 raftActor.changeCurrentBehavior(follower);
449 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
450 assertEquals(persistenceId, leaderStateChange.getMemberId());
451 assertEquals(null, leaderStateChange.getLeaderId());
453 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
454 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
455 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
457 notifierActor.underlyingActor().clear();
459 raftActor.handleCommand("any");
461 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
462 assertEquals(persistenceId, leaderStateChange.getMemberId());
463 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
468 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
469 new JavaTestKit(getSystem()) {{
470 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
471 MessageCollectorActor.waitUntilReady(notifierActor);
473 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
474 long heartBeatInterval = 100;
475 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
476 config.setElectionTimeoutFactor(1);
478 String persistenceId = factory.generateActorId("notifier-");
480 factory.createActor(MockRaftActor.props(persistenceId,
481 ImmutableMap.of("leader", "fake/path"), Optional.<ConfigParams>of(config), notifierActor), persistenceId);
483 List<RoleChanged> matches = null;
484 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
485 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
486 assertNotNull(matches);
487 if(matches.size() == 3) {
490 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
493 assertEquals(2, matches.size());
495 // check if the notifier got a role change from null to Follower
496 RoleChanged raftRoleChanged = matches.get(0);
497 assertEquals(persistenceId, raftRoleChanged.getMemberId());
498 assertNull(raftRoleChanged.getOldRole());
499 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
501 // check if the notifier got a role change from Follower to Candidate
502 raftRoleChanged = matches.get(1);
503 assertEquals(persistenceId, raftRoleChanged.getMemberId());
504 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
505 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
511 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
512 new JavaTestKit(getSystem()) {
514 String persistenceId = factory.generateActorId("leader-");
515 String follower1Id = factory.generateActorId("follower-");
517 ActorRef followerActor1 =
518 factory.createActor(Props.create(MessageCollectorActor.class));
520 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
521 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
522 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
524 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
526 Map<String, String> peerAddresses = new HashMap<>();
527 peerAddresses.put(follower1Id, followerActor1.path().toString());
529 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
530 MockRaftActor.props(persistenceId, peerAddresses,
531 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
533 MockRaftActor leaderActor = mockActorRef.underlyingActor();
535 leaderActor.getRaftActorContext().setCommitIndex(4);
536 leaderActor.getRaftActorContext().setLastApplied(4);
537 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
539 leaderActor.waitForInitializeBehaviorComplete();
541 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
543 Leader leader = new Leader(leaderActor.getRaftActorContext());
544 leaderActor.setCurrentBehavior(leader);
545 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
547 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
548 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
550 assertEquals(8, leaderActor.getReplicatedLog().size());
552 leaderActor.getRaftActorContext().getSnapshotManager()
553 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
554 new MockRaftActorContext.MockPayload("x")), 4);
556 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
558 assertEquals(8, leaderActor.getReplicatedLog().size());
560 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
561 //fake snapshot on index 5
562 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1));
564 assertEquals(8, leaderActor.getReplicatedLog().size());
566 //fake snapshot on index 6
567 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
568 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1));
569 assertEquals(8, leaderActor.getReplicatedLog().size());
571 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
573 assertEquals(8, leaderActor.getReplicatedLog().size());
575 ByteString snapshotBytes = fromObject(Arrays.asList(
576 new MockRaftActorContext.MockPayload("foo-0"),
577 new MockRaftActorContext.MockPayload("foo-1"),
578 new MockRaftActorContext.MockPayload("foo-2"),
579 new MockRaftActorContext.MockPayload("foo-3"),
580 new MockRaftActorContext.MockPayload("foo-4")));
582 leaderActor.getRaftActorContext().getSnapshotManager().persist(new NonPersistentDataProvider()
583 , snapshotBytes.toByteArray(), leader, Runtime.getRuntime().totalMemory());
585 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
587 // The commit is needed to complete the snapshot creation process
588 leaderActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
590 // capture snapshot reply should remove the snapshotted entries only
591 assertEquals(3, leaderActor.getReplicatedLog().size());
592 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
594 // add another non-replicated entry
595 leaderActor.getReplicatedLog().append(
596 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
598 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
599 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1));
600 assertEquals(2, leaderActor.getReplicatedLog().size());
601 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
608 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
609 new JavaTestKit(getSystem()) {
611 String persistenceId = factory.generateActorId("follower-");
612 String leaderId = factory.generateActorId("leader-");
615 ActorRef leaderActor1 =
616 factory.createActor(Props.create(MessageCollectorActor.class));
618 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
619 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
620 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
622 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
624 Map<String, String> peerAddresses = new HashMap<>();
625 peerAddresses.put(leaderId, leaderActor1.path().toString());
627 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
628 MockRaftActor.props(persistenceId, peerAddresses,
629 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
631 MockRaftActor followerActor = mockActorRef.underlyingActor();
632 followerActor.getRaftActorContext().setCommitIndex(4);
633 followerActor.getRaftActorContext().setLastApplied(4);
634 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
636 followerActor.waitForInitializeBehaviorComplete();
639 Follower follower = new Follower(followerActor.getRaftActorContext());
640 followerActor.setCurrentBehavior(follower);
641 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
643 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
644 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
645 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
647 // log has indices 0-5
648 assertEquals(6, followerActor.getReplicatedLog().size());
651 followerActor.getRaftActorContext().getSnapshotManager().capture(
652 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
653 new MockRaftActorContext.MockPayload("D")), 4);
655 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
657 assertEquals(6, followerActor.getReplicatedLog().size());
659 //fake snapshot on index 6
660 List<ReplicatedLogEntry> entries =
662 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
663 new MockRaftActorContext.MockPayload("foo-6"))
665 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5));
666 assertEquals(7, followerActor.getReplicatedLog().size());
668 //fake snapshot on index 7
669 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
673 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
674 new MockRaftActorContext.MockPayload("foo-7"))
676 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6));
677 assertEquals(8, followerActor.getReplicatedLog().size());
679 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
682 ByteString snapshotBytes = fromObject(Arrays.asList(
683 new MockRaftActorContext.MockPayload("foo-0"),
684 new MockRaftActorContext.MockPayload("foo-1"),
685 new MockRaftActorContext.MockPayload("foo-2"),
686 new MockRaftActorContext.MockPayload("foo-3"),
687 new MockRaftActorContext.MockPayload("foo-4")));
688 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
689 assertFalse(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
691 // The commit is needed to complete the snapshot creation process
692 followerActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
694 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
695 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
696 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
700 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
701 new MockRaftActorContext.MockPayload("foo-7"))
703 // send an additional entry 8 with leaderCommit = 7
704 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7));
706 // 7 and 8, as lastapplied is 7
707 assertEquals(2, followerActor.getReplicatedLog().size());
714 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
715 new JavaTestKit(getSystem()) {
717 String persistenceId = factory.generateActorId("leader-");
718 String follower1Id = factory.generateActorId("follower-");
719 String follower2Id = factory.generateActorId("follower-");
721 ActorRef followerActor1 =
722 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
723 ActorRef followerActor2 =
724 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
726 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
727 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
728 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
730 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
732 Map<String, String> peerAddresses = new HashMap<>();
733 peerAddresses.put(follower1Id, followerActor1.path().toString());
734 peerAddresses.put(follower2Id, followerActor2.path().toString());
736 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
737 MockRaftActor.props(persistenceId, peerAddresses,
738 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
740 MockRaftActor leaderActor = mockActorRef.underlyingActor();
741 leaderActor.getRaftActorContext().setCommitIndex(9);
742 leaderActor.getRaftActorContext().setLastApplied(9);
743 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
745 leaderActor.waitForInitializeBehaviorComplete();
747 Leader leader = new Leader(leaderActor.getRaftActorContext());
748 leaderActor.setCurrentBehavior(leader);
749 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
751 // create 5 entries in the log
752 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
753 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
755 //set the snapshot index to 4 , 0 to 4 are snapshotted
756 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
757 //setting replicatedToAllIndex = 9, for the log to clear
758 leader.setReplicatedToAllIndex(9);
759 assertEquals(5, leaderActor.getReplicatedLog().size());
760 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
762 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1));
763 assertEquals(5, leaderActor.getReplicatedLog().size());
764 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
766 // set the 2nd follower nextIndex to 1 which has been snapshotted
767 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1));
768 assertEquals(5, leaderActor.getReplicatedLog().size());
769 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
771 // simulate a real snapshot
772 leaderActor.onReceiveCommand(new SendHeartBeat());
773 assertEquals(5, leaderActor.getReplicatedLog().size());
774 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
775 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
776 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
779 //reply from a slow follower does not initiate a fake snapshot
780 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1));
781 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
783 ByteString snapshotBytes = fromObject(Arrays.asList(
784 new MockRaftActorContext.MockPayload("foo-0"),
785 new MockRaftActorContext.MockPayload("foo-1"),
786 new MockRaftActorContext.MockPayload("foo-2"),
787 new MockRaftActorContext.MockPayload("foo-3"),
788 new MockRaftActorContext.MockPayload("foo-4")));
789 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
790 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
792 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
794 //reply from a slow follower after should not raise errors
795 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1));
796 assertEquals(0, leaderActor.getReplicatedLog().size());
802 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
803 new JavaTestKit(getSystem()) {{
804 String persistenceId = factory.generateActorId("leader-");
805 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
806 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
807 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
808 config.setSnapshotBatchCount(5);
810 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
812 Map<String, String> peerAddresses = new HashMap<>();
814 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
815 MockRaftActor.props(persistenceId, peerAddresses,
816 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
818 MockRaftActor leaderActor = mockActorRef.underlyingActor();
819 leaderActor.getRaftActorContext().setCommitIndex(3);
820 leaderActor.getRaftActorContext().setLastApplied(3);
821 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
823 leaderActor.waitForInitializeBehaviorComplete();
824 for(int i=0;i< 4;i++) {
825 leaderActor.getReplicatedLog()
826 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
827 new MockRaftActorContext.MockPayload("A")));
830 Leader leader = new Leader(leaderActor.getRaftActorContext());
831 leaderActor.setCurrentBehavior(leader);
832 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
834 // Persist another entry (this will cause a CaptureSnapshot to be triggered
835 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
837 // Now send a CaptureSnapshotReply
838 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
840 // Trimming log in this scenario is a no-op
841 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
842 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
843 assertEquals(-1, leader.getReplicatedToAllIndex());
849 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
850 new JavaTestKit(getSystem()) {{
851 String persistenceId = factory.generateActorId("leader-");
852 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
853 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
854 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
855 config.setSnapshotBatchCount(5);
857 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
859 Map<String, String> peerAddresses = new HashMap<>();
861 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
862 MockRaftActor.props(persistenceId, peerAddresses,
863 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
865 MockRaftActor leaderActor = mockActorRef.underlyingActor();
866 leaderActor.getRaftActorContext().setCommitIndex(3);
867 leaderActor.getRaftActorContext().setLastApplied(3);
868 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
869 leaderActor.getReplicatedLog().setSnapshotIndex(3);
871 leaderActor.waitForInitializeBehaviorComplete();
872 Leader leader = new Leader(leaderActor.getRaftActorContext());
873 leaderActor.setCurrentBehavior(leader);
874 leader.setReplicatedToAllIndex(3);
875 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
877 // Persist another entry (this will cause a CaptureSnapshot to be triggered
878 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
880 // Now send a CaptureSnapshotReply
881 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
883 // Trimming log in this scenario is a no-op
884 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
885 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
886 assertEquals(3, leader.getReplicatedToAllIndex());
891 private ByteString fromObject(Object snapshot) throws Exception {
892 ByteArrayOutputStream b = null;
893 ObjectOutputStream o = null;
895 b = new ByteArrayOutputStream();
896 o = new ObjectOutputStream(b);
897 o.writeObject(snapshot);
898 byte[] snapshotBytes = b.toByteArray();
899 return ByteString.copyFrom(snapshotBytes);