2 * Copyright (c) 2014 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
8 package org.opendaylight.controller.cluster.raft.behaviors;
10 import static org.junit.Assert.assertEquals;
11 import akka.actor.ActorRef;
12 import akka.actor.Props;
13 import akka.testkit.TestActorRef;
14 import java.util.HashMap;
16 import org.junit.After;
17 import org.junit.Test;
18 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
19 import org.opendaylight.controller.cluster.raft.MockRaftActorContext;
20 import org.opendaylight.controller.cluster.raft.RaftActorContext;
21 import org.opendaylight.controller.cluster.raft.RaftState;
22 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
23 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
25 public class IsolatedLeaderTest extends AbstractLeaderTest {
27 private final TestActorRef<MessageCollectorActor> leaderActor = actorFactory.createTestActor(
28 Props.create(MessageCollectorActor.class), actorFactory.generateActorId("leader"));
30 private final TestActorRef<MessageCollectorActor> senderActor = actorFactory.createTestActor(
31 Props.create(MessageCollectorActor.class), actorFactory.generateActorId("sender"));
33 private AbstractLeader isolatedLeader;
37 public void tearDown() throws Exception {
38 if(isolatedLeader != null) {
39 isolatedLeader.close();
46 protected RaftActorBehavior createBehavior(RaftActorContext actorContext) {
47 return new IsolatedLeader(actorContext);
51 protected MockRaftActorContext createActorContext() {
52 return createActorContext(leaderActor);
56 protected MockRaftActorContext createActorContext(ActorRef actor) {
57 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
58 configParams.setElectionTimeoutFactor(100000);
59 MockRaftActorContext context = new MockRaftActorContext("isolated-leader", getSystem(), actor);
60 context.setConfigParams(configParams);
65 public void testHandleMessageWithThreeMembers() throws Exception {
66 String followerAddress1 = "akka://test/user/$a";
67 String followerAddress2 = "akka://test/user/$b";
69 MockRaftActorContext leaderActorContext = createActorContext();
70 Map<String, String> peerAddresses = new HashMap<>();
71 peerAddresses.put("follower-1", followerAddress1);
72 peerAddresses.put("follower-2", followerAddress2);
73 leaderActorContext.setPeerAddresses(peerAddresses);
75 isolatedLeader = new IsolatedLeader(leaderActorContext);
76 assertEquals("Raft state", RaftState.IsolatedLeader, isolatedLeader.state());
78 // in a 3 node cluster, even if 1 follower is returns a reply, the isolatedLeader is not isolated
79 RaftActorBehavior behavior = isolatedLeader.handleMessage(senderActor,
80 new AppendEntriesReply("follower-1", isolatedLeader.lastTerm() - 1, true,
81 isolatedLeader.lastIndex() - 1, isolatedLeader.lastTerm() - 1, (short)0));
83 assertEquals("Raft state", RaftState.Leader, behavior.state());
85 isolatedLeader.close();
86 isolatedLeader = (AbstractLeader) behavior;
88 behavior = isolatedLeader.handleMessage(senderActor,
89 new AppendEntriesReply("follower-2", isolatedLeader.lastTerm() - 1, true,
90 isolatedLeader.lastIndex() -1, isolatedLeader.lastTerm() -1, (short)0 ));
92 assertEquals("Raft state", RaftState.Leader, behavior.state());
96 public void testHandleMessageWithFiveMembers() throws Exception {
97 String followerAddress1 = "akka://test/user/$a";
98 String followerAddress2 = "akka://test/user/$b";
99 String followerAddress3 = "akka://test/user/$c";
100 String followerAddress4 = "akka://test/user/$d";
102 MockRaftActorContext leaderActorContext = createActorContext();
103 Map<String, String> peerAddresses = new HashMap<>();
104 peerAddresses.put("follower-1", followerAddress1);
105 peerAddresses.put("follower-2", followerAddress2);
106 peerAddresses.put("follower-3", followerAddress3);
107 peerAddresses.put("follower-4", followerAddress4);
108 leaderActorContext.setPeerAddresses(peerAddresses);
110 isolatedLeader = new IsolatedLeader(leaderActorContext);
111 assertEquals("Raft state", RaftState.IsolatedLeader, isolatedLeader.state());
113 // in a 5 member cluster, atleast 2 followers need to be active and return a reply
114 RaftActorBehavior behavior = isolatedLeader.handleMessage(senderActor,
115 new AppendEntriesReply("follower-1", isolatedLeader.lastTerm() - 1, true,
116 isolatedLeader.lastIndex() -1, isolatedLeader.lastTerm() -1, (short)0 ));
118 assertEquals("Raft state", RaftState.IsolatedLeader, behavior.state());
120 behavior = isolatedLeader.handleMessage(senderActor,
121 new AppendEntriesReply("follower-2", isolatedLeader.lastTerm() - 1, true,
122 isolatedLeader.lastIndex() -1, isolatedLeader.lastTerm() -1, (short)0 ));
124 assertEquals("Raft state", RaftState.Leader, behavior.state());
126 isolatedLeader.close();
127 isolatedLeader = (AbstractLeader) behavior;
129 behavior = isolatedLeader.handleMessage(senderActor,
130 new AppendEntriesReply("follower-3", isolatedLeader.lastTerm() - 1, true,
131 isolatedLeader.lastIndex() -1, isolatedLeader.lastTerm() -1, (short)0 ));
133 assertEquals("Raft state", RaftState.Leader, behavior.state());
137 public void testHandleMessageFromAnotherLeader() throws Exception {
138 String followerAddress1 = "akka://test/user/$a";
139 String followerAddress2 = "akka://test/user/$b";
141 MockRaftActorContext leaderActorContext = createActorContext();
142 Map<String, String> peerAddresses = new HashMap<>();
143 peerAddresses.put("follower-1", followerAddress1);
144 peerAddresses.put("follower-2", followerAddress2);
145 leaderActorContext.setPeerAddresses(peerAddresses);
147 isolatedLeader = new IsolatedLeader(leaderActorContext);
148 assertEquals("Raft state", RaftState.IsolatedLeader, isolatedLeader.state());
150 // if an append-entries reply is received by the isolated-leader, and that reply
151 // has a term > than its own term, then IsolatedLeader switches to Follower
152 // bowing itself to another leader in the cluster
153 RaftActorBehavior behavior = isolatedLeader.handleMessage(senderActor,
154 new AppendEntriesReply("follower-1", isolatedLeader.lastTerm() + 1, true,
155 isolatedLeader.lastIndex() + 1, isolatedLeader.lastTerm() + 1, (short)0));
157 assertEquals("Raft state", RaftState.Follower, behavior.state());