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;
29 import akka.actor.ActorRef;
30 import akka.actor.PoisonPill;
31 import akka.actor.Props;
32 import akka.actor.Status.Failure;
33 import akka.actor.Terminated;
34 import akka.dispatch.Dispatchers;
35 import akka.japi.Procedure;
36 import akka.persistence.SaveSnapshotFailure;
37 import akka.persistence.SaveSnapshotSuccess;
38 import akka.persistence.SnapshotMetadata;
39 import akka.persistence.SnapshotOffer;
40 import akka.testkit.JavaTestKit;
41 import akka.testkit.TestActorRef;
42 import com.google.common.base.Optional;
43 import com.google.common.collect.ImmutableMap;
44 import com.google.common.util.concurrent.Uninterruptibles;
45 import com.google.protobuf.ByteString;
46 import java.io.ByteArrayOutputStream;
47 import java.io.ObjectOutputStream;
48 import java.util.ArrayList;
49 import java.util.Arrays;
50 import java.util.Collections;
51 import java.util.HashMap;
52 import java.util.List;
54 import java.util.concurrent.TimeUnit;
55 import java.util.concurrent.TimeoutException;
56 import org.apache.commons.lang3.SerializationUtils;
57 import org.junit.After;
58 import org.junit.Before;
59 import org.junit.Test;
60 import org.mockito.ArgumentCaptor;
61 import org.opendaylight.controller.cluster.DataPersistenceProvider;
62 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
63 import org.opendaylight.controller.cluster.PersistentDataProvider;
64 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
65 import org.opendaylight.controller.cluster.notifications.RoleChanged;
66 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
67 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
68 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
69 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
70 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
71 import org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning;
72 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
73 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
74 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
75 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
76 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
77 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
78 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
79 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
80 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
81 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
82 import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries;
83 import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
84 import org.opendaylight.controller.cluster.raft.persisted.ServerInfo;
85 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
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() throws Exception {
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() throws Exception {
129 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
131 JavaTestKit kit = new JavaTestKit(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 ByteString snapshotBytes = fromObject(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(snapshotBytes.toByteArray(),
163 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
164 lastAppliedDuringSnapshotCapture, 1);
165 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
167 // add more entries after snapshot is taken
168 List<ReplicatedLogEntry> entries = new ArrayList<>();
169 ReplicatedLogEntry entry2 = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F", 2));
170 ReplicatedLogEntry entry3 = new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("G", 3));
171 ReplicatedLogEntry entry4 = new SimpleReplicatedLogEntry(7, 1, new MockRaftActorContext.MockPayload("H", 4));
176 final int lastAppliedToState = 5;
177 final int lastIndex = 7;
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 kit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
189 kit.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());
212 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
216 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
217 String persistenceId = factory.generateActorId("follower-");
219 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
221 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
223 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
224 ImmutableMap.<String, String>builder().put("member1", "address").build(),
225 config, new NonPersistentDataProvider()), persistenceId);
227 MockRaftActor mockRaftActor = ref.underlyingActor();
229 mockRaftActor.waitForRecoveryComplete();
231 mockRaftActor.waitForInitializeBehaviorComplete();
233 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
237 public void testUpdateElectionTermPersistedWithPersistenceDisabled() throws Exception {
238 final JavaTestKit kit = new JavaTestKit(getSystem());
239 String persistenceId = factory.generateActorId("follower-");
240 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
241 config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
242 config.setElectionTimeoutFactor(1);
244 InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1);
246 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
247 ImmutableMap.<String, String>builder().put("member1", "address").build(),
248 config, new NonPersistentDataProvider())
249 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
251 InMemoryJournal.waitForWriteMessagesComplete(persistenceId);
252 List<UpdateElectionTerm> entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
253 assertEquals("UpdateElectionTerm entries", 1, entries.size());
254 final UpdateElectionTerm updateEntry = entries.get(0);
256 factory.killActor(ref, kit);
258 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
259 ref = factory.createTestActor(MockRaftActor.props(persistenceId,
260 ImmutableMap.<String, String>builder().put("member1", "address").build(), config,
261 new NonPersistentDataProvider()).withDispatcher(Dispatchers.DefaultDispatcherId()),
262 factory.generateActorId("follower-"));
264 MockRaftActor actor = ref.underlyingActor();
265 actor.waitForRecoveryComplete();
267 RaftActorContext newContext = actor.getRaftActorContext();
268 assertEquals("electionTerm", updateEntry.getCurrentTerm(),
269 newContext.getTermInformation().getCurrentTerm());
270 assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor());
272 entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
273 assertEquals("UpdateElectionTerm entries", 1, entries.size());
277 public void testRaftActorForwardsToRaftActorRecoverySupport() {
278 String persistenceId = factory.generateActorId("leader-");
280 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
282 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
284 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
285 Collections.<String, String>emptyMap(), config), persistenceId);
287 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
289 // Wait for akka's recovery to complete so it doesn't interfere.
290 mockRaftActor.waitForRecoveryComplete();
292 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
293 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
295 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
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 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1, null);
341 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot), any(ActorRef.class));
342 mockRaftActor.handleCommand(captureSnapshot);
344 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
345 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
346 mockRaftActor.handleCommand(captureSnapshotReply);
348 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(new SnapshotMetadata("", 0L, 0L));
349 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
350 mockRaftActor.handleCommand(saveSnapshotSuccess);
352 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(new SnapshotMetadata("", 0L, 0L),
354 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
355 mockRaftActor.handleCommand(saveSnapshotFailure);
357 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
358 any(ActorRef.class));
359 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
361 doReturn(true).when(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
362 mockRaftActor.handleCommand(GetSnapshot.INSTANCE);
364 verify(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
365 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot), any(ActorRef.class));
366 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
367 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
368 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
369 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
370 any(ActorRef.class));
371 verify(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
374 @SuppressWarnings("unchecked")
376 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
377 String persistenceId = factory.generateActorId("leader-");
379 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
381 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
383 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
385 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
386 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
388 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
390 mockRaftActor.waitForInitializeBehaviorComplete();
392 mockRaftActor.waitUntilLeader();
394 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
396 verify(dataPersistenceProvider).persistAsync(any(ApplyJournalEntries.class), any(Procedure.class));
400 public void testApplyState() throws Exception {
401 String persistenceId = factory.generateActorId("leader-");
403 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
405 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
407 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
409 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
410 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
412 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
414 mockRaftActor.waitForInitializeBehaviorComplete();
416 ReplicatedLogEntry entry = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F"));
418 final Identifier id = new MockIdentifier("apply-state");
419 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, id, entry));
421 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq(id), anyObject());
425 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
426 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
427 Props.create(MessageCollectorActor.class));
428 MessageCollectorActor.waitUntilReady(notifierActor);
430 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
431 long heartBeatInterval = 100;
432 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
433 config.setElectionTimeoutFactor(20);
435 String persistenceId = factory.generateActorId("notifier-");
437 final TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder()
438 .id(persistenceId).config(config).roleChangeNotifier(notifierActor).dataPersistenceProvider(
439 new NonPersistentDataProvider()).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
442 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
445 // check if the notifier got a role change from null to Follower
446 RoleChanged raftRoleChanged = matches.get(0);
447 assertEquals(persistenceId, raftRoleChanged.getMemberId());
448 assertNull(raftRoleChanged.getOldRole());
449 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
451 // check if the notifier got a role change from Follower to Candidate
452 raftRoleChanged = matches.get(1);
453 assertEquals(persistenceId, raftRoleChanged.getMemberId());
454 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
455 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
457 // check if the notifier got a role change from Candidate to Leader
458 raftRoleChanged = matches.get(2);
459 assertEquals(persistenceId, raftRoleChanged.getMemberId());
460 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
461 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
463 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
464 notifierActor, LeaderStateChanged.class);
466 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
467 assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
469 notifierActor.underlyingActor().clear();
471 MockRaftActor raftActor = raftActorRef.underlyingActor();
472 final String newLeaderId = "new-leader";
473 final short newLeaderVersion = 6;
474 Follower follower = new Follower(raftActor.getRaftActorContext()) {
476 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
477 setLeaderId(newLeaderId);
478 setLeaderPayloadVersion(newLeaderVersion);
483 raftActor.newBehavior(follower);
485 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
486 assertEquals(persistenceId, leaderStateChange.getMemberId());
487 assertEquals(null, leaderStateChange.getLeaderId());
489 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
490 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
491 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
493 notifierActor.underlyingActor().clear();
495 raftActor.handleCommand("any");
497 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
498 assertEquals(persistenceId, leaderStateChange.getMemberId());
499 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
500 assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
502 notifierActor.underlyingActor().clear();
504 raftActor.handleCommand("any");
506 Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
507 leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
508 assertNull(leaderStateChange);
512 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
513 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
514 MessageCollectorActor.waitUntilReady(notifierActor);
516 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
517 long heartBeatInterval = 100;
518 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
519 config.setElectionTimeoutFactor(1);
521 String persistenceId = factory.generateActorId("notifier-");
523 factory.createActor(MockRaftActor.builder().id(persistenceId)
524 .peerAddresses(ImmutableMap.of("leader", "fake/path"))
525 .config(config).roleChangeNotifier(notifierActor).props());
527 List<RoleChanged> matches = null;
528 for (int i = 0; i < 5000 / heartBeatInterval; i++) {
529 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
530 assertNotNull(matches);
531 if (matches.size() == 3) {
534 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
537 assertNotNull(matches);
538 assertEquals(2, matches.size());
540 // check if the notifier got a role change from null to Follower
541 RoleChanged raftRoleChanged = matches.get(0);
542 assertEquals(persistenceId, raftRoleChanged.getMemberId());
543 assertNull(raftRoleChanged.getOldRole());
544 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
546 // check if the notifier got a role change from Follower to Candidate
547 raftRoleChanged = matches.get(1);
548 assertEquals(persistenceId, raftRoleChanged.getMemberId());
549 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
550 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
554 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
555 final String persistenceId = factory.generateActorId("leader-");
556 final String follower1Id = factory.generateActorId("follower-");
558 ActorRef followerActor1 =
559 factory.createActor(Props.create(MessageCollectorActor.class));
561 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
562 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
563 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
565 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
567 Map<String, String> peerAddresses = new HashMap<>();
568 peerAddresses.put(follower1Id, followerActor1.path().toString());
570 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
571 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
573 MockRaftActor leaderActor = mockActorRef.underlyingActor();
575 leaderActor.getRaftActorContext().setCommitIndex(4);
576 leaderActor.getRaftActorContext().setLastApplied(4);
577 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
579 leaderActor.waitForInitializeBehaviorComplete();
581 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
583 Leader leader = new Leader(leaderActor.getRaftActorContext());
584 leaderActor.setCurrentBehavior(leader);
585 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
587 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
588 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
590 assertEquals(8, leaderActor.getReplicatedLog().size());
592 leaderActor.getRaftActorContext().getSnapshotManager().capture(
593 new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("x")), 4);
595 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
597 assertEquals(8, leaderActor.getReplicatedLog().size());
599 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
600 //fake snapshot on index 5
601 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
603 assertEquals(8, leaderActor.getReplicatedLog().size());
605 //fake snapshot on index 6
606 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
607 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
608 assertEquals(8, leaderActor.getReplicatedLog().size());
610 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
612 assertEquals(8, leaderActor.getReplicatedLog().size());
614 ByteString snapshotBytes = fromObject(Arrays.asList(
615 new MockRaftActorContext.MockPayload("foo-0"),
616 new MockRaftActorContext.MockPayload("foo-1"),
617 new MockRaftActorContext.MockPayload("foo-2"),
618 new MockRaftActorContext.MockPayload("foo-3"),
619 new MockRaftActorContext.MockPayload("foo-4")));
621 leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotBytes.toByteArray(),
622 Runtime.getRuntime().totalMemory());
624 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
626 // The commit is needed to complete the snapshot creation process
627 leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, -1);
629 // capture snapshot reply should remove the snapshotted entries only
630 assertEquals(3, leaderActor.getReplicatedLog().size());
631 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
633 // add another non-replicated entry
634 leaderActor.getReplicatedLog().append(
635 new SimpleReplicatedLogEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
637 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
638 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
639 assertEquals(2, leaderActor.getReplicatedLog().size());
640 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
644 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
645 final String persistenceId = factory.generateActorId("follower-");
646 final String leaderId = factory.generateActorId("leader-");
649 ActorRef leaderActor1 =
650 factory.createActor(Props.create(MessageCollectorActor.class));
652 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
653 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
654 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
656 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
658 Map<String, String> peerAddresses = new HashMap<>();
659 peerAddresses.put(leaderId, leaderActor1.path().toString());
661 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
662 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
664 MockRaftActor followerActor = mockActorRef.underlyingActor();
665 followerActor.getRaftActorContext().setCommitIndex(4);
666 followerActor.getRaftActorContext().setLastApplied(4);
667 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
669 followerActor.waitForInitializeBehaviorComplete();
672 Follower follower = new Follower(followerActor.getRaftActorContext());
673 followerActor.setCurrentBehavior(follower);
674 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
676 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
677 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
678 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
680 // log has indices 0-5
681 assertEquals(6, followerActor.getReplicatedLog().size());
684 followerActor.getRaftActorContext().getSnapshotManager().capture(
685 new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("D")), 4);
687 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
689 assertEquals(6, followerActor.getReplicatedLog().size());
691 //fake snapshot on index 6
692 List<ReplicatedLogEntry> entries = Arrays.asList(
693 (ReplicatedLogEntry) new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("foo-6")));
694 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
695 assertEquals(7, followerActor.getReplicatedLog().size());
697 //fake snapshot on index 7
698 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
700 entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(7, 1,
701 new MockRaftActorContext.MockPayload("foo-7")));
702 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
703 assertEquals(8, followerActor.getReplicatedLog().size());
705 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
708 ByteString snapshotBytes = fromObject(Arrays.asList(
709 new MockRaftActorContext.MockPayload("foo-0"),
710 new MockRaftActorContext.MockPayload("foo-1"),
711 new MockRaftActorContext.MockPayload("foo-2"),
712 new MockRaftActorContext.MockPayload("foo-3"),
713 new MockRaftActorContext.MockPayload("foo-4")));
714 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
715 assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
717 // The commit is needed to complete the snapshot creation process
718 followerActor.getRaftActorContext().getSnapshotManager().commit(-1, -1);
720 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
721 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
722 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
724 entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(8, 1,
725 new MockRaftActorContext.MockPayload("foo-7")));
726 // send an additional entry 8 with leaderCommit = 7
727 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
729 // 7 and 8, as lastapplied is 7
730 assertEquals(2, followerActor.getReplicatedLog().size());
734 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
735 final String persistenceId = factory.generateActorId("leader-");
736 final String follower1Id = factory.generateActorId("follower-");
737 final String follower2Id = factory.generateActorId("follower-");
739 final ActorRef followerActor1 = factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
740 final ActorRef followerActor2 = factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
742 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
743 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
744 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
746 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
748 Map<String, String> peerAddresses = new HashMap<>();
749 peerAddresses.put(follower1Id, followerActor1.path().toString());
750 peerAddresses.put(follower2Id, followerActor2.path().toString());
752 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
753 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
755 MockRaftActor leaderActor = mockActorRef.underlyingActor();
756 leaderActor.getRaftActorContext().setCommitIndex(9);
757 leaderActor.getRaftActorContext().setLastApplied(9);
758 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
760 leaderActor.waitForInitializeBehaviorComplete();
762 Leader leader = new Leader(leaderActor.getRaftActorContext());
763 leaderActor.setCurrentBehavior(leader);
764 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
766 // create 5 entries in the log
767 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
768 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
770 //set the snapshot index to 4 , 0 to 4 are snapshotted
771 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
772 //setting replicatedToAllIndex = 9, for the log to clear
773 leader.setReplicatedToAllIndex(9);
774 assertEquals(5, leaderActor.getReplicatedLog().size());
775 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
777 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
778 assertEquals(5, leaderActor.getReplicatedLog().size());
779 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
781 // set the 2nd follower nextIndex to 1 which has been snapshotted
782 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
783 assertEquals(5, leaderActor.getReplicatedLog().size());
784 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
786 // simulate a real snapshot
787 leaderActor.onReceiveCommand(SendHeartBeat.INSTANCE);
788 assertEquals(5, leaderActor.getReplicatedLog().size());
789 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
790 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId()),
791 RaftState.Leader, leaderActor.getCurrentBehavior().state());
794 //reply from a slow follower does not initiate a fake snapshot
795 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
796 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5,
797 leaderActor.getReplicatedLog().size());
799 ByteString snapshotBytes = fromObject(Arrays.asList(
800 new MockRaftActorContext.MockPayload("foo-0"),
801 new MockRaftActorContext.MockPayload("foo-1"),
802 new MockRaftActorContext.MockPayload("foo-2"),
803 new MockRaftActorContext.MockPayload("foo-3"),
804 new MockRaftActorContext.MockPayload("foo-4")));
805 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
806 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
808 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0,
809 leaderActor.getReplicatedLog().size());
811 //reply from a slow follower after should not raise errors
812 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
813 assertEquals(0, leaderActor.getReplicatedLog().size());
817 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
818 String persistenceId = factory.generateActorId("leader-");
819 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
820 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
821 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
822 config.setSnapshotBatchCount(5);
824 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
826 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
828 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
829 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
831 MockRaftActor leaderActor = mockActorRef.underlyingActor();
832 leaderActor.getRaftActorContext().setCommitIndex(3);
833 leaderActor.getRaftActorContext().setLastApplied(3);
834 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
836 leaderActor.waitForInitializeBehaviorComplete();
837 for (int i = 0; i < 4; i++) {
838 leaderActor.getReplicatedLog().append(new SimpleReplicatedLogEntry(i, 1,
839 new MockRaftActorContext.MockPayload("A")));
842 Leader leader = new Leader(leaderActor.getRaftActorContext());
843 leaderActor.setCurrentBehavior(leader);
844 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
846 // Simulate an install snaphost to a follower.
847 leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
848 leaderActor.getReplicatedLog().last(), -1, "member1");
850 // Now send a CaptureSnapshotReply
851 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
853 // Trimming log in this scenario is a no-op
854 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
855 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
856 assertEquals(-1, leader.getReplicatedToAllIndex());
860 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
861 String persistenceId = factory.generateActorId("leader-");
862 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
863 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
864 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
865 config.setSnapshotBatchCount(5);
867 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
869 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
871 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
872 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
874 MockRaftActor leaderActor = mockActorRef.underlyingActor();
875 leaderActor.getRaftActorContext().setCommitIndex(3);
876 leaderActor.getRaftActorContext().setLastApplied(3);
877 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
878 leaderActor.getReplicatedLog().setSnapshotIndex(3);
880 leaderActor.waitForInitializeBehaviorComplete();
881 Leader leader = new Leader(leaderActor.getRaftActorContext());
882 leaderActor.setCurrentBehavior(leader);
883 leader.setReplicatedToAllIndex(3);
884 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
886 // Persist another entry (this will cause a CaptureSnapshot to be triggered
887 leaderActor.persistData(mockActorRef, new MockIdentifier("x"),
888 new MockRaftActorContext.MockPayload("duh"));
890 // Now send a CaptureSnapshotReply
891 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
893 // Trimming log in this scenario is a no-op
894 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
895 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
896 assertEquals(3, leader.getReplicatedToAllIndex());
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 = new NonPersistentDataProvider();
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(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() throws Exception {
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() throws Exception {
1010 TEST_LOG.info("testGetSnapshot starting");
1012 final JavaTestKit kit = new JavaTestKit(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());
1043 byte[] stateSnapshot = new byte[]{1,2,3};
1044 replyActor.getValue().tell(new CaptureSnapshotReply(stateSnapshot), ActorRef.noSender());
1046 GetSnapshotReply reply = kit.expectMsgClass(GetSnapshotReply.class);
1048 assertEquals("getId", persistenceId, reply.getId());
1049 Snapshot replySnapshot = SerializationUtils.deserialize(reply.getSnapshot());
1050 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1051 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1052 assertEquals("getLastAppliedIndex", 1L, replySnapshot.getLastAppliedIndex());
1053 assertEquals("getLastAppliedTerm", term, replySnapshot.getLastAppliedTerm());
1054 assertEquals("getLastIndex", 2L, replySnapshot.getLastIndex());
1055 assertEquals("getLastTerm", term, replySnapshot.getLastTerm());
1056 assertArrayEquals("getState", stateSnapshot, replySnapshot.getState());
1057 assertEquals("getUnAppliedEntries size", 1, replySnapshot.getUnAppliedEntries().size());
1058 assertEquals("UnApplied entry index ", 2L, replySnapshot.getUnAppliedEntries().get(0).getIndex());
1060 // Test with timeout
1062 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(
1063 Duration.create(200, TimeUnit.MILLISECONDS));
1064 reset(mockRaftActor.snapshotCohortDelegate);
1066 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1067 Failure failure = kit.expectMsgClass(akka.actor.Status.Failure.class);
1068 assertEquals("Failure cause type", TimeoutException.class, failure.cause().getClass());
1070 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(Duration.create(30, TimeUnit.SECONDS));
1072 // Test with persistence disabled.
1074 mockRaftActor.setPersistence(false);
1075 reset(mockRaftActor.snapshotCohortDelegate);
1077 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1078 reply = kit.expectMsgClass(GetSnapshotReply.class);
1079 verify(mockRaftActor.snapshotCohortDelegate, never()).createSnapshot(any(ActorRef.class));
1081 assertEquals("getId", persistenceId, reply.getId());
1082 replySnapshot = SerializationUtils.deserialize(reply.getSnapshot());
1083 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1084 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1085 assertEquals("getLastAppliedIndex", -1L, replySnapshot.getLastAppliedIndex());
1086 assertEquals("getLastAppliedTerm", -1L, replySnapshot.getLastAppliedTerm());
1087 assertEquals("getLastIndex", -1L, replySnapshot.getLastIndex());
1088 assertEquals("getLastTerm", -1L, replySnapshot.getLastTerm());
1089 assertEquals("getState length", 0, replySnapshot.getState().length);
1090 assertEquals("getUnAppliedEntries size", 0, replySnapshot.getUnAppliedEntries().size());
1092 TEST_LOG.info("testGetSnapshot ending");
1096 public void testRestoreFromSnapshot() throws Exception {
1097 TEST_LOG.info("testRestoreFromSnapshot starting");
1099 String persistenceId = factory.generateActorId("test-actor-");
1100 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1101 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1103 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
1104 snapshotUnappliedEntries.add(new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E")));
1106 int snapshotLastApplied = 3;
1107 int snapshotLastIndex = 4;
1109 List<MockPayload> state = Arrays.asList(
1110 new MockRaftActorContext.MockPayload("A"),
1111 new MockRaftActorContext.MockPayload("B"),
1112 new MockRaftActorContext.MockPayload("C"),
1113 new MockRaftActorContext.MockPayload("D"));
1114 ByteString stateBytes = fromObject(state);
1116 Snapshot snapshot = Snapshot.create(stateBytes.toByteArray(), snapshotUnappliedEntries,
1117 snapshotLastIndex, 1, snapshotLastApplied, 1, 1, "member-1");
1119 InMemorySnapshotStore.addSnapshotSavedLatch(persistenceId);
1121 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1122 .config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).props()
1123 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1124 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1126 mockRaftActor.waitForRecoveryComplete();
1128 Snapshot savedSnapshot = InMemorySnapshotStore.waitForSavedSnapshot(persistenceId, Snapshot.class);
1129 assertEquals("getElectionTerm", snapshot.getElectionTerm(), savedSnapshot.getElectionTerm());
1130 assertEquals("getElectionVotedFor", snapshot.getElectionVotedFor(), savedSnapshot.getElectionVotedFor());
1131 assertEquals("getLastAppliedIndex", snapshot.getLastAppliedIndex(), savedSnapshot.getLastAppliedIndex());
1132 assertEquals("getLastAppliedTerm", snapshot.getLastAppliedTerm(), savedSnapshot.getLastAppliedTerm());
1133 assertEquals("getLastIndex", snapshot.getLastIndex(), savedSnapshot.getLastIndex());
1134 assertEquals("getLastTerm", snapshot.getLastTerm(), savedSnapshot.getLastTerm());
1135 assertArrayEquals("getState", snapshot.getState(), savedSnapshot.getState());
1136 assertEquals("getUnAppliedEntries", snapshot.getUnAppliedEntries(), savedSnapshot.getUnAppliedEntries());
1138 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).applySnapshot(any(byte[].class));
1140 RaftActorContext context = mockRaftActor.getRaftActorContext();
1141 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1142 assertEquals("Last index", snapshotLastIndex, context.getReplicatedLog().lastIndex());
1143 assertEquals("Last applied", snapshotLastApplied, context.getLastApplied());
1144 assertEquals("Commit index", snapshotLastApplied, context.getCommitIndex());
1145 assertEquals("Recovered state", state, mockRaftActor.getState());
1146 assertEquals("Current term", 1L, context.getTermInformation().getCurrentTerm());
1147 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1149 // Test with data persistence disabled
1151 snapshot = Snapshot.create(new byte[0], Collections.<ReplicatedLogEntry>emptyList(),
1152 -1, -1, -1, -1, 5, "member-1");
1154 persistenceId = factory.generateActorId("test-actor-");
1156 raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1157 .config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot))
1158 .persistent(Optional.of(Boolean.FALSE)).props()
1159 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1160 mockRaftActor = raftActorRef.underlyingActor();
1162 mockRaftActor.waitForRecoveryComplete();
1163 assertEquals("snapshot committed", true,
1164 Uninterruptibles.awaitUninterruptibly(mockRaftActor.snapshotCommitted, 5, TimeUnit.SECONDS));
1166 context = mockRaftActor.getRaftActorContext();
1167 assertEquals("Current term", 5L, context.getTermInformation().getCurrentTerm());
1168 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1170 TEST_LOG.info("testRestoreFromSnapshot ending");
1174 public void testRestoreFromSnapshotWithRecoveredData() throws Exception {
1175 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData starting");
1177 String persistenceId = factory.generateActorId("test-actor-");
1178 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1179 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1181 List<MockPayload> state = Arrays.asList(new MockRaftActorContext.MockPayload("A"));
1182 Snapshot snapshot = Snapshot.create(fromObject(state).toByteArray(), Arrays.<ReplicatedLogEntry>asList(),
1183 5, 2, 5, 2, 2, "member-1");
1185 InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1,
1186 new MockRaftActorContext.MockPayload("B")));
1188 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1189 .config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).props()
1190 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1191 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1193 mockRaftActor.waitForRecoveryComplete();
1195 Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
1196 verify(mockRaftActor.snapshotCohortDelegate, never()).applySnapshot(any(byte[].class));
1198 RaftActorContext context = mockRaftActor.getRaftActorContext();
1199 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1200 assertEquals("Last index", 0, context.getReplicatedLog().lastIndex());
1201 assertEquals("Last applied", -1, context.getLastApplied());
1202 assertEquals("Commit index", -1, context.getCommitIndex());
1203 assertEquals("Current term", 0, context.getTermInformation().getCurrentTerm());
1204 assertEquals("Voted for", null, context.getTermInformation().getVotedFor());
1206 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData ending");
1210 public void testNonVotingOnRecovery() throws Exception {
1211 TEST_LOG.info("testNonVotingOnRecovery starting");
1213 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1214 config.setElectionTimeoutFactor(1);
1215 config.setHeartBeatInterval(FiniteDuration.create(1, TimeUnit.MILLISECONDS));
1217 String persistenceId = factory.generateActorId("test-actor-");
1218 InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1,
1219 new ServerConfigurationPayload(Arrays.asList(new ServerInfo(persistenceId, false)))));
1221 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1222 .config(config).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1223 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1225 mockRaftActor.waitForInitializeBehaviorComplete();
1227 // Sleep a bit and verify it didn't get an election timeout and schedule an election.
1229 Uninterruptibles.sleepUninterruptibly(400, TimeUnit.MILLISECONDS);
1230 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
1232 TEST_LOG.info("testNonVotingOnRecovery ending");
1236 public void testLeaderTransitioning() throws Exception {
1237 TEST_LOG.info("testLeaderTransitioning starting");
1239 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
1240 Props.create(MessageCollectorActor.class));
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(LeaderTransitioning.INSTANCE, 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(Props.create(MessageCollectorActor.class));
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"));
1299 ReplicatedLogEntry logEntry = leaderActor.getReplicatedLog().get(0);
1300 assertNotNull("ReplicatedLogEntry not found", logEntry);
1301 assertEquals("isPersistencePending", true, logEntry.isPersistencePending());
1302 assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex());
1304 leaderActor.onReceiveCommand(new AppendEntriesReply(followerId, 1, true, 0, 1, (short)0));
1305 assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex());
1307 ArgumentCaptor<Procedure> callbackCaptor = ArgumentCaptor.forClass(Procedure.class);
1308 verify(mockPersistenceProvider).persistAsync(eq(logEntry), callbackCaptor.capture());
1310 callbackCaptor.getValue().apply(logEntry);
1312 assertEquals("getCommitIndex", 0, leaderActor.getRaftActorContext().getCommitIndex());
1313 assertEquals("getLastApplied", 0, leaderActor.getRaftActorContext().getLastApplied());