opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/RaftActorTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.raft;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertNotSame;
  13 import static org.junit.Assert.assertNull;
  14 import static org.junit.Assert.assertSame;
  15 import static org.junit.Assert.assertTrue;
  16 import static org.mockito.ArgumentMatchers.any;
  17 import static org.mockito.ArgumentMatchers.anyObject;
  18 import static org.mockito.ArgumentMatchers.eq;
  19 import static org.mockito.ArgumentMatchers.same;
  20 import static org.mockito.Mockito.doReturn;
  21 import static org.mockito.Mockito.mock;
  22 import static org.mockito.Mockito.never;
  23 import static org.mockito.Mockito.reset;
  24 import static org.mockito.Mockito.timeout;
  25 import static org.mockito.Mockito.verify;
  26
  27 import akka.actor.ActorRef;
  28 import akka.actor.PoisonPill;
  29 import akka.actor.Status.Failure;
  30 import akka.actor.Terminated;
  31 import akka.dispatch.Dispatchers;
  32 import akka.japi.Procedure;
  33 import akka.persistence.SaveSnapshotFailure;
  34 import akka.persistence.SaveSnapshotSuccess;
  35 import akka.persistence.SnapshotMetadata;
  36 import akka.persistence.SnapshotOffer;
  37 import akka.protobuf.ByteString;
  38 import akka.testkit.TestActorRef;
  39 import akka.testkit.javadsl.TestKit;
  40 import com.google.common.base.Optional;
  41 import com.google.common.collect.ImmutableMap;
  42 import com.google.common.util.concurrent.Uninterruptibles;
  43 import java.io.ByteArrayOutputStream;
  44 import java.io.ObjectOutputStream;
  45 import java.time.Duration;
  46 import java.util.ArrayList;
  47 import java.util.Arrays;
  48 import java.util.Collections;
  49 import java.util.HashMap;
  50 import java.util.List;
  51 import java.util.Map;
  52 import java.util.concurrent.TimeUnit;
  53 import java.util.concurrent.TimeoutException;
  54 import org.junit.After;
  55 import org.junit.Before;
  56 import org.junit.Test;
  57 import org.mockito.ArgumentCaptor;
  58 import org.opendaylight.controller.cluster.DataPersistenceProvider;
  59 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
  60 import org.opendaylight.controller.cluster.PersistentDataProvider;
  61 import org.opendaylight.controller.cluster.notifications.LeaderStateChanged;
  62 import org.opendaylight.controller.cluster.notifications.RoleChanged;
  63 import org.opendaylight.controller.cluster.raft.MockRaftActor.MockSnapshotState;
  64 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
  65 import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot;
  66 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
  67 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
  68 import org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning;
  69 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
  70 import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior;
  71 import org.opendaylight.controller.cluster.raft.behaviors.Follower;
  72 import org.opendaylight.controller.cluster.raft.behaviors.Leader;
  73 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
  74 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot;
  75 import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply;
  76 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
  77 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
  78 import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries;
  79 import org.opendaylight.controller.cluster.raft.persisted.ByteState;
  80 import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries;
  81 import org.opendaylight.controller.cluster.raft.persisted.EmptyState;
  82 import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload;
  83 import org.opendaylight.controller.cluster.raft.persisted.ServerInfo;
  84 import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry;
  85 import org.opendaylight.controller.cluster.raft.persisted.Snapshot;
  86 import org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm;
  87 import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy;
  88 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  89 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  90 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
  91 import org.opendaylight.yangtools.concepts.Identifier;
  92 import org.slf4j.Logger;
  93 import org.slf4j.LoggerFactory;
  94 import scala.concurrent.duration.FiniteDuration;
  95
  96 public class RaftActorTest extends AbstractActorTest {
  97
  98     static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class);
  99
 100     private TestActorFactory factory;
 101
 102     @Before
 103     public void setUp() {
 104         factory = new TestActorFactory(getSystem());
 105     }
 106
 107     @After
 108     public void tearDown() {
 109         factory.close();
 110         InMemoryJournal.clear();
 111         InMemorySnapshotStore.clear();
 112     }
 113
 114     @Test
 115     public void testConstruction() {
 116         new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader();
 117     }
 118
 119     @Test
 120     public void testFindLeaderWhenLeaderIsSelf() {
 121         RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader");
 122         kit.waitUntilLeader();
 123     }
 124
 125
 126     @Test
 127     public void testRaftActorRecoveryWithPersistenceEnabled() {
 128         TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting");
 129
 130         TestKit kit = new TestKit(getSystem());
 131         String persistenceId = factory.generateActorId("follower-");
 132
 133         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 134
 135         // Set the heartbeat interval high to essentially disable election otherwise the test
 136         // may fail if the actor is switched to Leader and the commitIndex is set to the last
 137         // log entry.
 138         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 139
 140         ImmutableMap<String, String> peerAddresses = ImmutableMap.<String, String>builder()
 141                 .put("member1", "address").build();
 142         ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId,
 143                 peerAddresses, config), persistenceId);
 144
 145         kit.watch(followerActor);
 146
 147         List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
 148         ReplicatedLogEntry entry1 = new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E"));
 149         snapshotUnappliedEntries.add(entry1);
 150
 151         int lastAppliedDuringSnapshotCapture = 3;
 152         int lastIndexDuringSnapshotCapture = 4;
 153
 154         // 4 messages as part of snapshot, which are applied to state
 155         MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList(
 156                 new MockRaftActorContext.MockPayload("A"),
 157                 new MockRaftActorContext.MockPayload("B"),
 158                 new MockRaftActorContext.MockPayload("C"),
 159                 new MockRaftActorContext.MockPayload("D")));
 160
 161         Snapshot snapshot = Snapshot.create(snapshotState, snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1,
 162                 lastAppliedDuringSnapshotCapture, 1, -1, null, null);
 163         InMemorySnapshotStore.addSnapshot(persistenceId, snapshot);
 164
 165         // add more entries after snapshot is taken
 166         List<ReplicatedLogEntry> entries = new ArrayList<>();
 167         ReplicatedLogEntry entry2 = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F", 2));
 168         ReplicatedLogEntry entry3 = new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("G", 3));
 169         ReplicatedLogEntry entry4 = new SimpleReplicatedLogEntry(7, 1, new MockRaftActorContext.MockPayload("H", 4));
 170         entries.add(entry2);
 171         entries.add(entry3);
 172         entries.add(entry4);
 173
 174         final int lastAppliedToState = 5;
 175         final int lastIndex = 7;
 176
 177         InMemoryJournal.addEntry(persistenceId, 5, entry2);
 178         // 2 entries are applied to state besides the 4 entries in snapshot
 179         InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState));
 180         InMemoryJournal.addEntry(persistenceId, 7, entry3);
 181         InMemoryJournal.addEntry(persistenceId, 8, entry4);
 182
 183         // kill the actor
 184         followerActor.tell(PoisonPill.getInstance(), null);
 185         kit.expectMsgClass(Duration.ofSeconds(5), Terminated.class);
 186
 187         kit.unwatch(followerActor);
 188
 189         //reinstate the actor
 190         TestActorRef<MockRaftActor> ref = factory.createTestActor(
 191                 MockRaftActor.props(persistenceId, peerAddresses, config));
 192
 193         MockRaftActor mockRaftActor = ref.underlyingActor();
 194
 195         mockRaftActor.waitForRecoveryComplete();
 196
 197         RaftActorContext context = mockRaftActor.getRaftActorContext();
 198         assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(),
 199                 context.getReplicatedLog().size());
 200         assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize());
 201         assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex());
 202         assertEquals("Last applied", lastAppliedToState, context.getLastApplied());
 203         assertEquals("Commit index", lastAppliedToState, context.getCommitIndex());
 204         assertEquals("Recovered state size", 6, mockRaftActor.getState().size());
 205
 206         mockRaftActor.waitForInitializeBehaviorComplete();
 207
 208         assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
 209
 210         TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending");
 211     }
 212
 213     @Test
 214     public void testRaftActorRecoveryWithPersistenceDisabled() {
 215         String persistenceId = factory.generateActorId("follower-");
 216
 217         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 218
 219         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 220
 221         TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
 222                 ImmutableMap.<String, String>builder().put("member1", "address").build(),
 223                 config, createProvider()), persistenceId);
 224
 225         MockRaftActor mockRaftActor = ref.underlyingActor();
 226
 227         mockRaftActor.waitForRecoveryComplete();
 228
 229         mockRaftActor.waitForInitializeBehaviorComplete();
 230
 231         assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
 232     }
 233
 234     @Test
 235     public void testUpdateElectionTermPersistedWithPersistenceDisabled() {
 236         final TestKit kit = new TestKit(getSystem());
 237         String persistenceId = factory.generateActorId("follower-");
 238         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 239         config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
 240         config.setElectionTimeoutFactor(1);
 241
 242         InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1);
 243
 244         TestActorRef<MockRaftActor> ref = factory.createTestActor(MockRaftActor.props(persistenceId,
 245                 ImmutableMap.<String, String>builder().put("member1", "address").build(),
 246                 config, createProvider())
 247                 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
 248
 249         InMemoryJournal.waitForWriteMessagesComplete(persistenceId);
 250         List<UpdateElectionTerm> entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
 251         assertEquals("UpdateElectionTerm entries", 1, entries.size());
 252         final UpdateElectionTerm updateEntry = entries.get(0);
 253
 254         factory.killActor(ref, kit);
 255
 256         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 257         ref = factory.createTestActor(MockRaftActor.props(persistenceId,
 258                 ImmutableMap.<String, String>builder().put("member1", "address").build(), config,
 259                 createProvider()).withDispatcher(Dispatchers.DefaultDispatcherId()),
 260                 factory.generateActorId("follower-"));
 261
 262         MockRaftActor actor = ref.underlyingActor();
 263         actor.waitForRecoveryComplete();
 264
 265         RaftActorContext newContext = actor.getRaftActorContext();
 266         assertEquals("electionTerm", updateEntry.getCurrentTerm(),
 267                 newContext.getTermInformation().getCurrentTerm());
 268         assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor());
 269
 270         entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class);
 271         assertEquals("UpdateElectionTerm entries", 1, entries.size());
 272     }
 273
 274     @Test
 275     public void testRaftActorForwardsToRaftActorRecoverySupport() {
 276         String persistenceId = factory.generateActorId("leader-");
 277
 278         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 279
 280         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 281
 282         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
 283                 Collections.<String, String>emptyMap(), config), persistenceId);
 284
 285         MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
 286
 287         // Wait for akka's recovery to complete so it doesn't interfere.
 288         mockRaftActor.waitForRecoveryComplete();
 289
 290         RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class);
 291         mockRaftActor.setRaftActorRecoverySupport(mockSupport);
 292
 293         Snapshot snapshot = Snapshot.create(ByteState.of(new byte[]{1}),
 294                 Collections.<ReplicatedLogEntry>emptyList(), 3, 1, 3, 1, -1, null, null);
 295         SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot);
 296         mockRaftActor.handleRecover(snapshotOffer);
 297
 298         ReplicatedLogEntry logEntry = new SimpleReplicatedLogEntry(1, 1, new MockRaftActorContext.MockPayload("1", 5));
 299         mockRaftActor.handleRecover(logEntry);
 300
 301         ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2);
 302         mockRaftActor.handleRecover(applyJournalEntries);
 303
 304         DeleteEntries deleteEntries = new DeleteEntries(1);
 305         mockRaftActor.handleRecover(deleteEntries);
 306
 307         UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2");
 308         mockRaftActor.handleRecover(updateElectionTerm);
 309
 310         verify(mockSupport).handleRecoveryMessage(same(snapshotOffer), any(PersistentDataProvider.class));
 311         verify(mockSupport).handleRecoveryMessage(same(logEntry), any(PersistentDataProvider.class));
 312         verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries), any(PersistentDataProvider.class));
 313         verify(mockSupport).handleRecoveryMessage(same(deleteEntries), any(PersistentDataProvider.class));
 314         verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm), any(PersistentDataProvider.class));
 315     }
 316
 317     @Test
 318     public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() {
 319         String persistenceId = factory.generateActorId("leader-");
 320
 321         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 322
 323         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 324
 325         RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class);
 326
 327         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
 328                 .config(config).snapshotMessageSupport(mockSupport).props());
 329
 330         MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
 331
 332         // Wait for akka's recovery to complete so it doesn't interfere.
 333         mockRaftActor.waitForRecoveryComplete();
 334
 335         ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class));
 336         doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
 337         mockRaftActor.handleCommand(applySnapshot);
 338
 339         CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(ByteState.empty(),
 340                 java.util.Optional.empty());
 341         doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
 342         mockRaftActor.handleCommand(captureSnapshotReply);
 343
 344         SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(new SnapshotMetadata("", 0L, 0L));
 345         doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
 346         mockRaftActor.handleCommand(saveSnapshotSuccess);
 347
 348         SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(new SnapshotMetadata("", 0L, 0L),
 349                 new Throwable());
 350         doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
 351         mockRaftActor.handleCommand(saveSnapshotFailure);
 352
 353         doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
 354                 any(ActorRef.class));
 355         mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT);
 356
 357         doReturn(true).when(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
 358         mockRaftActor.handleCommand(GetSnapshot.INSTANCE);
 359
 360         verify(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class));
 361         verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class));
 362         verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class));
 363         verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class));
 364         verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT),
 365                 any(ActorRef.class));
 366         verify(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class));
 367     }
 368
 369     @SuppressWarnings("unchecked")
 370     @Test
 371     public void testApplyJournalEntriesCallsDataPersistence() throws Exception {
 372         String persistenceId = factory.generateActorId("leader-");
 373
 374         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 375
 376         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 377
 378         DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
 379
 380         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
 381                 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
 382
 383         MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
 384
 385         mockRaftActor.waitForInitializeBehaviorComplete();
 386
 387         mockRaftActor.waitUntilLeader();
 388
 389         mockRaftActor.onReceiveCommand(new ApplyJournalEntries(10));
 390
 391         verify(dataPersistenceProvider).persistAsync(any(ApplyJournalEntries.class), any(Procedure.class));
 392     }
 393
 394     @Test
 395     public void testApplyState() {
 396         String persistenceId = factory.generateActorId("leader-");
 397
 398         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 399
 400         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 401
 402         DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
 403
 404         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
 405                 Collections.<String, String>emptyMap(), config, dataPersistenceProvider), persistenceId);
 406
 407         MockRaftActor mockRaftActor = mockActorRef.underlyingActor();
 408
 409         mockRaftActor.waitForInitializeBehaviorComplete();
 410
 411         ReplicatedLogEntry entry = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F"));
 412
 413         final Identifier id = new MockIdentifier("apply-state");
 414         mockRaftActor.getRaftActorContext().getApplyStateConsumer().accept(new ApplyState(mockActorRef, id, entry));
 415
 416         verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq(id), anyObject());
 417     }
 418
 419     @Test
 420     public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception {
 421         ActorRef notifierActor = factory.createActor(MessageCollectorActor.props());
 422         MessageCollectorActor.waitUntilReady(notifierActor);
 423
 424         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 425         long heartBeatInterval = 100;
 426         config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
 427         config.setElectionTimeoutFactor(20);
 428
 429         String persistenceId = factory.generateActorId("notifier-");
 430
 431         final TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder()
 432                 .id(persistenceId).config(config).roleChangeNotifier(notifierActor).dataPersistenceProvider(
 433                     createProvider()).props().withDispatcher(Dispatchers.DefaultDispatcherId()),
 434                 persistenceId);
 435
 436         List<RoleChanged> matches =  MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3);
 437
 438
 439         // check if the notifier got a role change from null to Follower
 440         RoleChanged raftRoleChanged = matches.get(0);
 441         assertEquals(persistenceId, raftRoleChanged.getMemberId());
 442         assertNull(raftRoleChanged.getOldRole());
 443         assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
 444
 445         // check if the notifier got a role change from Follower to Candidate
 446         raftRoleChanged = matches.get(1);
 447         assertEquals(persistenceId, raftRoleChanged.getMemberId());
 448         assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
 449         assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
 450
 451         // check if the notifier got a role change from Candidate to Leader
 452         raftRoleChanged = matches.get(2);
 453         assertEquals(persistenceId, raftRoleChanged.getMemberId());
 454         assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole());
 455         assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole());
 456
 457         LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
 458                 notifierActor, LeaderStateChanged.class);
 459
 460         assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId());
 461         assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion());
 462
 463         MessageCollectorActor.clearMessages(notifierActor);
 464
 465         MockRaftActor raftActor = raftActorRef.underlyingActor();
 466         final String newLeaderId = "new-leader";
 467         final short newLeaderVersion = 6;
 468         Follower follower = new Follower(raftActor.getRaftActorContext()) {
 469             @Override
 470             public RaftActorBehavior handleMessage(final ActorRef sender, final Object message) {
 471                 setLeaderId(newLeaderId);
 472                 setLeaderPayloadVersion(newLeaderVersion);
 473                 return this;
 474             }
 475         };
 476
 477         raftActor.newBehavior(follower);
 478
 479         leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
 480         assertEquals(persistenceId, leaderStateChange.getMemberId());
 481         assertEquals(null, leaderStateChange.getLeaderId());
 482
 483         raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class);
 484         assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole());
 485         assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
 486
 487         MessageCollectorActor.clearMessages(notifierActor);
 488
 489         raftActor.handleCommand("any");
 490
 491         leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
 492         assertEquals(persistenceId, leaderStateChange.getMemberId());
 493         assertEquals(newLeaderId, leaderStateChange.getLeaderId());
 494         assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion());
 495
 496         MessageCollectorActor.clearMessages(notifierActor);
 497
 498         raftActor.handleCommand("any");
 499
 500         Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS);
 501         leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class);
 502         assertNull(leaderStateChange);
 503     }
 504
 505     @Test
 506     public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception {
 507         ActorRef notifierActor = factory.createActor(MessageCollectorActor.props());
 508         MessageCollectorActor.waitUntilReady(notifierActor);
 509
 510         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 511         long heartBeatInterval = 100;
 512         config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS));
 513         config.setElectionTimeoutFactor(1);
 514
 515         String persistenceId = factory.generateActorId("notifier-");
 516
 517         factory.createActor(MockRaftActor.builder().id(persistenceId)
 518                 .peerAddresses(ImmutableMap.of("leader", "fake/path"))
 519                 .config(config).roleChangeNotifier(notifierActor).props());
 520
 521         List<RoleChanged> matches =  null;
 522         for (int i = 0; i < 5000 / heartBeatInterval; i++) {
 523             matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class);
 524             assertNotNull(matches);
 525             if (matches.size() == 3) {
 526                 break;
 527             }
 528             Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS);
 529         }
 530
 531         assertNotNull(matches);
 532         assertEquals(2, matches.size());
 533
 534         // check if the notifier got a role change from null to Follower
 535         RoleChanged raftRoleChanged = matches.get(0);
 536         assertEquals(persistenceId, raftRoleChanged.getMemberId());
 537         assertNull(raftRoleChanged.getOldRole());
 538         assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole());
 539
 540         // check if the notifier got a role change from Follower to Candidate
 541         raftRoleChanged = matches.get(1);
 542         assertEquals(persistenceId, raftRoleChanged.getMemberId());
 543         assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole());
 544         assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole());
 545     }
 546
 547     @Test
 548     public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception {
 549         final String persistenceId = factory.generateActorId("leader-");
 550         final String follower1Id = factory.generateActorId("follower-");
 551
 552         ActorRef followerActor1 = factory.createActor(MessageCollectorActor.props());
 553
 554         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 555         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 556         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 557
 558         DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
 559
 560         Map<String, String> peerAddresses = new HashMap<>();
 561         peerAddresses.put(follower1Id, followerActor1.path().toString());
 562
 563         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
 564                 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
 565
 566         MockRaftActor leaderActor = mockActorRef.underlyingActor();
 567
 568         leaderActor.getRaftActorContext().setCommitIndex(4);
 569         leaderActor.getRaftActorContext().setLastApplied(4);
 570         leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
 571
 572         leaderActor.waitForInitializeBehaviorComplete();
 573
 574         // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
 575
 576         Leader leader = new Leader(leaderActor.getRaftActorContext());
 577         leaderActor.setCurrentBehavior(leader);
 578         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 579
 580         MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
 581         leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build());
 582
 583         assertEquals(8, leaderActor.getReplicatedLog().size());
 584
 585         leaderActor.getRaftActorContext().getSnapshotManager().capture(
 586                 new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("x")), 4);
 587
 588         verify(leaderActor.snapshotCohortDelegate).createSnapshot(anyObject(), anyObject());
 589
 590         assertEquals(8, leaderActor.getReplicatedLog().size());
 591
 592         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 593         //fake snapshot on index 5
 594         leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0));
 595
 596         assertEquals(8, leaderActor.getReplicatedLog().size());
 597
 598         //fake snapshot on index 6
 599         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 600         leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0));
 601         assertEquals(8, leaderActor.getReplicatedLog().size());
 602
 603         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 604
 605         assertEquals(8, leaderActor.getReplicatedLog().size());
 606
 607         MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList(
 608                 new MockRaftActorContext.MockPayload("foo-0"),
 609                 new MockRaftActorContext.MockPayload("foo-1"),
 610                 new MockRaftActorContext.MockPayload("foo-2"),
 611                 new MockRaftActorContext.MockPayload("foo-3"),
 612                 new MockRaftActorContext.MockPayload("foo-4")));
 613
 614         leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotState, java.util.Optional.empty(),
 615                 Runtime.getRuntime().totalMemory());
 616
 617         assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
 618
 619         // The commit is needed to complete the snapshot creation process
 620         leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, -1);
 621
 622         // capture snapshot reply should remove the snapshotted entries only
 623         assertEquals(3, leaderActor.getReplicatedLog().size());
 624         assertEquals(7, leaderActor.getReplicatedLog().lastIndex());
 625
 626         // add another non-replicated entry
 627         leaderActor.getReplicatedLog().append(
 628                 new SimpleReplicatedLogEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8")));
 629
 630         //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied
 631         leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0));
 632         assertEquals(2, leaderActor.getReplicatedLog().size());
 633         assertEquals(8, leaderActor.getReplicatedLog().lastIndex());
 634     }
 635
 636     @Test
 637     public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception {
 638         final String persistenceId = factory.generateActorId("follower-");
 639         final String leaderId = factory.generateActorId("leader-");
 640
 641         ActorRef leaderActor1 = factory.createActor(MessageCollectorActor.props());
 642
 643         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 644         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 645         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 646
 647         DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
 648
 649         Map<String, String> peerAddresses = new HashMap<>();
 650         peerAddresses.put(leaderId, leaderActor1.path().toString());
 651
 652         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
 653                 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
 654
 655         MockRaftActor followerActor = mockActorRef.underlyingActor();
 656         followerActor.getRaftActorContext().setCommitIndex(4);
 657         followerActor.getRaftActorContext().setLastApplied(4);
 658         followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
 659
 660         followerActor.waitForInitializeBehaviorComplete();
 661
 662
 663         Follower follower = new Follower(followerActor.getRaftActorContext());
 664         followerActor.setCurrentBehavior(follower);
 665         assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
 666
 667         // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot
 668         MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
 669         followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build());
 670
 671         // log has indices 0-5
 672         assertEquals(6, followerActor.getReplicatedLog().size());
 673
 674         //snapshot on 4
 675         followerActor.getRaftActorContext().getSnapshotManager().capture(
 676                 new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("D")), 4);
 677
 678         verify(followerActor.snapshotCohortDelegate).createSnapshot(anyObject(), anyObject());
 679
 680         assertEquals(6, followerActor.getReplicatedLog().size());
 681
 682         //fake snapshot on index 6
 683         List<ReplicatedLogEntry> entries = Arrays.asList(
 684                 (ReplicatedLogEntry) new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("foo-6")));
 685         followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0));
 686         assertEquals(7, followerActor.getReplicatedLog().size());
 687
 688         //fake snapshot on index 7
 689         assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
 690
 691         entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(7, 1,
 692                 new MockRaftActorContext.MockPayload("foo-7")));
 693         followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0));
 694         assertEquals(8, followerActor.getReplicatedLog().size());
 695
 696         assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state());
 697
 698
 699         ByteString snapshotBytes = fromObject(Arrays.asList(
 700                 new MockRaftActorContext.MockPayload("foo-0"),
 701                 new MockRaftActorContext.MockPayload("foo-1"),
 702                 new MockRaftActorContext.MockPayload("foo-2"),
 703                 new MockRaftActorContext.MockPayload("foo-3"),
 704                 new MockRaftActorContext.MockPayload("foo-4")));
 705         followerActor.onReceiveCommand(new CaptureSnapshotReply(ByteState.of(snapshotBytes.toByteArray()),
 706                 java.util.Optional.empty()));
 707         assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing());
 708
 709         // The commit is needed to complete the snapshot creation process
 710         followerActor.getRaftActorContext().getSnapshotManager().commit(-1, -1);
 711
 712         // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex
 713         assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log
 714         assertEquals(7, followerActor.getReplicatedLog().lastIndex());
 715
 716         entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(8, 1,
 717                 new MockRaftActorContext.MockPayload("foo-7")));
 718         // send an additional entry 8 with leaderCommit = 7
 719         followerActor.onReceiveCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0));
 720
 721         // 7 and 8, as lastapplied is 7
 722         assertEquals(2, followerActor.getReplicatedLog().size());
 723     }
 724
 725     @Test
 726     public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception {
 727         final String persistenceId = factory.generateActorId("leader-");
 728         final String follower1Id = factory.generateActorId("follower-");
 729         final String follower2Id = factory.generateActorId("follower-");
 730
 731         final ActorRef followerActor1 = factory.createActor(MessageCollectorActor.props(), follower1Id);
 732         final ActorRef followerActor2 = factory.createActor(MessageCollectorActor.props(), follower2Id);
 733
 734         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 735         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 736         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 737
 738         DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
 739
 740         Map<String, String> peerAddresses = new HashMap<>();
 741         peerAddresses.put(follower1Id, followerActor1.path().toString());
 742         peerAddresses.put(follower2Id, followerActor2.path().toString());
 743
 744         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
 745                 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
 746
 747         MockRaftActor leaderActor = mockActorRef.underlyingActor();
 748         leaderActor.getRaftActorContext().setCommitIndex(9);
 749         leaderActor.getRaftActorContext().setLastApplied(9);
 750         leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
 751
 752         leaderActor.waitForInitializeBehaviorComplete();
 753
 754         Leader leader = new Leader(leaderActor.getRaftActorContext());
 755         leaderActor.setCurrentBehavior(leader);
 756         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 757
 758         // create 5 entries in the log
 759         MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder();
 760         leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build());
 761
 762         //set the snapshot index to 4 , 0 to 4 are snapshotted
 763         leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4);
 764         //setting replicatedToAllIndex = 9, for the log to clear
 765         leader.setReplicatedToAllIndex(9);
 766         assertEquals(5, leaderActor.getReplicatedLog().size());
 767         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 768
 769         leaderActor.onReceiveCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0));
 770         assertEquals(5, leaderActor.getReplicatedLog().size());
 771         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 772
 773         // set the 2nd follower nextIndex to 1 which has been snapshotted
 774         leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0));
 775         assertEquals(5, leaderActor.getReplicatedLog().size());
 776         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 777
 778         // simulate a real snapshot
 779         leaderActor.onReceiveCommand(SendHeartBeat.INSTANCE);
 780         assertEquals(5, leaderActor.getReplicatedLog().size());
 781         assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ",
 782                 leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId()),
 783                 RaftState.Leader, leaderActor.getCurrentBehavior().state());
 784
 785
 786         //reply from a slow follower does not initiate a fake snapshot
 787         leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0));
 788         assertEquals("Fake snapshot should not happen when Initiate is in progress", 5,
 789                 leaderActor.getReplicatedLog().size());
 790
 791         ByteString snapshotBytes = fromObject(Arrays.asList(
 792                 new MockRaftActorContext.MockPayload("foo-0"),
 793                 new MockRaftActorContext.MockPayload("foo-1"),
 794                 new MockRaftActorContext.MockPayload("foo-2"),
 795                 new MockRaftActorContext.MockPayload("foo-3"),
 796                 new MockRaftActorContext.MockPayload("foo-4")));
 797         leaderActor.onReceiveCommand(new CaptureSnapshotReply(ByteState.of(snapshotBytes.toByteArray()),
 798                 java.util.Optional.empty()));
 799         assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
 800
 801         assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0,
 802                 leaderActor.getReplicatedLog().size());
 803
 804         //reply from a slow follower after should not raise errors
 805         leaderActor.onReceiveCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0));
 806         assertEquals(0, leaderActor.getReplicatedLog().size());
 807     }
 808
 809     @Test
 810     public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception {
 811         String persistenceId = factory.generateActorId("leader-");
 812         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 813         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 814         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 815         config.setSnapshotBatchCount(5);
 816
 817         DataPersistenceProvider dataPersistenceProvider = createProvider();
 818
 819         Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
 820
 821         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
 822                 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
 823
 824         MockRaftActor leaderActor = mockActorRef.underlyingActor();
 825         leaderActor.getRaftActorContext().setCommitIndex(3);
 826         leaderActor.getRaftActorContext().setLastApplied(3);
 827         leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
 828
 829         leaderActor.waitForInitializeBehaviorComplete();
 830         for (int i = 0; i < 4; i++) {
 831             leaderActor.getReplicatedLog().append(new SimpleReplicatedLogEntry(i, 1,
 832                     new MockRaftActorContext.MockPayload("A")));
 833         }
 834
 835         Leader leader = new Leader(leaderActor.getRaftActorContext());
 836         leaderActor.setCurrentBehavior(leader);
 837         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 838
 839         // Simulate an install snaphost to a follower.
 840         leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall(
 841                 leaderActor.getReplicatedLog().last(), -1, "member1");
 842
 843         // Now send a CaptureSnapshotReply
 844         mockActorRef.tell(new CaptureSnapshotReply(ByteState.of(fromObject("foo").toByteArray()),
 845                 java.util.Optional.empty()), mockActorRef);
 846
 847         // Trimming log in this scenario is a no-op
 848         assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex());
 849         assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
 850         assertEquals(-1, leader.getReplicatedToAllIndex());
 851     }
 852
 853     @Test
 854     public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception {
 855         String persistenceId = factory.generateActorId("leader-");
 856         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 857         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 858         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 859         config.setSnapshotBatchCount(5);
 860
 861         DataPersistenceProvider dataPersistenceProvider = createProvider();
 862
 863         Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().put("member1", "address").build();
 864
 865         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
 866                 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
 867
 868         MockRaftActor leaderActor = mockActorRef.underlyingActor();
 869         leaderActor.getRaftActorContext().setCommitIndex(3);
 870         leaderActor.getRaftActorContext().setLastApplied(3);
 871         leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId);
 872         leaderActor.getReplicatedLog().setSnapshotIndex(3);
 873
 874         leaderActor.waitForInitializeBehaviorComplete();
 875         Leader leader = new Leader(leaderActor.getRaftActorContext());
 876         leaderActor.setCurrentBehavior(leader);
 877         leader.setReplicatedToAllIndex(3);
 878         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 879
 880         // Persist another entry (this will cause a CaptureSnapshot to be triggered
 881         leaderActor.persistData(mockActorRef, new MockIdentifier("x"),
 882                 new MockRaftActorContext.MockPayload("duh"), false);
 883
 884         // Now send a CaptureSnapshotReply
 885         mockActorRef.tell(new CaptureSnapshotReply(ByteState.of(fromObject("foo").toByteArray()),
 886                 java.util.Optional.empty()), mockActorRef);
 887
 888         // Trimming log in this scenario is a no-op
 889         assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex());
 890         assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing());
 891         assertEquals(3, leader.getReplicatedToAllIndex());
 892     }
 893
 894     private static DataPersistenceProvider createProvider() {
 895         return new NonPersistentDataProvider(Runnable::run);
 896     }
 897
 898     @Test
 899     public void testSwitchBehavior() {
 900         String persistenceId = factory.generateActorId("leader-");
 901         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
 902         config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
 903         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
 904         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 905         config.setSnapshotBatchCount(5);
 906
 907         DataPersistenceProvider dataPersistenceProvider = createProvider();
 908
 909         Map<String, String> peerAddresses = ImmutableMap.<String, String>builder().build();
 910
 911         TestActorRef<MockRaftActor> mockActorRef = factory.createTestActor(
 912                 MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId);
 913
 914         MockRaftActor leaderActor = mockActorRef.underlyingActor();
 915
 916         leaderActor.waitForRecoveryComplete();
 917
 918         leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100));
 919
 920         assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
 921         assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state());
 922
 923         leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110));
 924
 925         assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
 926         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 927
 928         leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125));
 929
 930         assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
 931         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 932
 933         leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125));
 934
 935         assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm());
 936         assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state());
 937     }
 938
 939     public static ByteString fromObject(final Object snapshot) throws Exception {
 940         ByteArrayOutputStream bos = null;
 941         ObjectOutputStream os = null;
 942         try {
 943             bos = new ByteArrayOutputStream();
 944             os = new ObjectOutputStream(bos);
 945             os.writeObject(snapshot);
 946             byte[] snapshotBytes = bos.toByteArray();
 947             return ByteString.copyFrom(snapshotBytes);
 948         } finally {
 949             if (os != null) {
 950                 os.flush();
 951                 os.close();
 952             }
 953             if (bos != null) {
 954                 bos.close();
 955             }
 956         }
 957     }
 958
 959     @Test
 960     public void testUpdateConfigParam() {
 961         DefaultConfigParamsImpl emptyConfig = new DefaultConfigParamsImpl();
 962         String persistenceId = factory.generateActorId("follower-");
 963         ImmutableMap<String, String> peerAddresses =
 964             ImmutableMap.<String, String>builder().put("member1", "address").build();
 965         DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class);
 966
 967         TestActorRef<MockRaftActor> actorRef = factory.createTestActor(
 968                 MockRaftActor.props(persistenceId, peerAddresses, emptyConfig, dataPersistenceProvider), persistenceId);
 969         MockRaftActor mockRaftActor = actorRef.underlyingActor();
 970         mockRaftActor.waitForInitializeBehaviorComplete();
 971
 972         RaftActorBehavior behavior = mockRaftActor.getCurrentBehavior();
 973         mockRaftActor.updateConfigParams(emptyConfig);
 974         assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
 975         assertEquals("Behavior State", RaftState.Follower,
 976             mockRaftActor.getCurrentBehavior().state());
 977
 978         DefaultConfigParamsImpl disableConfig = new DefaultConfigParamsImpl();
 979         disableConfig.setCustomRaftPolicyImplementationClass(
 980             "org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy");
 981         mockRaftActor.updateConfigParams(disableConfig);
 982         assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
 983         assertEquals("Behavior State", RaftState.Follower,
 984             mockRaftActor.getCurrentBehavior().state());
 985
 986         behavior = mockRaftActor.getCurrentBehavior();
 987         mockRaftActor.updateConfigParams(disableConfig);
 988         assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
 989         assertEquals("Behavior State", RaftState.Follower,
 990             mockRaftActor.getCurrentBehavior().state());
 991
 992         DefaultConfigParamsImpl defaultConfig = new DefaultConfigParamsImpl();
 993         defaultConfig.setCustomRaftPolicyImplementationClass(
 994             "org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy");
 995         mockRaftActor.updateConfigParams(defaultConfig);
 996         assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior());
 997         assertEquals("Behavior State", RaftState.Follower,
 998             mockRaftActor.getCurrentBehavior().state());
 999
