2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.raft.behaviors;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertFalse;
13 import akka.actor.ActorRef;
14 import akka.actor.Props;
15 import akka.testkit.TestActorRef;
16 import com.google.protobuf.ByteString;
17 import java.io.ByteArrayOutputStream;
18 import java.io.IOException;
19 import java.io.ObjectOutputStream;
20 import java.util.ArrayList;
21 import java.util.List;
23 import org.junit.After;
24 import org.junit.Assert;
25 import org.junit.Test;
26 import org.opendaylight.controller.cluster.raft.AbstractActorTest;
27 import org.opendaylight.controller.cluster.raft.MockRaftActorContext;
28 import org.opendaylight.controller.cluster.raft.RaftActorContext;
29 import org.opendaylight.controller.cluster.raft.RaftState;
30 import org.opendaylight.controller.cluster.raft.ReplicatedLogEntry;
31 import org.opendaylight.controller.cluster.raft.SerializationUtils;
32 import org.opendaylight.controller.cluster.raft.TestActorFactory;
33 import org.opendaylight.controller.cluster.raft.messages.AppendEntries;
34 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
35 import org.opendaylight.controller.cluster.raft.messages.RaftRPC;
36 import org.opendaylight.controller.cluster.raft.messages.RequestVote;
37 import org.opendaylight.controller.cluster.raft.messages.RequestVoteReply;
38 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
39 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
40 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
41 import org.slf4j.LoggerFactory;
43 public abstract class AbstractRaftActorBehaviorTest extends AbstractActorTest {
45 protected final TestActorFactory actorFactory = new TestActorFactory(getSystem());
47 private final TestActorRef<MessageCollectorActor> behaviorActor = actorFactory.createTestActor(
48 Props.create(MessageCollectorActor.class), actorFactory.generateActorId("behavior"));
50 RaftActorBehavior behavior;
53 public void tearDown() throws Exception {
54 if(behavior != null) {
62 * This test checks that when a new Raft RPC message is received with a newer
63 * term the RaftActor gets into the Follower state.
68 public void testHandleRaftRPCWithNewerTerm() throws Exception {
69 RaftActorContext actorContext = createActorContext();
71 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(actorContext, behaviorActor,
72 createAppendEntriesWithNewerTerm());
74 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(actorContext, behaviorActor,
75 createAppendEntriesReplyWithNewerTerm());
77 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(actorContext, behaviorActor,
78 createRequestVoteWithNewerTerm());
80 assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(actorContext, behaviorActor,
81 createRequestVoteReplyWithNewerTerm());
86 * This test verifies that when an AppendEntries is received with a term that
87 * is less that the currentTerm of the RaftActor then the RaftActor does not
88 * change it's state and it responds back with a failure
93 public void testHandleAppendEntriesSenderTermLessThanReceiverTerm() throws Exception {
94 MockRaftActorContext context = createActorContext();
95 short payloadVersion = 5;
96 context.setPayloadVersion(payloadVersion);
98 // First set the receivers term to a high number (1000)
99 context.getTermInformation().update(1000, "test");
101 AppendEntries appendEntries = new AppendEntries(100, "leader-1", 0, 0, null, 101, -1, (short)4);
103 behavior = createBehavior(context);
105 // Send an unknown message so that the state of the RaftActor remains unchanged
106 RaftActorBehavior expected = behavior.handleMessage(behaviorActor, "unknown");
108 RaftActorBehavior raftBehavior = behavior.handleMessage(behaviorActor, appendEntries);
110 assertEquals("Raft state", expected.state(), raftBehavior.state());
112 // Also expect an AppendEntriesReply to be sent where success is false
114 AppendEntriesReply reply = MessageCollectorActor.expectFirstMatching(
115 behaviorActor, AppendEntriesReply.class);
117 assertEquals("isSuccess", false, reply.isSuccess());
118 assertEquals("getPayloadVersion", payloadVersion, reply.getPayloadVersion());
123 public void testHandleAppendEntriesAddSameEntryToLog() throws Exception {
124 MockRaftActorContext context = createActorContext();
126 context.getTermInformation().update(2, "test");
128 // Prepare the receivers log
129 MockRaftActorContext.MockPayload payload = new MockRaftActorContext.MockPayload("zero");
130 setLastLogEntry(context, 2, 0, payload);
132 List<ReplicatedLogEntry> entries = new ArrayList<>();
133 entries.add(new MockRaftActorContext.MockReplicatedLogEntry(2, 0, payload));
135 AppendEntries appendEntries = new AppendEntries(2, "leader-1", -1, -1, entries, 2, -1, (short)0);
137 behavior = createBehavior(context);
139 assertFalse("This test should be overridden when testing Candidate", behavior instanceof Candidate);
141 // Send an unknown message so that the state of the RaftActor remains unchanged
142 RaftActorBehavior expected = behavior.handleMessage(behaviorActor, "unknown");
144 RaftActorBehavior raftBehavior = behavior.handleMessage(behaviorActor, appendEntries);
146 assertEquals("Raft state", expected.state(), raftBehavior.state());
148 assertEquals("ReplicatedLog size", 1, context.getReplicatedLog().size());
150 handleAppendEntriesAddSameEntryToLogReply(behaviorActor);
153 protected void handleAppendEntriesAddSameEntryToLogReply(TestActorRef<MessageCollectorActor> replyActor)
155 AppendEntriesReply reply = MessageCollectorActor.getFirstMatching(replyActor, AppendEntriesReply.class);
156 Assert.assertNull("Expected no AppendEntriesReply", reply);
160 * This test verifies that when a RequestVote is received by the RaftActor
161 * with the senders' log is more up to date than the receiver that the receiver grants
162 * the vote to the sender.
165 public void testHandleRequestVoteWhenSenderLogMoreUpToDate() {
166 MockRaftActorContext context = createActorContext();
168 behavior = createBehavior(context);
170 context.getTermInformation().update(1, "test");
172 behavior.handleMessage(behaviorActor, new RequestVote(context.getTermInformation().getCurrentTerm(),
173 "test", 10000, 999));
175 RequestVoteReply reply = MessageCollectorActor.expectFirstMatching(behaviorActor,
176 RequestVoteReply.class);
177 assertEquals("isVoteGranted", true, reply.isVoteGranted());
181 * This test verifies that when a RaftActor receives a RequestVote message
182 * with a term that is greater than it's currentTerm but a less up-to-date
183 * log then the receiving RaftActor will not grant the vote to the sender
186 public void testHandleRequestVoteWhenSenderLogLessUptoDate() {
187 MockRaftActorContext context = createActorContext();
189 behavior = createBehavior(context);
191 context.getTermInformation().update(1, "test");
194 setLastLogEntry(context, context.getTermInformation().getCurrentTerm(), index,
195 new MockRaftActorContext.MockPayload(""));
197 behavior.handleMessage(behaviorActor, new RequestVote(
198 context.getTermInformation().getCurrentTerm(), "test",
199 index - 1, context.getTermInformation().getCurrentTerm()));
201 RequestVoteReply reply = MessageCollectorActor.expectFirstMatching(behaviorActor,
202 RequestVoteReply.class);
203 assertEquals("isVoteGranted", false, reply.isVoteGranted());
209 * This test verifies that the receiving RaftActor will not grant a vote
210 * to a sender if the sender's term is lesser than the currentTerm of the
211 * recipient RaftActor
214 public void testHandleRequestVoteWhenSenderTermLessThanCurrentTerm() {
215 RaftActorContext context = createActorContext();
217 context.getTermInformation().update(1000, null);
219 behavior = createBehavior(context);
221 behavior.handleMessage(behaviorActor, new RequestVote(999, "test", 10000, 999));
223 RequestVoteReply reply = MessageCollectorActor.expectFirstMatching(behaviorActor,
224 RequestVoteReply.class);
225 assertEquals("isVoteGranted", false, reply.isVoteGranted());
229 public void testPerformSnapshot() {
230 MockRaftActorContext context = new MockRaftActorContext("test", getSystem(), behaviorActor);
231 AbstractRaftActorBehavior abstractBehavior = (AbstractRaftActorBehavior) createBehavior(context);
232 if (abstractBehavior instanceof Candidate) {
236 context.getTermInformation().update(1, "test");
238 //log has 1 entry with replicatedToAllIndex = 0, does not do anything, returns the
239 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 1, 1).build());
240 context.setLastApplied(0);
241 abstractBehavior.performSnapshotWithoutCapture(0);
242 assertEquals(-1, abstractBehavior.getReplicatedToAllIndex());
243 assertEquals(1, context.getReplicatedLog().size());
245 //2 entries, lastApplied still 0, no purging.
246 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 2, 1).build());
247 context.setLastApplied(0);
248 abstractBehavior.performSnapshotWithoutCapture(0);
249 assertEquals(-1, abstractBehavior.getReplicatedToAllIndex());
250 assertEquals(2, context.getReplicatedLog().size());
252 //2 entries, lastApplied still 0, no purging.
253 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 2, 1).build());
254 context.setLastApplied(1);
255 abstractBehavior.performSnapshotWithoutCapture(0);
256 assertEquals(0, abstractBehavior.getReplicatedToAllIndex());
257 assertEquals(1, context.getReplicatedLog().size());
259 //5 entries, lastApplied =2 and replicatedIndex = 3, but since we want to keep the lastapplied, indices 0 and 1 will only get purged
260 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 5, 1).build());
261 context.setLastApplied(2);
262 abstractBehavior.performSnapshotWithoutCapture(3);
263 assertEquals(1, abstractBehavior.getReplicatedToAllIndex());
264 assertEquals(3, context.getReplicatedLog().size());
266 // scenario where Last applied > Replicated to all index (becoz of a slow follower)
267 context.setReplicatedLog(new MockRaftActorContext.MockReplicatedLogBuilder().createEntries(0, 3, 1).build());
268 context.setLastApplied(2);
269 abstractBehavior.performSnapshotWithoutCapture(1);
270 assertEquals(1, abstractBehavior.getReplicatedToAllIndex());
271 assertEquals(1, context.getReplicatedLog().size());
275 protected void assertStateChangesToFollowerWhenRaftRPCHasNewerTerm(RaftActorContext actorContext,
276 ActorRef actorRef, RaftRPC rpc) throws Exception {
278 Payload p = new MockRaftActorContext.MockPayload("");
279 setLastLogEntry((MockRaftActorContext) actorContext, 1, 0, p);
280 actorContext.getTermInformation().update(1, "test");
282 RaftActorBehavior origBehavior = createBehavior(actorContext);
283 RaftActorBehavior raftBehavior = origBehavior.handleMessage(actorRef, rpc);
285 assertEquals("New raft state", RaftState.Follower, raftBehavior.state());
286 assertEquals("New election term", rpc.getTerm(), actorContext.getTermInformation().getCurrentTerm());
288 origBehavior.close();
289 raftBehavior.close();
292 protected MockRaftActorContext.SimpleReplicatedLog setLastLogEntry(
293 MockRaftActorContext actorContext, long term, long index, Payload data) {
294 return setLastLogEntry(actorContext,
295 new MockRaftActorContext.MockReplicatedLogEntry(term, index, data));
298 protected MockRaftActorContext.SimpleReplicatedLog setLastLogEntry(MockRaftActorContext actorContext,
299 ReplicatedLogEntry logEntry) {
300 MockRaftActorContext.SimpleReplicatedLog log = new MockRaftActorContext.SimpleReplicatedLog();
301 log.append(logEntry);
302 actorContext.setReplicatedLog(log);
307 protected abstract RaftActorBehavior createBehavior(
308 RaftActorContext actorContext);
310 protected RaftActorBehavior createBehavior() {
311 return createBehavior(createActorContext());
314 protected MockRaftActorContext createActorContext() {
315 return new MockRaftActorContext();
318 protected MockRaftActorContext createActorContext(ActorRef actor) {
319 return new MockRaftActorContext("test", getSystem(), actor);
322 protected AppendEntries createAppendEntriesWithNewerTerm() {
323 return new AppendEntries(100, "leader-1", 0, 0, null, 1, -1, (short)0);
326 protected AppendEntriesReply createAppendEntriesReplyWithNewerTerm() {
327 return new AppendEntriesReply("follower-1", 100, false, 100, 100, (short)0);
330 protected RequestVote createRequestVoteWithNewerTerm() {
331 return new RequestVote(100, "candidate-1", 10, 100);
334 protected RequestVoteReply createRequestVoteReplyWithNewerTerm() {
335 return new RequestVoteReply(100, false);
338 protected Object fromSerializableMessage(Object serializable){
339 return SerializationUtils.fromSerializable(serializable);
342 protected ByteString toByteString(Map<String, String> state) {
343 ByteArrayOutputStream bos = new ByteArrayOutputStream();
344 try(ObjectOutputStream oos = new ObjectOutputStream(bos)) {
345 oos.writeObject(state);
346 return ByteString.copyFrom(bos.toByteArray());
347 } catch (IOException e) {
348 throw new AssertionError("IOException occurred converting Map to Bytestring", e);
352 protected void logStart(String name) {
353 LoggerFactory.getLogger(LeaderTest.class).info("Starting " + name);
356 protected RaftPolicy createRaftPolicy(final boolean automaticElectionsEnabled,
357 final boolean applyModificationToStateBeforeConsensus){
358 return new RaftPolicy() {
360 public boolean automaticElectionsEnabled() {
361 return automaticElectionsEnabled;
365 public boolean applyModificationToStateBeforeConsensus() {
366 return applyModificationToStateBeforeConsensus;