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

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