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

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