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;
13 import akka.actor.ActorRef;
14 import akka.actor.ActorSystem;
15 import akka.actor.Props;
16 import akka.dispatch.Dispatchers;
17 import akka.testkit.JavaTestKit;
18 import akka.testkit.TestActorRef;
19 import com.google.common.util.concurrent.Uninterruptibles;
21 import java.util.concurrent.ConcurrentHashMap;
22 import java.util.concurrent.CountDownLatch;
23 import java.util.concurrent.TimeUnit;
24 import org.junit.After;
25 import org.junit.Before;
26 import org.opendaylight.controller.cluster.raft.DefaultConfigParamsImpl;
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.base.messages.SendHeartBeat;
31 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
32 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
35 import scala.concurrent.duration.FiniteDuration;
38 * Abstract base for a leader election scenario test.
40 * @author Thomas Pantelis
42 public class AbstractLeaderElectionScenarioTest {
43 static final int HEARTBEAT_INTERVAL = 50;
45 static class MemberActor extends MessageCollectorActor {
47 volatile RaftActorBehavior behavior;
48 Map<Class<?>, CountDownLatch> messagesReceivedLatches = new ConcurrentHashMap<>();
49 Map<Class<?>, Boolean> dropMessagesToBehavior = new ConcurrentHashMap<>();
50 CountDownLatch behaviorStateChangeLatch;
52 public static Props props() {
53 return Props.create(MemberActor.class).withDispatcher(Dispatchers.DefaultDispatcherId());
57 public void onReceive(Object message) throws Exception {
58 // Ignore scheduled SendHeartBeat messages.
59 if(message instanceof SendHeartBeat) {
64 if(behavior != null && !dropMessagesToBehavior.containsKey(message.getClass())) {
65 RaftActorBehavior oldBehavior = behavior;
66 behavior = behavior.handleMessage(getSender(), message);
67 if(behavior != oldBehavior && behaviorStateChangeLatch != null) {
68 behaviorStateChangeLatch.countDown();
72 super.onReceive(message);
74 CountDownLatch latch = messagesReceivedLatches.get(message.getClass());
81 void expectBehaviorStateChange() {
82 behaviorStateChangeLatch = new CountDownLatch(1);
85 void waitForBehaviorStateChange() {
86 assertTrue("Expected behavior state change",
87 Uninterruptibles.awaitUninterruptibly(behaviorStateChangeLatch, 5, TimeUnit.SECONDS));
90 void expectMessageClass(Class<?> expClass, int expCount) {
91 messagesReceivedLatches.put(expClass, new CountDownLatch(expCount));
94 void waitForExpectedMessages(Class<?> expClass) {
95 CountDownLatch latch = messagesReceivedLatches.get(expClass);
96 assertNotNull("No messages received for " + expClass, latch);
97 assertTrue("Missing messages of type " + expClass,
98 Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS));
101 void dropMessagesToBehavior(Class<?> msgClass) {
102 dropMessagesToBehavior(msgClass, 1);
105 void dropMessagesToBehavior(Class<?> msgClass, int expCount) {
106 expectMessageClass(msgClass, expCount);
107 dropMessagesToBehavior.put(msgClass, Boolean.TRUE);
110 void clearDropMessagesToBehavior() {
111 dropMessagesToBehavior.clear();
115 public void clear() {
116 behaviorStateChangeLatch = null;
117 clearDropMessagesToBehavior();
118 messagesReceivedLatches.clear();
122 void forwardCapturedMessageToBehavior(Class<?> msgClass, ActorRef sender) throws Exception {
123 Object message = getFirstMatching(getSelf(), msgClass);
124 assertNotNull("Message of type " + msgClass + " not received", message);
125 getSelf().tell(message, sender);
128 void forwardCapturedMessagesToBehavior(Class<?> msgClass, ActorRef sender) throws Exception {
129 for(Object m: getAllMatching(getSelf(), msgClass)) {
130 getSelf().tell(m, sender);
134 <T> T getCapturedMessage(Class<T> msgClass) throws Exception {
135 Object message = getFirstMatching(getSelf(), msgClass);
136 assertNotNull("Message of type " + msgClass + " not received", message);
141 protected final Logger testLog = LoggerFactory.getLogger(MockRaftActorContext.class);
142 protected final ActorSystem system = ActorSystem.create("test");
143 protected TestActorRef<MemberActor> member1ActorRef;
144 protected TestActorRef<MemberActor> member2ActorRef;
145 protected TestActorRef<MemberActor> member3ActorRef;
146 protected MemberActor member1Actor;
147 protected MemberActor member2Actor;
148 protected MemberActor member3Actor;
149 protected MockRaftActorContext member1Context;
150 protected MockRaftActorContext member2Context;
151 protected MockRaftActorContext member3Context;
154 public void setup() throws Exception {
155 member1ActorRef = newMemberActor("member1");
156 member2ActorRef = newMemberActor("member2");
157 member3ActorRef = newMemberActor("member3");
159 member1Actor = member1ActorRef.underlyingActor();
160 member2Actor = member2ActorRef.underlyingActor();
161 member3Actor = member3ActorRef.underlyingActor();
165 public void tearDown() throws Exception {
167 if (member1Actor.behavior != null) {
168 member1Actor.behavior.close();
170 if (member2Actor.behavior != null) {
171 member2Actor.behavior.close();
173 if (member3Actor.behavior != null) {
174 member3Actor.behavior.close();
177 JavaTestKit.shutdownActorSystem(system);
180 DefaultConfigParamsImpl newConfigParams() {
181 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
182 configParams.setHeartBeatInterval(new FiniteDuration(HEARTBEAT_INTERVAL, TimeUnit.MILLISECONDS));
183 configParams.setElectionTimeoutFactor(100000);
184 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
188 MockRaftActorContext newRaftActorContext(String id, ActorRef actor,
189 Map<String, String> peerAddresses) {
190 MockRaftActorContext context = new MockRaftActorContext(id, system, actor);
191 context.setPeerAddresses(peerAddresses);
192 context.getTermInformation().updateAndPersist(1, "");
196 void verifyBehaviorState(String name, MemberActor actor, RaftState expState) {
197 assertEquals(name + " behavior state", expState, actor.behavior.state());
200 void initializeLeaderBehavior(MemberActor actor, RaftActorContext context, int numActiveFollowers) throws Exception {
201 // Leader sends immediate heartbeats - we don't care about it so ignore it.
203 actor.expectMessageClass(AppendEntriesReply.class, numActiveFollowers);
205 @SuppressWarnings("resource")
206 Leader leader = new Leader(context);
207 actor.waitForExpectedMessages(AppendEntriesReply.class);
208 // Delay assignment here so the AppendEntriesReply isn't forwarded to the behavior.
209 actor.behavior = leader;
211 actor.forwardCapturedMessagesToBehavior(AppendEntriesReply.class, ActorRef.noSender());
216 TestActorRef<MemberActor> newMemberActor(String name) throws Exception {
217 TestActorRef<MemberActor> actor = TestActorRef.create(system, MemberActor.props(), name);
218 MessageCollectorActor.waitUntilReady(actor);
222 void sendHeartbeat(TestActorRef<MemberActor> leaderActor) {
223 Uninterruptibles.sleepUninterruptibly(HEARTBEAT_INTERVAL, TimeUnit.MILLISECONDS);
224 leaderActor.underlyingActor().behavior.handleMessage(leaderActor, new SendHeartBeat());