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

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