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

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.cluster.raft;
  10
  11 import static org.junit.Assert.assertArrayEquals;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertFalse;
  14 import static org.junit.Assert.assertTrue;
  15 import static org.mockito.Matchers.any;
  16 import static org.mockito.Matchers.anyLong;
  17 import static org.mockito.Mockito.doReturn;
  18 import static org.mockito.Mockito.doThrow;
  19 import static org.mockito.Mockito.mock;
  20 import static org.mockito.Mockito.never;
  21 import static org.mockito.Mockito.reset;
  22 import static org.mockito.Mockito.times;
  23 import static org.mockito.Mockito.verify;
  24 import akka.actor.ActorRef;
  25 import akka.japi.Procedure;
  26 import akka.persistence.SnapshotSelectionCriteria;
  27 import akka.testkit.TestActorRef;
  28 import java.util.Arrays;
  29 import org.junit.After;
  30 import org.junit.Before;
  31 import org.junit.Test;
  32 import org.mockito.ArgumentCaptor;
  33 import org.mockito.Mock;
  34 import org.mockito.MockitoAnnotations;
  35 import org.opendaylight.controller.cluster.DataPersistenceProvider;
  36 import org.opendaylight.controller.cluster.raft.SnapshotManager.LastAppliedTermInformationReader;
  37 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot;
  38 import org.opendaylight.controller.cluster.raft.base.messages.SendInstallSnapshot;
  39 import org.opendaylight.controller.cluster.raft.base.messages.SnapshotComplete;
  40 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
  41 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
  42 import org.slf4j.LoggerFactory;
  43
  44 public class SnapshotManagerTest extends AbstractActorTest {
  45
  46     @Mock
  47     private RaftActorContext mockRaftActorContext;
  48
  49     @Mock
  50     private ConfigParams mockConfigParams;
  51
  52     @Mock
  53     private ReplicatedLog mockReplicatedLog;
  54
  55     @Mock
  56     private DataPersistenceProvider mockDataPersistenceProvider;
  57
  58     @Mock
  59     private RaftActorBehavior mockRaftActorBehavior;
  60
  61     @Mock
  62     private Procedure<Void> mockProcedure;
  63
  64     @Mock
  65     private ElectionTerm mockElectionTerm;
  66
  67     private SnapshotManager snapshotManager;
  68
  69     private TestActorFactory factory;
  70
  71     private TestActorRef<MessageCollectorActor> actorRef;
  72
  73     @Before
  74     public void setUp(){
  75         MockitoAnnotations.initMocks(this);
  76
  77         doReturn(false).when(mockRaftActorContext).hasFollowers();
  78         doReturn(mockConfigParams).when(mockRaftActorContext).getConfigParams();
  79         doReturn(10L).when(mockConfigParams).getSnapshotBatchCount();
  80         doReturn(70).when(mockConfigParams).getSnapshotDataThresholdPercentage();
  81         doReturn(mockReplicatedLog).when(mockRaftActorContext).getReplicatedLog();
  82         doReturn("123").when(mockRaftActorContext).getId();
  83         doReturn(mockDataPersistenceProvider).when(mockRaftActorContext).getPersistenceProvider();
  84         doReturn("123").when(mockRaftActorBehavior).getLeaderId();
  85
  86         doReturn(mockElectionTerm).when(mockRaftActorContext).getTermInformation();
  87         doReturn(5L).when(mockElectionTerm).getCurrentTerm();
  88         doReturn("member5").when(mockElectionTerm).getVotedFor();
  89
  90         snapshotManager = new SnapshotManager(mockRaftActorContext, LoggerFactory.getLogger(this.getClass()));
  91         factory = new TestActorFactory(getSystem());
  92
  93         actorRef = factory.createTestActor(MessageCollectorActor.props(), factory.generateActorId("test-"));
  94         doReturn(actorRef).when(mockRaftActorContext).getActor();
  95
  96         snapshotManager.setCreateSnapshotCallable(mockProcedure);
  97     }
  98
  99     @After
 100     public void tearDown(){
 101         factory.close();
 102     }
 103
 104     @Test
 105     public void testConstruction(){
 106         assertEquals(false, snapshotManager.isCapturing());
 107     }
 108
 109     @Test
 110     public void testCaptureToInstall() throws Exception {
 111
 112         // Force capturing toInstall = true
 113         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(1, 0,
 114                 new MockRaftActorContext.MockPayload()), 0, "follower-1");
 115
 116         assertEquals(true, snapshotManager.isCapturing());
 117
 118         verify(mockProcedure).apply(null);
 119
 120         CaptureSnapshot captureSnapshot = snapshotManager.getCaptureSnapshot();
 121
 122         // LastIndex and LastTerm are picked up from the lastLogEntry
 123         assertEquals(0L, captureSnapshot.getLastIndex());
 124         assertEquals(1L, captureSnapshot.getLastTerm());
 125
 126         // Since the actor does not have any followers (no peer addresses) lastApplied will be from lastLogEntry
 127         assertEquals(0L, captureSnapshot.getLastAppliedIndex());
 128         assertEquals(1L, captureSnapshot.getLastAppliedTerm());
 129
 130         //
 131         assertEquals(-1L, captureSnapshot.getReplicatedToAllIndex());
 132         assertEquals(-1L, captureSnapshot.getReplicatedToAllTerm());
 133         actorRef.underlyingActor().clear();
 134     }
 135
 136     @Test
 137     public void testCapture() throws Exception {
 138         boolean capture = snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(1,9,
 139                 new MockRaftActorContext.MockPayload()), 9);
 140
 141         assertTrue(capture);
 142
 143         assertEquals(true, snapshotManager.isCapturing());
 144
 145         verify(mockProcedure).apply(null);
 146
 147         CaptureSnapshot captureSnapshot = snapshotManager.getCaptureSnapshot();
 148
 149         // LastIndex and LastTerm are picked up from the lastLogEntry
 150         assertEquals(9L, captureSnapshot.getLastIndex());
 151         assertEquals(1L, captureSnapshot.getLastTerm());
 152
 153         // Since the actor does not have any followers (no peer addresses) lastApplied will be from lastLogEntry
 154         assertEquals(9L, captureSnapshot.getLastAppliedIndex());
 155         assertEquals(1L, captureSnapshot.getLastAppliedTerm());
 156
 157         //
 158         assertEquals(-1L, captureSnapshot.getReplicatedToAllIndex());
 159         assertEquals(-1L, captureSnapshot.getReplicatedToAllTerm());
 160
 161         actorRef.underlyingActor().clear();
 162
 163     }
 164
 165     @Test
 166     public void testCaptureWithNullLastLogEntry() throws Exception {
 167         boolean capture = snapshotManager.capture(null, 1);
 168
 169         assertTrue(capture);
 170
 171         assertEquals(true, snapshotManager.isCapturing());
 172
 173         verify(mockProcedure).apply(null);
 174
 175         CaptureSnapshot captureSnapshot = snapshotManager.getCaptureSnapshot();
 176
 177         System.out.println(captureSnapshot);
 178
 179         // LastIndex and LastTerm are picked up from the lastLogEntry
 180         assertEquals(-1L, captureSnapshot.getLastIndex());
 181         assertEquals(-1L, captureSnapshot.getLastTerm());
 182
 183         // Since the actor does not have any followers (no peer addresses) lastApplied will be from lastLogEntry
 184         assertEquals(-1L, captureSnapshot.getLastAppliedIndex());
 185         assertEquals(-1L, captureSnapshot.getLastAppliedTerm());
 186
 187         //
 188         assertEquals(-1L, captureSnapshot.getReplicatedToAllIndex());
 189         assertEquals(-1L, captureSnapshot.getReplicatedToAllTerm());
 190         actorRef.underlyingActor().clear();
 191
 192     }
 193
 194     @Test
 195     public void testCaptureWithCreateProcedureError () throws Exception {
 196         doThrow(new Exception("mock")).when(mockProcedure).apply(null);
 197
 198         boolean capture = snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(1,9,
 199                 new MockRaftActorContext.MockPayload()), 9);
 200
 201         assertFalse(capture);
 202
 203         assertEquals(false, snapshotManager.isCapturing());
 204
 205         verify(mockProcedure).apply(null);
 206     }
 207
 208     @Test
 209     public void testIllegalCapture() throws Exception {
 210         boolean capture = snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(1,9,
 211                 new MockRaftActorContext.MockPayload()), 9);
 212
 213         assertTrue(capture);
 214
 215         verify(mockProcedure).apply(null);
 216
 217         reset(mockProcedure);
 218
 219         // This will not cause snapshot capture to start again
 220         capture = snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(1,9,
 221                 new MockRaftActorContext.MockPayload()), 9);
 222
 223         assertFalse(capture);
 224
 225         verify(mockProcedure, never()).apply(null);
 226     }
 227
 228     @Test
 229     public void testPersistWhenReplicatedToAllIndexMinusOne(){
 230         doReturn(7L).when(mockReplicatedLog).getSnapshotIndex();
 231         doReturn(1L).when(mockReplicatedLog).getSnapshotTerm();
 232
 233         doReturn(true).when(mockRaftActorContext).hasFollowers();
 234
 235         doReturn(8L).when(mockRaftActorContext).getLastApplied();
 236
 237         MockRaftActorContext.MockReplicatedLogEntry lastLogEntry = new MockRaftActorContext.MockReplicatedLogEntry(
 238                 3L, 9L, new MockRaftActorContext.MockPayload());
 239
 240         MockRaftActorContext.MockReplicatedLogEntry lastAppliedEntry = new MockRaftActorContext.MockReplicatedLogEntry(
 241                 2L, 8L, new MockRaftActorContext.MockPayload());
 242
 243         doReturn(lastAppliedEntry).when(mockReplicatedLog).get(8L);
 244         doReturn(Arrays.asList(lastLogEntry)).when(mockReplicatedLog).getFrom(9L);
 245
 246         // when replicatedToAllIndex = -1
 247         snapshotManager.capture(lastLogEntry, -1);
 248
 249         byte[] bytes = new byte[] {1,2,3,4,5,6,7,8,9,10};
 250         snapshotManager.persist(bytes, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 251
 252         ArgumentCaptor<Snapshot> snapshotArgumentCaptor = ArgumentCaptor.forClass(Snapshot.class);
 253         verify(mockDataPersistenceProvider).saveSnapshot(snapshotArgumentCaptor.capture());
 254
 255         Snapshot snapshot = snapshotArgumentCaptor.getValue();
 256
 257         assertEquals("getLastTerm", 3L, snapshot.getLastTerm());
 258         assertEquals("getLastIndex", 9L, snapshot.getLastIndex());
 259         assertEquals("getLastAppliedTerm", 2L, snapshot.getLastAppliedTerm());
 260         assertEquals("getLastAppliedIndex", 8L, snapshot.getLastAppliedIndex());
 261         assertArrayEquals("getState", bytes, snapshot.getState());
 262         assertEquals("getUnAppliedEntries", Arrays.asList(lastLogEntry), snapshot.getUnAppliedEntries());
 263         assertEquals("electionTerm", mockElectionTerm.getCurrentTerm(), snapshot.getElectionTerm());
 264         assertEquals("electionVotedFor", mockElectionTerm.getVotedFor(), snapshot.getElectionVotedFor());
 265
 266         verify(mockReplicatedLog).snapshotPreCommit(7L, 1L);
 267     }
 268
 269     @Test
 270     public void testPersistWhenReplicatedToAllIndexNotMinus(){
 271         doReturn(45L).when(mockReplicatedLog).getSnapshotIndex();
 272         doReturn(6L).when(mockReplicatedLog).getSnapshotTerm();
 273         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 274         doReturn(replicatedLogEntry).when(mockReplicatedLog).get(9);
 275         doReturn(6L).when(replicatedLogEntry).getTerm();
 276         doReturn(9L).when(replicatedLogEntry).getIndex();
 277
 278         // when replicatedToAllIndex != -1
 279         snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(6,9,
 280                 new MockRaftActorContext.MockPayload()), 9);
 281
 282         byte[] bytes = new byte[] {1,2,3,4,5,6,7,8,9,10};
 283         snapshotManager.persist(bytes, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 284
 285         ArgumentCaptor<Snapshot> snapshotArgumentCaptor = ArgumentCaptor.forClass(Snapshot.class);
 286         verify(mockDataPersistenceProvider).saveSnapshot(snapshotArgumentCaptor.capture());
 287
 288         Snapshot snapshot = snapshotArgumentCaptor.getValue();
 289
 290         assertEquals("getLastTerm", 6L, snapshot.getLastTerm());
 291         assertEquals("getLastIndex", 9L, snapshot.getLastIndex());
 292         assertEquals("getLastAppliedTerm", 6L, snapshot.getLastAppliedTerm());
 293         assertEquals("getLastAppliedIndex", 9L, snapshot.getLastAppliedIndex());
 294         assertArrayEquals("getState", bytes, snapshot.getState());
 295         assertEquals("getUnAppliedEntries size", 0, snapshot.getUnAppliedEntries().size());
 296
 297         verify(mockReplicatedLog).snapshotPreCommit(9L, 6L);
 298
 299         verify(mockRaftActorBehavior).setReplicatedToAllIndex(9);
 300     }
 301
 302     @Test
 303     public void testPersistWhenReplicatedLogDataSizeGreaterThanThreshold(){
 304         doReturn(Integer.MAX_VALUE).when(mockReplicatedLog).dataSize();
 305
 306         // when replicatedToAllIndex = -1
 307         snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(6,9,
 308                 new MockRaftActorContext.MockPayload()), -1);
 309
 310         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 311
 312         verify(mockDataPersistenceProvider).saveSnapshot(any(Snapshot.class));
 313
 314         verify(mockReplicatedLog).snapshotPreCommit(9L, 6L);
 315
 316         verify(mockRaftActorBehavior, never()).setReplicatedToAllIndex(anyLong());
 317     }
 318
 319     @Test
 320     public void testPersistWhenReplicatedLogSizeExceedsSnapshotBatchCount() {
 321         doReturn(10L).when(mockReplicatedLog).size(); // matches snapshotBatchCount
 322         doReturn(100).when(mockReplicatedLog).dataSize();
 323
 324         doReturn(5L).when(mockReplicatedLog).getSnapshotIndex();
 325         doReturn(5L).when(mockReplicatedLog).getSnapshotTerm();
 326
 327         long replicatedToAllIndex = 1;
 328         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 329         doReturn(replicatedLogEntry).when(mockReplicatedLog).get(replicatedToAllIndex);
 330         doReturn(6L).when(replicatedLogEntry).getTerm();
 331         doReturn(replicatedToAllIndex).when(replicatedLogEntry).getIndex();
 332
 333         snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 334                 new MockRaftActorContext.MockPayload()), replicatedToAllIndex);
 335
 336         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, 2000000L);
 337
 338         verify(mockDataPersistenceProvider).saveSnapshot(any(Snapshot.class));
 339
 340         verify(mockReplicatedLog).snapshotPreCommit(9L, 6L);
 341
 342         verify(mockRaftActorBehavior).setReplicatedToAllIndex(replicatedToAllIndex);
 343     }
 344
 345     @Test
 346     public void testPersistSendInstallSnapshot(){
 347         doReturn(Integer.MAX_VALUE).when(mockReplicatedLog).dataSize();
 348
 349         // when replicatedToAllIndex = -1
 350         boolean capture = snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 351                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 352
 353         assertTrue(capture);
 354
 355         byte[] bytes = new byte[] {1,2,3,4,5,6,7,8,9,10};
 356
 357         snapshotManager.persist(bytes, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 358
 359         assertEquals(true, snapshotManager.isCapturing());
 360
 361         verify(mockDataPersistenceProvider).saveSnapshot(any(Snapshot.class));
 362
 363         verify(mockReplicatedLog).snapshotPreCommit(9L, 6L);
 364
 365         ArgumentCaptor<SendInstallSnapshot> sendInstallSnapshotArgumentCaptor
 366                 = ArgumentCaptor.forClass(SendInstallSnapshot.class);
 367
 368         verify(mockRaftActorBehavior).handleMessage(any(ActorRef.class), sendInstallSnapshotArgumentCaptor.capture());
 369
 370         SendInstallSnapshot sendInstallSnapshot = sendInstallSnapshotArgumentCaptor.getValue();
 371
 372         assertTrue(Arrays.equals(bytes, sendInstallSnapshot.getSnapshot().getState()));
 373     }
 374
 375     @Test
 376     public void testCallingPersistWithoutCaptureWillDoNothing(){
 377         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 378
 379         verify(mockDataPersistenceProvider, never()).saveSnapshot(any(Snapshot.class));
 380
 381         verify(mockReplicatedLog, never()).snapshotPreCommit(9L, 6L);
 382
 383         verify(mockRaftActorBehavior, never()).handleMessage(any(ActorRef.class), any(SendInstallSnapshot.class));
 384     }
 385     @Test
 386     public void testCallingPersistTwiceWillDoNoHarm(){
 387         doReturn(Integer.MAX_VALUE).when(mockReplicatedLog).dataSize();
 388
 389         // when replicatedToAllIndex = -1
 390         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 391                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 392
 393         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 394
 395         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 396
 397         verify(mockDataPersistenceProvider).saveSnapshot(any(Snapshot.class));
 398
 399         verify(mockReplicatedLog).snapshotPreCommit(9L, 6L);
 400
 401         verify(mockRaftActorBehavior).handleMessage(any(ActorRef.class), any(SendInstallSnapshot.class));
 402     }
 403
 404     @Test
 405     public void testCommit(){
 406         doReturn(50L).when(mockDataPersistenceProvider).getLastSequenceNumber();
 407
 408         // when replicatedToAllIndex = -1
 409         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 410                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 411
 412         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 413
 414         assertEquals(true, snapshotManager.isCapturing());
 415
 416         snapshotManager.commit(100L, mockRaftActorBehavior);
 417
 418         assertEquals(false, snapshotManager.isCapturing());
 419
 420         verify(mockReplicatedLog).snapshotCommit();
 421
 422         verify(mockDataPersistenceProvider).deleteMessages(50L);
 423
 424         ArgumentCaptor<SnapshotSelectionCriteria> criteriaCaptor = ArgumentCaptor.forClass(SnapshotSelectionCriteria.class);
 425
 426         verify(mockDataPersistenceProvider).deleteSnapshots(criteriaCaptor.capture());
 427
 428         assertEquals(90, criteriaCaptor.getValue().maxSequenceNr()); // sequenceNumber = 100
 429                                                                      // config snapShotBatchCount = 10
 430                                                                      // therefore maxSequenceNumber = 90
 431
 432         MessageCollectorActor.expectFirstMatching(actorRef, SnapshotComplete.class);
 433     }
 434
 435     @Test
 436     public void testCommitBeforePersist(){
 437         // when replicatedToAllIndex = -1
 438         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 439                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 440
 441         snapshotManager.commit(100L, mockRaftActorBehavior);
 442
 443         verify(mockReplicatedLog, never()).snapshotCommit();
 444
 445         verify(mockDataPersistenceProvider, never()).deleteMessages(100L);
 446
 447         verify(mockDataPersistenceProvider, never()).deleteSnapshots(any(SnapshotSelectionCriteria.class));
 448
 449     }
 450
 451     @Test
 452     public void testCommitBeforeCapture(){
 453         snapshotManager.commit(100L, mockRaftActorBehavior);
 454
 455         verify(mockReplicatedLog, never()).snapshotCommit();
 456
 457         verify(mockDataPersistenceProvider, never()).deleteMessages(anyLong());
 458
 459         verify(mockDataPersistenceProvider, never()).deleteSnapshots(any(SnapshotSelectionCriteria.class));
 460
 461     }
 462
 463     @Test
 464     public void testCallingCommitMultipleTimesCausesNoHarm(){
 465         doReturn(50L).when(mockDataPersistenceProvider).getLastSequenceNumber();
 466
 467         // when replicatedToAllIndex = -1
 468         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 469                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 470
 471         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 472
 473         snapshotManager.commit(100L, mockRaftActorBehavior);
 474
 475         snapshotManager.commit(100L, mockRaftActorBehavior);
 476
 477         verify(mockReplicatedLog, times(1)).snapshotCommit();
 478
 479         verify(mockDataPersistenceProvider, times(1)).deleteMessages(50L);
 480
 481         verify(mockDataPersistenceProvider, times(1)).deleteSnapshots(any(SnapshotSelectionCriteria.class));
 482     }
 483
 484     @Test
 485     public void testRollback(){
 486         // when replicatedToAllIndex = -1
 487         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 488                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 489
 490         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 491
 492         snapshotManager.rollback();
 493
 494         verify(mockReplicatedLog).snapshotRollback();
 495
 496         MessageCollectorActor.expectFirstMatching(actorRef, SnapshotComplete.class);
 497     }
 498
 499
 500     @Test
 501     public void testRollbackBeforePersist(){
 502         // when replicatedToAllIndex = -1
 503         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 504                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 505
 506         snapshotManager.rollback();
 507
 508         verify(mockReplicatedLog, never()).snapshotRollback();
 509     }
 510
 511     @Test
 512     public void testRollbackBeforeCapture(){
 513         snapshotManager.rollback();
 514
 515         verify(mockReplicatedLog, never()).snapshotRollback();
 516     }
 517
 518     @Test
 519     public void testCallingRollbackMultipleTimesCausesNoHarm(){
 520         // when replicatedToAllIndex = -1
 521         snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(6, 9,
 522                 new MockRaftActorContext.MockPayload()), -1, "follower-1");
 523
 524         snapshotManager.persist(new byte[]{}, mockRaftActorBehavior, Runtime.getRuntime().totalMemory());
 525
 526         snapshotManager.rollback();
 527
 528         snapshotManager.rollback();
 529
 530         verify(mockReplicatedLog, times(1)).snapshotRollback();
 531     }
 532
 533     @Test
 534     public void testTrimLogWhenTrimIndexLessThanLastApplied() {
 535         doReturn(20L).when(mockRaftActorContext).getLastApplied();
 536
 537         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 538         doReturn(true).when(mockReplicatedLog).isPresent(10);
 539         doReturn(replicatedLogEntry).when((mockReplicatedLog)).get(10);
 540         doReturn(5L).when(replicatedLogEntry).getTerm();
 541
 542         long retIndex = snapshotManager.trimLog(10, mockRaftActorBehavior);
 543         assertEquals("return index", 10L, retIndex);
 544
 545         verify(mockReplicatedLog).snapshotPreCommit(10, 5);
 546         verify(mockReplicatedLog).snapshotCommit();
 547
 548         verify(mockRaftActorBehavior, never()).setReplicatedToAllIndex(anyLong());
 549     }
 550
 551     @Test
 552     public void testTrimLogWhenLastAppliedNotSet() {
 553         doReturn(-1L).when(mockRaftActorContext).getLastApplied();
 554
 555         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 556         doReturn(true).when(mockReplicatedLog).isPresent(10);
 557         doReturn(replicatedLogEntry).when((mockReplicatedLog)).get(10);
 558         doReturn(5L).when(replicatedLogEntry).getTerm();
 559
 560         long retIndex = snapshotManager.trimLog(10, mockRaftActorBehavior);
 561         assertEquals("return index", -1L, retIndex);
 562
 563         verify(mockReplicatedLog, never()).snapshotPreCommit(anyLong(), anyLong());
 564         verify(mockReplicatedLog, never()).snapshotCommit();
 565
 566         verify(mockRaftActorBehavior, never()).setReplicatedToAllIndex(anyLong());
 567     }
 568
 569     @Test
 570     public void testTrimLogWhenLastAppliedZero() {
 571         doReturn(0L).when(mockRaftActorContext).getLastApplied();
 572
 573         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 574         doReturn(true).when(mockReplicatedLog).isPresent(10);
 575         doReturn(replicatedLogEntry).when((mockReplicatedLog)).get(10);
 576         doReturn(5L).when(replicatedLogEntry).getTerm();
 577
 578         long retIndex = snapshotManager.trimLog(10, mockRaftActorBehavior);
 579         assertEquals("return index", -1L, retIndex);
 580
 581         verify(mockReplicatedLog, never()).snapshotPreCommit(anyLong(), anyLong());
 582         verify(mockReplicatedLog, never()).snapshotCommit();
 583
 584         verify(mockRaftActorBehavior, never()).setReplicatedToAllIndex(anyLong());
 585     }
 586
 587     @Test
 588     public void testTrimLogWhenTrimIndexNotPresent() {
 589         doReturn(20L).when(mockRaftActorContext).getLastApplied();
 590
 591         doReturn(false).when(mockReplicatedLog).isPresent(10);
 592
 593         long retIndex = snapshotManager.trimLog(10, mockRaftActorBehavior);
 594         assertEquals("return index", -1L, retIndex);
 595
 596         verify(mockReplicatedLog, never()).snapshotPreCommit(anyLong(), anyLong());
 597         verify(mockReplicatedLog, never()).snapshotCommit();
 598
 599         // Trim index is greater than replicatedToAllIndex so should update it.
 600         verify(mockRaftActorBehavior).setReplicatedToAllIndex(10L);
 601     }
 602
 603     @Test
 604     public void testTrimLogAfterCapture(){
 605         boolean capture = snapshotManager.capture(new MockRaftActorContext.MockReplicatedLogEntry(1,9,
 606                 new MockRaftActorContext.MockPayload()), 9);
 607
 608         assertTrue(capture);
 609
 610         assertEquals(true, snapshotManager.isCapturing());
 611
 612         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 613         doReturn(20L).when(mockRaftActorContext).getLastApplied();
 614         doReturn(true).when(mockReplicatedLog).isPresent(10);
 615         doReturn(replicatedLogEntry).when((mockReplicatedLog)).get(10);
 616         doReturn(5L).when(replicatedLogEntry).getTerm();
 617
 618         snapshotManager.trimLog(10, mockRaftActorBehavior);
 619
 620         verify(mockReplicatedLog, never()).snapshotPreCommit(anyLong(), anyLong());
 621         verify(mockReplicatedLog, never()).snapshotCommit();
 622
 623     }
 624
 625     @Test
 626     public void testTrimLogAfterCaptureToInstall(){
 627         boolean capture = snapshotManager.captureToInstall(new MockRaftActorContext.MockReplicatedLogEntry(1,9,
 628                 new MockRaftActorContext.MockPayload()), 9, "follower-1");
 629
 630         assertTrue(capture);
 631
 632         assertEquals(true, snapshotManager.isCapturing());
 633
 634         ReplicatedLogEntry replicatedLogEntry = mock(ReplicatedLogEntry.class);
 635         doReturn(20L).when(mockRaftActorContext).getLastApplied();
 636         doReturn(true).when(mockReplicatedLog).isPresent(10);
 637         doReturn(replicatedLogEntry).when((mockReplicatedLog)).get(10);
 638         doReturn(5L).when(replicatedLogEntry).getTerm();
 639
 640         snapshotManager.trimLog(10, mockRaftActorBehavior);
 641
 642         verify(mockReplicatedLog, never()).snapshotPreCommit(10, 5);
 643         verify(mockReplicatedLog, never()).snapshotCommit();
 644
 645     }
 646
 647     @Test
 648     public void testLastAppliedTermInformationReader() {
 649
 650         LastAppliedTermInformationReader reader = new LastAppliedTermInformationReader();
 651
 652         doReturn(4L).when(mockReplicatedLog).getSnapshotTerm();
 653         doReturn(7L).when(mockReplicatedLog).getSnapshotIndex();
 654
 655         ReplicatedLogEntry lastLogEntry = new MockRaftActorContext.MockReplicatedLogEntry(6L, 9L,
 656                 new MockRaftActorContext.MockPayload());
 657
 658         // No followers and valid lastLogEntry
 659         reader.init(mockReplicatedLog, 1L, lastLogEntry, false);
 660
 661         assertEquals("getTerm", 6L, reader.getTerm());
 662         assertEquals("getIndex", 9L, reader.getIndex());
 663
 664         // No followers and null lastLogEntry
 665         reader.init(mockReplicatedLog, 1L, null, false);
 666
 667         assertEquals("getTerm", -1L, reader.getTerm());
 668         assertEquals("getIndex", -1L, reader.getIndex());
 669
 670         // Followers and valid originalIndex entry
 671         doReturn(new MockRaftActorContext.MockReplicatedLogEntry(5L, 8L,
 672                 new MockRaftActorContext.MockPayload())).when(mockReplicatedLog).get(8L);
 673         reader.init(mockReplicatedLog, 8L, lastLogEntry, true);
 674
 675         assertEquals("getTerm", 5L, reader.getTerm());
 676         assertEquals("getIndex", 8L, reader.getIndex());
 677
 678         // Followers and null originalIndex entry and valid snapshot index
 679         reader.init(mockReplicatedLog, 7L, lastLogEntry, true);
 680
 681         assertEquals("getTerm", 4L, reader.getTerm());
 682         assertEquals("getIndex", 7L, reader.getIndex());
 683
 684         // Followers and null originalIndex entry and invalid snapshot index
 685         doReturn(-1L).when(mockReplicatedLog).getSnapshotIndex();
 686         reader.init(mockReplicatedLog, 7L, lastLogEntry, true);
 687
 688         assertEquals("getTerm", -1L, reader.getTerm());
 689         assertEquals("getIndex", -1L, reader.getIndex());
 690     }
 691 }