1 package org.opendaylight.controller.cluster.raft;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertNotNull;
5 import static org.junit.Assert.assertNull;
6 import static org.junit.Assert.assertTrue;
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.RecoveryCompleted;
21 import akka.persistence.SaveSnapshotFailure;
22 import akka.persistence.SaveSnapshotSuccess;
23 import akka.persistence.SnapshotMetadata;
24 import akka.persistence.SnapshotOffer;
25 import akka.testkit.JavaTestKit;
26 import akka.testkit.TestActorRef;
27 import com.google.common.base.Optional;
28 import com.google.common.collect.ImmutableMap;
29 import com.google.common.util.concurrent.Uninterruptibles;
30 import com.google.protobuf.ByteString;
31 import java.io.ByteArrayOutputStream;
32 import java.io.ObjectOutputStream;
33 import java.util.ArrayList;
34 import java.util.Arrays;
35 import java.util.Collections;
36 import java.util.HashMap;
37 import java.util.List;
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.notifications.LeaderStateChanged;
46 import org.opendaylight.controller.cluster.notifications.RoleChanged;
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.base.messages.SwitchBehavior;
56 import org.opendaylight.controller.cluster.raft.base.messages.UpdateElectionTerm;
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 org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
67 import scala.concurrent.duration.FiniteDuration;
69 public class RaftActorTest extends AbstractActorTest {
71 static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
73 private TestActorFactory factory;
77 factory = new TestActorFactory(getSystem());
81 public void tearDown() throws Exception {
83 InMemoryJournal.clear();
84 InMemorySnapshotStore.clear();
88 public void testConstruction() {
89 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
93 public void testFindLeaderWhenLeaderIsSelf(){
94 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
95 kit.waitUntilLeader();
99 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
100 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
102 new JavaTestKit(getSystem()) {{
103 String persistenceId = factory.generateActorId("follower-");
105 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
107 // Set the heartbeat interval high to essentially disable election otherwise the test
108 // may fail if the actor is switched to Leader and the commitIndex is set to the last
110 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
112 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
113 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
114 peerAddresses, Optional.<ConfigParams>of(config)), persistenceId);
116 watch(followerActor);
118 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
119 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
120 new MockRaftActorContext.MockPayload("E"));
121 snapshotUnappliedEntries.add(entry1);
123 int lastAppliedDuringSnapshotCapture = 3;
124 int lastIndexDuringSnapshotCapture = 4;
126 // 4 messages as part of snapshot, which are applied to state
127 ByteString snapshotBytes = fromObject(Arrays.asList(
128 new MockRaftActorContext.MockPayload("A"),
129 new MockRaftActorContext.MockPayload("B"),
130 new MockRaftActorContext.MockPayload("C"),
131 new MockRaftActorContext.MockPayload("D")));
133 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
134 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
135 lastAppliedDuringSnapshotCapture, 1);
136 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
138 // add more entries after snapshot is taken
139 List<ReplicatedLogEntry> entries = new ArrayList<>();
140 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
141 new MockRaftActorContext.MockPayload("F", 2));
142 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
143 new MockRaftActorContext.MockPayload("G", 3));
144 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
145 new MockRaftActorContext.MockPayload("H", 4));
150 int lastAppliedToState = 5;
153 InMemoryJournal.addEntry(persistenceId, 5, entry2);
154 // 2 entries are applied to state besides the 4 entries in snapshot
155 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
156 InMemoryJournal.addEntry(persistenceId, 7, entry3);
157 InMemoryJournal.addEntry(persistenceId, 8, entry4);
160 followerActor.tell(PoisonPill.getInstance(), null);
161 expectMsgClass(duration("5 seconds"), Terminated.class);
163 unwatch(followerActor);
165 //reinstate the actor
166 TestActorRef<MockRaftActor> ref = factory.createTestActor(
167 MockRaftActor.props(persistenceId, peerAddresses, Optional.<ConfigParams>of(config)));
169 MockRaftActor mockRaftActor = ref.underlyingActor();
171 mockRaftActor.waitForRecoveryComplete();
173 RaftActorContext context = mockRaftActor.getRaftActorContext();
174 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
175 context.getReplicatedLog().size());
176 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
177 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
178 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
179 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
180 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
182 mockRaftActor.waitForInitializeBehaviorComplete();
184 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
187 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
191 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
192 new JavaTestKit(getSystem()) {{
193 String persistenceId = factory.generateActorId("follower-");
195 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
197 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
199 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
200 ImmutableMap.<String, String>builder().put("member1", "address").build(),
201 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()), persistenceId);
203 MockRaftActor mockRaftActor = ref.underlyingActor();
205 mockRaftActor.waitForRecoveryComplete();
207 mockRaftActor.waitForInitializeBehaviorComplete();
209 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
214 public void testRaftActorForwardsToRaftActorRecoverySupport() {
215 String persistenceId = factory.generateActorId("leader-");
217 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
219 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
221 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
222 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config)), persistenceId);
224 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
226 // Wait for akka's recovery to complete so it doesn't interfere.
227 mockRaftActor.waitForRecoveryComplete();
229 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
230 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
232 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
233 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
234 mockRaftActor.handleRecover(snapshotOffer);
236 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
237 1, new MockRaftActorContext.MockPayload("1", 5));
238 mockRaftActor.handleRecover(logEntry);
240 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
241 mockRaftActor.handleRecover(applyJournalEntries);
243 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
244 mockRaftActor.handleRecover(applyLogEntries);
246 DeleteEntries deleteEntries = new DeleteEntries(1);
247 mockRaftActor.handleRecover(deleteEntries);
249 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
250 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
251 mockRaftActor.handleRecover(deprecatedDeleteEntries);
253 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
254 mockRaftActor.handleRecover(updateElectionTerm);
256 org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm deprecatedUpdateElectionTerm =
257 new org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm(6, "member3");
258 mockRaftActor.handleRecover(deprecatedUpdateElectionTerm);
260 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer));
261 verify(mockSupport).handleRecoveryMessage(same(logEntry));
262 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries));
263 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries));
264 verify(mockSupport).handleRecoveryMessage(same(deleteEntries));
265 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries));
266 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm));
267 verify(mockSupport).handleRecoveryMessage(same(deprecatedUpdateElectionTerm));
271 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
272 String persistenceId = factory.generateActorId("leader-");
274 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
276 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
278 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
280 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
281 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), mockSupport), persistenceId);
283 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
285 // Wait for akka's recovery to complete so it doesn't interfere.
286 mockRaftActor.waitForRecoveryComplete();
288 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
289 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot));
290 mockRaftActor.handleCommand(applySnapshot);
292 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1, null);
293 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot));
294 mockRaftActor.handleCommand(captureSnapshot);
296 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
297 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
298 mockRaftActor.handleCommand(captureSnapshotReply);
300 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
301 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
302 mockRaftActor.handleCommand(saveSnapshotSuccess);
304 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
305 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
306 mockRaftActor.handleCommand(saveSnapshotFailure);
308 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
309 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
311 verify(mockSupport).handleSnapshotMessage(same(applySnapshot));
312 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot));
313 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
314 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
315 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
316 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
320 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
321 new JavaTestKit(getSystem()) {
323 String persistenceId = factory.generateActorId("leader-");
325 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
327 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
329 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
331 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
332 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
334 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
336 mockRaftActor.waitForInitializeBehaviorComplete();
338 mockRaftActor.waitUntilLeader();
340 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
342 verify(dataPersistenceProvider, times(2)).persist(anyObject(), any(Procedure.class));
350 public void testApplyState() throws Exception {
352 new JavaTestKit(getSystem()) {
354 String persistenceId = factory.generateActorId("leader-");
356 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
358 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
360 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
362 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
363 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
365 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
367 mockRaftActor.waitForInitializeBehaviorComplete();
369 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
370 new MockRaftActorContext.MockPayload("F"));
372 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
374 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
381 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
382 new JavaTestKit(getSystem()) {{
383 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
384 Props.create(MessageCollectorActor.class));
385 MessageCollectorActor.waitUntilReady(notifierActor);
387 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
388 long heartBeatInterval = 100;
389 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
390 config.setElectionTimeoutFactor(20);
392 String persistenceId = factory.generateActorId("notifier-");
394 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
395 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), notifierActor,
396 new NonPersistentDataProvider()), persistenceId);
398 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
401 // check if the notifier got a role change from null to Follower
402 RoleChanged raftRoleChanged = matches.get(0);
403 assertEquals(persistenceId, raftRoleChanged.getMemberId());
404 assertNull(raftRoleChanged.getOldRole());
405 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
407 // check if the notifier got a role change from Follower to Candidate
408 raftRoleChanged = matches.get(1);
409 assertEquals(persistenceId, raftRoleChanged.getMemberId());
410 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
411 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
413 // check if the notifier got a role change from Candidate to Leader
414 raftRoleChanged = matches.get(2);
415 assertEquals(persistenceId, raftRoleChanged.getMemberId());
416 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
417 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
419 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
420 notifierActor, LeaderStateChanged.class);
422 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
423 assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
425 notifierActor.underlyingActor().clear();
427 MockRaftActor raftActor = raftActorRef.underlyingActor();
428 final String newLeaderId = "new-leader";
429 final short newLeaderVersion = 6;
430 Follower follower = new Follower(raftActor.getRaftActorContext()) {
432 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
433 leaderId = newLeaderId;
434 setLeaderPayloadVersion(newLeaderVersion);
439 raftActor.changeCurrentBehavior(follower);
441 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
442 assertEquals(persistenceId, leaderStateChange.getMemberId());
443 assertEquals(null, leaderStateChange.getLeaderId());
445 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
446 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
447 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
449 notifierActor.underlyingActor().clear();
451 raftActor.handleCommand("any");
453 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
454 assertEquals(persistenceId, leaderStateChange.getMemberId());
455 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
456 assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
458 notifierActor.underlyingActor().clear();
460 raftActor.handleCommand("any");
462 Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
463 leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
464 assertNull(leaderStateChange);
469 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
470 new JavaTestKit(getSystem()) {{
471 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
472 MessageCollectorActor.waitUntilReady(notifierActor);
474 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
475 long heartBeatInterval = 100;
476 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
477 config.setElectionTimeoutFactor(1);
479 String persistenceId = factory.generateActorId("notifier-");
481 factory.createActor(MockRaftActor.props(persistenceId,
482 ImmutableMap.of("leader", "fake/path"), Optional.<ConfigParams>of(config), notifierActor), persistenceId);
484 List<RoleChanged> matches = null;
485 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
486 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
487 assertNotNull(matches);
488 if(matches.size() == 3) {
491 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
494 assertNotNull(matches);
495 assertEquals(2, matches.size());
497 // check if the notifier got a role change from null to Follower
498 RoleChanged raftRoleChanged = matches.get(0);
499 assertEquals(persistenceId, raftRoleChanged.getMemberId());
500 assertNull(raftRoleChanged.getOldRole());
501 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
503 // check if the notifier got a role change from Follower to Candidate
504 raftRoleChanged = matches.get(1);
505 assertEquals(persistenceId, raftRoleChanged.getMemberId());
506 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
507 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
513 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
514 new JavaTestKit(getSystem()) {
516 String persistenceId = factory.generateActorId("leader-");
517 String follower1Id = factory.generateActorId("follower-");
519 ActorRef followerActor1 =
520 factory.createActor(Props.create(MessageCollectorActor.class));
522 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
523 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
524 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
526 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
528 Map<String, String> peerAddresses = new HashMap<>();
529 peerAddresses.put(follower1Id, followerActor1.path().toString());
531 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
532 MockRaftActor.props(persistenceId, peerAddresses,
533 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
535 MockRaftActor leaderActor = mockActorRef.underlyingActor();
537 leaderActor.getRaftActorContext().setCommitIndex(4);
538 leaderActor.getRaftActorContext().setLastApplied(4);
539 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
541 leaderActor.waitForInitializeBehaviorComplete();
543 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
545 Leader leader = new Leader(leaderActor.getRaftActorContext());
546 leaderActor.setCurrentBehavior(leader);
547 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
549 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
550 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
552 assertEquals(8, leaderActor.getReplicatedLog().size());
554 leaderActor.getRaftActorContext().getSnapshotManager()
555 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
556 new MockRaftActorContext.MockPayload("x")), 4);
558 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
560 assertEquals(8, leaderActor.getReplicatedLog().size());
562 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
563 //fake snapshot on index 5
564 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
566 assertEquals(8, leaderActor.getReplicatedLog().size());
568 //fake snapshot on index 6
569 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
570 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
571 assertEquals(8, leaderActor.getReplicatedLog().size());
573 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
575 assertEquals(8, leaderActor.getReplicatedLog().size());
577 ByteString snapshotBytes = fromObject(Arrays.asList(
578 new MockRaftActorContext.MockPayload("foo-0"),
579 new MockRaftActorContext.MockPayload("foo-1"),
580 new MockRaftActorContext.MockPayload("foo-2"),
581 new MockRaftActorContext.MockPayload("foo-3"),
582 new MockRaftActorContext.MockPayload("foo-4")));
584 leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotBytes.toByteArray(),
585 leader, Runtime.getRuntime().totalMemory());
587 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
589 // The commit is needed to complete the snapshot creation process
590 leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, leader);
592 // capture snapshot reply should remove the snapshotted entries only
593 assertEquals(3, leaderActor.getReplicatedLog().size());
594 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
596 // add another non-replicated entry
597 leaderActor.getReplicatedLog().append(
598 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
600 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
601 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
602 assertEquals(2, leaderActor.getReplicatedLog().size());
603 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
610 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
611 new JavaTestKit(getSystem()) {
613 String persistenceId = factory.generateActorId("follower-");
614 String leaderId = factory.generateActorId("leader-");
617 ActorRef leaderActor1 =
618 factory.createActor(Props.create(MessageCollectorActor.class));
620 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
621 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
622 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
624 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
626 Map<String, String> peerAddresses = new HashMap<>();
627 peerAddresses.put(leaderId, leaderActor1.path().toString());
629 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
630 MockRaftActor.props(persistenceId, peerAddresses,
631 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
633 MockRaftActor followerActor = mockActorRef.underlyingActor();
634 followerActor.getRaftActorContext().setCommitIndex(4);
635 followerActor.getRaftActorContext().setLastApplied(4);
636 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
638 followerActor.waitForInitializeBehaviorComplete();
641 Follower follower = new Follower(followerActor.getRaftActorContext());
642 followerActor.setCurrentBehavior(follower);
643 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
645 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
646 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
647 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
649 // log has indices 0-5
650 assertEquals(6, followerActor.getReplicatedLog().size());
653 followerActor.getRaftActorContext().getSnapshotManager().capture(
654 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
655 new MockRaftActorContext.MockPayload("D")), 4);
657 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
659 assertEquals(6, followerActor.getReplicatedLog().size());
661 //fake snapshot on index 6
662 List<ReplicatedLogEntry> entries =
664 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
665 new MockRaftActorContext.MockPayload("foo-6"))
667 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
668 assertEquals(7, followerActor.getReplicatedLog().size());
670 //fake snapshot on index 7
671 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
675 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
676 new MockRaftActorContext.MockPayload("foo-7"))
678 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
679 assertEquals(8, followerActor.getReplicatedLog().size());
681 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
684 ByteString snapshotBytes = fromObject(Arrays.asList(
685 new MockRaftActorContext.MockPayload("foo-0"),
686 new MockRaftActorContext.MockPayload("foo-1"),
687 new MockRaftActorContext.MockPayload("foo-2"),
688 new MockRaftActorContext.MockPayload("foo-3"),
689 new MockRaftActorContext.MockPayload("foo-4")));
690 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
691 assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
693 // The commit is needed to complete the snapshot creation process
694 followerActor.getRaftActorContext().getSnapshotManager().commit(-1, follower);
696 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
697 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
698 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
702 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
703 new MockRaftActorContext.MockPayload("foo-7"))
705 // send an additional entry 8 with leaderCommit = 7
706 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
708 // 7 and 8, as lastapplied is 7
709 assertEquals(2, followerActor.getReplicatedLog().size());
716 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
717 new JavaTestKit(getSystem()) {
719 String persistenceId = factory.generateActorId("leader-");
720 String follower1Id = factory.generateActorId("follower-");
721 String follower2Id = factory.generateActorId("follower-");
723 ActorRef followerActor1 =
724 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
725 ActorRef followerActor2 =
726 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
728 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
729 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
730 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
732 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
734 Map<String, String> peerAddresses = new HashMap<>();
735 peerAddresses.put(follower1Id, followerActor1.path().toString());
736 peerAddresses.put(follower2Id, followerActor2.path().toString());
738 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
739 MockRaftActor.props(persistenceId, peerAddresses,
740 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
742 MockRaftActor leaderActor = mockActorRef.underlyingActor();
743 leaderActor.getRaftActorContext().setCommitIndex(9);
744 leaderActor.getRaftActorContext().setLastApplied(9);
745 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
747 leaderActor.waitForInitializeBehaviorComplete();
749 Leader leader = new Leader(leaderActor.getRaftActorContext());
750 leaderActor.setCurrentBehavior(leader);
751 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
753 // create 5 entries in the log
754 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
755 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
757 //set the snapshot index to 4 , 0 to 4 are snapshotted
758 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
759 //setting replicatedToAllIndex = 9, for the log to clear
760 leader.setReplicatedToAllIndex(9);
761 assertEquals(5, leaderActor.getReplicatedLog().size());
762 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
764 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
765 assertEquals(5, leaderActor.getReplicatedLog().size());
766 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
768 // set the 2nd follower nextIndex to 1 which has been snapshotted
769 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
770 assertEquals(5, leaderActor.getReplicatedLog().size());
771 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
773 // simulate a real snapshot
774 leaderActor.onReceiveCommand(new SendHeartBeat());
775 assertEquals(5, leaderActor.getReplicatedLog().size());
776 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
777 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
778 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
781 //reply from a slow follower does not initiate a fake snapshot
782 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
783 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
785 ByteString snapshotBytes = fromObject(Arrays.asList(
786 new MockRaftActorContext.MockPayload("foo-0"),
787 new MockRaftActorContext.MockPayload("foo-1"),
788 new MockRaftActorContext.MockPayload("foo-2"),
789 new MockRaftActorContext.MockPayload("foo-3"),
790 new MockRaftActorContext.MockPayload("foo-4")));
791 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
792 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
794 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
796 //reply from a slow follower after should not raise errors
797 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
798 assertEquals(0, leaderActor.getReplicatedLog().size());
804 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
805 new JavaTestKit(getSystem()) {{
806 String persistenceId = factory.generateActorId("leader-");
807 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
808 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
809 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
810 config.setSnapshotBatchCount(5);
812 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
814 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
816 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
817 MockRaftActor.props(persistenceId, peerAddresses,
818 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
820 MockRaftActor leaderActor = mockActorRef.underlyingActor();
821 leaderActor.getRaftActorContext().setCommitIndex(3);
822 leaderActor.getRaftActorContext().setLastApplied(3);
823 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
825 leaderActor.waitForInitializeBehaviorComplete();
826 for(int i=0;i< 4;i++) {
827 leaderActor.getReplicatedLog()
828 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
829 new MockRaftActorContext.MockPayload("A")));
832 Leader leader = new Leader(leaderActor.getRaftActorContext());
833 leaderActor.setCurrentBehavior(leader);
834 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
836 // Simulate an install snaphost to a follower.
837 leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
838 leaderActor.getReplicatedLog().last(), -1, "member1");
840 // Now send a CaptureSnapshotReply
841 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
843 // Trimming log in this scenario is a no-op
844 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
845 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
846 assertEquals(-1, leader.getReplicatedToAllIndex());
852 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
853 new JavaTestKit(getSystem()) {{
854 String persistenceId = factory.generateActorId("leader-");
855 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
856 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
857 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
858 config.setSnapshotBatchCount(5);
860 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
862 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
864 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
865 MockRaftActor.props(persistenceId, peerAddresses,
866 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
868 MockRaftActor leaderActor = mockActorRef.underlyingActor();
869 leaderActor.getRaftActorContext().setCommitIndex(3);
870 leaderActor.getRaftActorContext().setLastApplied(3);
871 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
872 leaderActor.getReplicatedLog().setSnapshotIndex(3);
874 leaderActor.waitForInitializeBehaviorComplete();
875 Leader leader = new Leader(leaderActor.getRaftActorContext());
876 leaderActor.setCurrentBehavior(leader);
877 leader.setReplicatedToAllIndex(3);
878 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
880 // Persist another entry (this will cause a CaptureSnapshot to be triggered
881 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
883 // Now send a CaptureSnapshotReply
884 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
886 // Trimming log in this scenario is a no-op
887 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
888 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
889 assertEquals(3, leader.getReplicatedToAllIndex());
895 public void testSwitchBehavior(){
896 String persistenceId = factory.generateActorId("leader-");
897 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
898 config.setCustomRaftPolicyImplementationClass("org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
899 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
900 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
901 config.setSnapshotBatchCount(5);
903 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
905 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().build();
907 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
908 MockRaftActor.props(persistenceId, peerAddresses,
909 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
911 MockRaftActor leaderActor = mockActorRef.underlyingActor();
913 leaderActor.handleRecover(RecoveryCompleted.getInstance());
915 leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100));
917 assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
918 assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state());
920 leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110));
922 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
923 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
925 leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125));
927 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
928 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
930 leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125));
932 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
933 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
938 public static ByteString fromObject(Object snapshot) throws Exception {
939 ByteArrayOutputStream b = null;
940 ObjectOutputStream o = null;
942 b = new ByteArrayOutputStream();
943 o = new ObjectOutputStream(b);
944 o.writeObject(snapshot);
945 byte[] snapshotBytes = b.toByteArray();
946 return ByteString.copyFrom(snapshotBytes);