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

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