1 package org.opendaylight.controller.cluster.raft.behaviors;
3 import static org.junit.Assert.assertEquals;
4 import static org.junit.Assert.assertTrue;
5 import akka.actor.ActorRef;
6 import akka.actor.Props;
7 import akka.testkit.JavaTestKit;
8 import java.util.ArrayList;
10 import org.junit.Test;
11 import org.opendaylight.controller.cluster.raft.AbstractActorTest;
12 import org.opendaylight.controller.cluster.raft.MockRaftActorContext;
13 import org.opendaylight.controller.cluster.raft.RaftActorContext;
14 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
15 import org.opendaylight.controller.cluster.raft.SerializationUtils;
16 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
17 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
18 import org.opendaylight.controller.cluster.raft.messages.RaftRPC;
19 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
20 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
21 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
22 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
24 public abstract class AbstractRaftActorBehaviorTest extends AbstractActorTest {
26 private final ActorRef behaviorActor = getSystem().actorOf(Props.create(
27 DoNothingActor.class));
30 * This test checks that when a new Raft RPC message is received with a newer
31 * term the RaftActor gets into the Follower state.
36 public void testHandleRaftRPCWithNewerTerm() throws Exception {
37 new JavaTestKit(getSystem()) {{
39 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(getTestActor(),
40 createAppendEntriesWithNewerTerm());
42 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(getTestActor(),
43 createAppendEntriesReplyWithNewerTerm());
45 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(getTestActor(),
46 createRequestVoteWithNewerTerm());
48 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(getTestActor(),
49 createRequestVoteReplyWithNewerTerm());
57 * This test verifies that when an AppendEntries is received with a term that
58 * is less that the currentTerm of the RaftActor then the RaftActor does not
59 * change it's state and it responds back with a failure
64 public void testHandleAppendEntriesSenderTermLessThanReceiverTerm()
66 new JavaTestKit(getSystem()) {{
68 MockRaftActorContext context = (MockRaftActorContext)
71 // First set the receivers term to a high number (1000)
72 context.getTermInformation().update(1000, "test");
74 AppendEntries appendEntries =
75 new AppendEntries(100, "leader-1", 0, 0, null, 101, -1);
77 RaftActorBehavior behavior = createBehavior(context);
79 // Send an unknown message so that the state of the RaftActor remains unchanged
80 RaftActorBehavior expected = behavior.handleMessage(getRef(), "unknown");
82 RaftActorBehavior raftBehavior =
83 behavior.handleMessage(getRef(), appendEntries);
85 assertEquals(expected, raftBehavior);
87 // Also expect an AppendEntriesReply to be sent where success is false
88 final Boolean out = new ExpectMsg<Boolean>(duration("1 seconds"),
89 "AppendEntriesReply") {
90 // do not put code outside this method, will run afterwards
91 protected Boolean match(Object in) {
92 if (in instanceof AppendEntriesReply) {
93 AppendEntriesReply reply = (AppendEntriesReply) in;
94 return reply.isSuccess();
101 assertEquals(false, out);
109 public void testHandleAppendEntriesAddSameEntryToLog(){
110 new JavaTestKit(getSystem()) {
113 MockRaftActorContext context = (MockRaftActorContext)
114 createActorContext();
116 // First set the receivers term to lower number
117 context.getTermInformation().update(2, "test");
119 // Prepare the receivers log
120 MockRaftActorContext.SimpleReplicatedLog log =
121 new MockRaftActorContext.SimpleReplicatedLog();
123 new MockRaftActorContext.MockReplicatedLogEntry(1, 0, new MockRaftActorContext.MockPayload("zero")));
125 context.setReplicatedLog(log);
127 List<ReplicatedLogEntry> entries = new ArrayList<>();
129 new MockRaftActorContext.MockReplicatedLogEntry(1, 0, new MockRaftActorContext.MockPayload("zero")));
131 AppendEntries appendEntries =
132 new AppendEntries(2, "leader-1", -1, 1, entries, 0, -1);
134 RaftActorBehavior behavior = createBehavior(context);
136 if (AbstractRaftActorBehaviorTest.this instanceof CandidateTest) {
137 // Resetting the Candidates term to make sure it will match
138 // the term sent by AppendEntries. If this was not done then
139 // the test will fail because the Candidate will assume that
140 // the message was sent to it from a lower term peer and will
141 // thus respond with a failure
142 context.getTermInformation().update(2, "test");
145 // Send an unknown message so that the state of the RaftActor remains unchanged
146 RaftActorBehavior expected = behavior.handleMessage(getRef(), "unknown");
148 RaftActorBehavior raftBehavior =
149 behavior.handleMessage(getRef(), appendEntries);
151 assertEquals(expected, raftBehavior);
153 assertEquals(1, log.size());
160 * This test verifies that when a RequestVote is received by the RaftActor
161 * with a term which is greater than the RaftActors' currentTerm and the
162 * senders' log is more upto date than the receiver that the receiver grants
163 * the vote to the sender
166 public void testHandleRequestVoteWhenSenderTermGreaterThanCurrentTermAndSenderLogMoreUpToDate() {
167 new JavaTestKit(getSystem()) {{
169 new Within(duration("1 seconds")) {
170 protected void run() {
172 RaftActorBehavior behavior = createBehavior(
173 createActorContext(behaviorActor));
175 RaftActorBehavior raftBehavior = behavior.handleMessage(getTestActor(),
176 new RequestVote(1000, "test", 10000, 999));
178 if(!(behavior instanceof Follower)){
179 assertTrue(raftBehavior instanceof Follower);
183 new ExpectMsg<Boolean>(duration("1 seconds"),
184 "RequestVoteReply") {
185 // do not put code outside this method, will run afterwards
186 protected Boolean match(Object in) {
187 if (in instanceof RequestVoteReply) {
188 RequestVoteReply reply =
189 (RequestVoteReply) in;
190 return reply.isVoteGranted();
197 assertEquals(true, out);
205 * This test verifies that when a RaftActor receives a RequestVote message
206 * with a term that is greater than it's currentTerm but a less up-to-date
207 * log then the receiving RaftActor will not grant the vote to the sender
210 public void testHandleRequestVoteWhenSenderTermGreaterThanCurrentTermButSenderLogLessUptoDate() {
211 new JavaTestKit(getSystem()) {{
213 new Within(duration("1 seconds")) {
214 protected void run() {
216 RaftActorContext actorContext =
217 createActorContext(behaviorActor);
219 MockRaftActorContext.SimpleReplicatedLog
220 log = new MockRaftActorContext.SimpleReplicatedLog();
222 new MockRaftActorContext.MockReplicatedLogEntry(20000,
223 1000000, new MockRaftActorContext.MockPayload("")));
225 ((MockRaftActorContext) actorContext).setReplicatedLog(log);
227 RaftActorBehavior behavior = createBehavior(actorContext);
229 RaftActorBehavior raftBehavior = behavior.handleMessage(getTestActor(),
230 new RequestVote(1000, "test", 10000, 999));
232 if(!(behavior instanceof Follower)){
233 assertTrue(raftBehavior instanceof Follower);
236 new ExpectMsg<Boolean>(duration("1 seconds"),
237 "RequestVoteReply") {
238 // do not put code outside this method, will run afterwards
239 protected Boolean match(Object in) {
240 if (in instanceof RequestVoteReply) {
241 RequestVoteReply reply =
242 (RequestVoteReply) in;
243 return reply.isVoteGranted();
250 assertEquals(false, out);
260 * This test verifies that the receiving RaftActor will not grant a vote
261 * to a sender if the sender's term is lesser than the currentTerm of the
262 * recipient RaftActor
265 public void testHandleRequestVoteWhenSenderTermLessThanCurrentTerm() {
266 new JavaTestKit(getSystem()) {{
268 new Within(duration("1 seconds")) {
269 protected void run() {
271 RaftActorContext context =
272 createActorContext(behaviorActor);
274 context.getTermInformation().update(1000, null);
276 RaftActorBehavior follower = createBehavior(context);
278 follower.handleMessage(getTestActor(),
279 new RequestVote(999, "test", 10000, 999));
282 new ExpectMsg<Boolean>(duration("1 seconds"),
283 "RequestVoteReply") {
284 // do not put code outside this method, will run afterwards
285 protected Boolean match(Object in) {
286 if (in instanceof RequestVoteReply) {
287 RequestVoteReply reply =
288 (RequestVoteReply) in;
289 return reply.isVoteGranted();
296 assertEquals(false, out);
303 public void testPerformSnapshot() {
304 MockRaftActorContext context = new MockRaftActorContext("test", getSystem(), behaviorActor);
305 AbstractRaftActorBehavior abstractBehavior = (AbstractRaftActorBehavior) createBehavior(context);
306 if (abstractBehavior instanceof Candidate) {
310 context.getTermInformation().update(1, "test");
312 //log has 1 entry with replicatedToAllIndex = 0, does not do anything, returns the
313 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 1, 1).build());
314 context.setLastApplied(0);
315 abstractBehavior.performSnapshotWithoutCapture(0);
316 assertEquals(-1, abstractBehavior.getReplicatedToAllIndex());
317 assertEquals(1, context.getReplicatedLog().size());
319 //2 entries, lastApplied still 0, no purging.
320 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 2, 1).build());
321 context.setLastApplied(0);
322 abstractBehavior.performSnapshotWithoutCapture(0);
323 assertEquals(-1, abstractBehavior.getReplicatedToAllIndex());
324 assertEquals(2, context.getReplicatedLog().size());
326 //2 entries, lastApplied still 0, no purging.
327 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 2, 1).build());
328 context.setLastApplied(1);
329 abstractBehavior.performSnapshotWithoutCapture(0);
330 assertEquals(0, abstractBehavior.getReplicatedToAllIndex());
331 assertEquals(1, context.getReplicatedLog().size());
333 //5 entries, lastApplied =2 and replicatedIndex = 3, but since we want to keep the lastapplied, indices 0 and 1 will only get purged
334 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 5, 1).build());
335 context.setLastApplied(2);
336 abstractBehavior.performSnapshotWithoutCapture(3);
337 assertEquals(1, abstractBehavior.getReplicatedToAllIndex());
338 assertEquals(3, context.getReplicatedLog().size());
340 // scenario where Last applied > Replicated to all index (becoz of a slow follower)
341 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
342 context.setLastApplied(2);
343 abstractBehavior.performSnapshotWithoutCapture(1);
344 assertEquals(1, abstractBehavior.getReplicatedToAllIndex());
345 assertEquals(1, context.getReplicatedLog().size());
349 protected void assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(
350 ActorRef actorRef, RaftRPC rpc) {
352 RaftActorContext actorContext = createActorContext();
353 Payload p = new MockRaftActorContext.MockPayload("");
355 (MockRaftActorContext) actorContext, 0, 0, p);
357 RaftActorBehavior raftBehavior = createBehavior(actorContext)
358 .handleMessage(actorRef, rpc);
360 assertTrue(raftBehavior instanceof Follower);
363 protected MockRaftActorContext.SimpleReplicatedLog setLastLogEntry(
364 MockRaftActorContext actorContext, long term, long index, Payload data) {
365 return setLastLogEntry(actorContext,
366 new MockRaftActorContext.MockReplicatedLogEntry(term, index, data));
369 protected MockRaftActorContext.SimpleReplicatedLog setLastLogEntry(
370 MockRaftActorContext actorContext, ReplicatedLogEntry logEntry) {
371 MockRaftActorContext.SimpleReplicatedLog
372 log = new MockRaftActorContext.SimpleReplicatedLog();
373 log.append(logEntry);
374 actorContext.setReplicatedLog(log);
379 protected abstract RaftActorBehavior createBehavior(
380 RaftActorContext actorContext);
382 protected RaftActorBehavior createBehavior() {
383 return createBehavior(createActorContext());
386 protected RaftActorContext createActorContext() {
387 return new MockRaftActorContext();
390 protected RaftActorContext createActorContext(ActorRef actor) {
391 return new MockRaftActorContext("test", getSystem(), actor);
394 protected AppendEntries createAppendEntriesWithNewerTerm() {
395 return new AppendEntries(100, "leader-1", 0, 0, null, 1, -1);
398 protected AppendEntriesReply createAppendEntriesReplyWithNewerTerm() {
399 return new AppendEntriesReply("follower-1", 100, false, 100, 100);
402 protected RequestVote createRequestVoteWithNewerTerm() {
403 return new RequestVote(100, "candidate-1", 10, 100);
406 protected RequestVoteReply createRequestVoteReplyWithNewerTerm() {
407 return new RequestVoteReply(100, false);
410 protected Object fromSerializableMessage(Object serializable){
411 return SerializationUtils.fromSerializable(serializable);