1000         behavior = mockRaftActor.getCurrentBehavior();
1001         mockRaftActor.updateConfigParams(defaultConfig);
1002         assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior());
1003         assertEquals("Behavior State", RaftState.Follower,
1004             mockRaftActor.getCurrentBehavior().state());
1005     }
1006
1007     @Test
1008     public void testGetSnapshot() {
1009         TEST_LOG.info("testGetSnapshot starting");
1010
1011         final TestKit kit = new TestKit(getSystem());
1012
1013         String persistenceId = factory.generateActorId("test-actor-");
1014         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1015         config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1016
1017         long term = 3;
1018         long seqN = 1;
1019         InMemoryJournal.addEntry(persistenceId, seqN++, new UpdateElectionTerm(term, "member-1"));
1020         InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(0, term,
1021                 new MockRaftActorContext.MockPayload("A")));
1022         InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(1, term,
1023                 new MockRaftActorContext.MockPayload("B")));
1024         InMemoryJournal.addEntry(persistenceId, seqN++, new ApplyJournalEntries(1));
1025         InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(2, term,
1026                 new MockRaftActorContext.MockPayload("C")));
1027
1028         TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId,
1029                 ImmutableMap.<String, String>builder().put("member1", "address").build(), config)
1030                     .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1031         MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1032
1033         mockRaftActor.waitForRecoveryComplete();
1034
1035         mockRaftActor.snapshotCohortDelegate = mock(RaftActorSnapshotCohort.class);
1036
1037         raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1038
1039         ArgumentCaptor<ActorRef> replyActor = ArgumentCaptor.forClass(ActorRef.class);
1040         verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(replyActor.capture(),
1041                 eq(java.util.Optional.empty()));
1042
1043         byte[] stateSnapshot = new byte[]{1,2,3};
1044         replyActor.getValue().tell(new CaptureSnapshotReply(ByteState.of(stateSnapshot), java.util.Optional.empty()),
1045                 ActorRef.noSender());
1046
1047         GetSnapshotReply reply = kit.expectMsgClass(GetSnapshotReply.class);
1048
1049         assertEquals("getId", persistenceId, reply.getId());
1050         Snapshot replySnapshot = reply.getSnapshot();
1051         assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1052         assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1053         assertEquals("getLastAppliedIndex", 1L, replySnapshot.getLastAppliedIndex());
1054         assertEquals("getLastAppliedTerm", term, replySnapshot.getLastAppliedTerm());
1055         assertEquals("getLastIndex", 2L, replySnapshot.getLastIndex());
1056         assertEquals("getLastTerm", term, replySnapshot.getLastTerm());
1057         assertEquals("getState", ByteState.of(stateSnapshot), replySnapshot.getState());
1058         assertEquals("getUnAppliedEntries size", 1, replySnapshot.getUnAppliedEntries().size());
1059         assertEquals("UnApplied entry index ", 2L, replySnapshot.getUnAppliedEntries().get(0).getIndex());
1060
1061         // Test with timeout
1062
1063         mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(
1064             FiniteDuration.create(200, TimeUnit.MILLISECONDS));
1065         reset(mockRaftActor.snapshotCohortDelegate);
1066
1067         raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1068         Failure failure = kit.expectMsgClass(akka.actor.Status.Failure.class);
1069         assertEquals("Failure cause type", TimeoutException.class, failure.cause().getClass());
1070
1071         mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout(
1072             FiniteDuration.create(30, TimeUnit.SECONDS));
1073
1074         // Test with persistence disabled.
1075
1076         mockRaftActor.setPersistence(false);
1077         reset(mockRaftActor.snapshotCohortDelegate);
1078
1079         raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef());
1080         reply = kit.expectMsgClass(GetSnapshotReply.class);
1081         verify(mockRaftActor.snapshotCohortDelegate, never()).createSnapshot(anyObject(), anyObject());
1082
1083         assertEquals("getId", persistenceId, reply.getId());
1084         replySnapshot = reply.getSnapshot();
1085         assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm());
1086         assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor());
1087         assertEquals("getLastAppliedIndex", -1L, replySnapshot.getLastAppliedIndex());
1088         assertEquals("getLastAppliedTerm", -1L, replySnapshot.getLastAppliedTerm());
1089         assertEquals("getLastIndex", -1L, replySnapshot.getLastIndex());
1090         assertEquals("getLastTerm", -1L, replySnapshot.getLastTerm());
1091         assertEquals("getState type", EmptyState.INSTANCE, replySnapshot.getState());
1092         assertEquals("getUnAppliedEntries size", 0, replySnapshot.getUnAppliedEntries().size());
1093
1094         TEST_LOG.info("testGetSnapshot ending");
1095     }
1096
1097     @Test
1098     public void testRestoreFromSnapshot() {
1099         TEST_LOG.info("testRestoreFromSnapshot starting");
1100
1101         String persistenceId = factory.generateActorId("test-actor-");
1102         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1103         config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1104
1105         List<ReplicatedLogEntry> snapshotUnappliedEntries = new ArrayList<>();
1106         snapshotUnappliedEntries.add(new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E")));
1107
1108         int snapshotLastApplied = 3;
1109         int snapshotLastIndex = 4;
1110
1111         MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList(
1112                 new MockRaftActorContext.MockPayload("A"),
1113                 new MockRaftActorContext.MockPayload("B"),
1114                 new MockRaftActorContext.MockPayload("C"),
1115                 new MockRaftActorContext.MockPayload("D")));
1116
1117         Snapshot snapshot = Snapshot.create(snapshotState, snapshotUnappliedEntries,
1118                 snapshotLastIndex, 1, snapshotLastApplied, 1, 1, "member-1", null);
1119
1120         InMemorySnapshotStore.addSnapshotSavedLatch(persistenceId);
1121
1122         TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1123                 .config(config).restoreFromSnapshot(snapshot).props()
1124                     .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1125         MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1126
1127         mockRaftActor.waitForRecoveryComplete();
1128
1129         Snapshot savedSnapshot = InMemorySnapshotStore.waitForSavedSnapshot(persistenceId, Snapshot.class);
1130         assertEquals("getElectionTerm", snapshot.getElectionTerm(), savedSnapshot.getElectionTerm());
1131         assertEquals("getElectionVotedFor", snapshot.getElectionVotedFor(), savedSnapshot.getElectionVotedFor());
1132         assertEquals("getLastAppliedIndex", snapshot.getLastAppliedIndex(), savedSnapshot.getLastAppliedIndex());
1133         assertEquals("getLastAppliedTerm", snapshot.getLastAppliedTerm(), savedSnapshot.getLastAppliedTerm());
1134         assertEquals("getLastIndex", snapshot.getLastIndex(), savedSnapshot.getLastIndex());
1135         assertEquals("getLastTerm", snapshot.getLastTerm(), savedSnapshot.getLastTerm());
1136         assertEquals("getState", snapshot.getState(), savedSnapshot.getState());
1137         assertEquals("getUnAppliedEntries", snapshot.getUnAppliedEntries(), savedSnapshot.getUnAppliedEntries());
1138
1139         verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).applySnapshot(any(Snapshot.State.class));
1140
1141         RaftActorContext context = mockRaftActor.getRaftActorContext();
1142         assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1143         assertEquals("Last index", snapshotLastIndex, context.getReplicatedLog().lastIndex());
1144         assertEquals("Last applied", snapshotLastApplied, context.getLastApplied());
1145         assertEquals("Commit index", snapshotLastApplied, context.getCommitIndex());
1146         assertEquals("Recovered state", snapshotState.getState(), mockRaftActor.getState());
1147         assertEquals("Current term", 1L, context.getTermInformation().getCurrentTerm());
1148         assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1149
1150         // Test with data persistence disabled
1151
1152         snapshot = Snapshot.create(EmptyState.INSTANCE, Collections.<ReplicatedLogEntry>emptyList(),
1153                 -1, -1, -1, -1, 5, "member-1", null);
1154
1155         persistenceId = factory.generateActorId("test-actor-");
1156
1157         raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1158                 .config(config).restoreFromSnapshot(snapshot)
1159                 .persistent(Optional.of(Boolean.FALSE)).props()
1160                     .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1161         mockRaftActor = raftActorRef.underlyingActor();
1162
1163         mockRaftActor.waitForRecoveryComplete();
1164         assertEquals("snapshot committed", true,
1165                 Uninterruptibles.awaitUninterruptibly(mockRaftActor.snapshotCommitted, 5, TimeUnit.SECONDS));
1166
1167         context = mockRaftActor.getRaftActorContext();
1168         assertEquals("Current term", 5L, context.getTermInformation().getCurrentTerm());
1169         assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor());
1170
1171         TEST_LOG.info("testRestoreFromSnapshot ending");
1172     }
1173
1174     @Test
1175     public void testRestoreFromSnapshotWithRecoveredData() throws Exception {
1176         TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData starting");
1177
1178         String persistenceId = factory.generateActorId("test-actor-");
1179         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1180         config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1181
1182         List<MockPayload> state = Arrays.asList(new MockRaftActorContext.MockPayload("A"));
1183         Snapshot snapshot = Snapshot.create(ByteState.of(fromObject(state).toByteArray()),
1184                 Arrays.<ReplicatedLogEntry>asList(), 5, 2, 5, 2, 2, "member-1", null);
1185
1186         InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1,
1187                 new MockRaftActorContext.MockPayload("B")));
1188
1189         TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1190                 .config(config).restoreFromSnapshot(snapshot).props()
1191                     .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1192         MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1193
1194         mockRaftActor.waitForRecoveryComplete();
1195
1196         Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS);
1197         verify(mockRaftActor.snapshotCohortDelegate, never()).applySnapshot(any(Snapshot.State.class));
1198
1199         RaftActorContext context = mockRaftActor.getRaftActorContext();
1200         assertEquals("Journal log size", 1, context.getReplicatedLog().size());
1201         assertEquals("Last index", 0, context.getReplicatedLog().lastIndex());
1202         assertEquals("Last applied", -1, context.getLastApplied());
1203         assertEquals("Commit index", -1, context.getCommitIndex());
1204         assertEquals("Current term", 0, context.getTermInformation().getCurrentTerm());
1205         assertEquals("Voted for", null, context.getTermInformation().getVotedFor());
1206
1207         TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData ending");
1208     }
1209
1210     @Test
1211     public void testNonVotingOnRecovery() {
1212         TEST_LOG.info("testNonVotingOnRecovery starting");
1213
1214         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1215         config.setElectionTimeoutFactor(1);
1216         config.setHeartBeatInterval(FiniteDuration.create(1, TimeUnit.MILLISECONDS));
1217
1218         String persistenceId = factory.generateActorId("test-actor-");
1219         InMemoryJournal.addEntry(persistenceId, 1,  new SimpleReplicatedLogEntry(0, 1,
1220                 new ServerConfigurationPayload(Arrays.asList(new ServerInfo(persistenceId, false)))));
1221
1222         TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1223                 .config(config).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1224         MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1225
1226         mockRaftActor.waitForInitializeBehaviorComplete();
1227
1228         // Sleep a bit and verify it didn't get an election timeout and schedule an election.
1229
1230         Uninterruptibles.sleepUninterruptibly(400, TimeUnit.MILLISECONDS);
1231         assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState());
1232
1233         TEST_LOG.info("testNonVotingOnRecovery ending");
1234     }
1235
1236     @Test
1237     public void testLeaderTransitioning() {
1238         TEST_LOG.info("testLeaderTransitioning starting");
1239
1240         ActorRef notifierActor = factory.createActor(MessageCollectorActor.props());
1241
1242         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1243         config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName());
1244
1245         String persistenceId = factory.generateActorId("test-actor-");
1246
1247         TestActorRef<MockRaftActor> raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId)
1248                 .config(config).roleChangeNotifier(notifierActor).props()
1249                 .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId);
1250         MockRaftActor mockRaftActor = raftActorRef.underlyingActor();
1251
1252         mockRaftActor.waitForInitializeBehaviorComplete();
1253
1254         raftActorRef.tell(new AppendEntries(1L, "leader", 0L, 1L, Collections.<ReplicatedLogEntry>emptyList(),
1255                 0L, -1L, (short)1), ActorRef.noSender());
1256         LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching(
1257                 notifierActor, LeaderStateChanged.class);
1258         assertEquals("getLeaderId", "leader", leaderStateChange.getLeaderId());
1259
1260         MessageCollectorActor.clearMessages(notifierActor);
1261
1262         raftActorRef.tell(new LeaderTransitioning("leader"), ActorRef.noSender());
1263
1264         leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class);
1265         assertEquals("getMemberId", persistenceId, leaderStateChange.getMemberId());
1266         assertEquals("getLeaderId", null, leaderStateChange.getLeaderId());
1267
1268         TEST_LOG.info("testLeaderTransitioning ending");
1269     }
1270
1271     @SuppressWarnings({ "unchecked", "rawtypes" })
1272     @Test
1273     public void testReplicateWithPersistencePending() throws Exception {
1274         final String leaderId = factory.generateActorId("leader-");
1275         final String followerId = factory.generateActorId("follower-");
1276
1277         final ActorRef followerActor = factory.createActor(MessageCollectorActor.props());
1278
1279         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1280         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
1281         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
1282
1283         DataPersistenceProvider mockPersistenceProvider = mock(DataPersistenceProvider.class);
1284         doReturn(true).when(mockPersistenceProvider).isRecoveryApplicable();
1285
1286         TestActorRef<MockRaftActor> leaderActorRef = factory.createTestActor(
1287                 MockRaftActor.props(leaderId, ImmutableMap.of(followerId, followerActor.path().toString()), config,
1288                         mockPersistenceProvider), leaderId);
1289         MockRaftActor leaderActor = leaderActorRef.underlyingActor();
1290         leaderActor.waitForInitializeBehaviorComplete();
1291
1292         leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId);
1293
1294         Leader leader = new Leader(leaderActor.getRaftActorContext());
1295         leaderActor.setCurrentBehavior(leader);
1296
1297         leaderActor.persistData(leaderActorRef, new MockIdentifier("1"), new MockRaftActorContext.MockPayload("1"),
1298                 false);
1299
1300         ReplicatedLogEntry logEntry = leaderActor.getReplicatedLog().get(0);
1301         assertNotNull("ReplicatedLogEntry not found", logEntry);
1302         assertEquals("isPersistencePending", true, logEntry.isPersistencePending());
1303         assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex());
1304
1305         leaderActor.onReceiveCommand(new AppendEntriesReply(followerId, 1, true, 0, 1, (short)0));
1306         assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex());
1307
1308         ArgumentCaptor<Procedure> callbackCaptor = ArgumentCaptor.forClass(Procedure.class);
1309         verify(mockPersistenceProvider).persistAsync(eq(logEntry), callbackCaptor.capture());
1310
1311         callbackCaptor.getValue().apply(logEntry);
1312
1313         assertEquals("getCommitIndex", 0, leaderActor.getRaftActorContext().getCommitIndex());
1314         assertEquals("getLastApplied", 0, leaderActor.getRaftActorContext().getLastApplied());
1315     }
1316
1317     @Test
1318     public void testReplicateWithBatchHint() throws Exception {
1319         final String leaderId = factory.generateActorId("leader-");
1320         final String followerId = factory.generateActorId("follower-");
1321
1322         final ActorRef followerActor = factory.createActor(MessageCollectorActor.props());
1323
1324         DefaultConfigParamsImpl config = new DefaultConfigParamsImpl();
1325         config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS));
1326         config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
1327
1328         TestActorRef<MockRaftActor> leaderActorRef = factory.createTestActor(
1329                 MockRaftActor.props(leaderId, ImmutableMap.of(followerId, followerActor.path().toString()), config),
1330                     leaderId);
1331         MockRaftActor leaderActor = leaderActorRef.underlyingActor();
1332         leaderActor.waitForInitializeBehaviorComplete();
1333
1334         leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId);
1335
1336         Leader leader = new Leader(leaderActor.getRaftActorContext());
1337         leaderActor.setCurrentBehavior(leader);
1338
1339         MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1340         MessageCollectorActor.clearMessages(followerActor);
1341
1342         leaderActor.onReceiveCommand(new AppendEntriesReply(followerId, 1, true, -1, -1, (short)0));
1343
1344         leaderActor.persistData(leaderActorRef, new MockIdentifier("1"), new MockPayload("1"), true);
1345         MessageCollectorActor.assertNoneMatching(followerActor, AppendEntries.class, 500);
1346
1347         leaderActor.persistData(leaderActorRef, new MockIdentifier("2"), new MockPayload("2"), true);
1348         MessageCollectorActor.assertNoneMatching(followerActor, AppendEntries.class, 500);
1349
1350         leaderActor.persistData(leaderActorRef, new MockIdentifier("3"), new MockPayload("3"), false);
1351         AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class);
1352         assertEquals("AppendEntries size", 3, appendEntries.getEntries().size());
1353     }
1354 }