2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.raft;
11 import static org.junit.Assert.assertArrayEquals;
12 import static org.junit.Assert.assertEquals;
13 import static org.junit.Assert.assertNotNull;
14 import static org.junit.Assert.assertNotSame;
15 import static org.junit.Assert.assertNull;
16 import static org.junit.Assert.assertSame;
17 import static org.junit.Assert.assertTrue;
18 import static org.mockito.Matchers.any;
19 import static org.mockito.Matchers.anyObject;
20 import static org.mockito.Matchers.eq;
21 import static org.mockito.Matchers.same;
22 import static org.mockito.Mockito.doReturn;
23 import static org.mockito.Mockito.mock;
24 import static org.mockito.Mockito.never;
25 import static org.mockito.Mockito.reset;
26 import static org.mockito.Mockito.timeout;
27 import static org.mockito.Mockito.verify;
28 import akka.actor.ActorRef;
29 import akka.actor.PoisonPill;
30 import akka.actor.Props;
31 import akka.actor.Status.Failure;
32 import akka.actor.Terminated;
33 import akka.dispatch.Dispatchers;
34 import akka.japi.Procedure;
35 import akka.persistence.SaveSnapshotFailure;
36 import akka.persistence.SaveSnapshotSuccess;
37 import akka.persistence.SnapshotMetadata;
38 import akka.persistence.SnapshotOffer;
39 import akka.testkit.JavaTestKit;
40 import akka.testkit.TestActorRef;
41 import com.google.common.base.Optional;
42 import com.google.common.collect.ImmutableMap;
43 import com.google.common.util.concurrent.Uninterruptibles;
44 import com.google.protobuf.ByteString;
45 import java.io.ByteArrayOutputStream;
46 import java.io.ObjectOutputStream;
47 import java.util.ArrayList;
48 import java.util.Arrays;
49 import java.util.Collections;
50 import java.util.HashMap;
51 import java.util.List;
53 import java.util.concurrent.TimeUnit;
54 import java.util.concurrent.TimeoutException;
55 import org.apache.commons.lang3.SerializationUtils;
56 import org.junit.After;
57 import org.junit.Before;
58 import org.junit.Test;
59 import org.mockito.ArgumentCaptor;
60 import org.opendaylight.controller.cluster.DataPersistenceProvider;
61 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
62 import org.opendaylight.controller.cluster.PersistentDataProvider;
63 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
64 import org.opendaylight.controller.cluster.notifications.RoleChanged;
65 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
66 import org.opendaylight.controller.cluster.raft.ServerConfigurationPayload.ServerInfo;
67 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
68 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
69 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
70 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
71 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
72 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
73 import org.opendaylight.controller.cluster.raft.base.messages.DeleteEntries;
74 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
75 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
76 import org.opendaylight.controller.cluster.raft.base.messages.UpdateElectionTerm;
77 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
78 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
79 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
80 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
81 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
82 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
83 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
84 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
85 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
86 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
87 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
88 import org.slf4j.Logger;
89 import org.slf4j.LoggerFactory;
90 import scala.concurrent.duration.Duration;
91 import scala.concurrent.duration.FiniteDuration;
93 public class RaftActorTest extends AbstractActorTest {
95 static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
97 private TestActorFactory factory;
101 factory = new TestActorFactory(getSystem());
105 public void tearDown() throws Exception {
107 InMemoryJournal.clear();
108 InMemorySnapshotStore.clear();
112 public void testConstruction() {
113 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
117 public void testFindLeaderWhenLeaderIsSelf(){
118 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
119 kit.waitUntilLeader();
124 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
125 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
127 new JavaTestKit(getSystem()) {{
128 String persistenceId = factory.generateActorId("follower-");
130 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
132 // Set the heartbeat interval high to essentially disable election otherwise the test
133 // may fail if the actor is switched to Leader and the commitIndex is set to the last
135 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
137 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
138 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
139 peerAddresses, config), persistenceId);
141 watch(followerActor);
143 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
144 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
145 new MockRaftActorContext.MockPayload("E"));
146 snapshotUnappliedEntries.add(entry1);
148 int lastAppliedDuringSnapshotCapture = 3;
149 int lastIndexDuringSnapshotCapture = 4;
151 // 4 messages as part of snapshot, which are applied to state
152 ByteString snapshotBytes = fromObject(Arrays.asList(
153 new MockRaftActorContext.MockPayload("A"),
154 new MockRaftActorContext.MockPayload("B"),
155 new MockRaftActorContext.MockPayload("C"),
156 new MockRaftActorContext.MockPayload("D")));
158 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
159 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
160 lastAppliedDuringSnapshotCapture, 1);
161 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
163 // add more entries after snapshot is taken
164 List<ReplicatedLogEntry> entries = new ArrayList<>();
165 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
166 new MockRaftActorContext.MockPayload("F", 2));
167 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
168 new MockRaftActorContext.MockPayload("G", 3));
169 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
170 new MockRaftActorContext.MockPayload("H", 4));
175 int lastAppliedToState = 5;
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 expectMsgClass(duration("5 seconds"), Terminated.class);
188 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());
212 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
216 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
217 new JavaTestKit(getSystem()) {{
218 String persistenceId = factory.generateActorId("follower-");
220 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
222 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
224 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
225 ImmutableMap.<String, String>builder().put("member1", "address").build(),
226 config, new NonPersistentDataProvider()), persistenceId);
228 MockRaftActor mockRaftActor = ref.underlyingActor();
230 mockRaftActor.waitForRecoveryComplete();
232 mockRaftActor.waitForInitializeBehaviorComplete();
234 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
239 public void testUpdateElectionTermPersistedWithPersistenceDisabled() throws Exception {
240 new JavaTestKit(getSystem()) {{
241 String persistenceId = factory.generateActorId("follower-");
242 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
243 config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
244 config.setElectionTimeoutFactor(1);
246 InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1);
248 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
249 ImmutableMap.<String, String>builder().put("member1", "address").build(),
250 config, new NonPersistentDataProvider()).
251 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
253 InMemoryJournal.waitForWriteMessagesComplete(persistenceId);
254 List<UpdateElectionTerm> entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
255 assertEquals("UpdateElectionTerm entries", 1, entries.size());
256 UpdateElectionTerm updateEntry = entries.get(0);
258 factory.killActor(ref, this);
260 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
261 ref = factory.createTestActor(MockRaftActor.props(persistenceId,
262 ImmutableMap.<String, String>builder().put("member1", "address").build(), config,
263 new NonPersistentDataProvider()).
264 withDispatcher(Dispatchers.DefaultDispatcherId()),
265 factory.generateActorId("follower-"));
267 MockRaftActor actor = ref.underlyingActor();
268 actor.waitForRecoveryComplete();
270 RaftActorContext newContext = actor.getRaftActorContext();
271 assertEquals("electionTerm", updateEntry.getCurrentTerm(),
272 newContext.getTermInformation().getCurrentTerm());
273 assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor());
275 entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
276 assertEquals("UpdateElectionTerm entries", 1, entries.size());
281 public void testRaftActorForwardsToRaftActorRecoverySupport() {
282 String persistenceId = factory.generateActorId("leader-");
284 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
286 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
288 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
289 Collections.<String, String>emptyMap(), config), persistenceId);
291 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
293 // Wait for akka's recovery to complete so it doesn't interfere.
294 mockRaftActor.waitForRecoveryComplete();
296 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
297 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
299 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
300 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
301 mockRaftActor.handleRecover(snapshotOffer);
303 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
304 1, new MockRaftActorContext.MockPayload("1", 5));
305 mockRaftActor.handleRecover(logEntry);
307 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
308 mockRaftActor.handleRecover(applyJournalEntries);
310 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
311 mockRaftActor.handleRecover(applyLogEntries);
313 DeleteEntries deleteEntries = new DeleteEntries(1);
314 mockRaftActor.handleRecover(deleteEntries);
316 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
317 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
318 mockRaftActor.handleRecover(deprecatedDeleteEntries);
320 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
321 mockRaftActor.handleRecover(updateElectionTerm);
323 org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm deprecatedUpdateElectionTerm =
324 new org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm(6, "member3");
325 mockRaftActor.handleRecover(deprecatedUpdateElectionTerm);
327 verify(mockSupport).handleRecoveryMessage(same(snapshotOffer), any(PersistentDataProvider.class));
328 verify(mockSupport).handleRecoveryMessage(same(logEntry), any(PersistentDataProvider.class));
329 verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries), any(PersistentDataProvider.class));
330 verify(mockSupport).handleRecoveryMessage(same(applyLogEntries), any(PersistentDataProvider.class));
331 verify(mockSupport).handleRecoveryMessage(same(deleteEntries), any(PersistentDataProvider.class));
332 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries), any(PersistentDataProvider.class));
333 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm), any(PersistentDataProvider.class));
334 verify(mockSupport).handleRecoveryMessage(same(deprecatedUpdateElectionTerm), any(PersistentDataProvider.class));
338 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
339 String persistenceId = factory.generateActorId("leader-");
341 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
343 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
345 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
347 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
348 config(config).snapshotMessageSupport(mockSupport).props());
350 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
352 // Wait for akka's recovery to complete so it doesn't interfere.
353 mockRaftActor.waitForRecoveryComplete();
355 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
356 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
357 mockRaftActor.handleCommand(applySnapshot);
359 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1, null);
360 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot), any(ActorRef.class));
361 mockRaftActor.handleCommand(captureSnapshot);
363 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
364 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
365 mockRaftActor.handleCommand(captureSnapshotReply);
367 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
368 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
369 mockRaftActor.handleCommand(saveSnapshotSuccess);
371 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
372 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
373 mockRaftActor.handleCommand(saveSnapshotFailure);
375 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
376 any(ActorRef.class));
377 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
379 doReturn(true).when(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
380 mockRaftActor.handleCommand(GetSnapshot.INSTANCE);
382 verify(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
383 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot), any(ActorRef.class));
384 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
385 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
386 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
387 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
388 any(ActorRef.class));
389 verify(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
393 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
394 new JavaTestKit(getSystem()) {
396 String persistenceId = factory.generateActorId("leader-");
398 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
400 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
402 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
404 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
405 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
407 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
409 mockRaftActor.waitForInitializeBehaviorComplete();
411 mockRaftActor.waitUntilLeader();
413 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
415 verify(dataPersistenceProvider).persist(any(ApplyJournalEntries.class), any(Procedure.class));
423 public void testApplyState() throws Exception {
425 new JavaTestKit(getSystem()) {
427 String persistenceId = factory.generateActorId("leader-");
429 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
431 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
433 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
435 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
436 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
438 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
440 mockRaftActor.waitForInitializeBehaviorComplete();
442 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
443 new MockRaftActorContext.MockPayload("F"));
445 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
447 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
454 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
455 new JavaTestKit(getSystem()) {{
456 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
457 Props.create(MessageCollectorActor.class));
458 MessageCollectorActor.waitUntilReady(notifierActor);
460 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
461 long heartBeatInterval = 100;
462 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
463 config.setElectionTimeoutFactor(20);
465 String persistenceId = factory.generateActorId("notifier-");
467 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
468 config(config).roleChangeNotifier(notifierActor).dataPersistenceProvider(
469 new NonPersistentDataProvider()).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
472 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
475 // check if the notifier got a role change from null to Follower
476 RoleChanged raftRoleChanged = matches.get(0);
477 assertEquals(persistenceId, raftRoleChanged.getMemberId());
478 assertNull(raftRoleChanged.getOldRole());
479 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
481 // check if the notifier got a role change from Follower to Candidate
482 raftRoleChanged = matches.get(1);
483 assertEquals(persistenceId, raftRoleChanged.getMemberId());
484 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
485 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
487 // check if the notifier got a role change from Candidate to Leader
488 raftRoleChanged = matches.get(2);
489 assertEquals(persistenceId, raftRoleChanged.getMemberId());
490 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
491 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
493 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
494 notifierActor, LeaderStateChanged.class);
496 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
497 assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
499 notifierActor.underlyingActor().clear();
501 MockRaftActor raftActor = raftActorRef.underlyingActor();
502 final String newLeaderId = "new-leader";
503 final short newLeaderVersion = 6;
504 Follower follower = new Follower(raftActor.getRaftActorContext()) {
506 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
507 leaderId = newLeaderId;
508 setLeaderPayloadVersion(newLeaderVersion);
513 raftActor.newBehavior(follower);
515 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
516 assertEquals(persistenceId, leaderStateChange.getMemberId());
517 assertEquals(null, leaderStateChange.getLeaderId());
519 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
520 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
521 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
523 notifierActor.underlyingActor().clear();
525 raftActor.handleCommand("any");
527 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
528 assertEquals(persistenceId, leaderStateChange.getMemberId());
529 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
530 assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
532 notifierActor.underlyingActor().clear();
534 raftActor.handleCommand("any");
536 Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
537 leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
538 assertNull(leaderStateChange);
543 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
544 new JavaTestKit(getSystem()) {{
545 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
546 MessageCollectorActor.waitUntilReady(notifierActor);
548 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
549 long heartBeatInterval = 100;
550 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
551 config.setElectionTimeoutFactor(1);
553 String persistenceId = factory.generateActorId("notifier-");
555 factory.createActor(MockRaftActor.builder().id(persistenceId).
556 peerAddresses(ImmutableMap.of("leader", "fake/path")).
557 config(config).roleChangeNotifier(notifierActor).props());
559 List<RoleChanged> matches = null;
560 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
561 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
562 assertNotNull(matches);
563 if(matches.size() == 3) {
566 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
569 assertNotNull(matches);
570 assertEquals(2, matches.size());
572 // check if the notifier got a role change from null to Follower
573 RoleChanged raftRoleChanged = matches.get(0);
574 assertEquals(persistenceId, raftRoleChanged.getMemberId());
575 assertNull(raftRoleChanged.getOldRole());
576 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
578 // check if the notifier got a role change from Follower to Candidate
579 raftRoleChanged = matches.get(1);
580 assertEquals(persistenceId, raftRoleChanged.getMemberId());
581 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
582 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
588 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
589 new JavaTestKit(getSystem()) {
591 String persistenceId = factory.generateActorId("leader-");
592 String follower1Id = factory.generateActorId("follower-");
594 ActorRef followerActor1 =
595 factory.createActor(Props.create(MessageCollectorActor.class));
597 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
598 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
599 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
601 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
603 Map<String, String> peerAddresses = new HashMap<>();
604 peerAddresses.put(follower1Id, followerActor1.path().toString());
606 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
607 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
609 MockRaftActor leaderActor = mockActorRef.underlyingActor();
611 leaderActor.getRaftActorContext().setCommitIndex(4);
612 leaderActor.getRaftActorContext().setLastApplied(4);
613 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
615 leaderActor.waitForInitializeBehaviorComplete();
617 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
619 Leader leader = new Leader(leaderActor.getRaftActorContext());
620 leaderActor.setCurrentBehavior(leader);
621 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
623 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
624 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
626 assertEquals(8, leaderActor.getReplicatedLog().size());
628 leaderActor.getRaftActorContext().getSnapshotManager()
629 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
630 new MockRaftActorContext.MockPayload("x")), 4);
632 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
634 assertEquals(8, leaderActor.getReplicatedLog().size());
636 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
637 //fake snapshot on index 5
638 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
640 assertEquals(8, leaderActor.getReplicatedLog().size());
642 //fake snapshot on index 6
643 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
644 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
645 assertEquals(8, leaderActor.getReplicatedLog().size());
647 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
649 assertEquals(8, leaderActor.getReplicatedLog().size());
651 ByteString snapshotBytes = fromObject(Arrays.asList(
652 new MockRaftActorContext.MockPayload("foo-0"),
653 new MockRaftActorContext.MockPayload("foo-1"),
654 new MockRaftActorContext.MockPayload("foo-2"),
655 new MockRaftActorContext.MockPayload("foo-3"),
656 new MockRaftActorContext.MockPayload("foo-4")));
658 leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotBytes.toByteArray(),
659 leader, Runtime.getRuntime().totalMemory());
661 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
663 // The commit is needed to complete the snapshot creation process
664 leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, leader);
666 // capture snapshot reply should remove the snapshotted entries only
667 assertEquals(3, leaderActor.getReplicatedLog().size());
668 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
670 // add another non-replicated entry
671 leaderActor.getReplicatedLog().append(
672 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
674 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
675 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
676 assertEquals(2, leaderActor.getReplicatedLog().size());
677 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
684 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
685 new JavaTestKit(getSystem()) {
687 String persistenceId = factory.generateActorId("follower-");
688 String leaderId = factory.generateActorId("leader-");
691 ActorRef leaderActor1 =
692 factory.createActor(Props.create(MessageCollectorActor.class));
694 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
695 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
696 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
698 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
700 Map<String, String> peerAddresses = new HashMap<>();
701 peerAddresses.put(leaderId, leaderActor1.path().toString());
703 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
704 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
706 MockRaftActor followerActor = mockActorRef.underlyingActor();
707 followerActor.getRaftActorContext().setCommitIndex(4);
708 followerActor.getRaftActorContext().setLastApplied(4);
709 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
711 followerActor.waitForInitializeBehaviorComplete();
714 Follower follower = new Follower(followerActor.getRaftActorContext());
715 followerActor.setCurrentBehavior(follower);
716 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
718 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
719 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
720 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
722 // log has indices 0-5
723 assertEquals(6, followerActor.getReplicatedLog().size());
726 followerActor.getRaftActorContext().getSnapshotManager().capture(
727 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
728 new MockRaftActorContext.MockPayload("D")), 4);
730 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
732 assertEquals(6, followerActor.getReplicatedLog().size());
734 //fake snapshot on index 6
735 List<ReplicatedLogEntry> entries =
737 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
738 new MockRaftActorContext.MockPayload("foo-6"))
740 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
741 assertEquals(7, followerActor.getReplicatedLog().size());
743 //fake snapshot on index 7
744 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
748 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
749 new MockRaftActorContext.MockPayload("foo-7"))
751 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
752 assertEquals(8, followerActor.getReplicatedLog().size());
754 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
757 ByteString snapshotBytes = fromObject(Arrays.asList(
758 new MockRaftActorContext.MockPayload("foo-0"),
759 new MockRaftActorContext.MockPayload("foo-1"),
760 new MockRaftActorContext.MockPayload("foo-2"),
761 new MockRaftActorContext.MockPayload("foo-3"),
762 new MockRaftActorContext.MockPayload("foo-4")));
763 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
764 assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
766 // The commit is needed to complete the snapshot creation process
767 followerActor.getRaftActorContext().getSnapshotManager().commit(-1, follower);
769 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
770 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
771 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
775 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
776 new MockRaftActorContext.MockPayload("foo-7"))
778 // send an additional entry 8 with leaderCommit = 7
779 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
781 // 7 and 8, as lastapplied is 7
782 assertEquals(2, followerActor.getReplicatedLog().size());
789 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
790 new JavaTestKit(getSystem()) {
792 String persistenceId = factory.generateActorId("leader-");
793 String follower1Id = factory.generateActorId("follower-");
794 String follower2Id = factory.generateActorId("follower-");
796 ActorRef followerActor1 =
797 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
798 ActorRef followerActor2 =
799 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
801 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
802 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
803 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
805 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
807 Map<String, String> peerAddresses = new HashMap<>();
808 peerAddresses.put(follower1Id, followerActor1.path().toString());
809 peerAddresses.put(follower2Id, followerActor2.path().toString());
811 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
812 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
814 MockRaftActor leaderActor = mockActorRef.underlyingActor();
815 leaderActor.getRaftActorContext().setCommitIndex(9);
816 leaderActor.getRaftActorContext().setLastApplied(9);
817 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
819 leaderActor.waitForInitializeBehaviorComplete();
821 Leader leader = new Leader(leaderActor.getRaftActorContext());
822 leaderActor.setCurrentBehavior(leader);
823 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
825 // create 5 entries in the log
826 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
827 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
829 //set the snapshot index to 4 , 0 to 4 are snapshotted
830 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
831 //setting replicatedToAllIndex = 9, for the log to clear
832 leader.setReplicatedToAllIndex(9);
833 assertEquals(5, leaderActor.getReplicatedLog().size());
834 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
836 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
837 assertEquals(5, leaderActor.getReplicatedLog().size());
838 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
840 // set the 2nd follower nextIndex to 1 which has been snapshotted
841 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
842 assertEquals(5, leaderActor.getReplicatedLog().size());
843 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
845 // simulate a real snapshot
846 leaderActor.onReceiveCommand(new SendHeartBeat());
847 assertEquals(5, leaderActor.getReplicatedLog().size());
848 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
849 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
850 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
853 //reply from a slow follower does not initiate a fake snapshot
854 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
855 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
857 ByteString snapshotBytes = fromObject(Arrays.asList(
858 new MockRaftActorContext.MockPayload("foo-0"),
859 new MockRaftActorContext.MockPayload("foo-1"),
860 new MockRaftActorContext.MockPayload("foo-2"),
861 new MockRaftActorContext.MockPayload("foo-3"),
862 new MockRaftActorContext.MockPayload("foo-4")));
863 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
864 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
866 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
868 //reply from a slow follower after should not raise errors
869 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
870 assertEquals(0, leaderActor.getReplicatedLog().size());
876 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
877 new JavaTestKit(getSystem()) {{
878 String persistenceId = factory.generateActorId("leader-");
879 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
880 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
881 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
882 config.setSnapshotBatchCount(5);
884 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
886 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
888 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
889 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
891 MockRaftActor leaderActor = mockActorRef.underlyingActor();
892 leaderActor.getRaftActorContext().setCommitIndex(3);
893 leaderActor.getRaftActorContext().setLastApplied(3);
894 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
896 leaderActor.waitForInitializeBehaviorComplete();
897 for(int i=0;i< 4;i++) {
898 leaderActor.getReplicatedLog()
899 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
900 new MockRaftActorContext.MockPayload("A")));
903 Leader leader = new Leader(leaderActor.getRaftActorContext());
904 leaderActor.setCurrentBehavior(leader);
905 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
907 // Simulate an install snaphost to a follower.
908 leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
909 leaderActor.getReplicatedLog().last(), -1, "member1");
911 // Now send a CaptureSnapshotReply
912 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
914 // Trimming log in this scenario is a no-op
915 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
916 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
917 assertEquals(-1, leader.getReplicatedToAllIndex());
923 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
924 new JavaTestKit(getSystem()) {{
925 String persistenceId = factory.generateActorId("leader-");
926 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
927 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
928 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
929 config.setSnapshotBatchCount(5);
931 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
933 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
935 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
936 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
938 MockRaftActor leaderActor = mockActorRef.underlyingActor();
939 leaderActor.getRaftActorContext().setCommitIndex(3);
940 leaderActor.getRaftActorContext().setLastApplied(3);
941 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
942 leaderActor.getReplicatedLog().setSnapshotIndex(3);
944 leaderActor.waitForInitializeBehaviorComplete();
945 Leader leader = new Leader(leaderActor.getRaftActorContext());
946 leaderActor.setCurrentBehavior(leader);
947 leader.setReplicatedToAllIndex(3);
948 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
950 // Persist another entry (this will cause a CaptureSnapshot to be triggered
951 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
953 // Now send a CaptureSnapshotReply
954 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
956 // Trimming log in this scenario is a no-op
957 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
958 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
959 assertEquals(3, leader.getReplicatedToAllIndex());
965 public void testRaftActorOnRecoverySnapshot() throws Exception {
966 TEST_LOG.info("testRaftActorOnRecoverySnapshot");
968 new JavaTestKit(getSystem()) {{
969 String persistenceId = factory.generateActorId("follower-");
971 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
973 // Set the heartbeat interval high to essentially disable election otherwise the test
974 // may fail if the actor is switched to Leader
975 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
977 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
979 // Create mock ReplicatedLogEntry
980 ReplicatedLogEntry replLogEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,1,
981 new MockRaftActorContext.MockPayload("F", 1));
983 InMemoryJournal.addEntry(persistenceId, 1, replLogEntry);
985 TestActorRef<MockRaftActor> ref = factory.createTestActor(
986 MockRaftActor.props(persistenceId, peerAddresses, config));
988 MockRaftActor mockRaftActor = ref.underlyingActor();
990 mockRaftActor.waitForRecoveryComplete();
992 mockRaftActor.waitForInitializeBehaviorComplete();
994 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(any(ActorRef.class));
999 public void testSwitchBehavior(){
1000 String persistenceId = factory.generateActorId("leader-");
1001 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1002 config.setCustomRaftPolicyImplementationClass("org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
1003 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
1004 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
1005 config.setSnapshotBatchCount(5);
1007 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
1009 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().build();
1011 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
1012 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
1014 MockRaftActor leaderActor = mockActorRef.underlyingActor();
1016 leaderActor.waitForRecoveryComplete();
1018 leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100));
1020 assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1021 assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state());
1023 leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110));
1025 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1026 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
1028 leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125));
1030 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1031 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
1033 leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125));
1035 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
1036 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
1039 public static ByteString fromObject(Object snapshot) throws Exception {
1040 ByteArrayOutputStream b = null;
1041 ObjectOutputStream o = null;
1043 b = new ByteArrayOutputStream();
1044 o = new ObjectOutputStream(b);
1045 o.writeObject(snapshot);
1046 byte[] snapshotBytes = b.toByteArray();
1047 return ByteString.copyFrom(snapshotBytes);
1060 public void testUpdateConfigParam() throws Exception {
1061 DefaultConfigParamsImpl emptyConfig = new DefaultConfigParamsImpl();
1062 String persistenceId = factory.generateActorId("follower-");
1063 ImmutableMap<String, String> peerAddresses =
1064 ImmutableMap.<String, String>builder().put("member1", "address").build();
1065 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
1067 TestActorRef<MockRaftActor> actorRef = factory.createTestActor(
1068 MockRaftActor.props(persistenceId, peerAddresses, emptyConfig, dataPersistenceProvider), persistenceId);
1069 MockRaftActor mockRaftActor = actorRef.underlyingActor();
1070 mockRaftActor.waitForInitializeBehaviorComplete();
1072 RaftActorBehavior behavior = mockRaftActor.getCurrentBehavior();
1073 mockRaftActor.updateConfigParams(emptyConfig);
1074 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1075 assertEquals("Behavior State", RaftState.Follower,
1076 mockRaftActor.getCurrentBehavior().state());
1078 DefaultConfigParamsImpl disableConfig = new DefaultConfigParamsImpl();
1079 disableConfig.setCustomRaftPolicyImplementationClass(
1080 "org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
1081 mockRaftActor.updateConfigParams(disableConfig);
1082 assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
1083 assertEquals("Behavior State", RaftState.Follower,
1084 mockRaftActor.getCurrentBehavior().state());
1086 behavior = mockRaftActor.getCurrentBehavior();
1087 mockRaftActor.updateConfigParams(disableConfig);
1088 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1089 assertEquals("Behavior State", RaftState.Follower,
1090 mockRaftActor.getCurrentBehavior().state());
1092 DefaultConfigParamsImpl defaultConfig = new DefaultConfigParamsImpl();
1093 defaultConfig.setCustomRaftPolicyImplementationClass(
1094 "org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy");
1095 mockRaftActor.updateConfigParams(defaultConfig);
1096 assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
1097 assertEquals("Behavior State", RaftState.Follower,
1098 mockRaftActor.getCurrentBehavior().state());
1100 behavior = mockRaftActor.getCurrentBehavior();
1101 mockRaftActor.updateConfigParams(defaultConfig);
1102 assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1103 assertEquals("Behavior State", RaftState.Follower,
1104 mockRaftActor.getCurrentBehavior().state());
1108 public void testGetSnapshot() throws Exception {
1109 TEST_LOG.info("testGetSnapshot starting");
1111 JavaTestKit kit = new JavaTestKit(getSystem());
1113 String persistenceId = factory.generateActorId("test-actor-");
1114 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1115 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1119 InMemoryJournal.addEntry(persistenceId, seqN++, new UpdateElectionTerm(term, "member-1"));
1120 InMemoryJournal.addEntry(persistenceId, seqN++, new MockRaftActorContext.MockReplicatedLogEntry(term, 0,
1121 new MockRaftActorContext.MockPayload("A")));
1122 InMemoryJournal.addEntry(persistenceId, seqN++, new MockRaftActorContext.MockReplicatedLogEntry(term, 1,
1123 new MockRaftActorContext.MockPayload("B")));
1124 InMemoryJournal.addEntry(persistenceId, seqN++, new ApplyJournalEntries(1));
1125 InMemoryJournal.addEntry(persistenceId, seqN++, new MockRaftActorContext.MockReplicatedLogEntry(term, 2,
1126 new MockRaftActorContext.MockPayload("C")));
1128 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
1129 ImmutableMap.<String, String>builder().put("member1", "address").build(), config).
1130 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1131 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1133 mockRaftActor.waitForRecoveryComplete();
1135 // Wait for snapshot after recovery
1136 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(any(ActorRef.class));
1138 mockRaftActor.snapshotCohortDelegate = mock(RaftActorSnapshotCohort.class);
1140 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1142 ArgumentCaptor<ActorRef> replyActor = ArgumentCaptor.forClass(ActorRef.class);
1143 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(replyActor.capture());
1145 byte[] stateSnapshot = new byte[]{1,2,3};
1146 replyActor.getValue().tell(new CaptureSnapshotReply(stateSnapshot), ActorRef.noSender());
1148 GetSnapshotReply reply = kit.expectMsgClass(GetSnapshotReply.class);
1150 assertEquals("getId", persistenceId, reply.getId());
1151 Snapshot replySnapshot = SerializationUtils.deserialize(reply.getSnapshot());
1152 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1153 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1154 assertEquals("getLastAppliedIndex", 1L, replySnapshot.getLastAppliedIndex());
1155 assertEquals("getLastAppliedTerm", term, replySnapshot.getLastAppliedTerm());
1156 assertEquals("getLastIndex", 2L, replySnapshot.getLastIndex());
1157 assertEquals("getLastTerm", term, replySnapshot.getLastTerm());
1158 assertArrayEquals("getState", stateSnapshot, replySnapshot.getState());
1159 assertEquals("getUnAppliedEntries size", 1, replySnapshot.getUnAppliedEntries().size());
1160 assertEquals("UnApplied entry index ", 2L, replySnapshot.getUnAppliedEntries().get(0).getIndex());
1162 // Test with timeout
1164 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(Duration.create(200, TimeUnit.MILLISECONDS));
1165 reset(mockRaftActor.snapshotCohortDelegate);
1167 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1168 Failure failure = kit.expectMsgClass(akka.actor.Status.Failure.class);
1169 assertEquals("Failure cause type", TimeoutException.class, failure.cause().getClass());
1171 mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(Duration.create(30, TimeUnit.SECONDS));
1173 // Test with persistence disabled.
1175 mockRaftActor.setPersistence(false);
1176 reset(mockRaftActor.snapshotCohortDelegate);
1178 raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1179 reply = kit.expectMsgClass(GetSnapshotReply.class);
1180 verify(mockRaftActor.snapshotCohortDelegate, never()).createSnapshot(any(ActorRef.class));
1182 assertEquals("getId", persistenceId, reply.getId());
1183 replySnapshot = SerializationUtils.deserialize(reply.getSnapshot());
1184 assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1185 assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1186 assertEquals("getLastAppliedIndex", -1L, replySnapshot.getLastAppliedIndex());
1187 assertEquals("getLastAppliedTerm", -1L, replySnapshot.getLastAppliedTerm());
1188 assertEquals("getLastIndex", -1L, replySnapshot.getLastIndex());
1189 assertEquals("getLastTerm", -1L, replySnapshot.getLastTerm());
1190 assertEquals("getState length", 0, replySnapshot.getState().length);
1191 assertEquals("getUnAppliedEntries size", 0, replySnapshot.getUnAppliedEntries().size());
1193 TEST_LOG.info("testGetSnapshot ending");
1197 public void testRestoreFromSnapshot() throws Exception {
1198 TEST_LOG.info("testRestoreFromSnapshot starting");
1200 String persistenceId = factory.generateActorId("test-actor-");
1201 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1202 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1204 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
1205 snapshotUnappliedEntries.add(new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
1206 new MockRaftActorContext.MockPayload("E")));
1208 int snapshotLastApplied = 3;
1209 int snapshotLastIndex = 4;
1211 List<MockPayload> state = Arrays.asList(
1212 new MockRaftActorContext.MockPayload("A"),
1213 new MockRaftActorContext.MockPayload("B"),
1214 new MockRaftActorContext.MockPayload("C"),
1215 new MockRaftActorContext.MockPayload("D"));
1216 ByteString stateBytes = fromObject(state);
1218 Snapshot snapshot = Snapshot.create(stateBytes.toByteArray(), snapshotUnappliedEntries,
1219 snapshotLastIndex, 1, snapshotLastApplied, 1, 1, "member-1");
1221 InMemorySnapshotStore.addSnapshotSavedLatch(persistenceId);
1223 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1224 config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).props().
1225 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1226 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1228 mockRaftActor.waitForRecoveryComplete();
1230 Snapshot savedSnapshot = InMemorySnapshotStore.waitForSavedSnapshot(persistenceId, Snapshot.class);
1231 assertEquals("getElectionTerm", snapshot.getElectionTerm(), savedSnapshot.getElectionTerm());
1232 assertEquals("getElectionVotedFor", snapshot.getElectionVotedFor(), savedSnapshot.getElectionVotedFor());
1233 assertEquals("getLastAppliedIndex", snapshot.getLastAppliedIndex(), savedSnapshot.getLastAppliedIndex());
1234 assertEquals("getLastAppliedTerm", snapshot.getLastAppliedTerm(), savedSnapshot.getLastAppliedTerm());
1235 assertEquals("getLastIndex", snapshot.getLastIndex(), savedSnapshot.getLastIndex());
1236 assertEquals("getLastTerm", snapshot.getLastTerm(), savedSnapshot.getLastTerm());
1237 assertArrayEquals("getState", snapshot.getState(), savedSnapshot.getState());
1238 assertEquals("getUnAppliedEntries", snapshot.getUnAppliedEntries(), savedSnapshot.getUnAppliedEntries());
1240 verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).applySnapshot(any(byte[].class));
1242 RaftActorContext context = mockRaftActor.getRaftActorContext();
1243 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1244 assertEquals("Last index", snapshotLastIndex, context.getReplicatedLog().lastIndex());
1245 assertEquals("Last applied", snapshotLastApplied, context.getLastApplied());
1246 assertEquals("Commit index", snapshotLastApplied, context.getCommitIndex());
1247 assertEquals("Recovered state", state, mockRaftActor.getState());
1248 assertEquals("Current term", 1L, context.getTermInformation().getCurrentTerm());
1249 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1251 // Test with data persistence disabled
1253 snapshot = Snapshot.create(new byte[0], Collections.<ReplicatedLogEntry>emptyList(),
1254 -1, -1, -1, -1, 5, "member-1");
1256 persistenceId = factory.generateActorId("test-actor-");
1258 raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1259 config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).
1260 persistent(Optional.of(Boolean.FALSE)).props().
1261 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1262 mockRaftActor = raftActorRef.underlyingActor();
1264 mockRaftActor.waitForRecoveryComplete();
1265 assertEquals("snapshot committed", true,
1266 Uninterruptibles.awaitUninterruptibly(mockRaftActor.snapshotCommitted, 5, TimeUnit.SECONDS));
1268 context = mockRaftActor.getRaftActorContext();
1269 assertEquals("Current term", 5L, context.getTermInformation().getCurrentTerm());
1270 assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1272 TEST_LOG.info("testRestoreFromSnapshot ending");
1276 public void testRestoreFromSnapshotWithRecoveredData() throws Exception {
1277 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData starting");
1279 String persistenceId = factory.generateActorId("test-actor-");
1280 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1281 config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1283 List<MockPayload> state = Arrays.asList(new MockRaftActorContext.MockPayload("A"));
1284 Snapshot snapshot = Snapshot.create(fromObject(state).toByteArray(), Arrays.<ReplicatedLogEntry>asList(),
1285 5, 2, 5, 2, 2, "member-1");
1287 InMemoryJournal.addEntry(persistenceId, 1, new MockRaftActorContext.MockReplicatedLogEntry(1, 0,
1288 new MockRaftActorContext.MockPayload("B")));
1290 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1291 config(config).restoreFromSnapshot(SerializationUtils.serialize(snapshot)).props().
1292 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1293 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1295 mockRaftActor.waitForRecoveryComplete();
1297 verify(mockRaftActor.snapshotCohortDelegate, timeout(500).never()).applySnapshot(any(byte[].class));
1299 RaftActorContext context = mockRaftActor.getRaftActorContext();
1300 assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1301 assertEquals("Last index", 0, context.getReplicatedLog().lastIndex());
1302 assertEquals("Last applied", -1, context.getLastApplied());
1303 assertEquals("Commit index", -1, context.getCommitIndex());
1304 assertEquals("Current term", 0, context.getTermInformation().getCurrentTerm());
1305 assertEquals("Voted for", null, context.getTermInformation().getVotedFor());
1307 TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData ending");
1311 public void testNonVotingOnRecovery() throws Exception {
1312 TEST_LOG.info("testNonVotingOnRecovery starting");
1314 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1315 config.setElectionTimeoutFactor(1);
1316 config.setHeartBeatInterval(FiniteDuration.create(1, TimeUnit.MILLISECONDS));
1318 String persistenceId = factory.generateActorId("test-actor-");
1319 InMemoryJournal.addEntry(persistenceId, 1, new MockRaftActorContext.MockReplicatedLogEntry(1, 0,
1320 new ServerConfigurationPayload(Arrays.asList(new ServerInfo(persistenceId, false)))));
1322 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId).
1323 config(config).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1324 MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1326 mockRaftActor.waitForInitializeBehaviorComplete();
1328 // Sleep a bit and verify it didn't get an election timeout and schedule an election.
1330 Uninterruptibles.sleepUninterruptibly(400, TimeUnit.MILLISECONDS);
1331 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
1333 TEST_LOG.info("testNonVotingOnRecovery ending");