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