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