2 * Copyright (c) 2015 Brocade Communications 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 static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.assertTrue;
14 import akka.actor.ActorRef;
15 import akka.actor.ActorSystem;
16 import akka.actor.Props;
17 import akka.actor.Status;
18 import akka.dispatch.ControlMessage;
19 import akka.dispatch.Dispatchers;
20 import akka.dispatch.Mailboxes;
21 import akka.pattern.Patterns;
22 import akka.testkit.JavaTestKit;
23 import akka.testkit.TestActorRef;
24 import akka.util.Timeout;
25 import com.google.common.util.concurrent.Uninterruptibles;
27 import java.util.concurrent.ConcurrentHashMap;
28 import java.util.concurrent.CountDownLatch;
29 import java.util.concurrent.TimeUnit;
30 import java.util.concurrent.TimeoutException;
31 import org.junit.After;
32 import org.junit.Before;
33 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
34 import org.opendaylight.controller.cluster.raft.MockRaftActorContext;
35 import org.opendaylight.controller.cluster.raft.RaftState;
36 import org.opendaylight.controller.cluster.raft.TestActorFactory;
37 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
38 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
39 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import scala.concurrent.Await;
43 import scala.concurrent.duration.Duration;
44 import scala.concurrent.duration.FiniteDuration;
47 * Abstract base for a leader election scenario test.
49 * @author Thomas Pantelis
51 public class AbstractLeaderElectionScenarioTest {
52 static final int HEARTBEAT_INTERVAL = 50;
54 static class MemberActor extends MessageCollectorActor {
55 private volatile RaftActorBehavior behavior;
56 Map<Class<?>, CountDownLatch> messagesReceivedLatches = new ConcurrentHashMap<>();
57 Map<Class<?>, Boolean> dropMessagesToBehavior = new ConcurrentHashMap<>();
58 CountDownLatch behaviorStateChangeLatch;
60 public static Props props() {
61 return Props.create(MemberActor.class).withDispatcher(Dispatchers.DefaultDispatcherId())
62 .withMailbox(Mailboxes.DefaultMailboxId());
66 public void onReceive(Object message) throws Exception {
67 // Ignore scheduled SendHeartBeat messages.
68 if (message instanceof SendHeartBeat) {
72 if (message instanceof SetBehavior) {
73 behavior = ((SetBehavior)message).behavior;
74 ((SetBehavior)message).context.setCurrentBehavior(behavior);
78 if (message instanceof GetBehaviorState) {
79 if (behavior != null) {
80 getSender().tell(behavior.state(), self());
82 getSender().tell(new Status.Failure(new IllegalStateException(
83 "RaftActorBehavior is not set in MemberActor")), self());
87 if (message instanceof SendImmediateHeartBeat) {
88 message = SendHeartBeat.INSTANCE;
92 if (behavior != null && !dropMessagesToBehavior.containsKey(message.getClass())) {
93 final RaftActorBehavior nextBehavior = behavior.handleMessage(getSender(), message);
94 if (nextBehavior != null) {
95 RaftActorBehavior oldBehavior = behavior;
96 behavior = nextBehavior;
97 if (behavior != oldBehavior && behaviorStateChangeLatch != null) {
98 behaviorStateChangeLatch.countDown();
103 super.onReceive(message);
105 CountDownLatch latch = messagesReceivedLatches.get(message.getClass());
113 public void postStop() throws Exception {
116 if (behavior != null) {
121 void expectBehaviorStateChange() {
122 behaviorStateChangeLatch = new CountDownLatch(1);
125 void waitForBehaviorStateChange() {
126 assertTrue("Expected behavior state change",
127 Uninterruptibles.awaitUninterruptibly(behaviorStateChangeLatch, 5, TimeUnit.SECONDS));
130 void expectMessageClass(final Class<?> expClass, final int expCount) {
131 messagesReceivedLatches.put(expClass, new CountDownLatch(expCount));
134 void waitForExpectedMessages(final Class<?> expClass) {
135 CountDownLatch latch = messagesReceivedLatches.get(expClass);
136 assertNotNull("No messages received for " + expClass, latch);
137 assertTrue("Missing messages of type " + expClass,
138 Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS));
141 void dropMessagesToBehavior(final Class<?> msgClass) {
142 dropMessagesToBehavior(msgClass, 1);
145 void dropMessagesToBehavior(final Class<?> msgClass, final int expCount) {
146 expectMessageClass(msgClass, expCount);
147 dropMessagesToBehavior.put(msgClass, Boolean.TRUE);
150 void clearDropMessagesToBehavior() {
151 dropMessagesToBehavior.clear();
155 public void clear() {
156 behaviorStateChangeLatch = null;
157 clearDropMessagesToBehavior();
158 messagesReceivedLatches.clear();
162 void forwardCapturedMessageToBehavior(final Class<?> msgClass, final ActorRef sender) {
163 Object message = getFirstMatching(getSelf(), msgClass);
164 assertNotNull("Message of type " + msgClass + " not received", message);
165 getSelf().tell(message, sender);
168 void forwardCapturedMessagesToBehavior(final Class<?> msgClass, final ActorRef sender) {
169 for (Object m: getAllMatching(getSelf(), msgClass)) {
170 getSelf().tell(m, sender);
174 <T> T getCapturedMessage(final Class<T> msgClass) {
175 T message = getFirstMatching(getSelf(), msgClass);
176 assertNotNull("Message of type " + msgClass + " not received", message);
181 static class SendImmediateHeartBeat implements ControlMessage {
182 public static final SendImmediateHeartBeat INSTANCE = new SendImmediateHeartBeat();
184 private SendImmediateHeartBeat() {
188 static class GetBehaviorState implements ControlMessage {
189 public static final GetBehaviorState INSTANCE = new GetBehaviorState();
191 private GetBehaviorState() {
195 static class SetBehavior implements ControlMessage {
196 RaftActorBehavior behavior;
197 MockRaftActorContext context;
199 SetBehavior(final RaftActorBehavior behavior, final MockRaftActorContext context) {
200 this.behavior = behavior;
201 this.context = context;
205 protected final Logger testLog = LoggerFactory.getLogger(MockRaftActorContext.class);
206 protected final ActorSystem system = ActorSystem.create("test");
207 protected final TestActorFactory factory = new TestActorFactory(system);
208 protected TestActorRef<MemberActor> member1ActorRef;
209 protected TestActorRef<MemberActor> member2ActorRef;
210 protected TestActorRef<MemberActor> member3ActorRef;
211 protected MemberActor member1Actor;
212 protected MemberActor member2Actor;
213 protected MemberActor member3Actor;
214 protected MockRaftActorContext member1Context;
215 protected MockRaftActorContext member2Context;
216 protected MockRaftActorContext member3Context;
219 public void setup() throws Exception {
220 member1ActorRef = newMemberActor("member1");
221 member2ActorRef = newMemberActor("member2");
222 member3ActorRef = newMemberActor("member3");
224 member1Actor = member1ActorRef.underlyingActor();
225 member2Actor = member2ActorRef.underlyingActor();
226 member3Actor = member3ActorRef.underlyingActor();
230 public void tearDown() throws Exception {
231 JavaTestKit.shutdownActorSystem(system);
234 DefaultConfigParamsImpl newConfigParams() {
235 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
236 configParams.setHeartBeatInterval(new FiniteDuration(HEARTBEAT_INTERVAL, TimeUnit.MILLISECONDS));
237 configParams.setElectionTimeoutFactor(100000);
238 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
242 MockRaftActorContext newRaftActorContext(final String id, final ActorRef actor,
243 final Map<String, String> peerAddresses) {
244 MockRaftActorContext context = new MockRaftActorContext(id, system, actor);
245 context.setPeerAddresses(peerAddresses);
246 context.getTermInformation().updateAndPersist(1, "");
250 @SuppressWarnings("checkstyle:IllegalCatch")
251 void verifyBehaviorState(final String name, final MemberActor actor, final RaftState expState) {
252 RaftState actualState;
254 actualState = (RaftState) Await.result(Patterns.ask(actor.self(), GetBehaviorState.INSTANCE,
255 Timeout.apply(5, TimeUnit.SECONDS)), Duration.apply(5, TimeUnit.SECONDS));
256 } catch (RuntimeException e) {
258 } catch (Exception e) {
259 throw new RuntimeException(e);
261 assertEquals(name + " behavior state", expState, actualState);
264 void initializeLeaderBehavior(final MemberActor actor, final MockRaftActorContext context,
265 final int numActiveFollowers) {
266 // Leader sends immediate heartbeats - we don't care about it so ignore it.
267 // Sometimes the initial AppendEntries messages go to dead letters, probably b/c the follower actors
268 // haven't been fully created/initialized by akka. So we try up to 3 times to create the Leader as
271 Leader leader = null;
272 AssertionError lastAssertError = null;
273 for (int i = 1; i <= 3; i++) {
274 actor.expectMessageClass(AppendEntriesReply.class, numActiveFollowers);
276 leader = new Leader(context);
278 actor.waitForExpectedMessages(AppendEntriesReply.class);
279 lastAssertError = null;
281 } catch (AssertionError e) {
286 if (lastAssertError != null) {
287 throw lastAssertError;
290 context.setCurrentBehavior(leader);
292 // Delay assignment of the leader behavior so the AppendEntriesReply isn't forwarded to the behavior.
293 actor.self().tell(new SetBehavior(leader, context), ActorRef.noSender());
295 actor.forwardCapturedMessagesToBehavior(AppendEntriesReply.class, ActorRef.noSender());
300 TestActorRef<MemberActor> newMemberActor(final String name) throws TimeoutException, InterruptedException {
301 TestActorRef<MemberActor> actor = factory.createTestActor(MemberActor.props()
302 .withDispatcher(Dispatchers.DefaultDispatcherId()), name);
303 MessageCollectorActor.waitUntilReady(actor);
307 void sendHeartbeat(final TestActorRef<MemberActor> leaderActor) {
308 Uninterruptibles.sleepUninterruptibly(HEARTBEAT_INTERVAL, TimeUnit.MILLISECONDS);
309 leaderActor.tell(SendImmediateHeartBeat.INSTANCE, ActorRef.noSender());