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