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