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