X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2FRaftActorTest.java;h=9e0e06c70bb694fdbd3cfe6b654877023e27a361;hb=7daddd72031b33ed686abe18a0813e41263aac8d;hp=82446045526adec70c15996ce0ea64dd511ccdb4;hpb=fa3763a80e5c8464252678565978527844ccdf98;p=controller.git diff --git a/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/RaftActorTest.java b/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/RaftActorTest.java index 8244604552..3b58cb01d1 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/RaftActorTest.java +++ b/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/RaftActorTest.java @@ -1,883 +1,1422 @@ +/* + * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ package org.opendaylight.controller.cluster.raft; +import static org.awaitility.Awaitility.await; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNotSame; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.ArgumentMatchers.same; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.reset; +import static org.mockito.Mockito.timeout; +import static org.mockito.Mockito.verify; + import akka.actor.ActorRef; -import akka.actor.ActorSystem; import akka.actor.PoisonPill; -import akka.actor.Props; +import akka.actor.Status.Failure; import akka.actor.Terminated; -import akka.japi.Creator; +import akka.dispatch.Dispatchers; import akka.japi.Procedure; -import akka.pattern.Patterns; -import akka.persistence.RecoveryCompleted; import akka.persistence.SaveSnapshotFailure; import akka.persistence.SaveSnapshotSuccess; import akka.persistence.SnapshotMetadata; import akka.persistence.SnapshotOffer; -import akka.persistence.SnapshotSelectionCriteria; -import akka.testkit.JavaTestKit; +import akka.protobuf.ByteString; import akka.testkit.TestActorRef; -import akka.util.Timeout; +import akka.testkit.javadsl.TestKit; import com.google.common.base.Optional; -import com.google.common.collect.Lists; +import com.google.common.collect.ImmutableMap; import com.google.common.util.concurrent.Uninterruptibles; -import com.google.protobuf.ByteString; +import java.io.ByteArrayOutputStream; +import java.io.ObjectOutputStream; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import org.junit.After; -import org.junit.Assert; +import org.junit.Before; import org.junit.Test; +import org.mockito.ArgumentCaptor; import org.opendaylight.controller.cluster.DataPersistenceProvider; -import org.opendaylight.controller.cluster.datastore.DataPersistenceProviderMonitor; -import org.opendaylight.controller.cluster.raft.base.messages.ApplyLogEntries; +import org.opendaylight.controller.cluster.NonPersistentDataProvider; +import org.opendaylight.controller.cluster.PersistentDataProvider; +import org.opendaylight.controller.cluster.notifications.LeaderStateChanged; +import org.opendaylight.controller.cluster.notifications.RoleChanged; +import org.opendaylight.controller.cluster.raft.AbstractRaftActorIntegrationTest.TestPersist; +import org.opendaylight.controller.cluster.raft.AbstractRaftActorIntegrationTest.TestRaftActor; +import org.opendaylight.controller.cluster.raft.MockRaftActor.MockSnapshotState; +import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload; import org.opendaylight.controller.cluster.raft.base.messages.ApplySnapshot; import org.opendaylight.controller.cluster.raft.base.messages.ApplyState; -import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshot; import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply; +import org.opendaylight.controller.cluster.raft.base.messages.LeaderTransitioning; +import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat; +import org.opendaylight.controller.cluster.raft.base.messages.SwitchBehavior; import org.opendaylight.controller.cluster.raft.behaviors.Follower; import org.opendaylight.controller.cluster.raft.behaviors.Leader; -import org.opendaylight.controller.cluster.raft.client.messages.FindLeader; -import org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply; -import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload; -import org.opendaylight.controller.cluster.raft.utils.MockAkkaJournal; -import org.opendaylight.controller.cluster.raft.utils.MockSnapshotStore; -import scala.concurrent.Await; -import scala.concurrent.Future; -import scala.concurrent.duration.Duration; +import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior; +import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshot; +import org.opendaylight.controller.cluster.raft.client.messages.GetSnapshotReply; +import org.opendaylight.controller.cluster.raft.messages.AppendEntries; +import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; +import org.opendaylight.controller.cluster.raft.persisted.ApplyJournalEntries; +import org.opendaylight.controller.cluster.raft.persisted.ByteState; +import org.opendaylight.controller.cluster.raft.persisted.DeleteEntries; +import org.opendaylight.controller.cluster.raft.persisted.EmptyState; +import org.opendaylight.controller.cluster.raft.persisted.ServerConfigurationPayload; +import org.opendaylight.controller.cluster.raft.persisted.ServerInfo; +import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry; +import org.opendaylight.controller.cluster.raft.persisted.Snapshot; +import org.opendaylight.controller.cluster.raft.persisted.UpdateElectionTerm; +import org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy; +import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal; +import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore; +import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor; +import org.opendaylight.yangtools.concepts.Identifier; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import scala.concurrent.duration.FiniteDuration; -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.List; -import java.util.Map; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; +public class RaftActorTest extends AbstractActorTest { -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNotEquals; -import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertTrue; -import static org.mockito.Matchers.any; -import static org.mockito.Matchers.anyObject; -import static org.mockito.Matchers.eq; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; + static final Logger TEST_LOG = LoggerFactory.getLogger(RaftActorTest.class); -public class RaftActorTest extends AbstractActorTest { + private TestActorFactory factory; + @Before + public void setUp() { + factory = new TestActorFactory(getSystem()); + } @After public void tearDown() { - MockAkkaJournal.clearJournal(); - MockSnapshotStore.setMockSnapshot(null); + factory.close(); + InMemoryJournal.clear(); + InMemorySnapshotStore.clear(); } - public static class MockRaftActor extends RaftActor { + @Test + public void testConstruction() { + new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader(); + } - private final DataPersistenceProvider dataPersistenceProvider; - private final RaftActor delegate; + @Test + public void testFindLeaderWhenLeaderIsSelf() { + RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader"); + kit.waitUntilLeader(); + } - public static final class MockRaftActorCreator implements Creator { - private final Map peerAddresses; - private final String id; - private final Optional config; - private final DataPersistenceProvider dataPersistenceProvider; - private MockRaftActorCreator(Map peerAddresses, String id, - Optional config, DataPersistenceProvider dataPersistenceProvider) { - this.peerAddresses = peerAddresses; - this.id = id; - this.config = config; - this.dataPersistenceProvider = dataPersistenceProvider; - } + @Test + public void testRaftActorRecoveryWithPersistenceEnabled() { + TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled starting"); - @Override - public MockRaftActor create() throws Exception { - return new MockRaftActor(id, peerAddresses, config, dataPersistenceProvider); - } - } + TestKit kit = new TestKit(getSystem()); + String persistenceId = factory.generateActorId("follower-"); - private final CountDownLatch recoveryComplete = new CountDownLatch(1); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); - private final List state; + // Set the heartbeat interval high to essentially disable election otherwise the test + // may fail if the actor is switched to Leader and the commitIndex is set to the last + // log entry. + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); - public MockRaftActor(String id, Map peerAddresses, Optional config, DataPersistenceProvider dataPersistenceProvider) { - super(id, peerAddresses, config); - state = new ArrayList<>(); - this.delegate = mock(RaftActor.class); - if(dataPersistenceProvider == null){ - this.dataPersistenceProvider = new PersistentDataProvider(); - } else { - this.dataPersistenceProvider = dataPersistenceProvider; - } - } + ImmutableMap peerAddresses = ImmutableMap.builder() + .put("member1", "address").build(); + ActorRef followerActor = factory.createActor(MockRaftActor.props(persistenceId, + peerAddresses, config), persistenceId); - public void waitForRecoveryComplete() { - try { - assertEquals("Recovery complete", true, recoveryComplete.await(5, TimeUnit.SECONDS)); - } catch (InterruptedException e) { - e.printStackTrace(); - } - } + kit.watch(followerActor); - public List getState() { - return state; - } + List snapshotUnappliedEntries = new ArrayList<>(); + ReplicatedLogEntry entry1 = new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E")); + snapshotUnappliedEntries.add(entry1); - public static Props props(final String id, final Map peerAddresses, - Optional config){ - return Props.create(new MockRaftActorCreator(peerAddresses, id, config, null)); - } + int lastAppliedDuringSnapshotCapture = 3; + int lastIndexDuringSnapshotCapture = 4; - public static Props props(final String id, final Map peerAddresses, - Optional config, DataPersistenceProvider dataPersistenceProvider){ - return Props.create(new MockRaftActorCreator(peerAddresses, id, config, dataPersistenceProvider)); - } + // 4 messages as part of snapshot, which are applied to state + MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList( + new MockRaftActorContext.MockPayload("A"), + new MockRaftActorContext.MockPayload("B"), + new MockRaftActorContext.MockPayload("C"), + new MockRaftActorContext.MockPayload("D"))); + Snapshot snapshot = Snapshot.create(snapshotState, snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1, + lastAppliedDuringSnapshotCapture, 1, -1, null, null); + InMemorySnapshotStore.addSnapshot(persistenceId, snapshot); - @Override protected void applyState(ActorRef clientActor, String identifier, Object data) { - delegate.applyState(clientActor, identifier, data); - LOG.info("applyState called"); - } + // add more entries after snapshot is taken + List entries = new ArrayList<>(); + ReplicatedLogEntry entry2 = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F", 2)); + ReplicatedLogEntry entry3 = new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("G", 3)); + ReplicatedLogEntry entry4 = new SimpleReplicatedLogEntry(7, 1, new MockRaftActorContext.MockPayload("H", 4)); + entries.add(entry2); + entries.add(entry3); + entries.add(entry4); + final int lastAppliedToState = 5; + final int lastIndex = 7; + InMemoryJournal.addEntry(persistenceId, 5, entry2); + // 2 entries are applied to state besides the 4 entries in snapshot + InMemoryJournal.addEntry(persistenceId, 6, new ApplyJournalEntries(lastAppliedToState)); + InMemoryJournal.addEntry(persistenceId, 7, entry3); + InMemoryJournal.addEntry(persistenceId, 8, entry4); + // kill the actor + followerActor.tell(PoisonPill.getInstance(), null); + kit.expectMsgClass(Duration.ofSeconds(5), Terminated.class); - @Override - protected void startLogRecoveryBatch(int maxBatchSize) { - } + kit.unwatch(followerActor); - @Override - protected void appendRecoveredLogEntry(Payload data) { - state.add(data); - } + //reinstate the actor + TestActorRef ref = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config)); - @Override - protected void applyCurrentLogRecoveryBatch() { - } + MockRaftActor mockRaftActor = ref.underlyingActor(); - @Override - protected void onRecoveryComplete() { - delegate.onRecoveryComplete(); - recoveryComplete.countDown(); - } + mockRaftActor.waitForRecoveryComplete(); - @Override - protected void applyRecoverySnapshot(ByteString snapshot) { - delegate.applyRecoverySnapshot(snapshot); - try { - Object data = toObject(snapshot); - System.out.println("!!!!!applyRecoverySnapshot: "+data); - if (data instanceof List) { - state.addAll((List) data); - } - } catch (Exception e) { - e.printStackTrace(); - } - } + RaftActorContext context = mockRaftActor.getRaftActorContext(); + assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(), + context.getReplicatedLog().size()); + assertEquals("Journal data size", 10, context.getReplicatedLog().dataSize()); + assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex()); + assertEquals("Last applied", lastAppliedToState, context.getLastApplied()); + assertEquals("Commit index", lastAppliedToState, context.getCommitIndex()); + assertEquals("Recovered state size", 6, mockRaftActor.getState().size()); - @Override protected void createSnapshot() { - delegate.createSnapshot(); - } + mockRaftActor.waitForInitializeBehaviorComplete(); - @Override protected void applySnapshot(ByteString snapshot) { - delegate.applySnapshot(snapshot); - } + assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState()); - @Override protected void onStateChanged() { - delegate.onStateChanged(); - } + TEST_LOG.info("testRaftActorRecoveryWithPersistenceEnabled ending"); + } - @Override - protected DataPersistenceProvider persistence() { - return this.dataPersistenceProvider; - } + @Test + public void testRaftActorRecoveryWithPersistenceDisabled() { + String persistenceId = factory.generateActorId("follower-"); - @Override public String persistenceId() { - return this.getId(); - } + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); - private Object toObject(ByteString bs) throws ClassNotFoundException, IOException { - Object obj = null; - ByteArrayInputStream bis = null; - ObjectInputStream ois = null; - try { - bis = new ByteArrayInputStream(bs.toByteArray()); - ois = new ObjectInputStream(bis); - obj = ois.readObject(); - } finally { - if (bis != null) { - bis.close(); - } - if (ois != null) { - ois.close(); - } - } - return obj; - } + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); - public ReplicatedLog getReplicatedLog(){ - return this.getRaftActorContext().getReplicatedLog(); - } + TestActorRef ref = factory.createTestActor(MockRaftActor.props(persistenceId, + ImmutableMap.builder().put("member1", "address").build(), + config, createProvider()), persistenceId); - } + MockRaftActor mockRaftActor = ref.underlyingActor(); + mockRaftActor.waitForRecoveryComplete(); - private static class RaftActorTestKit extends JavaTestKit { - private final ActorRef raftActor; + mockRaftActor.waitForInitializeBehaviorComplete(); - public RaftActorTestKit(ActorSystem actorSystem, String actorName) { - super(actorSystem); + assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState()); + } - raftActor = this.getSystem().actorOf(MockRaftActor.props(actorName, - Collections.EMPTY_MAP, Optional.absent()), actorName); + @Test + public void testUpdateElectionTermPersistedWithPersistenceDisabled() { + final TestKit kit = new TestKit(getSystem()); + String persistenceId = factory.generateActorId("follower-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS)); + config.setElectionTimeoutFactor(1); + + InMemoryJournal.addWriteMessagesCompleteLatch(persistenceId, 1); + + TestActorRef ref = factory.createTestActor(MockRaftActor.props(persistenceId, + ImmutableMap.builder().put("member1", "address").build(), + config, createProvider()) + .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + + InMemoryJournal.waitForWriteMessagesComplete(persistenceId); + List entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class); + assertEquals("UpdateElectionTerm entries", 1, entries.size()); + final UpdateElectionTerm updateEntry = entries.get(0); + + factory.killActor(ref, kit); + + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + ref = factory.createTestActor(MockRaftActor.props(persistenceId, + ImmutableMap.builder().put("member1", "address").build(), config, + createProvider()).withDispatcher(Dispatchers.DefaultDispatcherId()), + factory.generateActorId("follower-")); + + MockRaftActor actor = ref.underlyingActor(); + actor.waitForRecoveryComplete(); + + RaftActorContext newContext = actor.getRaftActorContext(); + assertEquals("electionTerm", updateEntry.getCurrentTerm(), + newContext.getTermInformation().getCurrentTerm()); + assertEquals("votedFor", updateEntry.getVotedFor(), newContext.getTermInformation().getVotedFor()); + + entries = InMemoryJournal.get(persistenceId, UpdateElectionTerm.class); + assertEquals("UpdateElectionTerm entries", 1, entries.size()); + } - } + @Test + public void testRaftActorForwardsToRaftActorRecoverySupport() { + String persistenceId = factory.generateActorId("leader-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); - public ActorRef getRaftActor() { - return raftActor; - } + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); - public boolean waitForLogMessage(final Class logEventClass, String message){ - // Wait for a specific log message to show up - return - new JavaTestKit.EventFilter(logEventClass - ) { - @Override - protected Boolean run() { - return true; - } - }.from(raftActor.path().toString()) - .message(message) - .occurrences(1).exec(); + TestActorRef mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId, + Collections.emptyMap(), config), persistenceId); + MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); - } + // Wait for akka's recovery to complete so it doesn't interfere. + mockRaftActor.waitForRecoveryComplete(); - protected void waitUntilLeader(){ - waitUntilLeader(raftActor); - } + RaftActorRecoverySupport mockSupport = mock(RaftActorRecoverySupport.class); + mockRaftActor.setRaftActorRecoverySupport(mockSupport); - protected void waitUntilLeader(ActorRef actorRef) { - FiniteDuration duration = Duration.create(100, TimeUnit.MILLISECONDS); - for(int i = 0; i < 20 * 5; i++) { - Future future = Patterns.ask(actorRef, new FindLeader(), new Timeout(duration)); - try { - FindLeaderReply resp = (FindLeaderReply) Await.result(future, duration); - if(resp.getLeaderActor() != null) { - return; - } - } catch(TimeoutException e) { - } catch(Exception e) { - System.err.println("FindLeader threw ex"); - e.printStackTrace(); - } + Snapshot snapshot = Snapshot.create(ByteState.of(new byte[]{1}), + Collections.emptyList(), 3, 1, 3, 1, -1, null, null); + SnapshotOffer snapshotOffer = new SnapshotOffer(new SnapshotMetadata("test", 6, 12345), snapshot); + mockRaftActor.handleRecover(snapshotOffer); + ReplicatedLogEntry logEntry = new SimpleReplicatedLogEntry(1, 1, new MockRaftActorContext.MockPayload("1", 5)); + mockRaftActor.handleRecover(logEntry); - Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS); - } + ApplyJournalEntries applyJournalEntries = new ApplyJournalEntries(2); + mockRaftActor.handleRecover(applyJournalEntries); - Assert.fail("Leader not found for actorRef " + actorRef.path()); - } + DeleteEntries deleteEntries = new DeleteEntries(1); + mockRaftActor.handleRecover(deleteEntries); - } + UpdateElectionTerm updateElectionTerm = new UpdateElectionTerm(5, "member2"); + mockRaftActor.handleRecover(updateElectionTerm); + verify(mockSupport).handleRecoveryMessage(same(snapshotOffer), any(PersistentDataProvider.class)); + verify(mockSupport).handleRecoveryMessage(same(logEntry), any(PersistentDataProvider.class)); + verify(mockSupport).handleRecoveryMessage(same(applyJournalEntries), any(PersistentDataProvider.class)); + verify(mockSupport).handleRecoveryMessage(same(deleteEntries), any(PersistentDataProvider.class)); + verify(mockSupport).handleRecoveryMessage(same(updateElectionTerm), any(PersistentDataProvider.class)); + } @Test - public void testConstruction() { - new RaftActorTestKit(getSystem(), "testConstruction").waitUntilLeader(); + public void testRaftActorForwardsToRaftActorSnapshotMessageSupport() { + String persistenceId = factory.generateActorId("leader-"); + + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + + RaftActorSnapshotMessageSupport mockSupport = mock(RaftActorSnapshotMessageSupport.class); + + TestActorRef mockActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId) + .config(config).snapshotMessageSupport(mockSupport).props()); + + MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + + // Wait for akka's recovery to complete so it doesn't interfere. + mockRaftActor.waitForRecoveryComplete(); + + ApplySnapshot applySnapshot = new ApplySnapshot(mock(Snapshot.class)); + doReturn(true).when(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class)); + mockRaftActor.handleCommand(applySnapshot); + + CaptureSnapshotReply captureSnapshotReply = new CaptureSnapshotReply(ByteState.empty(), + java.util.Optional.empty()); + doReturn(true).when(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class)); + mockRaftActor.handleCommand(captureSnapshotReply); + + SaveSnapshotSuccess saveSnapshotSuccess = new SaveSnapshotSuccess(new SnapshotMetadata("", 0L, 0L)); + doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class)); + mockRaftActor.handleCommand(saveSnapshotSuccess); + + SaveSnapshotFailure saveSnapshotFailure = new SaveSnapshotFailure(new SnapshotMetadata("", 0L, 0L), + new Throwable()); + doReturn(true).when(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class)); + mockRaftActor.handleCommand(saveSnapshotFailure); + + doReturn(true).when(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT), + any(ActorRef.class)); + mockRaftActor.handleCommand(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT); + + doReturn(true).when(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class)); + mockRaftActor.handleCommand(GetSnapshot.INSTANCE); + + verify(mockSupport).handleSnapshotMessage(same(applySnapshot), any(ActorRef.class)); + verify(mockSupport).handleSnapshotMessage(same(captureSnapshotReply), any(ActorRef.class)); + verify(mockSupport).handleSnapshotMessage(same(saveSnapshotSuccess), any(ActorRef.class)); + verify(mockSupport).handleSnapshotMessage(same(saveSnapshotFailure), any(ActorRef.class)); + verify(mockSupport).handleSnapshotMessage(same(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT), + any(ActorRef.class)); + verify(mockSupport).handleSnapshotMessage(same(GetSnapshot.INSTANCE), any(ActorRef.class)); } + @SuppressWarnings("unchecked") @Test - public void testFindLeaderWhenLeaderIsSelf(){ - RaftActorTestKit kit = new RaftActorTestKit(getSystem(), "testFindLeader"); - kit.waitUntilLeader(); + public void testApplyJournalEntriesCallsDataPersistence() throws Exception { + String persistenceId = factory.generateActorId("leader-"); + + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + + DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + + TestActorRef mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId, + Collections.emptyMap(), config, dataPersistenceProvider), persistenceId); + + MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + + mockRaftActor.waitForInitializeBehaviorComplete(); + + mockRaftActor.waitUntilLeader(); + + mockRaftActor.handleCommand(new ApplyJournalEntries(10)); + + verify(dataPersistenceProvider).persistAsync(any(ApplyJournalEntries.class), any(Procedure.class)); } @Test - public void testRaftActorRecovery() throws Exception { - new JavaTestKit(getSystem()) {{ - String persistenceId = "follower10"; - - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); - // Set the heartbeat interval high to essentially disable election otherwise the test - // may fail if the actor is switched to Leader and the commitIndex is set to the last - // log entry. - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); - - ActorRef followerActor = getSystem().actorOf(MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config)), persistenceId); - - watch(followerActor); - - List snapshotUnappliedEntries = new ArrayList<>(); - ReplicatedLogEntry entry1 = new MockRaftActorContext.MockReplicatedLogEntry(1, 4, - new MockRaftActorContext.MockPayload("E")); - snapshotUnappliedEntries.add(entry1); - - int lastAppliedDuringSnapshotCapture = 3; - int lastIndexDuringSnapshotCapture = 4; - - // 4 messages as part of snapshot, which are applied to state - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); - - Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(), - snapshotUnappliedEntries, lastIndexDuringSnapshotCapture, 1 , - lastAppliedDuringSnapshotCapture, 1); - MockSnapshotStore.setMockSnapshot(snapshot); - MockSnapshotStore.setPersistenceId(persistenceId); - - // add more entries after snapshot is taken - List entries = new ArrayList<>(); - ReplicatedLogEntry entry2 = new MockRaftActorContext.MockReplicatedLogEntry(1, 5, - new MockRaftActorContext.MockPayload("F")); - ReplicatedLogEntry entry3 = new MockRaftActorContext.MockReplicatedLogEntry(1, 6, - new MockRaftActorContext.MockPayload("G")); - ReplicatedLogEntry entry4 = new MockRaftActorContext.MockReplicatedLogEntry(1, 7, - new MockRaftActorContext.MockPayload("H")); - entries.add(entry2); - entries.add(entry3); - entries.add(entry4); - - int lastAppliedToState = 5; - int lastIndex = 7; - - MockAkkaJournal.addToJournal(5, entry2); - // 2 entries are applied to state besides the 4 entries in snapshot - MockAkkaJournal.addToJournal(6, new ApplyLogEntries(lastAppliedToState)); - MockAkkaJournal.addToJournal(7, entry3); - MockAkkaJournal.addToJournal(8, entry4); - - // kill the actor - followerActor.tell(PoisonPill.getInstance(), null); - expectMsgClass(duration("5 seconds"), Terminated.class); - - unwatch(followerActor); - - //reinstate the actor - TestActorRef ref = TestActorRef.create(getSystem(), - MockRaftActor.props(persistenceId, Collections.EMPTY_MAP, - Optional.of(config))); - - ref.underlyingActor().waitForRecoveryComplete(); - - RaftActorContext context = ref.underlyingActor().getRaftActorContext(); - assertEquals("Journal log size", snapshotUnappliedEntries.size() + entries.size(), - context.getReplicatedLog().size()); - assertEquals("Last index", lastIndex, context.getReplicatedLog().lastIndex()); - assertEquals("Last applied", lastAppliedToState, context.getLastApplied()); - assertEquals("Commit index", lastAppliedToState, context.getCommitIndex()); - assertEquals("Recovered state size", 6, ref.underlyingActor().getState().size()); - }}; - } + public void testApplyState() { + String persistenceId = factory.generateActorId("leader-"); - /** - * This test verifies that when recovery is applicable (typically when persistence is true) the RaftActor does - * process recovery messages - * - * @throws Exception - */ + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); - @Test - public void testHandleRecoveryWhenDataPersistenceRecoveryApplicable() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testHandleRecoveryWhenDataPersistenceRecoveryApplicable"; + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + TestActorRef mockActorRef = factory.createTestActor(MockRaftActor.props(persistenceId, + Collections.emptyMap(), config, dataPersistenceProvider), persistenceId); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config)), persistenceId); + MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + mockRaftActor.waitForInitializeBehaviorComplete(); - // Wait for akka's recovery to complete so it doesn't interfere. - mockRaftActor.waitForRecoveryComplete(); + ReplicatedLogEntry entry = new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("F")); - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); + final Identifier id = new MockIdentifier("apply-state"); + mockRaftActor.getRaftActorContext().getApplyStateConsumer().accept(new ApplyState(mockActorRef, id, entry)); - Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(), - Lists.newArrayList(), 3, 1 ,3, 1); + verify(mockRaftActor.actorDelegate).applyState(eq(mockActorRef), eq(id), any()); + } - mockRaftActor.onReceiveRecover(new SnapshotOffer(new SnapshotMetadata(persistenceId, 100, 100), snapshot)); + @Test + public void testRaftRoleChangeNotifierWhenRaftActorHasNoPeers() throws Exception { + ActorRef notifierActor = factory.createActor(MessageCollectorActor.props()); + MessageCollectorActor.waitUntilReady(notifierActor); - verify(mockRaftActor.delegate).applyRecoverySnapshot(eq(snapshotBytes)); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + long heartBeatInterval = 100; + config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS)); + config.setElectionTimeoutFactor(20); - mockRaftActor.onReceiveRecover(new ReplicatedLogImplEntry(0, 1, new MockRaftActorContext.MockPayload("A"))); + String persistenceId = factory.generateActorId("notifier-"); - ReplicatedLog replicatedLog = mockRaftActor.getReplicatedLog(); + final TestActorRef raftActorRef = factory.createTestActor(MockRaftActor.builder() + .id(persistenceId).config(config).roleChangeNotifier(notifierActor).dataPersistenceProvider( + createProvider()).props().withDispatcher(Dispatchers.DefaultDispatcherId()), + persistenceId); - assertEquals("add replicated log entry", 1, replicatedLog.size()); + List matches = MessageCollectorActor.expectMatching(notifierActor, RoleChanged.class, 3); - mockRaftActor.onReceiveRecover(new ReplicatedLogImplEntry(1, 1, new MockRaftActorContext.MockPayload("A"))); - assertEquals("add replicated log entry", 2, replicatedLog.size()); + // check if the notifier got a role change from null to Follower + RoleChanged raftRoleChanged = matches.get(0); + assertEquals(persistenceId, raftRoleChanged.getMemberId()); + assertNull(raftRoleChanged.getOldRole()); + assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole()); - mockRaftActor.onReceiveRecover(new ApplyLogEntries(1)); + // check if the notifier got a role change from Follower to Candidate + raftRoleChanged = matches.get(1); + assertEquals(persistenceId, raftRoleChanged.getMemberId()); + assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole()); + assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole()); - assertEquals("commit index 1", 1, mockRaftActor.getRaftActorContext().getCommitIndex()); + // check if the notifier got a role change from Candidate to Leader + raftRoleChanged = matches.get(2); + assertEquals(persistenceId, raftRoleChanged.getMemberId()); + assertEquals(RaftState.Candidate.name(), raftRoleChanged.getOldRole()); + assertEquals(RaftState.Leader.name(), raftRoleChanged.getNewRole()); - // The snapshot had 4 items + we added 2 more items during the test - // We start removing from 5 and we should get 1 item in the replicated log - mockRaftActor.onReceiveRecover(new RaftActor.DeleteEntries(5)); + LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching( + notifierActor, LeaderStateChanged.class); - assertEquals("remove log entries", 1, replicatedLog.size()); + assertEquals(raftRoleChanged.getMemberId(), leaderStateChange.getLeaderId()); + assertEquals(MockRaftActor.PAYLOAD_VERSION, leaderStateChange.getLeaderPayloadVersion()); - mockRaftActor.onReceiveRecover(new RaftActor.UpdateElectionTerm(10, "foobar")); + MessageCollectorActor.clearMessages(notifierActor); - assertEquals("election term", 10, mockRaftActor.getRaftActorContext().getTermInformation().getCurrentTerm()); - assertEquals("voted for", "foobar", mockRaftActor.getRaftActorContext().getTermInformation().getVotedFor()); + MockRaftActor raftActor = raftActorRef.underlyingActor(); + final String newLeaderId = "new-leader"; + final short newLeaderVersion = 6; + Follower follower = new Follower(raftActor.getRaftActorContext()) { + @Override + public RaftActorBehavior handleMessage(final ActorRef sender, final Object message) { + setLeaderId(newLeaderId); + setLeaderPayloadVersion(newLeaderVersion); + return this; + } + }; - mockRaftActor.onReceiveRecover(mock(RecoveryCompleted.class)); + raftActor.newBehavior(follower); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class); + assertEquals(persistenceId, leaderStateChange.getMemberId()); + assertEquals(null, leaderStateChange.getLeaderId()); - }}; - } + raftRoleChanged = MessageCollectorActor.expectFirstMatching(notifierActor, RoleChanged.class); + assertEquals(RaftState.Leader.name(), raftRoleChanged.getOldRole()); + assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole()); - /** - * This test verifies that when recovery is not applicable (typically when persistence is false) the RaftActor does - * not process recovery messages - * - * @throws Exception - */ - @Test - public void testHandleRecoveryWhenDataPersistenceRecoveryNotApplicable() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testHandleRecoveryWhenDataPersistenceRecoveryNotApplicable"; + MessageCollectorActor.clearMessages(notifierActor); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + raftActor.handleCommand("any"); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class); + assertEquals(persistenceId, leaderStateChange.getMemberId()); + assertEquals(newLeaderId, leaderStateChange.getLeaderId()); + assertEquals(newLeaderVersion, leaderStateChange.getLeaderPayloadVersion()); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), new DataPersistenceProviderMonitor()), persistenceId); + MessageCollectorActor.clearMessages(notifierActor); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + raftActor.handleCommand("any"); - // Wait for akka's recovery to complete so it doesn't interfere. - mockRaftActor.waitForRecoveryComplete(); + Uninterruptibles.sleepUninterruptibly(505, TimeUnit.MILLISECONDS); + leaderStateChange = MessageCollectorActor.getFirstMatching(notifierActor, LeaderStateChanged.class); + assertNull(leaderStateChange); + } - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); + @Test + public void testRaftRoleChangeNotifierWhenRaftActorHasPeers() throws Exception { + ActorRef notifierActor = factory.createActor(MessageCollectorActor.props()); + MessageCollectorActor.waitUntilReady(notifierActor); + + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + long heartBeatInterval = 100; + config.setHeartBeatInterval(FiniteDuration.create(heartBeatInterval, TimeUnit.MILLISECONDS)); + config.setElectionTimeoutFactor(1); + + String persistenceId = factory.generateActorId("notifier-"); + + factory.createActor(MockRaftActor.builder().id(persistenceId) + .peerAddresses(ImmutableMap.of("leader", "fake/path")) + .config(config).roleChangeNotifier(notifierActor).props()); + + List matches = null; + for (int i = 0; i < 5000 / heartBeatInterval; i++) { + matches = MessageCollectorActor.getAllMatching(notifierActor, RoleChanged.class); + assertNotNull(matches); + if (matches.size() == 3) { + break; + } + Uninterruptibles.sleepUninterruptibly(heartBeatInterval, TimeUnit.MILLISECONDS); + } - Snapshot snapshot = Snapshot.create(snapshotBytes.toByteArray(), - Lists.newArrayList(), 3, 1 ,3, 1); + assertNotNull(matches); + assertEquals(2, matches.size()); - mockRaftActor.onReceiveRecover(new SnapshotOffer(new SnapshotMetadata(persistenceId, 100, 100), snapshot)); + // check if the notifier got a role change from null to Follower + RoleChanged raftRoleChanged = matches.get(0); + assertEquals(persistenceId, raftRoleChanged.getMemberId()); + assertNull(raftRoleChanged.getOldRole()); + assertEquals(RaftState.Follower.name(), raftRoleChanged.getNewRole()); - verify(mockRaftActor.delegate, times(0)).applyRecoverySnapshot(any(ByteString.class)); + // check if the notifier got a role change from Follower to Candidate + raftRoleChanged = matches.get(1); + assertEquals(persistenceId, raftRoleChanged.getMemberId()); + assertEquals(RaftState.Follower.name(), raftRoleChanged.getOldRole()); + assertEquals(RaftState.Candidate.name(), raftRoleChanged.getNewRole()); + } - mockRaftActor.onReceiveRecover(new ReplicatedLogImplEntry(0, 1, new MockRaftActorContext.MockPayload("A"))); + @Test + public void testFakeSnapshotsForLeaderWithInRealSnapshots() throws Exception { + final String persistenceId = factory.generateActorId("leader-"); + final String follower1Id = factory.generateActorId("follower-"); - ReplicatedLog replicatedLog = mockRaftActor.getReplicatedLog(); + ActorRef followerActor1 = factory.createActor(MessageCollectorActor.props()); - assertEquals("add replicated log entry", 0, replicatedLog.size()); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); - mockRaftActor.onReceiveRecover(new ReplicatedLogImplEntry(1, 1, new MockRaftActorContext.MockPayload("A"))); + DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); - assertEquals("add replicated log entry", 0, replicatedLog.size()); + Map peerAddresses = new HashMap<>(); + peerAddresses.put(follower1Id, followerActor1.path().toString()); - mockRaftActor.onReceiveRecover(new ApplyLogEntries(1)); + TestActorRef mockActorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId); - assertEquals("commit index -1", -1, mockRaftActor.getRaftActorContext().getCommitIndex()); + MockRaftActor leaderActor = mockActorRef.underlyingActor(); - mockRaftActor.onReceiveRecover(new RaftActor.DeleteEntries(2)); + leaderActor.getRaftActorContext().setCommitIndex(4); + leaderActor.getRaftActorContext().setLastApplied(4); + leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId); - assertEquals("remove log entries", 0, replicatedLog.size()); + leaderActor.waitForInitializeBehaviorComplete(); - mockRaftActor.onReceiveRecover(new RaftActor.UpdateElectionTerm(10, "foobar")); + // create 8 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot - assertNotEquals("election term", 10, mockRaftActor.getRaftActorContext().getTermInformation().getCurrentTerm()); - assertNotEquals("voted for", "foobar", mockRaftActor.getRaftActorContext().getTermInformation().getVotedFor()); + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); - mockRaftActor.onReceiveRecover(mock(RecoveryCompleted.class)); + MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder(); + leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 8, 1).build()); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); - }}; - } + assertEquals(8, leaderActor.getReplicatedLog().size()); + leaderActor.getRaftActorContext().getSnapshotManager().capture( + new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("x")), 4); - @Test - public void testUpdatingElectionTermCallsDataPersistence() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testUpdatingElectionTermCallsDataPersistence"; + verify(leaderActor.snapshotCohortDelegate).createSnapshot(any(), any()); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + assertEquals(8, leaderActor.getReplicatedLog().size()); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + //fake snapshot on index 5 + leaderActor.handleCommand(new AppendEntriesReply(follower1Id, 1, true, 5, 1, (short)0)); - CountDownLatch persistLatch = new CountDownLatch(1); - DataPersistenceProviderMonitor dataPersistenceProviderMonitor = new DataPersistenceProviderMonitor(); - dataPersistenceProviderMonitor.setPersistLatch(persistLatch); + assertEquals(8, leaderActor.getReplicatedLog().size()); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProviderMonitor), persistenceId); + //fake snapshot on index 6 + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + leaderActor.handleCommand(new AppendEntriesReply(follower1Id, 1, true, 6, 1, (short)0)); + assertEquals(8, leaderActor.getReplicatedLog().size()); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); - mockRaftActor.getRaftActorContext().getTermInformation().updateAndPersist(10, "foobar"); + assertEquals(8, leaderActor.getReplicatedLog().size()); - assertEquals("Persist called", true, persistLatch.await(5, TimeUnit.SECONDS)); + MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList( + new MockRaftActorContext.MockPayload("foo-0"), + new MockRaftActorContext.MockPayload("foo-1"), + new MockRaftActorContext.MockPayload("foo-2"), + new MockRaftActorContext.MockPayload("foo-3"), + new MockRaftActorContext.MockPayload("foo-4"))); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + leaderActor.getRaftActorContext().getSnapshotManager().persist(snapshotState, java.util.Optional.empty(), + Runtime.getRuntime().totalMemory()); - } - }; + assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing()); + + // The commit is needed to complete the snapshot creation process + leaderActor.getRaftActorContext().getSnapshotManager().commit(-1, -1); + + // capture snapshot reply should remove the snapshotted entries only + assertEquals(3, leaderActor.getReplicatedLog().size()); + assertEquals(7, leaderActor.getReplicatedLog().lastIndex()); + + // add another non-replicated entry + leaderActor.getReplicatedLog().append( + new SimpleReplicatedLogEntry(8, 1, new MockRaftActorContext.MockPayload("foo-8"))); + + //fake snapshot on index 7, since lastApplied = 7 , we would keep the last applied + leaderActor.handleCommand(new AppendEntriesReply(follower1Id, 1, true, 7, 1, (short)0)); + assertEquals(2, leaderActor.getReplicatedLog().size()); + assertEquals(8, leaderActor.getReplicatedLog().lastIndex()); } @Test - public void testAddingReplicatedLogEntryCallsDataPersistence() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testAddingReplicatedLogEntryCallsDataPersistence"; + public void testFakeSnapshotsForFollowerWithInRealSnapshots() throws Exception { + final String persistenceId = factory.generateActorId("follower-"); + final String leaderId = factory.generateActorId("leader-"); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + ActorRef leaderActor1 = factory.createActor(MessageCollectorActor.props()); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); - DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProvider), persistenceId); + Map peerAddresses = new HashMap<>(); + peerAddresses.put(leaderId, leaderActor1.path().toString()); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + TestActorRef mockActorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId); - MockRaftActorContext.MockReplicatedLogEntry logEntry = new MockRaftActorContext.MockReplicatedLogEntry(10, 10, mock(Payload.class)); + MockRaftActor followerActor = mockActorRef.underlyingActor(); + followerActor.getRaftActorContext().setCommitIndex(4); + followerActor.getRaftActorContext().setLastApplied(4); + followerActor.getRaftActorContext().getTermInformation().update(1, persistenceId); - mockRaftActor.getRaftActorContext().getReplicatedLog().appendAndPersist(logEntry); + followerActor.waitForInitializeBehaviorComplete(); - verify(dataPersistenceProvider).persist(eq(logEntry), any(Procedure.class)); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + Follower follower = new Follower(followerActor.getRaftActorContext()); + followerActor.setCurrentBehavior(follower); + assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state()); - } - }; - } + // create 6 entries in the log - 0 to 4 are applied and will get picked up as part of the capture snapshot + MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder(); + followerActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(0, 6, 1).build()); - @Test - public void testRemovingReplicatedLogEntryCallsDataPersistence() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testRemovingReplicatedLogEntryCallsDataPersistence"; + // log has indices 0-5 + assertEquals(6, followerActor.getReplicatedLog().size()); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + //snapshot on 4 + followerActor.getRaftActorContext().getSnapshotManager().capture( + new SimpleReplicatedLogEntry(5, 1, new MockRaftActorContext.MockPayload("D")), 4); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + verify(followerActor.snapshotCohortDelegate).createSnapshot(any(), any()); - DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + assertEquals(6, followerActor.getReplicatedLog().size()); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProvider), persistenceId); + //fake snapshot on index 6 + List entries = Arrays.asList( + (ReplicatedLogEntry) new SimpleReplicatedLogEntry(6, 1, new MockRaftActorContext.MockPayload("foo-6"))); + followerActor.handleCommand(new AppendEntries(1, leaderId, 5, 1, entries, 5, 5, (short)0)); + assertEquals(7, followerActor.getReplicatedLog().size()); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + //fake snapshot on index 7 + assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state()); - mockRaftActor.getReplicatedLog().appendAndPersist(new MockRaftActorContext.MockReplicatedLogEntry(1, 0, mock(Payload.class))); + entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(7, 1, + new MockRaftActorContext.MockPayload("foo-7"))); + followerActor.handleCommand(new AppendEntries(1, leaderId, 6, 1, entries, 6, 6, (short) 0)); + assertEquals(8, followerActor.getReplicatedLog().size()); - mockRaftActor.getRaftActorContext().getReplicatedLog().removeFromAndPersist(0); + assertEquals(RaftState.Follower, followerActor.getCurrentBehavior().state()); - verify(dataPersistenceProvider, times(2)).persist(anyObject(), any(Procedure.class)); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + ByteString snapshotBytes = fromObject(Arrays.asList( + new MockRaftActorContext.MockPayload("foo-0"), + new MockRaftActorContext.MockPayload("foo-1"), + new MockRaftActorContext.MockPayload("foo-2"), + new MockRaftActorContext.MockPayload("foo-3"), + new MockRaftActorContext.MockPayload("foo-4"))); + followerActor.handleCommand(new CaptureSnapshotReply(ByteState.of(snapshotBytes.toByteArray()), + java.util.Optional.empty())); + assertTrue(followerActor.getRaftActorContext().getSnapshotManager().isCapturing()); - } - }; + // The commit is needed to complete the snapshot creation process + followerActor.getRaftActorContext().getSnapshotManager().commit(-1, -1); + + // capture snapshot reply should remove the snapshotted entries only till replicatedToAllIndex + assertEquals(3, followerActor.getReplicatedLog().size()); //indexes 5,6,7 left in the log + assertEquals(7, followerActor.getReplicatedLog().lastIndex()); + + entries = Arrays.asList((ReplicatedLogEntry) new SimpleReplicatedLogEntry(8, 1, + new MockRaftActorContext.MockPayload("foo-7"))); + // send an additional entry 8 with leaderCommit = 7 + followerActor.handleCommand(new AppendEntries(1, leaderId, 7, 1, entries, 7, 7, (short) 0)); + + // 7 and 8, as lastapplied is 7 + assertEquals(2, followerActor.getReplicatedLog().size()); } @Test - public void testApplyLogEntriesCallsDataPersistence() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testApplyLogEntriesCallsDataPersistence"; + public void testFakeSnapshotsForLeaderWithInInitiateSnapshots() throws Exception { + final String persistenceId = factory.generateActorId("leader-"); + final String follower1Id = factory.generateActorId("follower-"); + final String follower2Id = factory.generateActorId("follower-"); + + final ActorRef followerActor1 = factory.createActor(MessageCollectorActor.props(), follower1Id); + final ActorRef followerActor2 = factory.createActor(MessageCollectorActor.props(), follower2Id); + + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); + + DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + + Map peerAddresses = new HashMap<>(); + peerAddresses.put(follower1Id, followerActor1.path().toString()); + peerAddresses.put(follower2Id, followerActor2.path().toString()); + + TestActorRef mockActorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId); + + MockRaftActor leaderActor = mockActorRef.underlyingActor(); + leaderActor.getRaftActorContext().setCommitIndex(9); + leaderActor.getRaftActorContext().setLastApplied(9); + leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId); + + leaderActor.waitForInitializeBehaviorComplete(); + + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + + // create 5 entries in the log + MockRaftActorContext.MockReplicatedLogBuilder logBuilder = new MockRaftActorContext.MockReplicatedLogBuilder(); + leaderActor.getRaftActorContext().setReplicatedLog(logBuilder.createEntries(5, 10, 1).build()); + + //set the snapshot index to 4 , 0 to 4 are snapshotted + leaderActor.getRaftActorContext().getReplicatedLog().setSnapshotIndex(4); + //setting replicatedToAllIndex = 9, for the log to clear + leader.setReplicatedToAllIndex(9); + assertEquals(5, leaderActor.getReplicatedLog().size()); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + + leaderActor.handleCommand(new AppendEntriesReply(follower1Id, 1, true, 9, 1, (short) 0)); + assertEquals(5, leaderActor.getReplicatedLog().size()); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + + // set the 2nd follower nextIndex to 1 which has been snapshotted + leaderActor.handleCommand(new AppendEntriesReply(follower2Id, 1, true, 0, 1, (short)0)); + assertEquals(5, leaderActor.getReplicatedLog().size()); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + + // simulate a real snapshot + leaderActor.handleCommand(SendHeartBeat.INSTANCE); + assertEquals(5, leaderActor.getReplicatedLog().size()); + assertEquals(String.format("expected to be Leader but was %s. Current Leader = %s ", + leaderActor.getCurrentBehavior().state(), leaderActor.getLeaderId()), + RaftState.Leader, leaderActor.getCurrentBehavior().state()); + + + //reply from a slow follower does not initiate a fake snapshot + leaderActor.handleCommand(new AppendEntriesReply(follower2Id, 1, true, 9, 1, (short)0)); + assertEquals("Fake snapshot should not happen when Initiate is in progress", 5, + leaderActor.getReplicatedLog().size()); + + ByteString snapshotBytes = fromObject(Arrays.asList( + new MockRaftActorContext.MockPayload("foo-0"), + new MockRaftActorContext.MockPayload("foo-1"), + new MockRaftActorContext.MockPayload("foo-2"), + new MockRaftActorContext.MockPayload("foo-3"), + new MockRaftActorContext.MockPayload("foo-4"))); + leaderActor.handleCommand(new CaptureSnapshotReply(ByteState.of(snapshotBytes.toByteArray()), + java.util.Optional.empty())); + assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing()); + + assertEquals("Real snapshot didn't clear the log till replicatedToAllIndex", 0, + leaderActor.getReplicatedLog().size()); + + //reply from a slow follower after should not raise errors + leaderActor.handleCommand(new AppendEntriesReply(follower2Id, 1, true, 5, 1, (short) 0)); + assertEquals(0, leaderActor.getReplicatedLog().size()); + } - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + @Test + public void testRealSnapshotWhenReplicatedToAllIndexMinusOne() throws Exception { + String persistenceId = factory.generateActorId("leader-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setSnapshotBatchCount(5); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + DataPersistenceProvider dataPersistenceProvider = createProvider(); - DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + Map peerAddresses = ImmutableMap.builder().put("member1", "address").build(); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProvider), persistenceId); + TestActorRef mockActorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + MockRaftActor leaderActor = mockActorRef.underlyingActor(); + leaderActor.getRaftActorContext().setCommitIndex(3); + leaderActor.getRaftActorContext().setLastApplied(3); + leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId); - mockRaftActor.onReceiveCommand(new ApplyLogEntries(10)); + leaderActor.waitForInitializeBehaviorComplete(); + for (int i = 0; i < 4; i++) { + leaderActor.getReplicatedLog().append(new SimpleReplicatedLogEntry(i, 1, + new MockRaftActorContext.MockPayload("A"))); + } - verify(dataPersistenceProvider, times(1)).persist(anyObject(), any(Procedure.class)); + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + // Simulate an install snaphost to a follower. + leaderActor.getRaftActorContext().getSnapshotManager().captureToInstall( + leaderActor.getReplicatedLog().last(), -1, "member1"); - } - }; + // Now send a CaptureSnapshotReply + mockActorRef.tell(new CaptureSnapshotReply(ByteState.of(fromObject("foo").toByteArray()), + java.util.Optional.empty()), mockActorRef); + + // Trimming log in this scenario is a no-op + assertEquals(-1, leaderActor.getReplicatedLog().getSnapshotIndex()); + assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing()); + assertEquals(-1, leader.getReplicatedToAllIndex()); + } + + @Test + public void testRealSnapshotWhenReplicatedToAllIndexNotInReplicatedLog() throws Exception { + String persistenceId = factory.generateActorId("leader-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setSnapshotBatchCount(5); + + DataPersistenceProvider dataPersistenceProvider = createProvider(); + + Map peerAddresses = ImmutableMap.builder().put("member1", "address").build(); + + TestActorRef mockActorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId); + + MockRaftActor leaderActor = mockActorRef.underlyingActor(); + leaderActor.getRaftActorContext().setCommitIndex(3); + leaderActor.getRaftActorContext().setLastApplied(3); + leaderActor.getRaftActorContext().getTermInformation().update(1, persistenceId); + leaderActor.getReplicatedLog().setSnapshotIndex(3); + + leaderActor.waitForInitializeBehaviorComplete(); + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); + leader.setReplicatedToAllIndex(3); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + + // Persist another entry (this will cause a CaptureSnapshot to be triggered + leaderActor.persistData(mockActorRef, new MockIdentifier("x"), + new MockRaftActorContext.MockPayload("duh"), false); + + // Now send a CaptureSnapshotReply + mockActorRef.tell(new CaptureSnapshotReply(ByteState.of(fromObject("foo").toByteArray()), + java.util.Optional.empty()), mockActorRef); + + // Trimming log in this scenario is a no-op + assertEquals(3, leaderActor.getReplicatedLog().getSnapshotIndex()); + assertTrue(leaderActor.getRaftActorContext().getSnapshotManager().isCapturing()); + assertEquals(3, leader.getReplicatedToAllIndex()); + } + + private static DataPersistenceProvider createProvider() { + return new NonPersistentDataProvider(Runnable::run); } @Test - public void testCaptureSnapshotReplyCallsDataPersistence() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testCaptureSnapshotReplyCallsDataPersistence"; + public void testSwitchBehavior() { + String persistenceId = factory.generateActorId("leader-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName()); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setSnapshotBatchCount(5); + + DataPersistenceProvider dataPersistenceProvider = createProvider(); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + Map peerAddresses = ImmutableMap.builder().build(); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + TestActorRef mockActorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, config, dataPersistenceProvider), persistenceId); - DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + MockRaftActor leaderActor = mockActorRef.underlyingActor(); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), - MockRaftActor.props(persistenceId,Collections.EMPTY_MAP, - Optional.of(config), dataPersistenceProvider), persistenceId); + leaderActor.waitForRecoveryComplete(); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + leaderActor.handleCommand(new SwitchBehavior(RaftState.Follower, 100)); - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); + assertEquals(100, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm()); + assertEquals(RaftState.Follower, leaderActor.getCurrentBehavior().state()); - mockRaftActor.onReceiveCommand(new CaptureSnapshot(-1,1,-1,1)); + leaderActor.handleCommand(new SwitchBehavior(RaftState.Leader, 110)); - RaftActorContext raftActorContext = mockRaftActor.getRaftActorContext(); + assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm()); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); - mockRaftActor.setCurrentBehavior(new Leader(raftActorContext)); + leaderActor.handleCommand(new SwitchBehavior(RaftState.Candidate, 125)); - mockRaftActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes)); + assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm()); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); - verify(dataPersistenceProvider).saveSnapshot(anyObject()); + leaderActor.handleCommand(new SwitchBehavior(RaftState.IsolatedLeader, 125)); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + assertEquals(110, leaderActor.getRaftActorContext().getTermInformation().getCurrentTerm()); + assertEquals(RaftState.Leader, leaderActor.getCurrentBehavior().state()); + } + public static ByteString fromObject(final Object snapshot) throws Exception { + ByteArrayOutputStream bos = null; + ObjectOutputStream os = null; + try { + bos = new ByteArrayOutputStream(); + os = new ObjectOutputStream(bos); + os.writeObject(snapshot); + byte[] snapshotBytes = bos.toByteArray(); + return ByteString.copyFrom(snapshotBytes); + } finally { + if (os != null) { + os.flush(); + os.close(); } - }; + if (bos != null) { + bos.close(); + } + } + } + + @Test + public void testUpdateConfigParam() { + DefaultConfigParamsImpl emptyConfig = new DefaultConfigParamsImpl(); + String persistenceId = factory.generateActorId("follower-"); + ImmutableMap peerAddresses = + ImmutableMap.builder().put("member1", "address").build(); + DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + + TestActorRef actorRef = factory.createTestActor( + MockRaftActor.props(persistenceId, peerAddresses, emptyConfig, dataPersistenceProvider), persistenceId); + MockRaftActor mockRaftActor = actorRef.underlyingActor(); + mockRaftActor.waitForInitializeBehaviorComplete(); + + RaftActorBehavior behavior = mockRaftActor.getCurrentBehavior(); + mockRaftActor.updateConfigParams(emptyConfig); + assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior()); + assertEquals("Behavior State", RaftState.Follower, + mockRaftActor.getCurrentBehavior().state()); + + DefaultConfigParamsImpl disableConfig = new DefaultConfigParamsImpl(); + disableConfig.setCustomRaftPolicyImplementationClass( + "org.opendaylight.controller.cluster.raft.policy.DisableElectionsRaftPolicy"); + mockRaftActor.updateConfigParams(disableConfig); + assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior()); + assertEquals("Behavior State", RaftState.Follower, + mockRaftActor.getCurrentBehavior().state()); + + behavior = mockRaftActor.getCurrentBehavior(); + mockRaftActor.updateConfigParams(disableConfig); + assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior()); + assertEquals("Behavior State", RaftState.Follower, + mockRaftActor.getCurrentBehavior().state()); + + DefaultConfigParamsImpl defaultConfig = new DefaultConfigParamsImpl(); + defaultConfig.setCustomRaftPolicyImplementationClass( + "org.opendaylight.controller.cluster.raft.policy.DefaultRaftPolicy"); + mockRaftActor.updateConfigParams(defaultConfig); + assertNotSame("Different Behavior", behavior, mockRaftActor.getCurrentBehavior()); + assertEquals("Behavior State", RaftState.Follower, + mockRaftActor.getCurrentBehavior().state()); + + behavior = mockRaftActor.getCurrentBehavior(); + mockRaftActor.updateConfigParams(defaultConfig); + assertSame("Same Behavior", behavior, mockRaftActor.getCurrentBehavior()); + assertEquals("Behavior State", RaftState.Follower, + mockRaftActor.getCurrentBehavior().state()); } @Test - public void testSaveSnapshotSuccessCallsDataPersistence() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testSaveSnapshotSuccessCallsDataPersistence"; + public void testGetSnapshot() { + TEST_LOG.info("testGetSnapshot starting"); + + final TestKit kit = new TestKit(getSystem()); + + String persistenceId = factory.generateActorId("test-actor-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName()); + + long term = 3; + long seqN = 1; + InMemoryJournal.addEntry(persistenceId, seqN++, new UpdateElectionTerm(term, "member-1")); + InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(0, term, + new MockRaftActorContext.MockPayload("A"))); + InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(1, term, + new MockRaftActorContext.MockPayload("B"))); + InMemoryJournal.addEntry(persistenceId, seqN++, new ApplyJournalEntries(1)); + InMemoryJournal.addEntry(persistenceId, seqN++, new SimpleReplicatedLogEntry(2, term, + new MockRaftActorContext.MockPayload("C"))); + + TestActorRef raftActorRef = factory.createTestActor(MockRaftActor.props(persistenceId, + ImmutableMap.builder().put("member1", "address").build(), config) + .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + MockRaftActor mockRaftActor = raftActorRef.underlyingActor(); + + mockRaftActor.waitForRecoveryComplete(); + + mockRaftActor.snapshotCohortDelegate = mock(RaftActorSnapshotCohort.class); + + raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef()); + + ArgumentCaptor replyActor = ArgumentCaptor.forClass(ActorRef.class); + verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).createSnapshot(replyActor.capture(), + eq(java.util.Optional.empty())); + + byte[] stateSnapshot = new byte[]{1,2,3}; + replyActor.getValue().tell(new CaptureSnapshotReply(ByteState.of(stateSnapshot), java.util.Optional.empty()), + ActorRef.noSender()); + + GetSnapshotReply reply = kit.expectMsgClass(GetSnapshotReply.class); + + assertEquals("getId", persistenceId, reply.getId()); + Snapshot replySnapshot = reply.getSnapshot(); + assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm()); + assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor()); + assertEquals("getLastAppliedIndex", 1L, replySnapshot.getLastAppliedIndex()); + assertEquals("getLastAppliedTerm", term, replySnapshot.getLastAppliedTerm()); + assertEquals("getLastIndex", 2L, replySnapshot.getLastIndex()); + assertEquals("getLastTerm", term, replySnapshot.getLastTerm()); + assertEquals("getState", ByteState.of(stateSnapshot), replySnapshot.getState()); + assertEquals("getUnAppliedEntries size", 1, replySnapshot.getUnAppliedEntries().size()); + assertEquals("UnApplied entry index ", 2L, replySnapshot.getUnAppliedEntries().get(0).getIndex()); + + // Test with timeout + + mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout( + FiniteDuration.create(200, TimeUnit.MILLISECONDS)); + reset(mockRaftActor.snapshotCohortDelegate); + + raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef()); + Failure failure = kit.expectMsgClass(akka.actor.Status.Failure.class); + assertEquals("Failure cause type", TimeoutException.class, failure.cause().getClass()); + + mockRaftActor.getSnapshotMessageSupport().setSnapshotReplyActorTimeout( + FiniteDuration.create(30, TimeUnit.SECONDS)); + + // Test with persistence disabled. + + mockRaftActor.setPersistence(false); + reset(mockRaftActor.snapshotCohortDelegate); + + raftActorRef.tell(GetSnapshot.INSTANCE, kit.getRef()); + reply = kit.expectMsgClass(GetSnapshotReply.class); + verify(mockRaftActor.snapshotCohortDelegate, never()).createSnapshot(any(), any()); + + assertEquals("getId", persistenceId, reply.getId()); + replySnapshot = reply.getSnapshot(); + assertEquals("getElectionTerm", term, replySnapshot.getElectionTerm()); + assertEquals("getElectionVotedFor", "member-1", replySnapshot.getElectionVotedFor()); + assertEquals("getLastAppliedIndex", -1L, replySnapshot.getLastAppliedIndex()); + assertEquals("getLastAppliedTerm", -1L, replySnapshot.getLastAppliedTerm()); + assertEquals("getLastIndex", -1L, replySnapshot.getLastIndex()); + assertEquals("getLastTerm", -1L, replySnapshot.getLastTerm()); + assertEquals("getState type", EmptyState.INSTANCE, replySnapshot.getState()); + assertEquals("getUnAppliedEntries size", 0, replySnapshot.getUnAppliedEntries().size()); + + TEST_LOG.info("testGetSnapshot ending"); + } - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + @Test + public void testRestoreFromSnapshot() { + TEST_LOG.info("testRestoreFromSnapshot starting"); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + String persistenceId = factory.generateActorId("test-actor-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName()); - DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + List snapshotUnappliedEntries = new ArrayList<>(); + snapshotUnappliedEntries.add(new SimpleReplicatedLogEntry(4, 1, new MockRaftActorContext.MockPayload("E"))); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProvider), persistenceId); + int snapshotLastApplied = 3; + int snapshotLastIndex = 4; - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + MockSnapshotState snapshotState = new MockSnapshotState(Arrays.asList( + new MockRaftActorContext.MockPayload("A"), + new MockRaftActorContext.MockPayload("B"), + new MockRaftActorContext.MockPayload("C"), + new MockRaftActorContext.MockPayload("D"))); - mockRaftActor.getReplicatedLog().append(new MockRaftActorContext.MockReplicatedLogEntry(1,0, mock(Payload.class))); - mockRaftActor.getReplicatedLog().append(new MockRaftActorContext.MockReplicatedLogEntry(1,1, mock(Payload.class))); - mockRaftActor.getReplicatedLog().append(new MockRaftActorContext.MockReplicatedLogEntry(1,2, mock(Payload.class))); - mockRaftActor.getReplicatedLog().append(new MockRaftActorContext.MockReplicatedLogEntry(1,3, mock(Payload.class))); - mockRaftActor.getReplicatedLog().append(new MockRaftActorContext.MockReplicatedLogEntry(1,4, mock(Payload.class))); + Snapshot snapshot = Snapshot.create(snapshotState, snapshotUnappliedEntries, + snapshotLastIndex, 1, snapshotLastApplied, 1, 1, "member-1", null); - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); + InMemorySnapshotStore.addSnapshotSavedLatch(persistenceId); - RaftActorContext raftActorContext = mockRaftActor.getRaftActorContext(); - mockRaftActor.setCurrentBehavior(new Follower(raftActorContext)); + TestActorRef raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId) + .config(config).restoreFromSnapshot(snapshot).props() + .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + MockRaftActor mockRaftActor = raftActorRef.underlyingActor(); - mockRaftActor.onReceiveCommand(new CaptureSnapshot(-1, 1, 2, 1)); + mockRaftActor.waitForRecoveryComplete(); - verify(mockRaftActor.delegate).createSnapshot(); + Snapshot savedSnapshot = InMemorySnapshotStore.waitForSavedSnapshot(persistenceId, Snapshot.class); + assertEquals("getElectionTerm", snapshot.getElectionTerm(), savedSnapshot.getElectionTerm()); + assertEquals("getElectionVotedFor", snapshot.getElectionVotedFor(), savedSnapshot.getElectionVotedFor()); + assertEquals("getLastAppliedIndex", snapshot.getLastAppliedIndex(), savedSnapshot.getLastAppliedIndex()); + assertEquals("getLastAppliedTerm", snapshot.getLastAppliedTerm(), savedSnapshot.getLastAppliedTerm()); + assertEquals("getLastIndex", snapshot.getLastIndex(), savedSnapshot.getLastIndex()); + assertEquals("getLastTerm", snapshot.getLastTerm(), savedSnapshot.getLastTerm()); + assertEquals("getState", snapshot.getState(), savedSnapshot.getState()); + assertEquals("getUnAppliedEntries", snapshot.getUnAppliedEntries(), savedSnapshot.getUnAppliedEntries()); - mockRaftActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes)); + verify(mockRaftActor.snapshotCohortDelegate, timeout(5000)).applySnapshot(any(Snapshot.State.class)); - mockRaftActor.onReceiveCommand(new SaveSnapshotSuccess(new SnapshotMetadata("foo", 100, 100))); + RaftActorContext context = mockRaftActor.getRaftActorContext(); + assertEquals("Journal log size", 1, context.getReplicatedLog().size()); + assertEquals("Last index", snapshotLastIndex, context.getReplicatedLog().lastIndex()); + assertEquals("Last applied", snapshotLastApplied, context.getLastApplied()); + assertEquals("Commit index", snapshotLastApplied, context.getCommitIndex()); + assertEquals("Recovered state", snapshotState.getState(), mockRaftActor.getState()); + assertEquals("Current term", 1L, context.getTermInformation().getCurrentTerm()); + assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor()); - verify(dataPersistenceProvider).deleteSnapshots(any(SnapshotSelectionCriteria.class)); + // Test with data persistence disabled - verify(dataPersistenceProvider).deleteMessages(100); + snapshot = Snapshot.create(EmptyState.INSTANCE, Collections.emptyList(), + -1, -1, -1, -1, 5, "member-1", null); - assertEquals(2, mockRaftActor.getReplicatedLog().size()); + persistenceId = factory.generateActorId("test-actor-"); - assertNotNull(mockRaftActor.getReplicatedLog().get(3)); - assertNotNull(mockRaftActor.getReplicatedLog().get(4)); + raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId) + .config(config).restoreFromSnapshot(snapshot) + .persistent(Optional.of(Boolean.FALSE)).props() + .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + mockRaftActor = raftActorRef.underlyingActor(); - // Index 2 will not be in the log because it was removed due to snapshotting - assertNull(mockRaftActor.getReplicatedLog().get(2)); + mockRaftActor.waitForRecoveryComplete(); + assertEquals("snapshot committed", true, + Uninterruptibles.awaitUninterruptibly(mockRaftActor.snapshotCommitted, 5, TimeUnit.SECONDS)); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + context = mockRaftActor.getRaftActorContext(); + assertEquals("Current term", 5L, context.getTermInformation().getCurrentTerm()); + assertEquals("Voted for", "member-1", context.getTermInformation().getVotedFor()); - } - }; + TEST_LOG.info("testRestoreFromSnapshot ending"); } @Test - public void testApplyState() throws Exception { + public void testRestoreFromSnapshotWithRecoveredData() throws Exception { + TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData starting"); - new JavaTestKit(getSystem()) { - { - String persistenceId = "testApplyState"; + String persistenceId = factory.generateActorId("test-actor-"); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName()); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + List state = Arrays.asList(new MockRaftActorContext.MockPayload("A")); + Snapshot snapshot = Snapshot.create(ByteState.of(fromObject(state).toByteArray()), + Arrays.asList(), 5, 2, 5, 2, 2, "member-1", null); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1, + new MockRaftActorContext.MockPayload("B"))); - DataPersistenceProvider dataPersistenceProvider = mock(DataPersistenceProvider.class); + TestActorRef raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId) + .config(config).restoreFromSnapshot(snapshot).props() + .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + MockRaftActor mockRaftActor = raftActorRef.underlyingActor(); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProvider), persistenceId); + mockRaftActor.waitForRecoveryComplete(); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + Uninterruptibles.sleepUninterruptibly(500, TimeUnit.MILLISECONDS); + verify(mockRaftActor.snapshotCohortDelegate, never()).applySnapshot(any(Snapshot.State.class)); - ReplicatedLogEntry entry = new MockRaftActorContext.MockReplicatedLogEntry(1, 5, - new MockRaftActorContext.MockPayload("F")); + RaftActorContext context = mockRaftActor.getRaftActorContext(); + assertEquals("Journal log size", 1, context.getReplicatedLog().size()); + assertEquals("Last index", 0, context.getReplicatedLog().lastIndex()); + assertEquals("Last applied", -1, context.getLastApplied()); + assertEquals("Commit index", -1, context.getCommitIndex()); + assertEquals("Current term", 0, context.getTermInformation().getCurrentTerm()); + assertEquals("Voted for", null, context.getTermInformation().getVotedFor()); - mockRaftActor.onReceiveCommand(new ApplyState(mockActorRef, "apply-state", entry)); + TEST_LOG.info("testRestoreFromSnapshotWithRecoveredData ending"); + } - verify(mockRaftActor.delegate).applyState(eq(mockActorRef), eq("apply-state"), anyObject()); + @Test + public void testNonVotingOnRecovery() { + TEST_LOG.info("testNonVotingOnRecovery starting"); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setElectionTimeoutFactor(1); + config.setHeartBeatInterval(FiniteDuration.create(1, TimeUnit.MILLISECONDS)); - } - }; + String persistenceId = factory.generateActorId("test-actor-"); + InMemoryJournal.addEntry(persistenceId, 1, new SimpleReplicatedLogEntry(0, 1, + new ServerConfigurationPayload(Arrays.asList(new ServerInfo(persistenceId, false))))); + + TestActorRef raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId) + .config(config).props().withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + MockRaftActor mockRaftActor = raftActorRef.underlyingActor(); + + mockRaftActor.waitForInitializeBehaviorComplete(); + + // Sleep a bit and verify it didn't get an election timeout and schedule an election. + + Uninterruptibles.sleepUninterruptibly(400, TimeUnit.MILLISECONDS); + assertEquals("getRaftState", RaftState.Follower, mockRaftActor.getRaftState()); + + TEST_LOG.info("testNonVotingOnRecovery ending"); } @Test - public void testApplySnapshot() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testApplySnapshot"; + public void testLeaderTransitioning() { + TEST_LOG.info("testLeaderTransitioning starting"); + + ActorRef notifierActor = factory.createActor(MessageCollectorActor.props()); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName()); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + String persistenceId = factory.generateActorId("test-actor-"); - DataPersistenceProviderMonitor dataPersistenceProviderMonitor = new DataPersistenceProviderMonitor(); + TestActorRef raftActorRef = factory.createTestActor(MockRaftActor.builder().id(persistenceId) + .config(config).roleChangeNotifier(notifierActor).props() + .withDispatcher(Dispatchers.DefaultDispatcherId()), persistenceId); + MockRaftActor mockRaftActor = raftActorRef.underlyingActor(); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProviderMonitor), persistenceId); + mockRaftActor.waitForInitializeBehaviorComplete(); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + raftActorRef.tell(new AppendEntries(1L, "leader", 0L, 1L, Collections.emptyList(), + 0L, -1L, (short)1), ActorRef.noSender()); + LeaderStateChanged leaderStateChange = MessageCollectorActor.expectFirstMatching( + notifierActor, LeaderStateChanged.class); + assertEquals("getLeaderId", "leader", leaderStateChange.getLeaderId()); - ReplicatedLog oldReplicatedLog = mockRaftActor.getReplicatedLog(); + MessageCollectorActor.clearMessages(notifierActor); - oldReplicatedLog.append(new MockRaftActorContext.MockReplicatedLogEntry(1,0,mock(Payload.class))); - oldReplicatedLog.append(new MockRaftActorContext.MockReplicatedLogEntry(1,1,mock(Payload.class))); - oldReplicatedLog.append( - new MockRaftActorContext.MockReplicatedLogEntry(1, 2, - mock(Payload.class))); + raftActorRef.tell(new LeaderTransitioning("leader"), ActorRef.noSender()); - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); + leaderStateChange = MessageCollectorActor.expectFirstMatching(notifierActor, LeaderStateChanged.class); + assertEquals("getMemberId", persistenceId, leaderStateChange.getMemberId()); + assertEquals("getLeaderId", null, leaderStateChange.getLeaderId()); - Snapshot snapshot = mock(Snapshot.class); + TEST_LOG.info("testLeaderTransitioning ending"); + } - doReturn(snapshotBytes.toByteArray()).when(snapshot).getState(); + @SuppressWarnings({ "unchecked", "rawtypes" }) + @Test + public void testReplicateWithPersistencePending() throws Exception { + final String leaderId = factory.generateActorId("leader-"); + final String followerId = factory.generateActorId("follower-"); - doReturn(3L).when(snapshot).getLastAppliedIndex(); + final ActorRef followerActor = factory.createActor(MessageCollectorActor.props()); - mockRaftActor.onReceiveCommand(new ApplySnapshot(snapshot)); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); - verify(mockRaftActor.delegate).applySnapshot(eq(snapshotBytes)); + DataPersistenceProvider mockPersistenceProvider = mock(DataPersistenceProvider.class); + doReturn(true).when(mockPersistenceProvider).isRecoveryApplicable(); - assertTrue("The replicatedLog should have changed", - oldReplicatedLog != mockRaftActor.getReplicatedLog()); + TestActorRef leaderActorRef = factory.createTestActor( + MockRaftActor.props(leaderId, ImmutableMap.of(followerId, followerActor.path().toString()), config, + mockPersistenceProvider), leaderId); + MockRaftActor leaderActor = leaderActorRef.underlyingActor(); + leaderActor.waitForInitializeBehaviorComplete(); - assertEquals("lastApplied should be same as in the snapshot", - (Long) 3L, mockRaftActor.getLastApplied()); + leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId); - assertEquals(0, mockRaftActor.getReplicatedLog().size()); + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + leaderActor.persistData(leaderActorRef, new MockIdentifier("1"), new MockRaftActorContext.MockPayload("1"), + false); - } - }; + ReplicatedLogEntry logEntry = leaderActor.getReplicatedLog().get(0); + assertNotNull("ReplicatedLogEntry not found", logEntry); + assertEquals("isPersistencePending", true, logEntry.isPersistencePending()); + assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex()); + + leaderActor.handleCommand(new AppendEntriesReply(followerId, 1, true, 0, 1, (short)0)); + assertEquals("getCommitIndex", -1, leaderActor.getRaftActorContext().getCommitIndex()); + + ArgumentCaptor callbackCaptor = ArgumentCaptor.forClass(Procedure.class); + verify(mockPersistenceProvider).persistAsync(eq(logEntry), callbackCaptor.capture()); + + callbackCaptor.getValue().apply(logEntry); + + assertEquals("getCommitIndex", 0, leaderActor.getRaftActorContext().getCommitIndex()); + assertEquals("getLastApplied", 0, leaderActor.getRaftActorContext().getLastApplied()); } @Test - public void testSaveSnapshotFailure() throws Exception { - new JavaTestKit(getSystem()) { - { - String persistenceId = "testSaveSnapshotFailure"; + public void testReplicateWithBatchHint() throws Exception { + final String leaderId = factory.generateActorId("leader-"); + final String followerId = factory.generateActorId("follower-"); - DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + final ActorRef followerActor = factory.createActor(MessageCollectorActor.props()); - config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setHeartBeatInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); - DataPersistenceProviderMonitor dataPersistenceProviderMonitor = new DataPersistenceProviderMonitor(); + TestActorRef leaderActorRef = factory.createTestActor( + MockRaftActor.props(leaderId, ImmutableMap.of(followerId, followerActor.path().toString()), config), + leaderId); + MockRaftActor leaderActor = leaderActorRef.underlyingActor(); + leaderActor.waitForInitializeBehaviorComplete(); - TestActorRef mockActorRef = TestActorRef.create(getSystem(), MockRaftActor.props(persistenceId, - Collections.EMPTY_MAP, Optional.of(config), dataPersistenceProviderMonitor), persistenceId); + leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId); - MockRaftActor mockRaftActor = mockActorRef.underlyingActor(); + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); - ByteString snapshotBytes = fromObject(Arrays.asList( - new MockRaftActorContext.MockPayload("A"), - new MockRaftActorContext.MockPayload("B"), - new MockRaftActorContext.MockPayload("C"), - new MockRaftActorContext.MockPayload("D"))); + MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class); + MessageCollectorActor.clearMessages(followerActor); - RaftActorContext raftActorContext = mockRaftActor.getRaftActorContext(); + leaderActor.handleCommand(new AppendEntriesReply(followerId, 1, true, -1, -1, (short)0)); - mockRaftActor.setCurrentBehavior(new Leader(raftActorContext)); + leaderActor.persistData(leaderActorRef, new MockIdentifier("1"), new MockPayload("1"), true); + MessageCollectorActor.assertNoneMatching(followerActor, AppendEntries.class, 500); - mockRaftActor.onReceiveCommand(new CaptureSnapshot(-1,1,-1,1)); + leaderActor.persistData(leaderActorRef, new MockIdentifier("2"), new MockPayload("2"), true); + MessageCollectorActor.assertNoneMatching(followerActor, AppendEntries.class, 500); - mockRaftActor.onReceiveCommand(new CaptureSnapshotReply(snapshotBytes)); + leaderActor.persistData(leaderActorRef, new MockIdentifier("3"), new MockPayload("3"), false); + AppendEntries appendEntries = MessageCollectorActor.expectFirstMatching(followerActor, AppendEntries.class); + assertEquals("AppendEntries size", 3, appendEntries.getEntries().size()); + } - mockRaftActor.onReceiveCommand(new SaveSnapshotFailure(new SnapshotMetadata("foobar", 10L, 1234L), - new Exception())); + @Test + @SuppressWarnings("checkstyle:illegalcatch") + public void testApplyStateRace() throws Exception { + final String leaderId = factory.generateActorId("leader-"); + final String followerId = factory.generateActorId("follower-"); - assertEquals("Snapshot index should not have advanced because save snapshot failed", -1, - mockRaftActor.getReplicatedLog().getSnapshotIndex()); + DefaultConfigParamsImpl config = new DefaultConfigParamsImpl(); + config.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS)); + config.setCustomRaftPolicyImplementationClass(DisableElectionsRaftPolicy.class.getName()); - mockActorRef.tell(PoisonPill.getInstance(), getRef()); + ActorRef mockFollowerActorRef = factory.createActor(MessageCollectorActor.props()); - } - }; - } + TestRaftActor.Builder builder = TestRaftActor.newBuilder() + .id(leaderId) + .peerAddresses(ImmutableMap.of(followerId, + mockFollowerActorRef.path().toString())) + .config(config) + .collectorActor(factory.createActor( + MessageCollectorActor.props(), factory.generateActorId(leaderId + "-collector"))); - private ByteString fromObject(Object snapshot) throws Exception { - ByteArrayOutputStream b = null; - ObjectOutputStream o = null; - try { - b = new ByteArrayOutputStream(); - o = new ObjectOutputStream(b); - o.writeObject(snapshot); - byte[] snapshotBytes = b.toByteArray(); - return ByteString.copyFrom(snapshotBytes); - } finally { - if (o != null) { - o.flush(); - o.close(); - } - if (b != null) { - b.close(); + TestActorRef leaderActorRef = factory.createTestActor( + builder.props(), leaderId); + MockRaftActor leaderActor = leaderActorRef.underlyingActor(); + leaderActor.waitForInitializeBehaviorComplete(); + + leaderActor.getRaftActorContext().getTermInformation().update(1, leaderId); + Leader leader = new Leader(leaderActor.getRaftActorContext()); + leaderActor.setCurrentBehavior(leader); + + final ExecutorService executorService = Executors.newSingleThreadExecutor(); + + leaderActor.setPersistence(new PersistentDataProvider(leaderActor) { + @Override + public void persistAsync(final T entry, final Procedure procedure) { + // needs to be executed from another thread to simulate the persistence actor calling this callback + executorService.submit(() -> { + try { + procedure.apply(entry); + } catch (Exception e) { + TEST_LOG.info("Fail during async persist callback", e); + } + }, "persistence-callback"); } + }); + + leader.getFollower(followerId).setNextIndex(0); + leader.getFollower(followerId).setMatchIndex(-1); + + // hitting this is flimsy so run multiple times to improve the chance of things + // blowing up while breaking actor containment + final TestPersist message = + new TestPersist(leaderActorRef, new MockIdentifier("1"), new MockPayload("1")); + for (int i = 0; i < 100; i++) { + leaderActorRef.tell(message, null); + + AppendEntriesReply reply = + new AppendEntriesReply(followerId, 1, true, i, 1, (short) 5); + leaderActorRef.tell(reply, mockFollowerActorRef); } + + await("Persistence callback.").atMost(5, TimeUnit.SECONDS).until(() -> leaderActor.getState().size() == 100); + executorService.shutdown(); } }