2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.raft;
11 import static org.junit.Assert.assertArrayEquals;
12 import static org.junit.Assert.assertEquals;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertNotSame;
15 import static org.junit.Assert.assertNull;
16 import static org.junit.Assert.assertSame;
17 import static org.junit.Assert.assertTrue;
18 import static org.mockito.Matchers.any;
19 import static org.mockito.Matchers.anyObject;
20 import static org.mockito.Matchers.eq;
21 import static org.mockito.Matchers.same;
22 import static org.mockito.Mockito.doReturn;
23 import static org.mockito.Mockito.mock;
24 import static org.mockito.Mockito.never;
25 import static org.mockito.Mockito.reset;
26 import static org.mockito.Mockito.timeout;
27 import static org.mockito.Mockito.verify;
28 import akka.actor.ActorRef;
29 import akka.actor.PoisonPill;
30 import akka.actor.Props;
31 import akka.actor.Status.Failure;
32 import akka.actor.Terminated;
33 import akka.dispatch.Dispatchers;
34 import akka.japi.Procedure;
35 import akka.persistence.SaveSnapshotFailure;
36 import akka.persistence.SaveSnapshotSuccess;
37 import akka.persistence.SnapshotMetadata;
38 import akka.persistence.SnapshotOffer;
39 import akka.testkit.JavaTestKit;
40 import akka.testkit.TestActorRef;
41 import com.google.common.base.Optional;
42 import com.google.common.collect.ImmutableMap;
43 import com.google.common.util.concurrent.Uninterruptibles;
44 import com.google.protobuf.ByteString;
45 import java.io.ByteArrayOutputStream;
46 import java.io.ObjectOutputStream;
47 import java.util.ArrayList;
48 import java.util.Arrays;
49 import java.util.Collections;
50 import java.util.HashMap;
51 import java.util.List;
53 import java.util.concurrent.TimeUnit;
54 import java.util.concurrent.TimeoutException;
55 import org.apache.commons.lang3.SerializationUtils;
56 import org.junit.After;
57 import org.junit.Before;
58 import org.junit.Test;
59 import org.mockito.ArgumentCaptor;
60 import org.opendaylight.controller.cluster.DataPersistenceProvider;
61 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
62 import org.opendaylight.controller.cluster.PersistentDataProvider;
63 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
64 import org.opendaylight.controller.cluster.notifications.RoleChanged;
65 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
66 import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo;
67 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
68 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
69 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
70 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
71 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
72 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
73 import org.opendaylight.controller.cluster.raft.base.messages.DeleteEntries;
74 import org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning;
75 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
76 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
77 import org.opendaylight.controller.cluster.raft.base.messages.UpdateElectionTerm;
78 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
79 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
80 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
81 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
82 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
83 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
84 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
85 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
86 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
87 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
88 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
89 import org.slf4j.Logger;
90 import org.slf4j.LoggerFactory;
91 import scala.concurrent.duration.Duration;
92 import scala.concurrent.duration.FiniteDuration;
94 public class RaftActorTest extends AbstractActorTest {
96 static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
98 private TestActorFactory factory;
102 factory = new TestActorFactory(getSystem());
106 public void tearDown() throws Exception {
108 InMemoryJournal.clear();
109 InMemorySnapshotStore.clear();
113 public void testConstruction() {
114 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
118 public void testFindLeaderWhenLeaderIsSelf(){
119 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
120 kit.waitUntilLeader();
125 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
126 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
128 new JavaTestKit(getSystem()) {{
129 String persistenceId = factory.generateActorId("follower-");
131 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
133 // Set the heartbeat interval high to essentially disable election otherwise the test
134 // may fail if the actor is switched to Leader and the commitIndex is set to the last
136 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
138 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
139 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
140 peerAddresses, config), persistenceId);
142 watch(followerActor);
144 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
145 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
146 new MockRaftActorContext.MockPayload("E"));
147 snapshotUnappliedEntries.add(entry1);
149 int lastAppliedDuringSnapshotCapture = 3;
150 int lastIndexDuringSnapshotCapture = 4;
152 // 4 messages as part of snapshot, which are applied to state
153 ByteString snapshotBytes = fromObject(Arrays.asList(
154 new MockRaftActorContext.MockPayload("A"),
155 new MockRaftActorContext.MockPayload("B"),
156 new MockRaftActorContext.MockPayload("C"),
157 new MockRaftActorContext.MockPayload("D")));
159 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
160 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
161 lastAppliedDuringSnapshotCapture, 1);
162 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
164 // add more entries after snapshot is taken
165 List<ReplicatedLogEntry> entries = new ArrayList<>();
166 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
167 new MockRaftActorContext.MockPayload("F", 2));
168 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
169 new MockRaftActorContext.MockPayload("G", 3));
170 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
171 new MockRaftActorContext.MockPayload("H", 4));
176 int lastAppliedToState = 5;
179 InMemoryJournal.addEntry(persistenceId, 5, entry2);
180 // 2 entries are applied to state besides the 4 entries in snapshot
181 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
182 InMemoryJournal.addEntry(persistenceId, 7, entry3);
183 InMemoryJournal.addEntry(persistenceId, 8, entry4);
186 followerActor.tell(PoisonPill.getInstance(), null);
187 expectMsgClass(duration("5 seconds"), Terminated.class);
189 unwatch(followerActor);
191 //reinstate the actor
192 TestActorRef<MockRaftActor> ref = factory.createTestActor(
193 MockRaftActor.props(persistenceId, peerAddresses, config));
195 MockRaftActor mockRaftActor = ref.underlyingActor();
197 mockRaftActor.waitForRecoveryComplete();
199 RaftActorContext context = mockRaftActor.getRaftActorContext();
200 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
201 context.getReplicatedLog().size());
202 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
203 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
204 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
205 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
206 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
208 mockRaftActor.waitForInitializeBehaviorComplete();
210 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
213 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
217 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
218 new JavaTestKit(getSystem()) {{
219 String persistenceId = factory.generateActorId("follower-");
221 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
223 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
225 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
226 ImmutableMap.<String, String>builder().put("member1", "address").build(),
227 config, new NonPersistentDataProvider()), persistenceId);
229 MockRaftActor mockRaftActor = ref.underlyingActor();
231 mockRaftActor.waitForRecoveryComplete();
233 mockRaftActor.waitForInitializeBehaviorComplete();
235 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
240 public void testUpdateElectionTermPersistedWithPersistenceDisabled() throws Exception {
241 new JavaTestKit(getSystem()) {{
242 String persistenceId = factory.generateActorId("follower-");
243 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
244 config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
245 config.setElectionTimeoutFactor(1);
247 InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1);
249 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
250 ImmutableMap.<String, String>builder().put("member1", "address").build(),
251 config, new NonPersistentDataProvider()).
252 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
254 InMemoryJournal.waitForWriteMessagesComplete(persistenceId);
255 List<UpdateElectionTerm> entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
256 assertEquals("UpdateElectionTerm entries", 1, entries.size());
257 UpdateElectionTerm updateEntry = entries.get(0);
259 factory.killActor(ref, this);
261 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
262 ref = factory.createTestActor(MockRaftActor.props(persistenceId,
263 ImmutableMap.<String, String>builder().put("member1", "address").build(), config,
264 new NonPersistentDataProvider()).
265 withDispatcher(Dispatchers.DefaultDispatcherId()),
266 factory.generateActorId("follower-"));
268 MockRaftActor actor = ref.underlyingActor();
269 actor.waitForRecoveryComplete();
271 RaftActorContext newContext = actor.getRaftActorContext();
272 assertEquals("electionTerm", updateEntry.getCurrentTerm(),
273 newContext.getTermInformation().getCurrentTerm());
274 assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor());
276 entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
277 assertEquals("UpdateElectionTerm entries", 1, entries.size());
282 public void testRaftActorForwardsToRaftActorRecoverySupport() {
283 String persistenceId = factory.generateActorId("leader-");
285 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
287 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
289 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
290 Collections.<String, String>emptyMap(), config), persistenceId);
292 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
294 // Wait for akka's recovery to complete so it doesn't interfere.
295 mockRaftActor.waitForRecoveryComplete();
297 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
298 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
300 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
301 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
302 mockRaftActor.handleRecover(snapshotOffer);
304 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
305 1, new MockRaftActorContext.MockPayload("1", 5));
306 mockRaftActor.handleRecover(logEntry);
308 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
309 mockRaftActor.handleRecover(applyJournalEntries);
311 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
312 mockRaftActor.handleRecover(applyLogEntries);
314 DeleteEntries deleteEntries = new DeleteEntries(1);
315 mockRaftActor.handleRecover(deleteEntries);
317 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
318 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
319 mockRaftActor.handleRecover(deprecatedDeleteEntries);
321 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
322 mockRaftActor.handleRecover(updateElectionTerm);
324 org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm deprecatedUpdateElectionTerm =
325 new org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm(6, "member3");
326 mockRaftActor.handleRecover(deprecatedUpdateElectionTerm);
328 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer), any(PersistentDataProvider.class));
329 verify(mockSupport).handleRecoveryMessage(same(logEntry), any(PersistentDataProvider.class));
330 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries), any(PersistentDataProvider.class));
331 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries), any(PersistentDataProvider.class));
332 verify(mockSupport).handleRecoveryMessage(same(deleteEntries), any(PersistentDataProvider.class));
333 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries), any(PersistentDataProvider.class));
334 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm), any(PersistentDataProvider.class));
335 verify(mockSupport).handleRecoveryMessage(same(deprecatedUpdateElectionTerm), any(PersistentDataProvider.class));
339 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
340 String persistenceId = factory.generateActorId("leader-");
342 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
344 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
346 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
348 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
349 config(config).snapshotMessageSupport(mockSupport).props());
351 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
353 // Wait for akka's recovery to complete so it doesn't interfere.
354 mockRaftActor.waitForRecoveryComplete();
356 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
357 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
358 mockRaftActor.handleCommand(applySnapshot);
360 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1, null);
361 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot), any(ActorRef.class));
362 mockRaftActor.handleCommand(captureSnapshot);
364 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
365 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
366 mockRaftActor.handleCommand(captureSnapshotReply);
368 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
369 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
370 mockRaftActor.handleCommand(saveSnapshotSuccess);
372 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
373 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
374 mockRaftActor.handleCommand(saveSnapshotFailure);
376 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
377 any(ActorRef.class));
378 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
380 doReturn(true).when(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
381 mockRaftActor.handleCommand(GetSnapshot.INSTANCE);
383 verify(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
384 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot), any(ActorRef.class));
385 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
386 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
387 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
388 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
389 any(ActorRef.class));
390 verify(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
394 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
395 new JavaTestKit(getSystem()) {
397 String persistenceId = factory.generateActorId("leader-");
399 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
401 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
403 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
405 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
406 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
408 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
410 mockRaftActor.waitForInitializeBehaviorComplete();
412 mockRaftActor.waitUntilLeader();
414 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
416 verify(dataPersistenceProvider).persist(any(ApplyJournalEntries.class), any(Procedure.class));
424 public void testApplyState() throws Exception {
426 new JavaTestKit(getSystem()) {
428 String persistenceId = factory.generateActorId("leader-");
430 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
432 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
434 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
436 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
437 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
439 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
441 mockRaftActor.waitForInitializeBehaviorComplete();
443 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
444 new MockRaftActorContext.MockPayload("F"));
446 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
448 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
455 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
456 new JavaTestKit(getSystem()) {{
457 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
458 Props.create(MessageCollectorActor.class));
459 MessageCollectorActor.waitUntilReady(notifierActor);
461 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
462 long heartBeatInterval = 100;
463 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
464 config.setElectionTimeoutFactor(20);
466 String persistenceId = factory.generateActorId("notifier-");
468 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
469 config(config).roleChangeNotifier(notifierActor).dataPersistenceProvider(
470 new NonPersistentDataProvider()).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
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());
498 assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
500 notifierActor.underlyingActor().clear();
502 MockRaftActor raftActor = raftActorRef.underlyingActor();
503 final String newLeaderId = "new-leader";
504 final short newLeaderVersion = 6;
505 Follower follower = new Follower(raftActor.getRaftActorContext()) {
507 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
508 leaderId = newLeaderId;
509 setLeaderPayloadVersion(newLeaderVersion);
514 raftActor.newBehavior(follower);
516 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
517 assertEquals(persistenceId, leaderStateChange.getMemberId());
518 assertEquals(null, leaderStateChange.getLeaderId());
520 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
521 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
522 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
524 notifierActor.underlyingActor().clear();
526 raftActor.handleCommand("any");
528 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
529 assertEquals(persistenceId, leaderStateChange.getMemberId());
530 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
531 assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
533 notifierActor.underlyingActor().clear();
535 raftActor.handleCommand("any");
537 Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
538 leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
539 assertNull(leaderStateChange);
544 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
545 new JavaTestKit(getSystem()) {{
546 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
547 MessageCollectorActor.waitUntilReady(notifierActor);
549 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
550 long heartBeatInterval = 100;
551 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
552 config.setElectionTimeoutFactor(1);
554 String persistenceId = factory.generateActorId("notifier-");
556 factory.createActor(MockRaftActor.builder().id(persistenceId).
557 peerAddresses(ImmutableMap.of("leader", "fake/path")).
558 config(config).roleChangeNotifier(notifierActor).props());
560 List<RoleChanged> matches = null;
561 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
562 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
563 assertNotNull(matches);
564 if(matches.size() == 3) {
567 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
570 assertNotNull(matches);
571 assertEquals(2, matches.size());
573 // check if the notifier got a role change from null to Follower
574 RoleChanged raftRoleChanged = matches.get(0);
575 assertEquals(persistenceId, raftRoleChanged.getMemberId());
576 assertNull(raftRoleChanged.getOldRole());
577 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
579 // check if the notifier got a role change from Follower to Candidate
580 raftRoleChanged = matches.get(1);
581 assertEquals(persistenceId, raftRoleChanged.getMemberId());
582 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
583 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
589 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
590 new JavaTestKit(getSystem()) {
592 String persistenceId = factory.generateActorId("leader-");
593 String follower1Id = factory.generateActorId("follower-");
595 ActorRef followerActor1 =
596 factory.createActor(Props.create(MessageCollectorActor.class));
598 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
599 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
600 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
602 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
604 Map<String, String> peerAddresses = new HashMap<>();
605 peerAddresses.put(follower1Id, followerActor1.path().toString());
607 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
608 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
610 MockRaftActor leaderActor = mockActorRef.underlyingActor();
612 leaderActor.getRaftActorContext().setCommitIndex(4);
613 leaderActor.getRaftActorContext().setLastApplied(4);
614 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
616 leaderActor.waitForInitializeBehaviorComplete();
618 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
620 Leader leader = new Leader(leaderActor.getRaftActorContext());
621 leaderActor.setCurrentBehavior(leader);
622 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
624 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
625 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
627 assertEquals(8, leaderActor.getReplicatedLog().size());
629 leaderActor.getRaftActorContext().getSnapshotManager()
630 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
631 new MockRaftActorContext.MockPayload("x")), 4);
633 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
635 assertEquals(8, leaderActor.getReplicatedLog().size());
637 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
638 //fake snapshot on index 5
639 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
641 assertEquals(8, leaderActor.getReplicatedLog().size());
643 //fake snapshot on index 6
644 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
645 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
646 assertEquals(8, leaderActor.getReplicatedLog().size());
648 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
650 assertEquals(8, leaderActor.getReplicatedLog().size());
652 ByteString snapshotBytes = fromObject(Arrays.asList(
653 new MockRaftActorContext.MockPayload("foo-0"),
654 new MockRaftActorContext.MockPayload("foo-1"),
655 new MockRaftActorContext.MockPayload("foo-2"),
656 new MockRaftActorContext.MockPayload("foo-3"),
657 new MockRaftActorContext.MockPayload("foo-4")));
659 leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotBytes.toByteArray(),
660 leader, Runtime.getRuntime().totalMemory());
662 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
664 // The commit is needed to complete the snapshot creation process
665 leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, leader);
667 // capture snapshot reply should remove the snapshotted entries only
668 assertEquals(3, leaderActor.getReplicatedLog().size());
669 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
671 // add another non-replicated entry
672 leaderActor.getReplicatedLog().append(
673 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
675 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
676 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
677 assertEquals(2, leaderActor.getReplicatedLog().size());
678 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
685 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
686 new JavaTestKit(getSystem()) {
688 String persistenceId = factory.generateActorId("follower-");
689 String leaderId = factory.generateActorId("leader-");
692 ActorRef leaderActor1 =
693 factory.createActor(Props.create(MessageCollectorActor.class));
695 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
696 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
697 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
699 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
701 Map<String, String> peerAddresses = new HashMap<>();
702 peerAddresses.put(leaderId, leaderActor1.path().toString());
704 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
705 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
707 MockRaftActor followerActor = mockActorRef.underlyingActor();
708 followerActor.getRaftActorContext().setCommitIndex(4);
709 followerActor.getRaftActorContext().setLastApplied(4);
710 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
712 followerActor.waitForInitializeBehaviorComplete();
715 Follower follower = new Follower(followerActor.getRaftActorContext());
716 followerActor.setCurrentBehavior(follower);
717 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
719 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
720 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
721 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
723 // log has indices 0-5
724 assertEquals(6, followerActor.getReplicatedLog().size());
727 followerActor.getRaftActorContext().getSnapshotManager().capture(
728 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
729 new MockRaftActorContext.MockPayload("D")), 4);
731 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
733 assertEquals(6, followerActor.getReplicatedLog().size());
735 //fake snapshot on index 6
736 List<ReplicatedLogEntry> entries =
738 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
739 new MockRaftActorContext.MockPayload("foo-6"))
741 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
742 assertEquals(7, followerActor.getReplicatedLog().size());
744 //fake snapshot on index 7
745 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
749 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
750 new MockRaftActorContext.MockPayload("foo-7"))
752 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
753 assertEquals(8, followerActor.getReplicatedLog().size());
755 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
758 ByteString snapshotBytes = fromObject(Arrays.asList(
759 new MockRaftActorContext.MockPayload("foo-0"),
760 new MockRaftActorContext.MockPayload("foo-1"),
761 new MockRaftActorContext.MockPayload("foo-2"),
762 new MockRaftActorContext.MockPayload("foo-3"),
763 new MockRaftActorContext.MockPayload("foo-4")));
764 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
765 assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
767 // The commit is needed to complete the snapshot creation process
768 followerActor.getRaftActorContext().getSnapshotManager().commit(-1, follower);
770 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
771 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
772 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
776 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
777 new MockRaftActorContext.MockPayload("foo-7"))
779 // send an additional entry 8 with leaderCommit = 7
780 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
782 // 7 and 8, as lastapplied is 7
783 assertEquals(2, followerActor.getReplicatedLog().size());
790 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
791 new JavaTestKit(getSystem()) {
793 String persistenceId = factory.generateActorId("leader-");
794 String follower1Id = factory.generateActorId("follower-");
795 String follower2Id = factory.generateActorId("follower-");
797 ActorRef followerActor1 =
798 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
799 ActorRef followerActor2 =
800 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
802 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
803 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
804 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
806 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
808 Map<String, String> peerAddresses = new HashMap<>();
809 peerAddresses.put(follower1Id, followerActor1.path().toString());
810 peerAddresses.put(follower2Id, followerActor2.path().toString());
812 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
813 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
815 MockRaftActor leaderActor = mockActorRef.underlyingActor();
816 leaderActor.getRaftActorContext().setCommitIndex(9);
817 leaderActor.getRaftActorContext().setLastApplied(9);
818 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
820 leaderActor.waitForInitializeBehaviorComplete();
822 Leader leader = new Leader(leaderActor.getRaftActorContext());
823 leaderActor.setCurrentBehavior(leader);
824 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
826 // create 5 entries in the log
827 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
828 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
830 //set the snapshot index to 4 , 0 to 4 are snapshotted
831 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
832 //setting replicatedToAllIndex = 9, for the log to clear
833 leader.setReplicatedToAllIndex(9);
834 assertEquals(5, leaderActor.getReplicatedLog().size());
835 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
837 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
838 assertEquals(5, leaderActor.getReplicatedLog().size());
839 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
841 // set the 2nd follower nextIndex to 1 which has been snapshotted
842 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
843 assertEquals(5, leaderActor.getReplicatedLog().size());
844 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
846 // simulate a real snapshot
847 leaderActor.onReceiveCommand(new SendHeartBeat());
848 assertEquals(5, leaderActor.getReplicatedLog().size());
849 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
850 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
851 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
854 //reply from a slow follower does not initiate a fake snapshot
855 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
856 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
858 ByteString snapshotBytes = fromObject(Arrays.asList(
859 new MockRaftActorContext.MockPayload("foo-0"),
860 new MockRaftActorContext.MockPayload("foo-1"),
861 new MockRaftActorContext.MockPayload("foo-2"),
862 new MockRaftActorContext.MockPayload("foo-3"),
863 new MockRaftActorContext.MockPayload("foo-4")));
864 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
865 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
867 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
869 //reply from a slow follower after should not raise errors
870 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
871 assertEquals(0, leaderActor.getReplicatedLog().size());
877 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
878 new JavaTestKit(getSystem()) {{
879 String persistenceId = factory.generateActorId("leader-");
880 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
881 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
882 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
883 config.setSnapshotBatchCount(5);
885 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
887 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
889 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
890 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
892 MockRaftActor leaderActor = mockActorRef.underlyingActor();
893 leaderActor.getRaftActorContext().setCommitIndex(3);
894 leaderActor.getRaftActorContext().setLastApplied(3);
895 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
897 leaderActor.waitForInitializeBehaviorComplete();
898 for(int i=0;i< 4;i++) {
899 leaderActor.getReplicatedLog()
900 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
901 new MockRaftActorContext.MockPayload("A")));
904 Leader leader = new Leader(leaderActor.getRaftActorContext());
905 leaderActor.setCurrentBehavior(leader);
906 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
908 // Simulate an install snaphost to a follower.
909 leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
910 leaderActor.getReplicatedLog().last(), -1, "member1");
912 // Now send a CaptureSnapshotReply
913 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
915 // Trimming log in this scenario is a no-op
916 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
917 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
918 assertEquals(-1, leader.getReplicatedToAllIndex());
924 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
925 new JavaTestKit(getSystem()) {{
926 String persistenceId = factory.generateActorId("leader-");
927 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
928 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
929 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
930 config.setSnapshotBatchCount(5);
932 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
934 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
936 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
937 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
939 MockRaftActor leaderActor = mockActorRef.underlyingActor();
940 leaderActor.getRaftActorContext().setCommitIndex(3);
941 leaderActor.getRaftActorContext().setLastApplied(3);
942 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
943 leaderActor.getReplicatedLog().setSnapshotIndex(3);
945 leaderActor.waitForInitializeBehaviorComplete();
946 Leader leader = new Leader(leaderActor.getRaftActorContext());
947 leaderActor.setCurrentBehavior(leader);
948 leader.setReplicatedToAllIndex(3);
949 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
951 // Persist another entry (this will cause a CaptureSnapshot to be triggered
952 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
954 // Now send a CaptureSnapshotReply
955 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
957 // Trimming log in this scenario is a no-op
958 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
959 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
960 assertEquals(3, leader.getReplicatedToAllIndex());
966 public void testRaftActorOnRecoverySnapshot() throws Exception {
967 TEST_LOG.info("testRaftActorOnRecoverySnapshot");
969 new JavaTestKit(getSystem()) {{
970 String persistenceId = factory.generateActorId("follower-");
972 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
974 // Set the heartbeat interval high to essentially disable election otherwise the test
975 // may fail if the actor is switched to Leader
976 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
978 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
980 // Create mock ReplicatedLogEntry
981 ReplicatedLogEntry replLogEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,1,
982 new MockRaftActorContext.MockPayload("F", 1));
984 InMemoryJournal.addEntry(persistenceId, 1, replLogEntry);
986 TestActorRef<MockRaftActor> ref = factory.createTestActor(
987 MockRaftActor.props(persistenceId, peerAddresses, config));
989 MockRaftActor mockRaftActor = ref.underlyingActor();
991 mockRaftActor.waitForRecoveryComplete();
993 mockRaftActor.waitForInitializeBehaviorComplete();
995 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(any(ActorRef.class));
1000 public void testSwitchBehavior(){
1001 String persistenceId = factory.generateActorId("leader-");
1002 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1003 config.setCustomRaftPolicyImplementationClass("org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
1004 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
1005 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
1006 config.setSnapshotBatchCount(5);
1008 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
1010 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().build();
1012 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
1013 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
1015 MockRaftActor leaderActor = mockActorRef.underlyingActor();
1017 leaderActor.waitForRecoveryComplete();
1019 leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100));
1021 assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1022 assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state());
1024 leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110));
1026 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1027 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
1029 leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125));
1031 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1032 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
1034 leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125));
1036 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1037 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
1040 public static ByteString fromObject(Object snapshot) throws Exception {
1041 ByteArrayOutputStream b = null;
1042 ObjectOutputStream o = null;
1044 b = new ByteArrayOutputStream();
1045 o = new ObjectOutputStream(b);
1046 o.writeObject(snapshot);
1047 byte[] snapshotBytes = b.toByteArray();
1048 return ByteString.copyFrom(snapshotBytes);
1061 public void testUpdateConfigParam() throws Exception {
1062 DefaultConfigParamsImpl emptyConfig = new DefaultConfigParamsImpl();
1063 String persistenceId = factory.generateActorId("follower-");
1064 ImmutableMap<String, String> peerAddresses =
1065 ImmutableMap.<String, String>builder().put("member1", "address").build();
1066 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
1068 TestActorRef<MockRaftActor> actorRef = factory.createTestActor(
1069 MockRaftActor.props(persistenceId, peerAddresses, emptyConfig, dataPersistenceProvider), persistenceId);
1070 MockRaftActor mockRaftActor = actorRef.underlyingActor();
1071 mockRaftActor.waitForInitializeBehaviorComplete();
1073 RaftActorBehavior behavior = mockRaftActor.getCurrentBehavior();
1074 mockRaftActor.updateConfigParams(emptyConfig);
1075 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1076 assertEquals("Behavior State", RaftState.Follower,
1077 mockRaftActor.getCurrentBehavior().state());
1079 DefaultConfigParamsImpl disableConfig = new DefaultConfigParamsImpl();
1080 disableConfig.setCustomRaftPolicyImplementationClass(
1081 "org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
1082 mockRaftActor.updateConfigParams(disableConfig);
1083 assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
1084 assertEquals("Behavior State", RaftState.Follower,
1085 mockRaftActor.getCurrentBehavior().state());
1087 behavior = mockRaftActor.getCurrentBehavior();
1088 mockRaftActor.updateConfigParams(disableConfig);
1089 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1090 assertEquals("Behavior State", RaftState.Follower,
1091 mockRaftActor.getCurrentBehavior().state());
1093 DefaultConfigParamsImpl defaultConfig = new DefaultConfigParamsImpl();
1094 defaultConfig.setCustomRaftPolicyImplementationClass(
1095 "org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy");
1096 mockRaftActor.updateConfigParams(defaultConfig);
1097 assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
1098 assertEquals("Behavior State", RaftState.Follower,
1099 mockRaftActor.getCurrentBehavior().state());
1101 behavior = mockRaftActor.getCurrentBehavior();
1102 mockRaftActor.updateConfigParams(defaultConfig);
1103 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1104 assertEquals("Behavior State", RaftState.Follower,
1105 mockRaftActor.getCurrentBehavior().state());
1109 public void testGetSnapshot() throws Exception {
1110 TEST_LOG.info("testGetSnapshot starting");
1112 JavaTestKit kit = new JavaTestKit(getSystem());
1114 String persistenceId = factory.generateActorId("test-actor-");
1115 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1116 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1120 InMemoryJournal.addEntry(persistenceId, seqN++, new UpdateElectionTerm(term, "member-1"));
1121 InMemoryJournal.addEntry(persistenceId, seqN++, new MockRaftActorContext.MockReplicatedLogEntry(term, 0,
1122 new MockRaftActorContext.MockPayload("A")));
1123 InMemoryJournal.addEntry(persistenceId, seqN++, new MockRaftActorContext.MockReplicatedLogEntry(term, 1,
1124 new MockRaftActorContext.MockPayload("B")));
1125 InMemoryJournal.addEntry(persistenceId, seqN++, new ApplyJournalEntries(1));
1126 InMemoryJournal.addEntry(persistenceId, seqN++, new MockRaftActorContext.MockReplicatedLogEntry(term, 2,
1127 new MockRaftActorContext.MockPayload("C")));
1129 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
1130 ImmutableMap.<String, String>builder().put("member1", "address").build(), config).
1131 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1132 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1134 mockRaftActor.waitForRecoveryComplete();
1136 // Wait for snapshot after recovery
1137 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(any(ActorRef.class));
1139 mockRaftActor.snapshotCohortDelegate = mock(RaftActorSnapshotCohort.class);
1141 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1143 ArgumentCaptor<ActorRef> replyActor = ArgumentCaptor.forClass(ActorRef.class);
1144 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(replyActor.capture());
1146 byte[] stateSnapshot = new byte[]{1,2,3};
1147 replyActor.getValue().tell(new CaptureSnapshotReply(stateSnapshot), ActorRef.noSender());
1149 GetSnapshotReply reply = kit.expectMsgClass(GetSnapshotReply.class);
1151 assertEquals("getId", persistenceId, reply.getId());
1152 Snapshot replySnapshot = SerializationUtils.deserialize(reply.getSnapshot());
1153 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1154 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1155 assertEquals("getLastAppliedIndex", 1L, replySnapshot.getLastAppliedIndex());
1156 assertEquals("getLastAppliedTerm", term, replySnapshot.getLastAppliedTerm());
1157 assertEquals("getLastIndex", 2L, replySnapshot.getLastIndex());
1158 assertEquals("getLastTerm", term, replySnapshot.getLastTerm());
1159 assertArrayEquals("getState", stateSnapshot, replySnapshot.getState());
1160 assertEquals("getUnAppliedEntries size", 1, replySnapshot.getUnAppliedEntries().size());
1161 assertEquals("UnApplied entry index ", 2L, replySnapshot.getUnAppliedEntries().get(0).getIndex());
1163 // Test with timeout
1165 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(Duration.create(200, TimeUnit.MILLISECONDS));
1166 reset(mockRaftActor.snapshotCohortDelegate);
1168 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1169 Failure failure = kit.expectMsgClass(akka.actor.Status.Failure.class);
1170 assertEquals("Failure cause type", TimeoutException.class, failure.cause().getClass());
1172 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(Duration.create(30, TimeUnit.SECONDS));
1174 // Test with persistence disabled.
1176 mockRaftActor.setPersistence(false);
1177 reset(mockRaftActor.snapshotCohortDelegate);
1179 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1180 reply = kit.expectMsgClass(GetSnapshotReply.class);
1181 verify(mockRaftActor.snapshotCohortDelegate, never()).createSnapshot(any(ActorRef.class));
1183 assertEquals("getId", persistenceId, reply.getId());
1184 replySnapshot = SerializationUtils.deserialize(reply.getSnapshot());
1185 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1186 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1187 assertEquals("getLastAppliedIndex", -1L, replySnapshot.getLastAppliedIndex());
1188 assertEquals("getLastAppliedTerm", -1L, replySnapshot.getLastAppliedTerm());
1189 assertEquals("getLastIndex", -1L, replySnapshot.getLastIndex());
1190 assertEquals("getLastTerm", -1L, replySnapshot.getLastTerm());
1191 assertEquals("getState length", 0, replySnapshot.getState().length);
1192 assertEquals("getUnAppliedEntries size", 0, replySnapshot.getUnAppliedEntries().size());
1194 TEST_LOG.info("testGetSnapshot ending");
1198 public void testRestoreFromSnapshot() throws Exception {
1199 TEST_LOG.info("testRestoreFromSnapshot starting");
1201 String persistenceId = factory.generateActorId("test-actor-");
1202 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1203 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1205 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
1206 snapshotUnappliedEntries.add(new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
1207 new MockRaftActorContext.MockPayload("E")));
1209 int snapshotLastApplied = 3;
1210 int snapshotLastIndex = 4;
1212 List<MockPayload> state = Arrays.asList(
1213 new MockRaftActorContext.MockPayload("A"),
1214 new MockRaftActorContext.MockPayload("B"),
1215 new MockRaftActorContext.MockPayload("C"),
1216 new MockRaftActorContext.MockPayload("D"));
1217 ByteString stateBytes = fromObject(state);
1219 Snapshot snapshot = Snapshot.create(stateBytes.toByteArray(), snapshotUnappliedEntries,
1220 snapshotLastIndex, 1, snapshotLastApplied, 1, 1, "member-1");
1222 InMemorySnapshotStore.addSnapshotSavedLatch(persistenceId);
1224 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1225 config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).props().
1226 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1227 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1229 mockRaftActor.waitForRecoveryComplete();
1231 Snapshot savedSnapshot = InMemorySnapshotStore.waitForSavedSnapshot(persistenceId, Snapshot.class);
1232 assertEquals("getElectionTerm", snapshot.getElectionTerm(), savedSnapshot.getElectionTerm());
1233 assertEquals("getElectionVotedFor", snapshot.getElectionVotedFor(), savedSnapshot.getElectionVotedFor());
1234 assertEquals("getLastAppliedIndex", snapshot.getLastAppliedIndex(), savedSnapshot.getLastAppliedIndex());
1235 assertEquals("getLastAppliedTerm", snapshot.getLastAppliedTerm(), savedSnapshot.getLastAppliedTerm());
1236 assertEquals("getLastIndex", snapshot.getLastIndex(), savedSnapshot.getLastIndex());
1237 assertEquals("getLastTerm", snapshot.getLastTerm(), savedSnapshot.getLastTerm());
1238 assertArrayEquals("getState", snapshot.getState(), savedSnapshot.getState());
1239 assertEquals("getUnAppliedEntries", snapshot.getUnAppliedEntries(), savedSnapshot.getUnAppliedEntries());
1241 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).applySnapshot(any(byte[].class));
1243 RaftActorContext context = mockRaftActor.getRaftActorContext();
1244 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1245 assertEquals("Last index", snapshotLastIndex, context.getReplicatedLog().lastIndex());
1246 assertEquals("Last applied", snapshotLastApplied, context.getLastApplied());
1247 assertEquals("Commit index", snapshotLastApplied, context.getCommitIndex());
1248 assertEquals("Recovered state", state, mockRaftActor.getState());
1249 assertEquals("Current term", 1L, context.getTermInformation().getCurrentTerm());
1250 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1252 // Test with data persistence disabled
1254 snapshot = Snapshot.create(new byte[0], Collections.<ReplicatedLogEntry>emptyList(),
1255 -1, -1, -1, -1, 5, "member-1");
1257 persistenceId = factory.generateActorId("test-actor-");
1259 raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1260 config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).
1261 persistent(Optional.of(Boolean.FALSE)).props().
1262 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1263 mockRaftActor = raftActorRef.underlyingActor();
1265 mockRaftActor.waitForRecoveryComplete();
1266 assertEquals("snapshot committed", true,
1267 Uninterruptibles.awaitUninterruptibly(mockRaftActor.snapshotCommitted, 5, TimeUnit.SECONDS));
1269 context = mockRaftActor.getRaftActorContext();
1270 assertEquals("Current term", 5L, context.getTermInformation().getCurrentTerm());
1271 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1273 TEST_LOG.info("testRestoreFromSnapshot ending");
1277 public void testRestoreFromSnapshotWithRecoveredData() throws Exception {
1278 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData starting");
1280 String persistenceId = factory.generateActorId("test-actor-");
1281 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1282 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1284 List<MockPayload> state = Arrays.asList(new MockRaftActorContext.MockPayload("A"));
1285 Snapshot snapshot = Snapshot.create(fromObject(state).toByteArray(), Arrays.<ReplicatedLogEntry>asList(),
1286 5, 2, 5, 2, 2, "member-1");
1288 InMemoryJournal.addEntry(persistenceId, 1, new MockRaftActorContext.MockReplicatedLogEntry(1, 0,
1289 new MockRaftActorContext.MockPayload("B")));
1291 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1292 config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).props().
1293 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1294 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1296 mockRaftActor.waitForRecoveryComplete();
1298 verify(mockRaftActor.snapshotCohortDelegate, timeout(500).never()).applySnapshot(any(byte[].class));
1300 RaftActorContext context = mockRaftActor.getRaftActorContext();
1301 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1302 assertEquals("Last index", 0, context.getReplicatedLog().lastIndex());
1303 assertEquals("Last applied", -1, context.getLastApplied());
1304 assertEquals("Commit index", -1, context.getCommitIndex());
1305 assertEquals("Current term", 0, context.getTermInformation().getCurrentTerm());
1306 assertEquals("Voted for", null, context.getTermInformation().getVotedFor());
1308 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData ending");
1312 public void testNonVotingOnRecovery() throws Exception {
1313 TEST_LOG.info("testNonVotingOnRecovery starting");
1315 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1316 config.setElectionTimeoutFactor(1);
1317 config.setHeartBeatInterval(FiniteDuration.create(1, TimeUnit.MILLISECONDS));
1319 String persistenceId = factory.generateActorId("test-actor-");
1320 InMemoryJournal.addEntry(persistenceId, 1, new MockRaftActorContext.MockReplicatedLogEntry(1, 0,
1321 new ServerConfigurationPayload(Arrays.asList(new ServerInfo(persistenceId, false)))));
1323 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1324 config(config).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1325 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1327 mockRaftActor.waitForInitializeBehaviorComplete();
1329 // Sleep a bit and verify it didn't get an election timeout and schedule an election.
1331 Uninterruptibles.sleepUninterruptibly(400, TimeUnit.MILLISECONDS);
1332 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
1334 TEST_LOG.info("testNonVotingOnRecovery ending");
1338 public void testLeaderTransitioning() throws Exception {
1339 TEST_LOG.info("testLeaderTransitioning starting");
1341 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
1342 Props.create(MessageCollectorActor.class));
1344 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1345 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1347 String persistenceId = factory.generateActorId("test-actor-");
1349 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1350 config(config).roleChangeNotifier(notifierActor).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1351 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1353 mockRaftActor.waitForInitializeBehaviorComplete();
1355 raftActorRef.tell(new AppendEntries(1L, "leader", 0L, 1L, Collections.<ReplicatedLogEntry>emptyList(),
1356 0L, -1L, (short)1), ActorRef.noSender());
1357 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
1358 notifierActor, LeaderStateChanged.class);
1359 assertEquals("getLeaderId", "leader", leaderStateChange.getLeaderId());
1361 MessageCollectorActor.clearMessages(notifierActor);
1363 raftActorRef.tell(new LeaderTransitioning(), ActorRef.noSender());
1365 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
1366 assertEquals("getMemberId", persistenceId, leaderStateChange.getMemberId());
1367 assertEquals("getLeaderId", null, leaderStateChange.getLeaderId());
1369 TEST_LOG.info("testLeaderTransitioning ending");