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.TestActorFactory;
31 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
32 import org.opendaylight.controller.cluster.raft.messages.AppendEntriesReply;
33 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36 import scala.concurrent.duration.FiniteDuration;
39 * Abstract base for a leader election scenario test.
41 * @author Thomas Pantelis
43 public class AbstractLeaderElectionScenarioTest {
44 static final int HEARTBEAT_INTERVAL = 50;
46 static class MemberActor extends MessageCollectorActor {
48 volatile RaftActorBehavior behavior;
49 Map<Class<?>, CountDownLatch> messagesReceivedLatches = new ConcurrentHashMap<>();
50 Map<Class<?>, Boolean> dropMessagesToBehavior = new ConcurrentHashMap<>();
51 CountDownLatch behaviorStateChangeLatch;
53 public static Props props() {
54 return Props.create(MemberActor.class).withDispatcher(Dispatchers.DefaultDispatcherId());
58 public void onReceive(Object message) throws Exception {
59 // Ignore scheduled SendHeartBeat messages.
60 if(message instanceof SendHeartBeat) {
65 if(behavior != null && !dropMessagesToBehavior.containsKey(message.getClass())) {
66 RaftActorBehavior oldBehavior = behavior;
67 behavior = behavior.handleMessage(getSender(), message);
68 if(behavior != oldBehavior && behaviorStateChangeLatch != null) {
69 behaviorStateChangeLatch.countDown();
73 super.onReceive(message);
75 CountDownLatch latch = messagesReceivedLatches.get(message.getClass());
82 void expectBehaviorStateChange() {
83 behaviorStateChangeLatch = new CountDownLatch(1);
86 void waitForBehaviorStateChange() {
87 assertTrue("Expected behavior state change",
88 Uninterruptibles.awaitUninterruptibly(behaviorStateChangeLatch, 5, TimeUnit.SECONDS));
91 void expectMessageClass(Class<?> expClass, int expCount) {
92 messagesReceivedLatches.put(expClass, new CountDownLatch(expCount));
95 void waitForExpectedMessages(Class<?> expClass) {
96 CountDownLatch latch = messagesReceivedLatches.get(expClass);
97 assertNotNull("No messages received for " + expClass, latch);
98 assertTrue("Missing messages of type " + expClass,
99 Uninterruptibles.awaitUninterruptibly(latch, 5, TimeUnit.SECONDS));
102 void dropMessagesToBehavior(Class<?> msgClass) {
103 dropMessagesToBehavior(msgClass, 1);
106 void dropMessagesToBehavior(Class<?> msgClass, int expCount) {
107 expectMessageClass(msgClass, expCount);
108 dropMessagesToBehavior.put(msgClass, Boolean.TRUE);
111 void clearDropMessagesToBehavior() {
112 dropMessagesToBehavior.clear();
116 public void clear() {
117 behaviorStateChangeLatch = null;
118 clearDropMessagesToBehavior();
119 messagesReceivedLatches.clear();
123 void forwardCapturedMessageToBehavior(Class<?> msgClass, ActorRef sender) throws Exception {
124 Object message = getFirstMatching(getSelf(), msgClass);
125 assertNotNull("Message of type " + msgClass + " not received", message);
126 getSelf().tell(message, sender);
129 void forwardCapturedMessagesToBehavior(Class<?> msgClass, ActorRef sender) throws Exception {
130 for(Object m: getAllMatching(getSelf(), msgClass)) {
131 getSelf().tell(m, sender);
135 <T> T getCapturedMessage(Class<T> msgClass) throws Exception {
136 T message = getFirstMatching(getSelf(), msgClass);
137 assertNotNull("Message of type " + msgClass + " not received", message);
142 protected final Logger testLog = LoggerFactory.getLogger(MockRaftActorContext.class);
143 protected final ActorSystem system = ActorSystem.create("test");
144 protected final TestActorFactory factory = new TestActorFactory(system);
145 protected TestActorRef<MemberActor> member1ActorRef;
146 protected TestActorRef<MemberActor> member2ActorRef;
147 protected TestActorRef<MemberActor> member3ActorRef;
148 protected MemberActor member1Actor;
149 protected MemberActor member2Actor;
150 protected MemberActor member3Actor;
151 protected MockRaftActorContext member1Context;
152 protected MockRaftActorContext member2Context;
153 protected MockRaftActorContext member3Context;
156 public void setup() throws Exception {
157 member1ActorRef = newMemberActor("member1");
158 member2ActorRef = newMemberActor("member2");
159 member3ActorRef = newMemberActor("member3");
161 member1Actor = member1ActorRef.underlyingActor();
162 member2Actor = member2ActorRef.underlyingActor();
163 member3Actor = member3ActorRef.underlyingActor();
167 public void tearDown() throws Exception {
169 if (member1Actor.behavior != null) {
170 member1Actor.behavior.close();
172 if (member2Actor.behavior != null) {
173 member2Actor.behavior.close();
175 if (member3Actor.behavior != null) {
176 member3Actor.behavior.close();
179 JavaTestKit.shutdownActorSystem(system);
182 DefaultConfigParamsImpl newConfigParams() {
183 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
184 configParams.setHeartBeatInterval(new FiniteDuration(HEARTBEAT_INTERVAL, TimeUnit.MILLISECONDS));
185 configParams.setElectionTimeoutFactor(100000);
186 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
190 MockRaftActorContext newRaftActorContext(String id, ActorRef actor,
191 Map<String, String> peerAddresses) {
192 MockRaftActorContext context = new MockRaftActorContext(id, system, actor);
193 context.setPeerAddresses(peerAddresses);
194 context.getTermInformation().updateAndPersist(1, "");
198 void verifyBehaviorState(String name, MemberActor actor, RaftState expState) {
199 assertEquals(name + " behavior state", expState, actor.behavior.state());
202 void initializeLeaderBehavior(MemberActor actor, RaftActorContext context, int numActiveFollowers) throws Exception {
203 // Leader sends immediate heartbeats - we don't care about it so ignore it.
205 actor.expectMessageClass(AppendEntriesReply.class, numActiveFollowers);
207 @SuppressWarnings("resource")
208 Leader leader = new Leader(context);
209 actor.waitForExpectedMessages(AppendEntriesReply.class);
210 // Delay assignment here so the AppendEntriesReply isn't forwarded to the behavior.
211 actor.behavior = leader;
213 actor.forwardCapturedMessagesToBehavior(AppendEntriesReply.class, ActorRef.noSender());
218 TestActorRef<MemberActor> newMemberActor(String name) throws Exception {
219 TestActorRef<MemberActor> actor = factory.createTestActor(MemberActor.props().
220 withDispatcher(Dispatchers.DefaultDispatcherId()), name);
221 MessageCollectorActor.waitUntilReady(actor);
225 void sendHeartbeat(TestActorRef<MemberActor> leaderActor) {
226 Uninterruptibles.sleepUninterruptibly(HEARTBEAT_INTERVAL, TimeUnit.MILLISECONDS);
227 leaderActor.underlyingActor().behavior.handleMessage(leaderActor, SendHeartBeat.INSTANCE);