2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.raft;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertNull;
14 import static org.junit.Assert.assertTrue;
15 import static org.mockito.Matchers.any;
16 import static org.mockito.Matchers.anyObject;
17 import static org.mockito.Matchers.eq;
18 import static org.mockito.Matchers.same;
19 import static org.mockito.Mockito.doReturn;
20 import static org.mockito.Mockito.mock;
21 import static org.mockito.Mockito.verify;
22 import akka.actor.ActorRef;
23 import akka.actor.PoisonPill;
24 import akka.actor.Props;
25 import akka.actor.Terminated;
26 import akka.dispatch.Dispatchers;
27 import akka.japi.Procedure;
28 import akka.persistence.RecoveryCompleted;
29 import akka.persistence.SaveSnapshotFailure;
30 import akka.persistence.SaveSnapshotSuccess;
31 import akka.persistence.SnapshotMetadata;
32 import akka.persistence.SnapshotOffer;
33 import akka.testkit.JavaTestKit;
34 import akka.testkit.TestActorRef;
35 import com.google.common.base.Optional;
36 import com.google.common.collect.ImmutableMap;
37 import com.google.common.util.concurrent.Uninterruptibles;
38 import com.google.protobuf.ByteString;
39 import java.io.ByteArrayOutputStream;
40 import java.io.ObjectOutputStream;
41 import java.util.ArrayList;
42 import java.util.Arrays;
43 import java.util.Collections;
44 import java.util.HashMap;
45 import java.util.List;
47 import java.util.concurrent.TimeUnit;
48 import org.junit.After;
49 import org.junit.Before;
50 import org.junit.Test;
51 import org.opendaylight.controller.cluster.DataPersistenceProvider;
52 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
53 import org.opendaylight.controller.cluster.PersistentDataProvider;
54 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
55 import org.opendaylight.controller.cluster.notifications.RoleChanged;
56 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
57 import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries;
58 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
59 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
60 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
61 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
62 import org.opendaylight.controller.cluster.raft.base.messages.DeleteEntries;
63 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
64 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
65 import org.opendaylight.controller.cluster.raft.base.messages.UpdateElectionTerm;
66 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
67 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
68 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
69 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
70 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
71 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
72 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
73 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
74 import org.slf4j.Logger;
75 import org.slf4j.LoggerFactory;
76 import scala.concurrent.duration.FiniteDuration;
78 public class RaftActorTest extends AbstractActorTest {
80 static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
82 private TestActorFactory factory;
86 factory = new TestActorFactory(getSystem());
90 public void tearDown() throws Exception {
92 InMemoryJournal.clear();
93 InMemorySnapshotStore.clear();
97 public void testConstruction() {
98 new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
102 public void testFindLeaderWhenLeaderIsSelf(){
103 RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
104 kit.waitUntilLeader();
108 public void testRaftActorRecoveryWithPersistenceEnabled() throws Exception {
109 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
111 new JavaTestKit(getSystem()) {{
112 String persistenceId = factory.generateActorId("follower-");
114 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
116 // Set the heartbeat interval high to essentially disable election otherwise the test
117 // may fail if the actor is switched to Leader and the commitIndex is set to the last
119 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
121 ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
122 ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
123 peerAddresses, Optional.<ConfigParams>of(config)), persistenceId);
125 watch(followerActor);
127 List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
128 ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4,
129 new MockRaftActorContext.MockPayload("E"));
130 snapshotUnappliedEntries.add(entry1);
132 int lastAppliedDuringSnapshotCapture = 3;
133 int lastIndexDuringSnapshotCapture = 4;
135 // 4 messages as part of snapshot, which are applied to state
136 ByteString snapshotBytes = fromObject(Arrays.asList(
137 new MockRaftActorContext.MockPayload("A"),
138 new MockRaftActorContext.MockPayload("B"),
139 new MockRaftActorContext.MockPayload("C"),
140 new MockRaftActorContext.MockPayload("D")));
142 Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(),
143 snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
144 lastAppliedDuringSnapshotCapture, 1);
145 InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
147 // add more entries after snapshot is taken
148 List<ReplicatedLogEntry> entries = new ArrayList<>();
149 ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
150 new MockRaftActorContext.MockPayload("F", 2));
151 ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
152 new MockRaftActorContext.MockPayload("G", 3));
153 ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
154 new MockRaftActorContext.MockPayload("H", 4));
159 int lastAppliedToState = 5;
162 InMemoryJournal.addEntry(persistenceId, 5, entry2);
163 // 2 entries are applied to state besides the 4 entries in snapshot
164 InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
165 InMemoryJournal.addEntry(persistenceId, 7, entry3);
166 InMemoryJournal.addEntry(persistenceId, 8, entry4);
169 followerActor.tell(PoisonPill.getInstance(), null);
170 expectMsgClass(duration("5 seconds"), Terminated.class);
172 unwatch(followerActor);
174 //reinstate the actor
175 TestActorRef<MockRaftActor> ref = factory.createTestActor(
176 MockRaftActor.props(persistenceId, peerAddresses, Optional.<ConfigParams>of(config)));
178 MockRaftActor mockRaftActor = ref.underlyingActor();
180 mockRaftActor.waitForRecoveryComplete();
182 RaftActorContext context = mockRaftActor.getRaftActorContext();
183 assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
184 context.getReplicatedLog().size());
185 assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
186 assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
187 assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
188 assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
189 assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
191 mockRaftActor.waitForInitializeBehaviorComplete();
193 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
196 TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
200 public void testRaftActorRecoveryWithPersistenceDisabled() throws Exception {
201 new JavaTestKit(getSystem()) {{
202 String persistenceId = factory.generateActorId("follower-");
204 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
206 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
208 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
209 ImmutableMap.<String, String>builder().put("member1", "address").build(),
210 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()), persistenceId);
212 MockRaftActor mockRaftActor = ref.underlyingActor();
214 mockRaftActor.waitForRecoveryComplete();
216 mockRaftActor.waitForInitializeBehaviorComplete();
218 assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
223 public void testUpdateElectionTermPersistedWithPersistenceDisabled() throws Exception {
224 new JavaTestKit(getSystem()) {{
225 String persistenceId = factory.generateActorId("follower-");
226 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
227 config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
228 config.setElectionTimeoutFactor(1);
230 InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1);
232 TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
233 ImmutableMap.<String, String>builder().put("member1", "address").build(),
234 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()).
235 withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
237 InMemoryJournal.waitForWriteMessagesComplete(persistenceId);
238 List<UpdateElectionTerm> entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
239 assertEquals("UpdateElectionTerm entries", 1, entries.size());
240 UpdateElectionTerm updateEntry = entries.get(0);
242 factory.killActor(ref, this);
244 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
245 ref = factory.createTestActor(MockRaftActor.props(persistenceId,
246 ImmutableMap.<String, String>builder().put("member1", "address").build(),
247 Optional.<ConfigParams>of(config), new NonPersistentDataProvider()).
248 withDispatcher(Dispatchers.DefaultDispatcherId()),
249 factory.generateActorId("follower-"));
251 MockRaftActor actor = ref.underlyingActor();
252 actor.waitForRecoveryComplete();
254 RaftActorContext newContext = actor.getRaftActorContext();
255 assertEquals("electionTerm", updateEntry.getCurrentTerm(),
256 newContext.getTermInformation().getCurrentTerm());
257 assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor());
259 entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
260 assertEquals("UpdateElectionTerm entries", 1, entries.size());
265 public void testRaftActorForwardsToRaftActorRecoverySupport() {
266 String persistenceId = factory.generateActorId("leader-");
268 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
270 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
272 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
273 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config)), persistenceId);
275 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
277 // Wait for akka's recovery to complete so it doesn't interfere.
278 mockRaftActor.waitForRecoveryComplete();
280 RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
281 mockRaftActor.setRaftActorRecoverySupport(mockSupport );
283 Snapshot snapshot = Snapshot.create(new byte[]{1}, Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1);
284 SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
285 mockRaftActor.handleRecover(snapshotOffer);
287 MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(1,
288 1, new MockRaftActorContext.MockPayload("1", 5));
289 mockRaftActor.handleRecover(logEntry);
291 ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
292 mockRaftActor.handleRecover(applyJournalEntries);
294 ApplyLogEntries applyLogEntries = new ApplyLogEntries(0);
295 mockRaftActor.handleRecover(applyLogEntries);
297 DeleteEntries deleteEntries = new DeleteEntries(1);
298 mockRaftActor.handleRecover(deleteEntries);
300 org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries deprecatedDeleteEntries =
301 new org.opendaylight.controller.cluster.raft.RaftActor.DeleteEntries(1);
302 mockRaftActor.handleRecover(deprecatedDeleteEntries);
304 UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
305 mockRaftActor.handleRecover(updateElectionTerm);
307 org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm deprecatedUpdateElectionTerm =
308 new org.opendaylight.controller.cluster.raft.RaftActor.UpdateElectionTerm(6, "member3");
309 mockRaftActor.handleRecover(deprecatedUpdateElectionTerm);
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(applyLogEntries), any(PersistentDataProvider.class));
315 verify(mockSupport).handleRecoveryMessage(same(deleteEntries), any(PersistentDataProvider.class));
316 verify(mockSupport).handleRecoveryMessage(same(deprecatedDeleteEntries), any(PersistentDataProvider.class));
317 verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm), any(PersistentDataProvider.class));
318 verify(mockSupport).handleRecoveryMessage(same(deprecatedUpdateElectionTerm), any(PersistentDataProvider.class));
322 public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
323 String persistenceId = factory.generateActorId("leader-");
325 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
327 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
329 RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
331 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
332 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), mockSupport), persistenceId);
334 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
336 // Wait for akka's recovery to complete so it doesn't interfere.
337 mockRaftActor.waitForRecoveryComplete();
339 ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
340 doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot));
341 mockRaftActor.handleCommand(applySnapshot);
343 CaptureSnapshot captureSnapshot = new CaptureSnapshot(1, 1, 1, 1, 0, 1, null);
344 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshot));
345 mockRaftActor.handleCommand(captureSnapshot);
347 CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(new byte[0]);
348 doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
349 mockRaftActor.handleCommand(captureSnapshotReply);
351 SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(mock(SnapshotMetadata.class));
352 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
353 mockRaftActor.handleCommand(saveSnapshotSuccess);
355 SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(mock(SnapshotMetadata.class), new Throwable());
356 doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
357 mockRaftActor.handleCommand(saveSnapshotFailure);
359 doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
360 mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
362 verify(mockSupport).handleSnapshotMessage(same(applySnapshot));
363 verify(mockSupport).handleSnapshotMessage(same(captureSnapshot));
364 verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply));
365 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess));
366 verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure));
367 verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT));
371 public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
372 new JavaTestKit(getSystem()) {
374 String persistenceId = factory.generateActorId("leader-");
376 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
378 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
380 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
382 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
383 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
385 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
387 mockRaftActor.waitForInitializeBehaviorComplete();
389 mockRaftActor.waitUntilLeader();
391 mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
393 verify(dataPersistenceProvider).persist(any(ApplyJournalEntries.class), any(Procedure.class));
401 public void testApplyState() throws Exception {
403 new JavaTestKit(getSystem()) {
405 String persistenceId = factory.generateActorId("leader-");
407 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
409 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
411 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
413 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
414 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
416 MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
418 mockRaftActor.waitForInitializeBehaviorComplete();
420 ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
421 new MockRaftActorContext.MockPayload("F"));
423 mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry));
425 verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject());
432 public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
433 new JavaTestKit(getSystem()) {{
434 TestActorRef<MessageCollectorActor> notifierActor = factory.createTestActor(
435 Props.create(MessageCollectorActor.class));
436 MessageCollectorActor.waitUntilReady(notifierActor);
438 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
439 long heartBeatInterval = 100;
440 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
441 config.setElectionTimeoutFactor(20);
443 String persistenceId = factory.generateActorId("notifier-");
445 TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
446 Collections.<String, String>emptyMap(), Optional.<ConfigParams>of(config), notifierActor,
447 new NonPersistentDataProvider()).withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
449 List<RoleChanged> matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
452 // check if the notifier got a role change from null to Follower
453 RoleChanged raftRoleChanged = matches.get(0);
454 assertEquals(persistenceId, raftRoleChanged.getMemberId());
455 assertNull(raftRoleChanged.getOldRole());
456 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
458 // check if the notifier got a role change from Follower to Candidate
459 raftRoleChanged = matches.get(1);
460 assertEquals(persistenceId, raftRoleChanged.getMemberId());
461 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
462 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
464 // check if the notifier got a role change from Candidate to Leader
465 raftRoleChanged = matches.get(2);
466 assertEquals(persistenceId, raftRoleChanged.getMemberId());
467 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
468 assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
470 LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
471 notifierActor, LeaderStateChanged.class);
473 assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
474 assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
476 notifierActor.underlyingActor().clear();
478 MockRaftActor raftActor = raftActorRef.underlyingActor();
479 final String newLeaderId = "new-leader";
480 final short newLeaderVersion = 6;
481 Follower follower = new Follower(raftActor.getRaftActorContext()) {
483 public RaftActorBehavior handleMessage(ActorRef sender, Object message) {
484 leaderId = newLeaderId;
485 setLeaderPayloadVersion(newLeaderVersion);
490 raftActor.newBehavior(follower);
492 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
493 assertEquals(persistenceId, leaderStateChange.getMemberId());
494 assertEquals(null, leaderStateChange.getLeaderId());
496 raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
497 assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
498 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
500 notifierActor.underlyingActor().clear();
502 raftActor.handleCommand("any");
504 leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
505 assertEquals(persistenceId, leaderStateChange.getMemberId());
506 assertEquals(newLeaderId, leaderStateChange.getLeaderId());
507 assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
509 notifierActor.underlyingActor().clear();
511 raftActor.handleCommand("any");
513 Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
514 leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
515 assertNull(leaderStateChange);
520 public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
521 new JavaTestKit(getSystem()) {{
522 ActorRef notifierActor = factory.createActor(Props.create(MessageCollectorActor.class));
523 MessageCollectorActor.waitUntilReady(notifierActor);
525 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
526 long heartBeatInterval = 100;
527 config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
528 config.setElectionTimeoutFactor(1);
530 String persistenceId = factory.generateActorId("notifier-");
532 factory.createActor(MockRaftActor.props(persistenceId,
533 ImmutableMap.of("leader", "fake/path"), Optional.<ConfigParams>of(config), notifierActor), persistenceId);
535 List<RoleChanged> matches = null;
536 for(int i = 0; i < 5000 / heartBeatInterval; i++) {
537 matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
538 assertNotNull(matches);
539 if(matches.size() == 3) {
542 Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
545 assertNotNull(matches);
546 assertEquals(2, matches.size());
548 // check if the notifier got a role change from null to Follower
549 RoleChanged raftRoleChanged = matches.get(0);
550 assertEquals(persistenceId, raftRoleChanged.getMemberId());
551 assertNull(raftRoleChanged.getOldRole());
552 assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
554 // check if the notifier got a role change from Follower to Candidate
555 raftRoleChanged = matches.get(1);
556 assertEquals(persistenceId, raftRoleChanged.getMemberId());
557 assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
558 assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
564 public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
565 new JavaTestKit(getSystem()) {
567 String persistenceId = factory.generateActorId("leader-");
568 String follower1Id = factory.generateActorId("follower-");
570 ActorRef followerActor1 =
571 factory.createActor(Props.create(MessageCollectorActor.class));
573 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
574 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
575 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
577 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
579 Map<String, String> peerAddresses = new HashMap<>();
580 peerAddresses.put(follower1Id, followerActor1.path().toString());
582 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
583 MockRaftActor.props(persistenceId, peerAddresses,
584 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
586 MockRaftActor leaderActor = mockActorRef.underlyingActor();
588 leaderActor.getRaftActorContext().setCommitIndex(4);
589 leaderActor.getRaftActorContext().setLastApplied(4);
590 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
592 leaderActor.waitForInitializeBehaviorComplete();
594 // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
596 Leader leader = new Leader(leaderActor.getRaftActorContext());
597 leaderActor.setCurrentBehavior(leader);
598 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
600 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
601 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
603 assertEquals(8, leaderActor.getReplicatedLog().size());
605 leaderActor.getRaftActorContext().getSnapshotManager()
606 .capture(new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
607 new MockRaftActorContext.MockPayload("x")), 4);
609 verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
611 assertEquals(8, leaderActor.getReplicatedLog().size());
613 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
614 //fake snapshot on index 5
615 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
617 assertEquals(8, leaderActor.getReplicatedLog().size());
619 //fake snapshot on index 6
620 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
621 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
622 assertEquals(8, leaderActor.getReplicatedLog().size());
624 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
626 assertEquals(8, leaderActor.getReplicatedLog().size());
628 ByteString snapshotBytes = fromObject(Arrays.asList(
629 new MockRaftActorContext.MockPayload("foo-0"),
630 new MockRaftActorContext.MockPayload("foo-1"),
631 new MockRaftActorContext.MockPayload("foo-2"),
632 new MockRaftActorContext.MockPayload("foo-3"),
633 new MockRaftActorContext.MockPayload("foo-4")));
635 leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotBytes.toByteArray(),
636 leader, Runtime.getRuntime().totalMemory());
638 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
640 // The commit is needed to complete the snapshot creation process
641 leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, leader);
643 // capture snapshot reply should remove the snapshotted entries only
644 assertEquals(3, leaderActor.getReplicatedLog().size());
645 assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
647 // add another non-replicated entry
648 leaderActor.getReplicatedLog().append(
649 new ReplicatedLogImplEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
651 //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
652 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
653 assertEquals(2, leaderActor.getReplicatedLog().size());
654 assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
661 public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
662 new JavaTestKit(getSystem()) {
664 String persistenceId = factory.generateActorId("follower-");
665 String leaderId = factory.generateActorId("leader-");
668 ActorRef leaderActor1 =
669 factory.createActor(Props.create(MessageCollectorActor.class));
671 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
672 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
673 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
675 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
677 Map<String, String> peerAddresses = new HashMap<>();
678 peerAddresses.put(leaderId, leaderActor1.path().toString());
680 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
681 MockRaftActor.props(persistenceId, peerAddresses,
682 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
684 MockRaftActor followerActor = mockActorRef.underlyingActor();
685 followerActor.getRaftActorContext().setCommitIndex(4);
686 followerActor.getRaftActorContext().setLastApplied(4);
687 followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
689 followerActor.waitForInitializeBehaviorComplete();
692 Follower follower = new Follower(followerActor.getRaftActorContext());
693 followerActor.setCurrentBehavior(follower);
694 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
696 // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
697 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
698 followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
700 // log has indices 0-5
701 assertEquals(6, followerActor.getReplicatedLog().size());
704 followerActor.getRaftActorContext().getSnapshotManager().capture(
705 new MockRaftActorContext.MockReplicatedLogEntry(1, 5,
706 new MockRaftActorContext.MockPayload("D")), 4);
708 verify(followerActor.snapshotCohortDelegate).createSnapshot(any(ActorRef.class));
710 assertEquals(6, followerActor.getReplicatedLog().size());
712 //fake snapshot on index 6
713 List<ReplicatedLogEntry> entries =
715 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 6,
716 new MockRaftActorContext.MockPayload("foo-6"))
718 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
719 assertEquals(7, followerActor.getReplicatedLog().size());
721 //fake snapshot on index 7
722 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
726 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 7,
727 new MockRaftActorContext.MockPayload("foo-7"))
729 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
730 assertEquals(8, followerActor.getReplicatedLog().size());
732 assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
735 ByteString snapshotBytes = fromObject(Arrays.asList(
736 new MockRaftActorContext.MockPayload("foo-0"),
737 new MockRaftActorContext.MockPayload("foo-1"),
738 new MockRaftActorContext.MockPayload("foo-2"),
739 new MockRaftActorContext.MockPayload("foo-3"),
740 new MockRaftActorContext.MockPayload("foo-4")));
741 followerActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
742 assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
744 // The commit is needed to complete the snapshot creation process
745 followerActor.getRaftActorContext().getSnapshotManager().commit(-1, follower);
747 // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
748 assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
749 assertEquals(7, followerActor.getReplicatedLog().lastIndex());
753 (ReplicatedLogEntry) new MockRaftActorContext.MockReplicatedLogEntry(1, 8,
754 new MockRaftActorContext.MockPayload("foo-7"))
756 // send an additional entry 8 with leaderCommit = 7
757 followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
759 // 7 and 8, as lastapplied is 7
760 assertEquals(2, followerActor.getReplicatedLog().size());
767 public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
768 new JavaTestKit(getSystem()) {
770 String persistenceId = factory.generateActorId("leader-");
771 String follower1Id = factory.generateActorId("follower-");
772 String follower2Id = factory.generateActorId("follower-");
774 ActorRef followerActor1 =
775 factory.createActor(Props.create(MessageCollectorActor.class), follower1Id);
776 ActorRef followerActor2 =
777 factory.createActor(Props.create(MessageCollectorActor.class), follower2Id);
779 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
780 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
781 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
783 DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
785 Map<String, String> peerAddresses = new HashMap<>();
786 peerAddresses.put(follower1Id, followerActor1.path().toString());
787 peerAddresses.put(follower2Id, followerActor2.path().toString());
789 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
790 MockRaftActor.props(persistenceId, peerAddresses,
791 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
793 MockRaftActor leaderActor = mockActorRef.underlyingActor();
794 leaderActor.getRaftActorContext().setCommitIndex(9);
795 leaderActor.getRaftActorContext().setLastApplied(9);
796 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
798 leaderActor.waitForInitializeBehaviorComplete();
800 Leader leader = new Leader(leaderActor.getRaftActorContext());
801 leaderActor.setCurrentBehavior(leader);
802 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
804 // create 5 entries in the log
805 MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
806 leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
808 //set the snapshot index to 4 , 0 to 4 are snapshotted
809 leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
810 //setting replicatedToAllIndex = 9, for the log to clear
811 leader.setReplicatedToAllIndex(9);
812 assertEquals(5, leaderActor.getReplicatedLog().size());
813 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
815 leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
816 assertEquals(5, leaderActor.getReplicatedLog().size());
817 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
819 // set the 2nd follower nextIndex to 1 which has been snapshotted
820 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
821 assertEquals(5, leaderActor.getReplicatedLog().size());
822 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
824 // simulate a real snapshot
825 leaderActor.onReceiveCommand(new SendHeartBeat());
826 assertEquals(5, leaderActor.getReplicatedLog().size());
827 assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
828 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId())
829 , RaftState.Leader, leaderActor.getCurrentBehavior().state());
832 //reply from a slow follower does not initiate a fake snapshot
833 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
834 assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, leaderActor.getReplicatedLog().size());
836 ByteString snapshotBytes = fromObject(Arrays.asList(
837 new MockRaftActorContext.MockPayload("foo-0"),
838 new MockRaftActorContext.MockPayload("foo-1"),
839 new MockRaftActorContext.MockPayload("foo-2"),
840 new MockRaftActorContext.MockPayload("foo-3"),
841 new MockRaftActorContext.MockPayload("foo-4")));
842 leaderActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes.toByteArray()));
843 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
845 assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, leaderActor.getReplicatedLog().size());
847 //reply from a slow follower after should not raise errors
848 leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
849 assertEquals(0, leaderActor.getReplicatedLog().size());
855 public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
856 new JavaTestKit(getSystem()) {{
857 String persistenceId = factory.generateActorId("leader-");
858 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
859 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
860 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
861 config.setSnapshotBatchCount(5);
863 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
865 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
867 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
868 MockRaftActor.props(persistenceId, peerAddresses,
869 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
871 MockRaftActor leaderActor = mockActorRef.underlyingActor();
872 leaderActor.getRaftActorContext().setCommitIndex(3);
873 leaderActor.getRaftActorContext().setLastApplied(3);
874 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
876 leaderActor.waitForInitializeBehaviorComplete();
877 for(int i=0;i< 4;i++) {
878 leaderActor.getReplicatedLog()
879 .append(new MockRaftActorContext.MockReplicatedLogEntry(1, i,
880 new MockRaftActorContext.MockPayload("A")));
883 Leader leader = new Leader(leaderActor.getRaftActorContext());
884 leaderActor.setCurrentBehavior(leader);
885 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
887 // Simulate an install snaphost to a follower.
888 leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
889 leaderActor.getReplicatedLog().last(), -1, "member1");
891 // Now send a CaptureSnapshotReply
892 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
894 // Trimming log in this scenario is a no-op
895 assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
896 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
897 assertEquals(-1, leader.getReplicatedToAllIndex());
903 public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
904 new JavaTestKit(getSystem()) {{
905 String persistenceId = factory.generateActorId("leader-");
906 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
907 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
908 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
909 config.setSnapshotBatchCount(5);
911 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
913 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
915 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
916 MockRaftActor.props(persistenceId, peerAddresses,
917 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
919 MockRaftActor leaderActor = mockActorRef.underlyingActor();
920 leaderActor.getRaftActorContext().setCommitIndex(3);
921 leaderActor.getRaftActorContext().setLastApplied(3);
922 leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
923 leaderActor.getReplicatedLog().setSnapshotIndex(3);
925 leaderActor.waitForInitializeBehaviorComplete();
926 Leader leader = new Leader(leaderActor.getRaftActorContext());
927 leaderActor.setCurrentBehavior(leader);
928 leader.setReplicatedToAllIndex(3);
929 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
931 // Persist another entry (this will cause a CaptureSnapshot to be triggered
932 leaderActor.persistData(mockActorRef, "x", new MockRaftActorContext.MockPayload("duh"));
934 // Now send a CaptureSnapshotReply
935 mockActorRef.tell(new CaptureSnapshotReply(fromObject("foo").toByteArray()), mockActorRef);
937 // Trimming log in this scenario is a no-op
938 assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
939 assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
940 assertEquals(3, leader.getReplicatedToAllIndex());
946 public void testSwitchBehavior(){
947 String persistenceId = factory.generateActorId("leader-");
948 DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
949 config.setCustomRaftPolicyImplementationClass("org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
950 config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
951 config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
952 config.setSnapshotBatchCount(5);
954 DataPersistenceProvider dataPersistenceProvider = new NonPersistentDataProvider();
956 Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().build();
958 TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
959 MockRaftActor.props(persistenceId, peerAddresses,
960 Optional.<ConfigParams>of(config), dataPersistenceProvider), persistenceId);
962 MockRaftActor leaderActor = mockActorRef.underlyingActor();
964 leaderActor.handleRecover(RecoveryCompleted.getInstance());
966 leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100));
968 assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
969 assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state());
971 leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110));
973 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
974 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
976 leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125));
978 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
979 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
981 leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125));
983 assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
984 assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
989 public static ByteString fromObject(Object snapshot) throws Exception {
990 ByteArrayOutputStream b = null;
991 ObjectOutputStream o = null;
993 b = new ByteArrayOutputStream();
994 o = new ObjectOutputStream(b);
995 o.writeObject(snapshot);
996 byte[] snapshotBytes = b.toByteArray();
997 return ByteString.copyFrom(snapshotBytes);