X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fbehaviors%2FCandidateTest.java;h=88a261328ade2700077121ecfb765edfb311f2fd;hp=60f45523cf204d5d246fb14ac01eddc4dcc760ba;hb=fe8352361d49c76a0ecc80162a2b8258d35198b5;hpb=3927509ec3ecfa32a51b725d2b7155d425f5b877 diff --git a/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/behaviors/CandidateTest.java b/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/behaviors/CandidateTest.java index 60f45523cf..88a261328a 100644 --- a/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/behaviors/CandidateTest.java +++ b/opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/behaviors/CandidateTest.java @@ -1,28 +1,52 @@ +/* + * 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.behaviors; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + import akka.actor.ActorRef; import akka.actor.Props; import akka.testkit.TestActorRef; +import com.google.common.base.Stopwatch; +import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; +import java.util.List; import java.util.Map; +import java.util.concurrent.TimeUnit; import org.junit.After; import org.junit.Before; import org.junit.Test; +import org.mockito.Mockito; +import org.opendaylight.controller.cluster.NonPersistentDataProvider; +import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl; +import org.opendaylight.controller.cluster.raft.ElectionTerm; import org.opendaylight.controller.cluster.raft.MockRaftActorContext; import org.opendaylight.controller.cluster.raft.RaftActorContext; +import org.opendaylight.controller.cluster.raft.RaftActorContextImpl; import org.opendaylight.controller.cluster.raft.RaftState; import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry; +import org.opendaylight.controller.cluster.raft.VotingState; import org.opendaylight.controller.cluster.raft.base.messages.ElectionTimeout; import org.opendaylight.controller.cluster.raft.messages.AppendEntries; import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply; import org.opendaylight.controller.cluster.raft.messages.RaftRPC; import org.opendaylight.controller.cluster.raft.messages.RequestVote; import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply; +import org.opendaylight.controller.cluster.raft.persisted.SimpleReplicatedLogEntry; import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; -public class CandidateTest extends AbstractRaftActorBehaviorTest { +public class CandidateTest extends AbstractRaftActorBehaviorTest { + static final Logger LOG = LoggerFactory.getLogger(CandidateTest.class); private final TestActorRef candidateActor = actorFactory.createTestActor( Props.create(MessageCollectorActor.class), actorFactory.generateActorId("candidate")); @@ -38,7 +62,7 @@ public class CandidateTest extends AbstractRaftActorBehaviorTest { @Override @After public void tearDown() throws Exception { - if(candidate != null) { + if (candidate != null) { candidate.close(); } @@ -46,50 +70,51 @@ public class CandidateTest extends AbstractRaftActorBehaviorTest { } @Test - public void testWhenACandidateIsCreatedItIncrementsTheCurrentTermAndVotesForItself(){ + public void testWhenACandidateIsCreatedItIncrementsTheCurrentTermAndVotesForItself() { RaftActorContext raftActorContext = createActorContext(); long expectedTerm = raftActorContext.getTermInformation().getCurrentTerm(); candidate = new Candidate(raftActorContext); - assertEquals("getCurrentTerm", expectedTerm+1, raftActorContext.getTermInformation().getCurrentTerm()); + assertEquals("getCurrentTerm", expectedTerm + 1, raftActorContext.getTermInformation().getCurrentTerm()); assertEquals("getVotedFor", raftActorContext.getId(), raftActorContext.getTermInformation().getVotedFor()); } @Test - public void testThatAnElectionTimeoutIsTriggered(){ - MockRaftActorContext actorContext = createActorContext(); - candidate = new Candidate(actorContext); + public void testThatAnElectionTimeoutIsTriggered() { + MockRaftActorContext actorContext = createActorContext(); + candidate = new Candidate(actorContext); - MessageCollectorActor.expectFirstMatching(candidateActor, ElectionTimeout.class, - actorContext.getConfigParams().getElectionTimeOutInterval().$times(6).toMillis()); + MessageCollectorActor.expectFirstMatching(candidateActor, ElectionTimeout.class, + actorContext.getConfigParams().getElectionTimeOutInterval().$times(6).toMillis()); } @Test - public void testHandleElectionTimeoutWhenThereAreZeroPeers(){ + public void testHandleElectionTimeoutWhenThereAreZeroPeers() { RaftActorContext raftActorContext = createActorContext(); candidate = new Candidate(raftActorContext); RaftActorBehavior newBehavior = - candidate.handleMessage(candidateActor, new ElectionTimeout()); + candidate.handleMessage(candidateActor, ElectionTimeout.INSTANCE); assertEquals("Behavior", RaftState.Leader, newBehavior.state()); } @Test - public void testHandleElectionTimeoutWhenThereAreTwoNodeCluster(){ + public void testHandleElectionTimeoutWhenThereAreTwoNodeCluster() { MockRaftActorContext raftActorContext = createActorContext(); raftActorContext.setPeerAddresses(setupPeers(1)); candidate = new Candidate(raftActorContext); - candidate = candidate.handleMessage(candidateActor, new ElectionTimeout()); + candidate = candidate.handleMessage(candidateActor, ElectionTimeout.INSTANCE); assertEquals("Behavior", RaftState.Candidate, candidate.state()); } @Test - public void testBecomeLeaderOnReceivingMajorityVotesInThreeNodeCluster(){ + public void testBecomeLeaderOnReceivingMajorityVotesInThreeNodeCluster() { MockRaftActorContext raftActorContext = createActorContext(); + raftActorContext.setLastApplied(raftActorContext.getReplicatedLog().lastIndex()); raftActorContext.setPeerAddresses(setupPeers(2)); candidate = new Candidate(raftActorContext); @@ -99,11 +124,39 @@ public class CandidateTest extends AbstractRaftActorBehaviorTest { } @Test - public void testBecomeLeaderOnReceivingMajorityVotesInFiveNodeCluster(){ + public void testBecomePreLeaderOnReceivingMajorityVotesInThreeNodeCluster() { + MockRaftActorContext raftActorContext = createActorContext(); + raftActorContext.setLastApplied(-1); + raftActorContext.setPeerAddresses(setupPeers(2)); + candidate = new Candidate(raftActorContext); + + candidate = candidate.handleMessage(peerActors[0], new RequestVoteReply(1, true)); + + // LastApplied is -1 and behind the last index. + assertEquals("Behavior", RaftState.PreLeader, candidate.state()); + } + + @Test + public void testBecomeLeaderOnReceivingMajorityVotesInFiveNodeCluster() { MockRaftActorContext raftActorContext = createActorContext(); + raftActorContext.getTermInformation().update(2L, "other"); + raftActorContext.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder() + .createEntries(0, 5, 1).build()); + raftActorContext.setCommitIndex(raftActorContext.getReplicatedLog().lastIndex()); + raftActorContext.setLastApplied(raftActorContext.getReplicatedLog().lastIndex()); raftActorContext.setPeerAddresses(setupPeers(4)); candidate = new Candidate(raftActorContext); + RequestVote requestVote = MessageCollectorActor.expectFirstMatching(peerActors[0], RequestVote.class); + assertEquals("getTerm", 3L, requestVote.getTerm()); + assertEquals("getCandidateId", raftActorContext.getId(), requestVote.getCandidateId()); + assertEquals("getLastLogTerm", 1L, requestVote.getLastLogTerm()); + assertEquals("getLastLogIndex", 4L, requestVote.getLastLogIndex()); + + MessageCollectorActor.expectFirstMatching(peerActors[1], RequestVote.class); + MessageCollectorActor.expectFirstMatching(peerActors[2], RequestVote.class); + MessageCollectorActor.expectFirstMatching(peerActors[3], RequestVote.class); + // First peers denies the vote. candidate = candidate.handleMessage(peerActors[0], new RequestVoteReply(1, false)); @@ -118,20 +171,73 @@ public class CandidateTest extends AbstractRaftActorBehaviorTest { assertEquals("Behavior", RaftState.Leader, candidate.state()); } + @Test + public void testBecomeLeaderOnReceivingMajorityVotesWithNonVotingPeers() { + ElectionTerm mockElectionTerm = Mockito.mock(ElectionTerm.class); + Mockito.doReturn(1L).when(mockElectionTerm).getCurrentTerm(); + RaftActorContext raftActorContext = new RaftActorContextImpl(candidateActor, candidateActor.actorContext(), + "candidate", mockElectionTerm, -1, -1, setupPeers(4), new DefaultConfigParamsImpl(), + new NonPersistentDataProvider(), LOG); + raftActorContext.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().build()); + raftActorContext.getPeerInfo("peer1").setVotingState(VotingState.NON_VOTING); + raftActorContext.getPeerInfo("peer4").setVotingState(VotingState.NON_VOTING); + candidate = new Candidate(raftActorContext); + + MessageCollectorActor.expectFirstMatching(peerActors[1], RequestVote.class); + MessageCollectorActor.expectFirstMatching(peerActors[2], RequestVote.class); + MessageCollectorActor.assertNoneMatching(peerActors[0], RequestVote.class, 300); + MessageCollectorActor.assertNoneMatching(peerActors[3], RequestVote.class, 100); + + candidate = candidate.handleMessage(peerActors[1], new RequestVoteReply(1, false)); + + assertEquals("Behavior", RaftState.Candidate, candidate.state()); + + candidate = candidate.handleMessage(peerActors[2], new RequestVoteReply(1, true)); + + assertEquals("Behavior", RaftState.Leader, candidate.state()); + } + @Test public void testResponseToHandleAppendEntriesWithLowerTerm() { candidate = new Candidate(createActorContext()); setupPeers(1); - candidate.handleMessage(peerActors[0], new AppendEntries(1, "test", 0, 0, - Collections.emptyList(), 0, -1)); + RaftActorBehavior newBehavior = candidate.handleMessage(peerActors[0], new AppendEntries(1, "test", 0, 0, + Collections.emptyList(), 0, -1, (short) 0)); AppendEntriesReply reply = MessageCollectorActor.expectFirstMatching( peerActors[0], AppendEntriesReply.class); assertEquals("isSuccess", false, reply.isSuccess()); assertEquals("getTerm", 2, reply.getTerm()); + assertTrue("New Behavior : " + newBehavior, newBehavior instanceof Candidate); + } + + @Test + public void testResponseToHandleAppendEntriesWithHigherTerm() { + candidate = new Candidate(createActorContext()); + + setupPeers(1); + RaftActorBehavior newBehavior = candidate.handleMessage(peerActors[0], new AppendEntries(5, "test", 0, 0, + Collections.emptyList(), 0, -1, (short) 0)); + + assertTrue("New Behavior : " + newBehavior, newBehavior instanceof Follower); } + @Test + public void testResponseToHandleAppendEntriesWithEqualTerm() { + MockRaftActorContext actorContext = createActorContext(); + + candidate = new Candidate(actorContext); + + setupPeers(1); + RaftActorBehavior newBehavior = candidate.handleMessage(peerActors[0], new AppendEntries(2, "test", 0, 0, + Collections.emptyList(), 0, -1, (short) 0)); + + assertTrue("New Behavior : " + newBehavior + " term = " + actorContext.getTermInformation().getCurrentTerm(), + newBehavior instanceof Follower); + } + + @Test public void testResponseToRequestVoteWithLowerTerm() { candidate = new Candidate(createActorContext()); @@ -184,10 +290,60 @@ public class CandidateTest extends AbstractRaftActorBehaviorTest { assertEquals("getTerm", 1001, reply.getTerm()); } + @Test + public void testCandidateSchedulesElectionTimeoutImmediatelyWhenItHasNoPeers() { + MockRaftActorContext context = createActorContext(); + + Stopwatch stopwatch = Stopwatch.createStarted(); + + candidate = createBehavior(context); + + MessageCollectorActor.expectFirstMatching(candidateActor, ElectionTimeout.class); + + long elapsed = stopwatch.elapsed(TimeUnit.MILLISECONDS); + + assertTrue(elapsed < context.getConfigParams().getElectionTimeOutInterval().toMillis()); + } + + @Test + @Override + public void testHandleAppendEntriesAddSameEntryToLog() throws Exception { + MockRaftActorContext context = createActorContext(); + + context.getTermInformation().update(2, "test"); + + // Prepare the receivers log + MockRaftActorContext.MockPayload payload = new MockRaftActorContext.MockPayload("zero"); + setLastLogEntry(context, 2, 0, payload); + + List entries = new ArrayList<>(); + entries.add(new SimpleReplicatedLogEntry(0, 2, payload)); + + final AppendEntries appendEntries = new AppendEntries(2, "leader-1", -1, -1, entries, 2, -1, (short)0); + behavior = createBehavior(context); + + // Resetting the Candidates term to make sure it will match + // the term sent by AppendEntries. If this was not done then + // the test will fail because the Candidate will assume that + // the message was sent to it from a lower term peer and will + // thus respond with a failure + context.getTermInformation().update(2, "test"); + + // Send an unknown message so that the state of the RaftActor remains unchanged + behavior.handleMessage(candidateActor, "unknown"); + + RaftActorBehavior raftBehavior = behavior.handleMessage(candidateActor, appendEntries); + + assertEquals("Raft state", RaftState.Follower, raftBehavior.state()); + + assertEquals("ReplicatedLog size", 1, context.getReplicatedLog().size()); + + handleAppendEntriesAddSameEntryToLogReply(candidateActor); + } @Override - protected RaftActorBehavior createBehavior(RaftActorContext actorContext) { + protected Candidate createBehavior(final RaftActorContext actorContext) { return new Candidate(actorContext); } @@ -195,22 +351,28 @@ public class CandidateTest extends AbstractRaftActorBehaviorTest { return new MockRaftActorContext("candidate", getSystem(), candidateActor); } - private Map setupPeers(int count) { + @SuppressWarnings("unchecked") + private Map setupPeers(final int count) { Map peerMap = new HashMap<>(); peerActors = new TestActorRef[count]; - for(int i = 0; i < count; i++) { + for (int i = 0; i < count; i++) { peerActors[i] = actorFactory.createTestActor(Props.create(MessageCollectorActor.class), actorFactory.generateActorId("peer")); - peerMap.put("peer" + (i+1), peerActors[i].path().toString()); + peerMap.put("peer" + (i + 1), peerActors[i].path().toString()); } return peerMap; } @Override - protected void assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(RaftActorContext actorContext, - ActorRef actorRef, RaftRPC rpc) throws Exception { + protected void assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(final MockRaftActorContext actorContext, + final ActorRef actorRef, final RaftRPC rpc) throws Exception { super.assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(actorContext, actorRef, rpc); - assertEquals("New votedFor", null, actorContext.getTermInformation().getVotedFor()); + if (rpc instanceof RequestVote) { + assertEquals("New votedFor", ((RequestVote)rpc).getCandidateId(), + actorContext.getTermInformation().getVotedFor()); + } else { + assertEquals("New votedFor", null, actorContext.getTermInformation().getVotedFor()); + } } }