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.UpdateElectionTerm;
49 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
50 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
51 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
52 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
53 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
54 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
55 import org.opendaylight.controller.cluster.raft.base.messages.DeleteEntries;
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.protobuff.client.messages.Payload;
63 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
64 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
65 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
66 import scala.concurrent.duration.FiniteDuration;
68 public class RaftActorTest extends AbstractActorTest {
70 private TestActorFactory factory;
74 factory = new TestActorFactory(getSystem());
78 public void tearDown() throws Exception {
80 InMemoryJournal.clear();
81 InMemorySnapshotStore.clear();
85 public void testConstruction() {
86 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
90 public void testFindLeaderWhenLeaderIsSelf(){
91 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
92 kit.waitUntilLeader();
96 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
97 new JavaTestKit(getSystem()) {{
98 String persistenceId = factory.generateActorId("follower-");
100 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
102 // Set the heartbeat interval high to essentially disable election otherwise the test
103 // may fail if the actor is switched to Leader and the commitIndex is set to the last
105 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
107 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
108 ImmutableMap.<String, String>builder().put("member1", "address").build(),
109 Optional.<ConfigParams>of(config)), persistenceId);
111 watch(followerActor);
113 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
114 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
115 new MockRaftActorContext.MockPayload("E"));
116 snapshotUnappliedEntries.add(entry1);
118 int lastAppliedDuringSnapshotCapture = 3;
119 int lastIndexDuringSnapshotCapture = 4;
121 // 4 messages as part of snapshot, which are applied to state
122 ByteString snapshotBytes = fromObject(Arrays.asList(
123 new MockRaftActorContext.MockPayload("A"),
124 new MockRaftActorContext.MockPayload("B"),
125 new MockRaftActorContext.MockPayload("C"),
126 new MockRaftActorContext.MockPayload("D")));
128 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
129 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
130 lastAppliedDuringSnapshotCapture, 1);
131 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
133 // add more entries after snapshot is taken
134 List<ReplicatedLogEntry> entries = new ArrayList<>();
135 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
136 new MockRaftActorContext.MockPayload("F", 2));
137 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
138 new MockRaftActorContext.MockPayload("G", 3));
139 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
140 new MockRaftActorContext.MockPayload("H", 4));
145 int lastAppliedToState = 5;
148 InMemoryJournal.addEntry(persistenceId, 5, entry2);
149 // 2 entries are applied to state besides the 4 entries in snapshot
150 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
151 InMemoryJournal.addEntry(persistenceId, 7, entry3);
152 InMemoryJournal.addEntry(persistenceId, 8, entry4);
155 followerActor.tell(PoisonPill.getInstance(), null);
156 expectMsgClass(duration("5 seconds"), Terminated.class);
158 unwatch(followerActor);
160 //reinstate the actor
161 TestActorRef<MockRaftActor> ref = factory.createTestActor(
162 MockRaftActor.props(persistenceId, Collections.<String, String>emptyMap(),
163 Optional.<ConfigParams>of(config)));
165 MockRaftActor mockRaftActor = ref.underlyingActor();
167 mockRaftActor.waitForRecoveryComplete();
169 RaftActorContext context = mockRaftActor.getRaftActorContext();
170 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
171 context.getReplicatedLog().size());
172 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
173 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
174 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
175 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
176 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
178 mockRaftActor.waitForInitializeBehaviorComplete();
180 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
185 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
186 new JavaTestKit(getSystem()) {{
187 String persistenceId = factory.generateActorId("follower-");
189 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
191 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
193 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
194 ImmutableMap.<String, String>builder().put("member1", "address").build(),
195 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()), persistenceId);
197 MockRaftActor mockRaftActor = ref.underlyingActor();
199 mockRaftActor.waitForRecoveryComplete();
201 mockRaftActor.waitForInitializeBehaviorComplete();
203 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
208 public void testRaftActorForwardsToRaftActorRecoverySupport() {
209 String persistenceId = factory.generateActorId("leader-");
211 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
213 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
215 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
216 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config)), persistenceId);
218 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
220 // Wait for akka's recovery to complete so it doesn't interfere.
221 mockRaftActor.waitForRecoveryComplete();
223 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
224 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
226 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
227 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
228 mockRaftActor.handleRecover(snapshotOffer);
230 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
231 1, new MockRaftActorContext.MockPayload("1", 5));
232 mockRaftActor.handleRecover(logEntry);
234 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
235 mockRaftActor.handleRecover(applyJournalEntries);
237 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
238 mockRaftActor.handleRecover(applyLogEntries);
240 DeleteEntries deleteEntries = new DeleteEntries(1);
241 mockRaftActor.handleRecover(deleteEntries);
243 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
244 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
245 mockRaftActor.handleRecover(deprecatedDeleteEntries);
247 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
248 mockRaftActor.handleRecover(updateElectionTerm);
250 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer));
251 verify(mockSupport).handleRecoveryMessage(same(logEntry));
252 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries));
253 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries));
254 verify(mockSupport).handleRecoveryMessage(same(deleteEntries));
255 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries));
256 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm));
260 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
261 String persistenceId = factory.generateActorId("leader-");
263 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
265 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
267 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
269 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
270 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), mockSupport), persistenceId);
272 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
274 // Wait for akka's recovery to complete so it doesn't interfere.
275 mockRaftActor.waitForRecoveryComplete();
277 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
278 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot));
279 mockRaftActor.handleCommand(applySnapshot);
281 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1);
282 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot));
283 mockRaftActor.handleCommand(captureSnapshot);
285 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
286 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
287 mockRaftActor.handleCommand(captureSnapshotReply);
289 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
290 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
291 mockRaftActor.handleCommand(saveSnapshotSuccess);
293 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
294 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
295 mockRaftActor.handleCommand(saveSnapshotFailure);
297 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
298 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
300 verify(mockSupport).handleSnapshotMessage(same(applySnapshot));
301 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot));
302 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
303 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
304 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
305 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
309 public void testUpdatingElectionTermCallsDataPersistence() throws Exception {
310 new JavaTestKit(getSystem()) {
312 String persistenceId = factory.generateActorId("leader-");
314 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
316 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
318 CountDownLatch persistLatch = new CountDownLatch(1);
319 DataPersistenceProviderMonitor dataPersistenceProviderMonitor = new DataPersistenceProviderMonitor();
320 dataPersistenceProviderMonitor.setPersistLatch(persistLatch);
322 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
323 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProviderMonitor), persistenceId);
325 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
327 mockRaftActor.waitForInitializeBehaviorComplete();
329 mockRaftActor.getRaftActorContext().getTermInformation().updateAndPersist(10, "foobar");
331 assertEquals("Persist called", true, persistLatch.await(5, TimeUnit.SECONDS));
337 public void testAddingReplicatedLogEntryCallsDataPersistence() 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 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(10, 10, mock(Payload.class));
357 mockRaftActor.getRaftActorContext().getReplicatedLog().appendAndPersist(logEntry);
359 verify(dataPersistenceProvider).persist(eq(logEntry), any(Procedure.class));
365 public void testRemovingReplicatedLogEntryCallsDataPersistence() throws Exception {
366 new JavaTestKit(getSystem()) {
368 String persistenceId = factory.generateActorId("leader-");
370 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
372 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
374 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
376 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
377 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
379 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
381 mockRaftActor.waitForInitializeBehaviorComplete();
383 mockRaftActor.waitUntilLeader();
385 mockRaftActor.getReplicatedLog().appendAndPersist(new MockRaftActorContext.MockReplicatedLogEntry(1, 0, mock(Payload.class)));
387 mockRaftActor.getRaftActorContext().getReplicatedLog().removeFromAndPersist(0);
389 verify(dataPersistenceProvider, times(3)).persist(anyObject(), any(Procedure.class));
395 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
396 new JavaTestKit(getSystem()) {
398 String persistenceId = factory.generateActorId("leader-");
400 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
402 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
404 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
406 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
407 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
409 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
411 mockRaftActor.waitForInitializeBehaviorComplete();
413 mockRaftActor.waitUntilLeader();
415 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
417 verify(dataPersistenceProvider, times(2)).persist(anyObject(), any(Procedure.class));
425 public void testApplyState() throws Exception {
427 new JavaTestKit(getSystem()) {
429 String persistenceId = factory.generateActorId("leader-");
431 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
433 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
435 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
437 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
438 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
440 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
442 mockRaftActor.waitForInitializeBehaviorComplete();
444 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
445 new MockRaftActorContext.MockPayload("F"));
447 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
449 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
456 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
457 new JavaTestKit(getSystem()) {{
458 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
459 Props.create(MessageCollectorActor.class));
460 MessageCollectorActor.waitUntilReady(notifierActor);
462 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
463 long heartBeatInterval = 100;
464 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
465 config.setElectionTimeoutFactor(20);
467 String persistenceId = factory.generateActorId("notifier-");
469 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
470 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), notifierActor,
471 new NonPersistentDataProvider()), persistenceId);
473 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
476 // check if the notifier got a role change from null to Follower
477 RoleChanged raftRoleChanged = matches.get(0);
478 assertEquals(persistenceId, raftRoleChanged.getMemberId());
479 assertNull(raftRoleChanged.getOldRole());
480 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
482 // check if the notifier got a role change from Follower to Candidate
483 raftRoleChanged = matches.get(1);
484 assertEquals(persistenceId, raftRoleChanged.getMemberId());
485 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
486 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
488 // check if the notifier got a role change from Candidate to Leader
489 raftRoleChanged = matches.get(2);
490 assertEquals(persistenceId, raftRoleChanged.getMemberId());
491 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
492 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
494 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
495 notifierActor, LeaderStateChanged.class);
497 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
499 notifierActor.underlyingActor().clear();
501 MockRaftActor raftActor = raftActorRef.underlyingActor();
502 final String newLeaderId = "new-leader";
503 Follower follower = new Follower(raftActor.getRaftActorContext()) {
505 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
506 leaderId = newLeaderId;
511 raftActor.changeCurrentBehavior(follower);
513 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
514 assertEquals(persistenceId, leaderStateChange.getMemberId());
515 assertEquals(null, leaderStateChange.getLeaderId());
517 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
518 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
519 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
521 notifierActor.underlyingActor().clear();
523 raftActor.handleCommand("any");
525 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
526 assertEquals(persistenceId, leaderStateChange.getMemberId());
527 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
532 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
533 new JavaTestKit(getSystem()) {{
534 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
535 MessageCollectorActor.waitUntilReady(notifierActor);
537 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
538 long heartBeatInterval = 100;
539 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
540 config.setElectionTimeoutFactor(1);
542 String persistenceId = factory.generateActorId("notifier-");
544 factory.createActor(MockRaftActor.props(persistenceId,
545 ImmutableMap.of("leader", "fake/path"), Optional.<ConfigParams>of(config), notifierActor), persistenceId);
547 List<RoleChanged> matches = null;
548 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
549 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
550 assertNotNull(matches);
551 if(matches.size() == 3) {
554 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
557 assertEquals(2, matches.size());
559 // check if the notifier got a role change from null to Follower
560 RoleChanged raftRoleChanged = matches.get(0);
561 assertEquals(persistenceId, raftRoleChanged.getMemberId());
562 assertNull(raftRoleChanged.getOldRole());
563 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
565 // check if the notifier got a role change from Follower to Candidate
566 raftRoleChanged = matches.get(1);
567 assertEquals(persistenceId, raftRoleChanged.getMemberId());
568 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
569 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
575 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
576 new JavaTestKit(getSystem()) {
578 String persistenceId = factory.generateActorId("leader-");
579 String follower1Id = factory.generateActorId("follower-");
581 ActorRef followerActor1 =
582 factory.createActor(Props.create(MessageCollectorActor.class));
584 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
585 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
586 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
588 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
590 Map<String, String> peerAddresses = new HashMap<>();
591 peerAddresses.put(follower1Id, followerActor1.path().toString());
593 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
594 MockRaftActor.props(persistenceId, peerAddresses,
595 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
597 MockRaftActor leaderActor = mockActorRef.underlyingActor();
599 leaderActor.getRaftActorContext().setCommitIndex(4);
600 leaderActor.getRaftActorContext().setLastApplied(4);
601 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
603 leaderActor.waitForInitializeBehaviorComplete();
605 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
607 Leader leader = new Leader(leaderActor.getRaftActorContext());
608 leaderActor.setCurrentBehavior(leader);
609 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
611 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
612 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
614 assertEquals(8, leaderActor.getReplicatedLog().size());
616 leaderActor.getRaftActorContext().getSnapshotManager()
617 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
618 new MockRaftActorContext.MockPayload("x")), 4);
620 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
622 assertEquals(8, leaderActor.getReplicatedLog().size());
624 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
625 //fake snapshot on index 5
626 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1));
628 assertEquals(8, leaderActor.getReplicatedLog().size());
630 //fake snapshot on index 6
631 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
632 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1));
633 assertEquals(8, leaderActor.getReplicatedLog().size());
635 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
637 assertEquals(8, leaderActor.getReplicatedLog().size());
639 ByteString snapshotBytes = fromObject(Arrays.asList(
640 new MockRaftActorContext.MockPayload("foo-0"),
641 new MockRaftActorContext.MockPayload("foo-1"),
642 new MockRaftActorContext.MockPayload("foo-2"),
643 new MockRaftActorContext.MockPayload("foo-3"),
644 new MockRaftActorContext.MockPayload("foo-4")));
646 leaderActor.getRaftActorContext().getSnapshotManager().persist(new NonPersistentDataProvider()
647 , snapshotBytes.toByteArray(), leader, Runtime.getRuntime().totalMemory());
649 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
651 // The commit is needed to complete the snapshot creation process
652 leaderActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
654 // capture snapshot reply should remove the snapshotted entries only
655 assertEquals(3, leaderActor.getReplicatedLog().size());
656 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
658 // add another non-replicated entry
659 leaderActor.getReplicatedLog().append(
660 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
662 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
663 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1));
664 assertEquals(2, leaderActor.getReplicatedLog().size());
665 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
672 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
673 new JavaTestKit(getSystem()) {
675 String persistenceId = factory.generateActorId("follower-");
676 String leaderId = factory.generateActorId("leader-");
679 ActorRef leaderActor1 =
680 factory.createActor(Props.create(MessageCollectorActor.class));
682 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
683 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
684 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
686 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
688 Map<String, String> peerAddresses = new HashMap<>();
689 peerAddresses.put(leaderId, leaderActor1.path().toString());
691 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
692 MockRaftActor.props(persistenceId, peerAddresses,
693 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
695 MockRaftActor followerActor = mockActorRef.underlyingActor();
696 followerActor.getRaftActorContext().setCommitIndex(4);
697 followerActor.getRaftActorContext().setLastApplied(4);
698 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
700 followerActor.waitForInitializeBehaviorComplete();
703 Follower follower = new Follower(followerActor.getRaftActorContext());
704 followerActor.setCurrentBehavior(follower);
705 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
707 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
708 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
709 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
711 // log has indices 0-5
712 assertEquals(6, followerActor.getReplicatedLog().size());
715 followerActor.getRaftActorContext().getSnapshotManager().capture(
716 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
717 new MockRaftActorContext.MockPayload("D")), 4);
719 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
721 assertEquals(6, followerActor.getReplicatedLog().size());
723 //fake snapshot on index 6
724 List<ReplicatedLogEntry> entries =
726 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
727 new MockRaftActorContext.MockPayload("foo-6"))
729 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5));
730 assertEquals(7, followerActor.getReplicatedLog().size());
732 //fake snapshot on index 7
733 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
737 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
738 new MockRaftActorContext.MockPayload("foo-7"))
740 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6));
741 assertEquals(8, followerActor.getReplicatedLog().size());
743 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
746 ByteString snapshotBytes = fromObject(Arrays.asList(
747 new MockRaftActorContext.MockPayload("foo-0"),
748 new MockRaftActorContext.MockPayload("foo-1"),
749 new MockRaftActorContext.MockPayload("foo-2"),
750 new MockRaftActorContext.MockPayload("foo-3"),
751 new MockRaftActorContext.MockPayload("foo-4")));
752 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
753 assertFalse(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
755 // The commit is needed to complete the snapshot creation process
756 followerActor.getRaftActorContext().getSnapshotManager().commit(new NonPersistentDataProvider(), -1);
758 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
759 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
760 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
764 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
765 new MockRaftActorContext.MockPayload("foo-7"))
767 // send an additional entry 8 with leaderCommit = 7
768 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7));
770 // 7 and 8, as lastapplied is 7
771 assertEquals(2, followerActor.getReplicatedLog().size());
778 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
779 new JavaTestKit(getSystem()) {
781 String persistenceId = factory.generateActorId("leader-");
782 String follower1Id = factory.generateActorId("follower-");
783 String follower2Id = factory.generateActorId("follower-");
785 ActorRef followerActor1 =
786 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
787 ActorRef followerActor2 =
788 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
790 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
791 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
792 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
794 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
796 Map<String, String> peerAddresses = new HashMap<>();
797 peerAddresses.put(follower1Id, followerActor1.path().toString());
798 peerAddresses.put(follower2Id, followerActor2.path().toString());
800 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
801 MockRaftActor.props(persistenceId, peerAddresses,
802 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
804 MockRaftActor leaderActor = mockActorRef.underlyingActor();
805 leaderActor.getRaftActorContext().setCommitIndex(9);
806 leaderActor.getRaftActorContext().setLastApplied(9);
807 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
809 leaderActor.waitForInitializeBehaviorComplete();
811 Leader leader = new Leader(leaderActor.getRaftActorContext());
812 leaderActor.setCurrentBehavior(leader);
813 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
815 // create 5 entries in the log
816 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
817 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
819 //set the snapshot index to 4 , 0 to 4 are snapshotted
820 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
821 //setting replicatedToAllIndex = 9, for the log to clear
822 leader.setReplicatedToAllIndex(9);
823 assertEquals(5, leaderActor.getReplicatedLog().size());
824 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
826 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1));
827 assertEquals(5, leaderActor.getReplicatedLog().size());
828 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
830 // set the 2nd follower nextIndex to 1 which has been snapshotted
831 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1));
832 assertEquals(5, leaderActor.getReplicatedLog().size());
833 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
835 // simulate a real snapshot
836 leaderActor.onReceiveCommand(new SendHeartBeat());
837 assertEquals(5, leaderActor.getReplicatedLog().size());
838 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
839 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
840 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
843 //reply from a slow follower does not initiate a fake snapshot
844 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1));
845 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
847 ByteString snapshotBytes = fromObject(Arrays.asList(
848 new MockRaftActorContext.MockPayload("foo-0"),
849 new MockRaftActorContext.MockPayload("foo-1"),
850 new MockRaftActorContext.MockPayload("foo-2"),
851 new MockRaftActorContext.MockPayload("foo-3"),
852 new MockRaftActorContext.MockPayload("foo-4")));
853 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
854 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
856 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
858 //reply from a slow follower after should not raise errors
859 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1));
860 assertEquals(0, leaderActor.getReplicatedLog().size());
866 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
867 new JavaTestKit(getSystem()) {{
868 String persistenceId = factory.generateActorId("leader-");
869 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
870 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
871 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
872 config.setSnapshotBatchCount(5);
874 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
876 Map<String, String> peerAddresses = new HashMap<>();
878 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
879 MockRaftActor.props(persistenceId, peerAddresses,
880 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
882 MockRaftActor leaderActor = mockActorRef.underlyingActor();
883 leaderActor.getRaftActorContext().setCommitIndex(3);
884 leaderActor.getRaftActorContext().setLastApplied(3);
885 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
887 leaderActor.waitForInitializeBehaviorComplete();
888 for(int i=0;i< 4;i++) {
889 leaderActor.getReplicatedLog()
890 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
891 new MockRaftActorContext.MockPayload("A")));
894 Leader leader = new Leader(leaderActor.getRaftActorContext());
895 leaderActor.setCurrentBehavior(leader);
896 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
898 // Persist another entry (this will cause a CaptureSnapshot to be triggered
899 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
901 // Now send a CaptureSnapshotReply
902 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
904 // Trimming log in this scenario is a no-op
905 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
906 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
907 assertEquals(-1, leader.getReplicatedToAllIndex());
913 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
914 new JavaTestKit(getSystem()) {{
915 String persistenceId = factory.generateActorId("leader-");
916 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
917 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
918 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
919 config.setSnapshotBatchCount(5);
921 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
923 Map<String, String> peerAddresses = new HashMap<>();
925 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
926 MockRaftActor.props(persistenceId, peerAddresses,
927 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
929 MockRaftActor leaderActor = mockActorRef.underlyingActor();
930 leaderActor.getRaftActorContext().setCommitIndex(3);
931 leaderActor.getRaftActorContext().setLastApplied(3);
932 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
933 leaderActor.getReplicatedLog().setSnapshotIndex(3);
935 leaderActor.waitForInitializeBehaviorComplete();
936 Leader leader = new Leader(leaderActor.getRaftActorContext());
937 leaderActor.setCurrentBehavior(leader);
938 leader.setReplicatedToAllIndex(3);
939 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
941 // Persist another entry (this will cause a CaptureSnapshot to be triggered
942 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
944 // Now send a CaptureSnapshotReply
945 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
947 // Trimming log in this scenario is a no-op
948 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
949 assertFalse(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
950 assertEquals(3, leader.getReplicatedToAllIndex());
955 private ByteString fromObject(Object snapshot) throws Exception {
956 ByteArrayOutputStream b = null;
957 ObjectOutputStream o = null;
959 b = new ByteArrayOutputStream();
960 o = new ObjectOutputStream(b);
961 o.writeObject(snapshot);
962 byte[] snapshotBytes = b.toByteArray();
963 return ByteString.copyFrom(snapshotBytes);