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.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertNotSame;
14 import static org.junit.Assert.assertNull;
15 import static org.junit.Assert.assertSame;
16 import static org.junit.Assert.assertTrue;
17 import static org.mockito.Matchers.any;
18 import static org.mockito.Matchers.anyObject;
19 import static org.mockito.Matchers.eq;
20 import static org.mockito.Matchers.same;
21 import static org.mockito.Mockito.doReturn;
22 import static org.mockito.Mockito.mock;
23 import static org.mockito.Mockito.never;
24 import static org.mockito.Mockito.reset;
25 import static org.mockito.Mockito.timeout;
26 import static org.mockito.Mockito.verify;
28 import akka.actor.ActorRef;
29 import akka.actor.PoisonPill;
30 import akka.actor.Status.Failure;
31 import akka.actor.Terminated;
32 import akka.dispatch.Dispatchers;
33 import akka.japi.Procedure;
34 import akka.persistence.SaveSnapshotFailure;
35 import akka.persistence.SaveSnapshotSuccess;
36 import akka.persistence.SnapshotMetadata;
37 import akka.persistence.SnapshotOffer;
38 import akka.protobuf.ByteString;
39 import akka.testkit.TestActorRef;
40 import akka.testkit.javadsl.TestKit;
41 import com.google.common.base.Optional;
42 import com.google.common.collect.ImmutableMap;
43 import com.google.common.util.concurrent.Uninterruptibles;
44 import java.io.ByteArrayOutputStream;
45 import java.io.ObjectOutputStream;
46 import java.util.ArrayList;
47 import java.util.Arrays;
48 import java.util.Collections;
49 import java.util.HashMap;
50 import java.util.List;
52 import java.util.concurrent.TimeUnit;
53 import java.util.concurrent.TimeoutException;
54 import org.junit.After;
55 import org.junit.Before;
56 import org.junit.Test;
57 import org.mockito.ArgumentCaptor;
58 import org.opendaylight.controller.cluster.DataPersistenceProvider;
59 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
60 import org.opendaylight.controller.cluster.PersistentDataProvider;
61 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
62 import org.opendaylight.controller.cluster.notifications.RoleChanged;
63 import org.opendaylight.controller.cluster.raft.MockRaftActor.MockSnapshotState;
64 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
65 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
66 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
67 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
68 import org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning;
69 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
70 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
71 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
72 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
73 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
74 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
75 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
76 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
77 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
78 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
79 import org.opendaylight.controller.cluster.raft.persisted.ByteState;
80 import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries;
81 import org.opendaylight.controller.cluster.raft.persisted.EmptyState;
82 import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
83 import org.opendaylight.controller.cluster.raft.persisted.ServerInfo;
84 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
85 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
86 import org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm;
87 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
88 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
89 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
90 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
91 import org.opendaylight.yangtools.concepts.Identifier;
92 import org.slf4j.Logger;
93 import org.slf4j.LoggerFactory;
94 import scala.concurrent.duration.Duration;
95 import scala.concurrent.duration.FiniteDuration;
97 public class RaftActorTest extends AbstractActorTest {
99 static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
101 private TestActorFactory factory;
104 public void setUp() {
105 factory = new TestActorFactory(getSystem());
109 public void tearDown() {
111 InMemoryJournal.clear();
112 InMemorySnapshotStore.clear();
116 public void testConstruction() {
117 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
121 public void testFindLeaderWhenLeaderIsSelf() {
122 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
123 kit.waitUntilLeader();
128 public void testRaftActorRecoveryWithPersistenceEnabled() {
129 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
131 TestKit kit = new TestKit(getSystem());
132 String persistenceId = factory.generateActorId("follower-");
134 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
136 // Set the heartbeat interval high to essentially disable election otherwise the test
137 // may fail if the actor is switched to Leader and the commitIndex is set to the last
139 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
141 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder()
142 .put("member1", "address").build();
143 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
144 peerAddresses, config), persistenceId);
146 kit.watch(followerActor);
148 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
149 ReplicatedLogEntry entry1 = new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E"));
150 snapshotUnappliedEntries.add(entry1);
152 int lastAppliedDuringSnapshotCapture = 3;
153 int lastIndexDuringSnapshotCapture = 4;
155 // 4 messages as part of snapshot, which are applied to state
156 MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList(
157 new MockRaftActorContext.MockPayload("A"),
158 new MockRaftActorContext.MockPayload("B"),
159 new MockRaftActorContext.MockPayload("C"),
160 new MockRaftActorContext.MockPayload("D")));
162 Snapshot snapshot = Snapshot.create(snapshotState, snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
163 lastAppliedDuringSnapshotCapture, 1, -1, null, null);
164 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
166 // add more entries after snapshot is taken
167 List<ReplicatedLogEntry> entries = new ArrayList<>();
168 ReplicatedLogEntry entry2 = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F", 2));
169 ReplicatedLogEntry entry3 = new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("G", 3));
170 ReplicatedLogEntry entry4 = new SimpleReplicatedLogEntry(7, 1, new MockRaftActorContext.MockPayload("H", 4));
175 final int lastAppliedToState = 5;
176 final int lastIndex = 7;
178 InMemoryJournal.addEntry(persistenceId, 5, entry2);
179 // 2 entries are applied to state besides the 4 entries in snapshot
180 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
181 InMemoryJournal.addEntry(persistenceId, 7, entry3);
182 InMemoryJournal.addEntry(persistenceId, 8, entry4);
185 followerActor.tell(PoisonPill.getInstance(), null);
186 kit.expectMsgClass(kit.duration("5 seconds"), Terminated.class);
188 kit.unwatch(followerActor);
190 //reinstate the actor
191 TestActorRef<MockRaftActor> ref = factory.createTestActor(
192 MockRaftActor.props(persistenceId, peerAddresses, config));
194 MockRaftActor mockRaftActor = ref.underlyingActor();
196 mockRaftActor.waitForRecoveryComplete();
198 RaftActorContext context = mockRaftActor.getRaftActorContext();
199 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
200 context.getReplicatedLog().size());
201 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
202 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
203 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
204 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
205 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
207 mockRaftActor.waitForInitializeBehaviorComplete();
209 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
211 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
215 public void testRaftActorRecoveryWithPersistenceDisabled() {
216 String persistenceId = factory.generateActorId("follower-");
218 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
220 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
222 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
223 ImmutableMap.<String, String>builder().put("member1", "address").build(),
224 config, createProvider()), persistenceId);
226 MockRaftActor mockRaftActor = ref.underlyingActor();
228 mockRaftActor.waitForRecoveryComplete();
230 mockRaftActor.waitForInitializeBehaviorComplete();
232 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
236 public void testUpdateElectionTermPersistedWithPersistenceDisabled() {
237 final TestKit kit = new TestKit(getSystem());
238 String persistenceId = factory.generateActorId("follower-");
239 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
240 config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
241 config.setElectionTimeoutFactor(1);
243 InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1);
245 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
246 ImmutableMap.<String, String>builder().put("member1", "address").build(),
247 config, createProvider())
248 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
250 InMemoryJournal.waitForWriteMessagesComplete(persistenceId);
251 List<UpdateElectionTerm> entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
252 assertEquals("UpdateElectionTerm entries", 1, entries.size());
253 final UpdateElectionTerm updateEntry = entries.get(0);
255 factory.killActor(ref, kit);
257 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
258 ref = factory.createTestActor(MockRaftActor.props(persistenceId,
259 ImmutableMap.<String, String>builder().put("member1", "address").build(), config,
260 createProvider()).withDispatcher(Dispatchers.DefaultDispatcherId()),
261 factory.generateActorId("follower-"));
263 MockRaftActor actor = ref.underlyingActor();
264 actor.waitForRecoveryComplete();
266 RaftActorContext newContext = actor.getRaftActorContext();
267 assertEquals("electionTerm", updateEntry.getCurrentTerm(),
268 newContext.getTermInformation().getCurrentTerm());
269 assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor());
271 entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
272 assertEquals("UpdateElectionTerm entries", 1, entries.size());
276 public void testRaftActorForwardsToRaftActorRecoverySupport() {
277 String persistenceId = factory.generateActorId("leader-");
279 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
281 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
283 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
284 Collections.<String, String>emptyMap(), config), persistenceId);
286 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
288 // Wait for akka's recovery to complete so it doesn't interfere.
289 mockRaftActor.waitForRecoveryComplete();
291 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
292 mockRaftActor.setRaftActorRecoverySupport(mockSupport);
294 Snapshot snapshot = Snapshot.create(ByteState.of(new byte[]{1}),
295 Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1, -1, null, null);
296 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
297 mockRaftActor.handleRecover(snapshotOffer);
299 ReplicatedLogEntry logEntry = new SimpleReplicatedLogEntry(1, 1, new MockRaftActorContext.MockPayload("1", 5));
300 mockRaftActor.handleRecover(logEntry);
302 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
303 mockRaftActor.handleRecover(applyJournalEntries);
305 DeleteEntries deleteEntries = new DeleteEntries(1);
306 mockRaftActor.handleRecover(deleteEntries);
308 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
309 mockRaftActor.handleRecover(updateElectionTerm);
311 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer), any(PersistentDataProvider.class));
312 verify(mockSupport).handleRecoveryMessage(same(logEntry), any(PersistentDataProvider.class));
313 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries), any(PersistentDataProvider.class));
314 verify(mockSupport).handleRecoveryMessage(same(deleteEntries), any(PersistentDataProvider.class));
315 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm), any(PersistentDataProvider.class));
319 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
320 String persistenceId = factory.generateActorId("leader-");
322 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
324 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
326 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
328 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
329 .config(config).snapshotMessageSupport(mockSupport).props());
331 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
333 // Wait for akka's recovery to complete so it doesn't interfere.
334 mockRaftActor.waitForRecoveryComplete();
336 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
337 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
338 mockRaftActor.handleCommand(applySnapshot);
340 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(ByteState.empty(),
341 java.util.Optional.empty());
342 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
343 mockRaftActor.handleCommand(captureSnapshotReply);
345 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(new SnapshotMetadata("", 0L, 0L));
346 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
347 mockRaftActor.handleCommand(saveSnapshotSuccess);
349 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(new SnapshotMetadata("", 0L, 0L),
351 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
352 mockRaftActor.handleCommand(saveSnapshotFailure);
354 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
355 any(ActorRef.class));
356 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
358 doReturn(true).when(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
359 mockRaftActor.handleCommand(GetSnapshot.INSTANCE);
361 verify(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
362 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
363 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
364 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
365 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
366 any(ActorRef.class));
367 verify(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
370 @SuppressWarnings("unchecked")
372 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
373 String persistenceId = factory.generateActorId("leader-");
375 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
377 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
379 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
381 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
382 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
384 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
386 mockRaftActor.waitForInitializeBehaviorComplete();
388 mockRaftActor.waitUntilLeader();
390 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
392 verify(dataPersistenceProvider).persistAsync(any(ApplyJournalEntries.class), any(Procedure.class));
396 public void testApplyState() {
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 ReplicatedLogEntry entry = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F"));
414 final Identifier id = new MockIdentifier("apply-state");
415 mockRaftActor.getRaftActorContext().getApplyStateConsumer().accept(new ApplyState(mockActorRef, id, entry));
417 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq(id), anyObject());
421 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
422 ActorRef notifierActor = factory.createActor(MessageCollectorActor.props());
423 MessageCollectorActor.waitUntilReady(notifierActor);
425 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
426 long heartBeatInterval = 100;
427 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
428 config.setElectionTimeoutFactor(20);
430 String persistenceId = factory.generateActorId("notifier-");
432 final TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder()
433 .id(persistenceId).config(config).roleChangeNotifier(notifierActor).dataPersistenceProvider(
434 createProvider()).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
437 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
440 // check if the notifier got a role change from null to Follower
441 RoleChanged raftRoleChanged = matches.get(0);
442 assertEquals(persistenceId, raftRoleChanged.getMemberId());
443 assertNull(raftRoleChanged.getOldRole());
444 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
446 // check if the notifier got a role change from Follower to Candidate
447 raftRoleChanged = matches.get(1);
448 assertEquals(persistenceId, raftRoleChanged.getMemberId());
449 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
450 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
452 // check if the notifier got a role change from Candidate to Leader
453 raftRoleChanged = matches.get(2);
454 assertEquals(persistenceId, raftRoleChanged.getMemberId());
455 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
456 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
458 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
459 notifierActor, LeaderStateChanged.class);
461 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
462 assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
464 MessageCollectorActor.clearMessages(notifierActor);
466 MockRaftActor raftActor = raftActorRef.underlyingActor();
467 final String newLeaderId = "new-leader";
468 final short newLeaderVersion = 6;
469 Follower follower = new Follower(raftActor.getRaftActorContext()) {
471 public RaftActorBehavior handleMessage(final ActorRef sender, final Object message) {
472 setLeaderId(newLeaderId);
473 setLeaderPayloadVersion(newLeaderVersion);
478 raftActor.newBehavior(follower);
480 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
481 assertEquals(persistenceId, leaderStateChange.getMemberId());
482 assertEquals(null, leaderStateChange.getLeaderId());
484 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
485 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
486 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
488 MessageCollectorActor.clearMessages(notifierActor);
490 raftActor.handleCommand("any");
492 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
493 assertEquals(persistenceId, leaderStateChange.getMemberId());
494 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
495 assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
497 MessageCollectorActor.clearMessages(notifierActor);
499 raftActor.handleCommand("any");
501 Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
502 leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
503 assertNull(leaderStateChange);
507 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
508 ActorRef notifierActor = factory.createActor(MessageCollectorActor.props());
509 MessageCollectorActor.waitUntilReady(notifierActor);
511 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
512 long heartBeatInterval = 100;
513 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
514 config.setElectionTimeoutFactor(1);
516 String persistenceId = factory.generateActorId("notifier-");
518 factory.createActor(MockRaftActor.builder().id(persistenceId)
519 .peerAddresses(ImmutableMap.of("leader", "fake/path"))
520 .config(config).roleChangeNotifier(notifierActor).props());
522 List<RoleChanged> matches = null;
523 for (int i = 0; i < 5000 / heartBeatInterval; i++) {
524 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
525 assertNotNull(matches);
526 if (matches.size() == 3) {
529 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
532 assertNotNull(matches);
533 assertEquals(2, matches.size());
535 // check if the notifier got a role change from null to Follower
536 RoleChanged raftRoleChanged = matches.get(0);
537 assertEquals(persistenceId, raftRoleChanged.getMemberId());
538 assertNull(raftRoleChanged.getOldRole());
539 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
541 // check if the notifier got a role change from Follower to Candidate
542 raftRoleChanged = matches.get(1);
543 assertEquals(persistenceId, raftRoleChanged.getMemberId());
544 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
545 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
549 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
550 final String persistenceId = factory.generateActorId("leader-");
551 final String follower1Id = factory.generateActorId("follower-");
553 ActorRef followerActor1 = factory.createActor(MessageCollectorActor.props());
555 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
556 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
557 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
559 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
561 Map<String, String> peerAddresses = new HashMap<>();
562 peerAddresses.put(follower1Id, followerActor1.path().toString());
564 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
565 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
567 MockRaftActor leaderActor = mockActorRef.underlyingActor();
569 leaderActor.getRaftActorContext().setCommitIndex(4);
570 leaderActor.getRaftActorContext().setLastApplied(4);
571 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
573 leaderActor.waitForInitializeBehaviorComplete();
575 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
577 Leader leader = new Leader(leaderActor.getRaftActorContext());
578 leaderActor.setCurrentBehavior(leader);
579 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
581 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
582 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
584 assertEquals(8, leaderActor.getReplicatedLog().size());
586 leaderActor.getRaftActorContext().getSnapshotManager().capture(
587 new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("x")), 4);
589 verify(leaderActor.snapshotCohortDelegate).createSnapshot(anyObject(), anyObject());
591 assertEquals(8, leaderActor.getReplicatedLog().size());
593 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
594 //fake snapshot on index 5
595 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
597 assertEquals(8, leaderActor.getReplicatedLog().size());
599 //fake snapshot on index 6
600 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
601 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
602 assertEquals(8, leaderActor.getReplicatedLog().size());
604 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
606 assertEquals(8, leaderActor.getReplicatedLog().size());
608 MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList(
609 new MockRaftActorContext.MockPayload("foo-0"),
610 new MockRaftActorContext.MockPayload("foo-1"),
611 new MockRaftActorContext.MockPayload("foo-2"),
612 new MockRaftActorContext.MockPayload("foo-3"),
613 new MockRaftActorContext.MockPayload("foo-4")));
615 leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotState, java.util.Optional.empty(),
616 Runtime.getRuntime().totalMemory());
618 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
620 // The commit is needed to complete the snapshot creation process
621 leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, -1);
623 // capture snapshot reply should remove the snapshotted entries only
624 assertEquals(3, leaderActor.getReplicatedLog().size());
625 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
627 // add another non-replicated entry
628 leaderActor.getReplicatedLog().append(
629 new SimpleReplicatedLogEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
631 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
632 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
633 assertEquals(2, leaderActor.getReplicatedLog().size());
634 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
638 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
639 final String persistenceId = factory.generateActorId("follower-");
640 final String leaderId = factory.generateActorId("leader-");
642 ActorRef leaderActor1 = factory.createActor(MessageCollectorActor.props());
644 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
645 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
646 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
648 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
650 Map<String, String> peerAddresses = new HashMap<>();
651 peerAddresses.put(leaderId, leaderActor1.path().toString());
653 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
654 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
656 MockRaftActor followerActor = mockActorRef.underlyingActor();
657 followerActor.getRaftActorContext().setCommitIndex(4);
658 followerActor.getRaftActorContext().setLastApplied(4);
659 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
661 followerActor.waitForInitializeBehaviorComplete();
664 Follower follower = new Follower(followerActor.getRaftActorContext());
665 followerActor.setCurrentBehavior(follower);
666 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
668 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
669 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
670 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
672 // log has indices 0-5
673 assertEquals(6, followerActor.getReplicatedLog().size());
676 followerActor.getRaftActorContext().getSnapshotManager().capture(
677 new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("D")), 4);
679 verify(followerActor.snapshotCohortDelegate).createSnapshot(anyObject(), anyObject());
681 assertEquals(6, followerActor.getReplicatedLog().size());
683 //fake snapshot on index 6
684 List<ReplicatedLogEntry> entries = Arrays.asList(
685 (ReplicatedLogEntry) new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("foo-6")));
686 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
687 assertEquals(7, followerActor.getReplicatedLog().size());
689 //fake snapshot on index 7
690 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
692 entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(7, 1,
693 new MockRaftActorContext.MockPayload("foo-7")));
694 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
695 assertEquals(8, followerActor.getReplicatedLog().size());
697 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
700 ByteString snapshotBytes = fromObject(Arrays.asList(
701 new MockRaftActorContext.MockPayload("foo-0"),
702 new MockRaftActorContext.MockPayload("foo-1"),
703 new MockRaftActorContext.MockPayload("foo-2"),
704 new MockRaftActorContext.MockPayload("foo-3"),
705 new MockRaftActorContext.MockPayload("foo-4")));
706 followerActor.onReceiveCommand(new CaptureSnapshotReply(ByteState.of(snapshotBytes.toByteArray()),
707 java.util.Optional.empty()));
708 assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
710 // The commit is needed to complete the snapshot creation process
711 followerActor.getRaftActorContext().getSnapshotManager().commit(-1, -1);
713 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
714 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
715 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
717 entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(8, 1,
718 new MockRaftActorContext.MockPayload("foo-7")));
719 // send an additional entry 8 with leaderCommit = 7
720 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
722 // 7 and 8, as lastapplied is 7
723 assertEquals(2, followerActor.getReplicatedLog().size());
727 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
728 final String persistenceId = factory.generateActorId("leader-");
729 final String follower1Id = factory.generateActorId("follower-");
730 final String follower2Id = factory.generateActorId("follower-");
732 final ActorRef followerActor1 = factory.createActor(MessageCollectorActor.props(), follower1Id);
733 final ActorRef followerActor2 = factory.createActor(MessageCollectorActor.props(), follower2Id);
735 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
736 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
737 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
739 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
741 Map<String, String> peerAddresses = new HashMap<>();
742 peerAddresses.put(follower1Id, followerActor1.path().toString());
743 peerAddresses.put(follower2Id, followerActor2.path().toString());
745 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
746 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
748 MockRaftActor leaderActor = mockActorRef.underlyingActor();
749 leaderActor.getRaftActorContext().setCommitIndex(9);
750 leaderActor.getRaftActorContext().setLastApplied(9);
751 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
753 leaderActor.waitForInitializeBehaviorComplete();
755 Leader leader = new Leader(leaderActor.getRaftActorContext());
756 leaderActor.setCurrentBehavior(leader);
757 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
759 // create 5 entries in the log
760 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
761 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
763 //set the snapshot index to 4 , 0 to 4 are snapshotted
764 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
765 //setting replicatedToAllIndex = 9, for the log to clear
766 leader.setReplicatedToAllIndex(9);
767 assertEquals(5, leaderActor.getReplicatedLog().size());
768 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
770 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
771 assertEquals(5, leaderActor.getReplicatedLog().size());
772 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
774 // set the 2nd follower nextIndex to 1 which has been snapshotted
775 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
776 assertEquals(5, leaderActor.getReplicatedLog().size());
777 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
779 // simulate a real snapshot
780 leaderActor.onReceiveCommand(SendHeartBeat.INSTANCE);
781 assertEquals(5, leaderActor.getReplicatedLog().size());
782 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
783 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId()),
784 RaftState.Leader, leaderActor.getCurrentBehavior().state());
787 //reply from a slow follower does not initiate a fake snapshot
788 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
789 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5,
790 leaderActor.getReplicatedLog().size());
792 ByteString snapshotBytes = fromObject(Arrays.asList(
793 new MockRaftActorContext.MockPayload("foo-0"),
794 new MockRaftActorContext.MockPayload("foo-1"),
795 new MockRaftActorContext.MockPayload("foo-2"),
796 new MockRaftActorContext.MockPayload("foo-3"),
797 new MockRaftActorContext.MockPayload("foo-4")));
798 leaderActor.onReceiveCommand(new CaptureSnapshotReply(ByteState.of(snapshotBytes.toByteArray()),
799 java.util.Optional.empty()));
800 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
802 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0,
803 leaderActor.getReplicatedLog().size());
805 //reply from a slow follower after should not raise errors
806 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
807 assertEquals(0, leaderActor.getReplicatedLog().size());
811 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
812 String persistenceId = factory.generateActorId("leader-");
813 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
814 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
815 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
816 config.setSnapshotBatchCount(5);
818 DataPersistenceProvider dataPersistenceProvider = createProvider();
820 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
822 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
823 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
825 MockRaftActor leaderActor = mockActorRef.underlyingActor();
826 leaderActor.getRaftActorContext().setCommitIndex(3);
827 leaderActor.getRaftActorContext().setLastApplied(3);
828 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
830 leaderActor.waitForInitializeBehaviorComplete();
831 for (int i = 0; i < 4; i++) {
832 leaderActor.getReplicatedLog().append(new SimpleReplicatedLogEntry(i, 1,
833 new MockRaftActorContext.MockPayload("A")));
836 Leader leader = new Leader(leaderActor.getRaftActorContext());
837 leaderActor.setCurrentBehavior(leader);
838 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
840 // Simulate an install snaphost to a follower.
841 leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
842 leaderActor.getReplicatedLog().last(), -1, "member1");
844 // Now send a CaptureSnapshotReply
845 mockActorRef.tell(new CaptureSnapshotReply(ByteState.of(fromObject("foo").toByteArray()),
846 java.util.Optional.empty()), mockActorRef);
848 // Trimming log in this scenario is a no-op
849 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
850 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
851 assertEquals(-1, leader.getReplicatedToAllIndex());
855 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
856 String persistenceId = factory.generateActorId("leader-");
857 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
858 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
859 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
860 config.setSnapshotBatchCount(5);
862 DataPersistenceProvider dataPersistenceProvider = createProvider();
864 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
866 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
867 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
869 MockRaftActor leaderActor = mockActorRef.underlyingActor();
870 leaderActor.getRaftActorContext().setCommitIndex(3);
871 leaderActor.getRaftActorContext().setLastApplied(3);
872 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
873 leaderActor.getReplicatedLog().setSnapshotIndex(3);
875 leaderActor.waitForInitializeBehaviorComplete();
876 Leader leader = new Leader(leaderActor.getRaftActorContext());
877 leaderActor.setCurrentBehavior(leader);
878 leader.setReplicatedToAllIndex(3);
879 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
881 // Persist another entry (this will cause a CaptureSnapshot to be triggered
882 leaderActor.persistData(mockActorRef, new MockIdentifier("x"),
883 new MockRaftActorContext.MockPayload("duh"), false);
885 // Now send a CaptureSnapshotReply
886 mockActorRef.tell(new CaptureSnapshotReply(ByteState.of(fromObject("foo").toByteArray()),
887 java.util.Optional.empty()), mockActorRef);
889 // Trimming log in this scenario is a no-op
890 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
891 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
892 assertEquals(3, leader.getReplicatedToAllIndex());
895 private static DataPersistenceProvider createProvider() {
896 return new NonPersistentDataProvider(Runnable::run);
900 public void testSwitchBehavior() {
901 String persistenceId = factory.generateActorId("leader-");
902 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
903 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
904 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
905 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
906 config.setSnapshotBatchCount(5);
908 DataPersistenceProvider dataPersistenceProvider = createProvider();
910 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().build();
912 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
913 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
915 MockRaftActor leaderActor = mockActorRef.underlyingActor();
917 leaderActor.waitForRecoveryComplete();
919 leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100));
921 assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
922 assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state());
924 leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110));
926 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
927 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
929 leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125));
931 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
932 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
934 leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125));
936 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
937 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
940 public static ByteString fromObject(final Object snapshot) throws Exception {
941 ByteArrayOutputStream bos = null;
942 ObjectOutputStream os = null;
944 bos = new ByteArrayOutputStream();
945 os = new ObjectOutputStream(bos);
946 os.writeObject(snapshot);
947 byte[] snapshotBytes = bos.toByteArray();
948 return ByteString.copyFrom(snapshotBytes);
961 public void testUpdateConfigParam() {
962 DefaultConfigParamsImpl emptyConfig = new DefaultConfigParamsImpl();
963 String persistenceId = factory.generateActorId("follower-");
964 ImmutableMap<String, String> peerAddresses =
965 ImmutableMap.<String, String>builder().put("member1", "address").build();
966 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
968 TestActorRef<MockRaftActor> actorRef = factory.createTestActor(
969 MockRaftActor.props(persistenceId, peerAddresses, emptyConfig, dataPersistenceProvider), persistenceId);
970 MockRaftActor mockRaftActor = actorRef.underlyingActor();
971 mockRaftActor.waitForInitializeBehaviorComplete();
973 RaftActorBehavior behavior = mockRaftActor.getCurrentBehavior();
974 mockRaftActor.updateConfigParams(emptyConfig);
975 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
976 assertEquals("Behavior State", RaftState.Follower,
977 mockRaftActor.getCurrentBehavior().state());
979 DefaultConfigParamsImpl disableConfig = new DefaultConfigParamsImpl();
980 disableConfig.setCustomRaftPolicyImplementationClass(
981 "org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
982 mockRaftActor.updateConfigParams(disableConfig);
983 assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
984 assertEquals("Behavior State", RaftState.Follower,
985 mockRaftActor.getCurrentBehavior().state());
987 behavior = mockRaftActor.getCurrentBehavior();
988 mockRaftActor.updateConfigParams(disableConfig);
989 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
990 assertEquals("Behavior State", RaftState.Follower,
991 mockRaftActor.getCurrentBehavior().state());
993 DefaultConfigParamsImpl defaultConfig = new DefaultConfigParamsImpl();
994 defaultConfig.setCustomRaftPolicyImplementationClass(
995 "org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy");
996 mockRaftActor.updateConfigParams(defaultConfig);
997 assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
998 assertEquals("Behavior State", RaftState.Follower,
999 mockRaftActor.getCurrentBehavior().state());
1001 behavior = mockRaftActor.getCurrentBehavior();
1002 mockRaftActor.updateConfigParams(defaultConfig);
1003 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1004 assertEquals("Behavior State", RaftState.Follower,
1005 mockRaftActor.getCurrentBehavior().state());
1009 public void testGetSnapshot() {
1010 TEST_LOG.info("testGetSnapshot starting");
1012 final TestKit kit = new TestKit(getSystem());
1014 String persistenceId = factory.generateActorId("test-actor-");
1015 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1016 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1020 InMemoryJournal.addEntry(persistenceId, seqN++, new UpdateElectionTerm(term, "member-1"));
1021 InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(0, term,
1022 new MockRaftActorContext.MockPayload("A")));
1023 InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(1, term,
1024 new MockRaftActorContext.MockPayload("B")));
1025 InMemoryJournal.addEntry(persistenceId, seqN++, new ApplyJournalEntries(1));
1026 InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(2, term,
1027 new MockRaftActorContext.MockPayload("C")));
1029 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
1030 ImmutableMap.<String, String>builder().put("member1", "address").build(), config)
1031 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1032 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1034 mockRaftActor.waitForRecoveryComplete();
1036 mockRaftActor.snapshotCohortDelegate = mock(RaftActorSnapshotCohort.class);
1038 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1040 ArgumentCaptor<ActorRef> replyActor = ArgumentCaptor.forClass(ActorRef.class);
1041 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(replyActor.capture(),
1042 eq(java.util.Optional.empty()));
1044 byte[] stateSnapshot = new byte[]{1,2,3};
1045 replyActor.getValue().tell(new CaptureSnapshotReply(ByteState.of(stateSnapshot), java.util.Optional.empty()),
1046 ActorRef.noSender());
1048 GetSnapshotReply reply = kit.expectMsgClass(GetSnapshotReply.class);
1050 assertEquals("getId", persistenceId, reply.getId());
1051 Snapshot replySnapshot = reply.getSnapshot();
1052 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1053 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1054 assertEquals("getLastAppliedIndex", 1L, replySnapshot.getLastAppliedIndex());
1055 assertEquals("getLastAppliedTerm", term, replySnapshot.getLastAppliedTerm());
1056 assertEquals("getLastIndex", 2L, replySnapshot.getLastIndex());
1057 assertEquals("getLastTerm", term, replySnapshot.getLastTerm());
1058 assertEquals("getState", ByteState.of(stateSnapshot), replySnapshot.getState());
1059 assertEquals("getUnAppliedEntries size", 1, replySnapshot.getUnAppliedEntries().size());
1060 assertEquals("UnApplied entry index ", 2L, replySnapshot.getUnAppliedEntries().get(0).getIndex());
1062 // Test with timeout
1064 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(
1065 Duration.create(200, TimeUnit.MILLISECONDS));
1066 reset(mockRaftActor.snapshotCohortDelegate);
1068 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1069 Failure failure = kit.expectMsgClass(akka.actor.Status.Failure.class);
1070 assertEquals("Failure cause type", TimeoutException.class, failure.cause().getClass());
1072 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(Duration.create(30, TimeUnit.SECONDS));
1074 // Test with persistence disabled.
1076 mockRaftActor.setPersistence(false);
1077 reset(mockRaftActor.snapshotCohortDelegate);
1079 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1080 reply = kit.expectMsgClass(GetSnapshotReply.class);
1081 verify(mockRaftActor.snapshotCohortDelegate, never()).createSnapshot(anyObject(), anyObject());
1083 assertEquals("getId", persistenceId, reply.getId());
1084 replySnapshot = reply.getSnapshot();
1085 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1086 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1087 assertEquals("getLastAppliedIndex", -1L, replySnapshot.getLastAppliedIndex());
1088 assertEquals("getLastAppliedTerm", -1L, replySnapshot.getLastAppliedTerm());
1089 assertEquals("getLastIndex", -1L, replySnapshot.getLastIndex());
1090 assertEquals("getLastTerm", -1L, replySnapshot.getLastTerm());
1091 assertEquals("getState type", EmptyState.INSTANCE, replySnapshot.getState());
1092 assertEquals("getUnAppliedEntries size", 0, replySnapshot.getUnAppliedEntries().size());
1094 TEST_LOG.info("testGetSnapshot ending");
1098 public void testRestoreFromSnapshot() {
1099 TEST_LOG.info("testRestoreFromSnapshot starting");
1101 String persistenceId = factory.generateActorId("test-actor-");
1102 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1103 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1105 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
1106 snapshotUnappliedEntries.add(new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E")));
1108 int snapshotLastApplied = 3;
1109 int snapshotLastIndex = 4;
1111 MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList(
1112 new MockRaftActorContext.MockPayload("A"),
1113 new MockRaftActorContext.MockPayload("B"),
1114 new MockRaftActorContext.MockPayload("C"),
1115 new MockRaftActorContext.MockPayload("D")));
1117 Snapshot snapshot = Snapshot.create(snapshotState, snapshotUnappliedEntries,
1118 snapshotLastIndex, 1, snapshotLastApplied, 1, 1, "member-1", null);
1120 InMemorySnapshotStore.addSnapshotSavedLatch(persistenceId);
1122 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1123 .config(config).restoreFromSnapshot(snapshot).props()
1124 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1125 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1127 mockRaftActor.waitForRecoveryComplete();
1129 Snapshot savedSnapshot = InMemorySnapshotStore.waitForSavedSnapshot(persistenceId, Snapshot.class);
1130 assertEquals("getElectionTerm", snapshot.getElectionTerm(), savedSnapshot.getElectionTerm());
1131 assertEquals("getElectionVotedFor", snapshot.getElectionVotedFor(), savedSnapshot.getElectionVotedFor());
1132 assertEquals("getLastAppliedIndex", snapshot.getLastAppliedIndex(), savedSnapshot.getLastAppliedIndex());
1133 assertEquals("getLastAppliedTerm", snapshot.getLastAppliedTerm(), savedSnapshot.getLastAppliedTerm());
1134 assertEquals("getLastIndex", snapshot.getLastIndex(), savedSnapshot.getLastIndex());
1135 assertEquals("getLastTerm", snapshot.getLastTerm(), savedSnapshot.getLastTerm());
1136 assertEquals("getState", snapshot.getState(), savedSnapshot.getState());
1137 assertEquals("getUnAppliedEntries", snapshot.getUnAppliedEntries(), savedSnapshot.getUnAppliedEntries());
1139 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).applySnapshot(any(Snapshot.State.class));
1141 RaftActorContext context = mockRaftActor.getRaftActorContext();
1142 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1143 assertEquals("Last index", snapshotLastIndex, context.getReplicatedLog().lastIndex());
1144 assertEquals("Last applied", snapshotLastApplied, context.getLastApplied());
1145 assertEquals("Commit index", snapshotLastApplied, context.getCommitIndex());
1146 assertEquals("Recovered state", snapshotState.getState(), mockRaftActor.getState());
1147 assertEquals("Current term", 1L, context.getTermInformation().getCurrentTerm());
1148 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1150 // Test with data persistence disabled
1152 snapshot = Snapshot.create(EmptyState.INSTANCE, Collections.<ReplicatedLogEntry>emptyList(),
1153 -1, -1, -1, -1, 5, "member-1", null);
1155 persistenceId = factory.generateActorId("test-actor-");
1157 raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1158 .config(config).restoreFromSnapshot(snapshot)
1159 .persistent(Optional.of(Boolean.FALSE)).props()
1160 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1161 mockRaftActor = raftActorRef.underlyingActor();
1163 mockRaftActor.waitForRecoveryComplete();
1164 assertEquals("snapshot committed", true,
1165 Uninterruptibles.awaitUninterruptibly(mockRaftActor.snapshotCommitted, 5, TimeUnit.SECONDS));
1167 context = mockRaftActor.getRaftActorContext();
1168 assertEquals("Current term", 5L, context.getTermInformation().getCurrentTerm());
1169 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1171 TEST_LOG.info("testRestoreFromSnapshot ending");
1175 public void testRestoreFromSnapshotWithRecoveredData() throws Exception {
1176 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData starting");
1178 String persistenceId = factory.generateActorId("test-actor-");
1179 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1180 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1182 List<MockPayload> state = Arrays.asList(new MockRaftActorContext.MockPayload("A"));
1183 Snapshot snapshot = Snapshot.create(ByteState.of(fromObject(state).toByteArray()),
1184 Arrays.<ReplicatedLogEntry>asList(), 5, 2, 5, 2, 2, "member-1", null);
1186 InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1,
1187 new MockRaftActorContext.MockPayload("B")));
1189 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1190 .config(config).restoreFromSnapshot(snapshot).props()
1191 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1192 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1194 mockRaftActor.waitForRecoveryComplete();
1196 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
1197 verify(mockRaftActor.snapshotCohortDelegate, never()).applySnapshot(any(Snapshot.State.class));
1199 RaftActorContext context = mockRaftActor.getRaftActorContext();
1200 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1201 assertEquals("Last index", 0, context.getReplicatedLog().lastIndex());
1202 assertEquals("Last applied", -1, context.getLastApplied());
1203 assertEquals("Commit index", -1, context.getCommitIndex());
1204 assertEquals("Current term", 0, context.getTermInformation().getCurrentTerm());
1205 assertEquals("Voted for", null, context.getTermInformation().getVotedFor());
1207 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData ending");
1211 public void testNonVotingOnRecovery() {
1212 TEST_LOG.info("testNonVotingOnRecovery starting");
1214 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1215 config.setElectionTimeoutFactor(1);
1216 config.setHeartBeatInterval(FiniteDuration.create(1, TimeUnit.MILLISECONDS));
1218 String persistenceId = factory.generateActorId("test-actor-");
1219 InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1,
1220 new ServerConfigurationPayload(Arrays.asList(new ServerInfo(persistenceId, false)))));
1222 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1223 .config(config).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1224 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1226 mockRaftActor.waitForInitializeBehaviorComplete();
1228 // Sleep a bit and verify it didn't get an election timeout and schedule an election.
1230 Uninterruptibles.sleepUninterruptibly(400, TimeUnit.MILLISECONDS);
1231 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
1233 TEST_LOG.info("testNonVotingOnRecovery ending");
1237 public void testLeaderTransitioning() {
1238 TEST_LOG.info("testLeaderTransitioning starting");
1240 ActorRef notifierActor = factory.createActor(MessageCollectorActor.props());
1242 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1243 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1245 String persistenceId = factory.generateActorId("test-actor-");
1247 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1248 .config(config).roleChangeNotifier(notifierActor).props()
1249 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1250 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1252 mockRaftActor.waitForInitializeBehaviorComplete();
1254 raftActorRef.tell(new AppendEntries(1L, "leader", 0L, 1L, Collections.<ReplicatedLogEntry>emptyList(),
1255 0L, -1L, (short)1), ActorRef.noSender());
1256 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
1257 notifierActor, LeaderStateChanged.class);
1258 assertEquals("getLeaderId", "leader", leaderStateChange.getLeaderId());
1260 MessageCollectorActor.clearMessages(notifierActor);
1262 raftActorRef.tell(new LeaderTransitioning("leader"), ActorRef.noSender());
1264 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
1265 assertEquals("getMemberId", persistenceId, leaderStateChange.getMemberId());
1266 assertEquals("getLeaderId", null, leaderStateChange.getLeaderId());
1268 TEST_LOG.info("testLeaderTransitioning ending");
1271 @SuppressWarnings({ "unchecked", "rawtypes" })
1273 public void testReplicateWithPersistencePending() throws Exception {
1274 final String leaderId = factory.generateActorId("leader-");
1275 final String followerId = factory.generateActorId("follower-");
1277 final ActorRef followerActor = factory.createActor(MessageCollectorActor.props());
1279 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1280 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
1281 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
1283 DataPersistenceProvider mockPersistenceProvider = mock(DataPersistenceProvider.class);
1284 doReturn(true).when(mockPersistenceProvider).isRecoveryApplicable();
1286 TestActorRef<MockRaftActor> leaderActorRef = factory.createTestActor(
1287 MockRaftActor.props(leaderId, ImmutableMap.of(followerId, followerActor.path().toString()), config,
1288 mockPersistenceProvider), leaderId);
1289 MockRaftActor leaderActor = leaderActorRef.underlyingActor();
1290 leaderActor.waitForInitializeBehaviorComplete();
1292 leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId);
1294 Leader leader = new Leader(leaderActor.getRaftActorContext());
1295 leaderActor.setCurrentBehavior(leader);
1297 leaderActor.persistData(leaderActorRef, new MockIdentifier("1"), new MockRaftActorContext.MockPayload("1"),
1300 ReplicatedLogEntry logEntry = leaderActor.getReplicatedLog().get(0);
1301 assertNotNull("ReplicatedLogEntry not found", logEntry);
1302 assertEquals("isPersistencePending", true, logEntry.isPersistencePending());
1303 assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex());
1305 leaderActor.onReceiveCommand(new AppendEntriesReply(followerId, 1, true, 0, 1, (short)0));
1306 assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex());
1308 ArgumentCaptor<Procedure> callbackCaptor = ArgumentCaptor.forClass(Procedure.class);
1309 verify(mockPersistenceProvider).persistAsync(eq(logEntry), callbackCaptor.capture());
1311 callbackCaptor.getValue().apply(logEntry);
1313 assertEquals("getCommitIndex", 0, leaderActor.getRaftActorContext().getCommitIndex());
1314 assertEquals("getLastApplied", 0, leaderActor.getRaftActorContext().getLastApplied());
1318 public void testReplicateWithBatchHint() throws Exception {
1319 final String leaderId = factory.generateActorId("leader-");
1320 final String followerId = factory.generateActorId("follower-");
1322 final ActorRef followerActor = factory.createActor(MessageCollectorActor.props());
1324 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1325 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
1326 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
1328 TestActorRef<MockRaftActor> leaderActorRef = factory.createTestActor(
1329 MockRaftActor.props(leaderId, ImmutableMap.of(followerId, followerActor.path().toString()), config),
1331 MockRaftActor leaderActor = leaderActorRef.underlyingActor();
1332 leaderActor.waitForInitializeBehaviorComplete();
1334 leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId);
1336 Leader leader = new Leader(leaderActor.getRaftActorContext());
1337 leaderActor.setCurrentBehavior(leader);
1339 MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1340 MessageCollectorActor.clearMessages(followerActor);
1342 leaderActor.onReceiveCommand(new AppendEntriesReply(followerId, 1, true, -1, -1, (short)0));
1344 leaderActor.persistData(leaderActorRef, new MockIdentifier("1"), new MockPayload("1"), true);
1345 MessageCollectorActor.assertNoneMatching(followerActor, AppendEntries.class, 500);
1347 leaderActor.persistData(leaderActorRef, new MockIdentifier("2"), new MockPayload("2"), true);
1348 MessageCollectorActor.assertNoneMatching(followerActor, AppendEntries.class, 500);
1350 leaderActor.persistData(leaderActorRef, new MockIdentifier("3"), new MockPayload("3"), false);
1351 AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1352 assertEquals("AppendEntries size", 3, appendEntries.getEntries().size());