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;
10 import static org.junit.Assert.assertArrayEquals;
11 import static org.junit.Assert.assertEquals;
12 import akka.actor.ActorRef;
13 import akka.actor.PoisonPill;
14 import akka.actor.Props;
15 import akka.actor.Terminated;
16 import akka.dispatch.Dispatchers;
17 import akka.testkit.JavaTestKit;
18 import akka.testkit.TestActorRef;
19 import com.google.common.base.Optional;
20 import com.google.common.base.Predicate;
21 import com.google.common.base.Supplier;
22 import com.google.common.collect.ImmutableMap;
23 import java.util.Collections;
24 import java.util.List;
26 import java.util.concurrent.ConcurrentHashMap;
27 import java.util.concurrent.TimeUnit;
28 import org.junit.After;
29 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
30 import org.opendaylight.controller.cluster.raft.RaftActorTest.MockRaftActor;
31 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
32 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
33 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
34 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
35 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
36 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
37 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
38 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
39 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import scala.concurrent.duration.FiniteDuration;
45 * Abstract base for an integration test that tests end-to-end RaftActor and behavior functionality.
47 * @author Thomas Pantelis
49 public abstract class AbstractRaftActorIntegrationTest extends AbstractActorTest {
51 public static class TestRaftActor extends MockRaftActor {
53 private final TestActorRef<MessageCollectorActor> collectorActor;
54 private final Map<Class<?>, Boolean> dropMessages = new ConcurrentHashMap<>();
55 private volatile byte[] snapshot;
57 private TestRaftActor(String id, Map<String, String> peerAddresses, ConfigParams config,
58 TestActorRef<MessageCollectorActor> collectorActor) {
59 super(id, peerAddresses, Optional.of(config), null);
60 this.collectorActor = collectorActor;
63 public static Props props(String id, Map<String, String> peerAddresses, ConfigParams config,
64 TestActorRef<MessageCollectorActor> collectorActor) {
65 return Props.create(TestRaftActor.class, id, peerAddresses, config, collectorActor).
66 withDispatcher(Dispatchers.DefaultDispatcherId());
69 void startDropMessages(Class<?> msgClass) {
70 dropMessages.put(msgClass, Boolean.TRUE);
73 void stopDropMessages(Class<?> msgClass) {
74 dropMessages.remove(msgClass);
77 void setMockTotalMemory(final long mockTotalMemory) {
78 if(mockTotalMemory > 0) {
79 getRaftActorContext().setTotalMemoryRetriever(new Supplier<Long>() {
82 return mockTotalMemory;
87 getRaftActorContext().setTotalMemoryRetriever(null);
92 public void handleCommand(Object message) {
93 if(message instanceof MockPayload) {
94 MockPayload payload = (MockPayload)message;
95 super.persistData(collectorActor, payload.toString(), payload);
100 if(!dropMessages.containsKey(message.getClass())) {
101 super.handleCommand(message);
104 if(!(message instanceof SendHeartBeat)) {
106 collectorActor.tell(message, ActorRef.noSender());
107 } catch (Exception e) {
108 LOG.error("MessageCollectorActor error", e);
115 protected void createSnapshot() {
116 if(snapshot != null) {
117 getSelf().tell(new CaptureSnapshotReply(snapshot), ActorRef.noSender());
122 public void applyRecoverySnapshot(byte[] bytes) {
125 void setSnapshot(byte[] snapshot) {
126 this.snapshot = snapshot;
129 public ActorRef collectorActor() {
130 return collectorActor;
134 protected final Logger testLog = LoggerFactory.getLogger(getClass());
136 protected final TestActorFactory factory = new TestActorFactory(getSystem());
138 protected String leaderId = factory.generateActorId("leader");
139 protected DefaultConfigParamsImpl leaderConfigParams;
140 protected TestActorRef<TestRaftActor> leaderActor;
141 protected ActorRef leaderCollectorActor;
142 protected RaftActorContext leaderContext;
143 protected RaftActorBehavior leader;
145 protected String follower1Id = factory.generateActorId("follower");
146 protected TestActorRef<TestRaftActor> follower1Actor;
147 protected ActorRef follower1CollectorActor;
148 protected RaftActorBehavior follower1;
149 protected RaftActorContext follower1Context;
151 protected String follower2Id = factory.generateActorId("follower");
152 protected TestActorRef<TestRaftActor> follower2Actor;
153 protected ActorRef follower2CollectorActor;
154 protected RaftActorBehavior follower2;
155 protected RaftActorContext follower2Context;
157 protected ImmutableMap<String, String> peerAddresses;
159 protected long initialTerm = 5;
160 protected long currentTerm;
163 public void tearDown() {
164 InMemoryJournal.clear();
165 InMemorySnapshotStore.clear();
169 protected DefaultConfigParamsImpl newLeaderConfigParams() {
170 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
171 configParams.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
172 configParams.setElectionTimeoutFactor(1);
173 configParams.setSnapshotBatchCount(4);
174 configParams.setSnapshotDataThresholdPercentage(70);
175 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
179 protected DefaultConfigParamsImpl newFollowerConfigParams() {
180 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
181 configParams.setHeartBeatInterval(new FiniteDuration(500, TimeUnit.MILLISECONDS));
182 configParams.setElectionTimeoutFactor(1000);
186 protected void waitUntilLeader(ActorRef actorRef) {
187 RaftActorTest.RaftActorTestKit.waitUntilLeader(actorRef);
190 protected TestActorRef<TestRaftActor> newTestRaftActor(String id, Map<String, String> peerAddresses,
191 ConfigParams configParams) {
192 TestActorRef<MessageCollectorActor> collectorActor = factory.createTestActor(
193 MessageCollectorActor.props().withDispatcher(Dispatchers.DefaultDispatcherId()),
194 factory.generateActorId(id + "-collector"));
195 return factory.createTestActor(TestRaftActor.props(id,
196 peerAddresses != null ? peerAddresses : Collections.<String, String>emptyMap(),
197 configParams, collectorActor), id);
200 protected void killActor(TestActorRef<TestRaftActor> leaderActor) {
201 JavaTestKit testkit = new JavaTestKit(getSystem());
202 testkit.watch(leaderActor);
204 leaderActor.tell(PoisonPill.getInstance(), null);
205 testkit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
207 testkit.unwatch(leaderActor);
210 protected void verifyApplyJournalEntries(ActorRef actor, final long expIndex) {
211 MessageCollectorActor.expectFirstMatching(actor, ApplyJournalEntries.class, new Predicate<ApplyJournalEntries>() {
213 public boolean apply(ApplyJournalEntries msg) {
214 return msg.getToIndex() == expIndex;
219 protected void verifySnapshot(String prefix, Snapshot snapshot, long lastAppliedTerm,
220 int lastAppliedIndex, long lastTerm, long lastIndex, byte[] data) {
221 assertEquals(prefix + " Snapshot getLastAppliedTerm", lastAppliedTerm, snapshot.getLastAppliedTerm());
222 assertEquals(prefix + " Snapshot getLastAppliedIndex", lastAppliedIndex, snapshot.getLastAppliedIndex());
223 assertEquals(prefix + " Snapshot getLastTerm", lastTerm, snapshot.getLastTerm());
224 assertEquals(prefix + " Snapshot getLastIndex", lastIndex, snapshot.getLastIndex());
225 assertArrayEquals(prefix + " Snapshot getState", data, snapshot.getState());
228 protected void verifyPersistedJournal(String persistenceId, List<? extends ReplicatedLogEntry> expJournal) {
229 List<ReplicatedLogEntry> journal = InMemoryJournal.get(persistenceId, ReplicatedLogEntry.class);
230 assertEquals("Journal ReplicatedLogEntry count", expJournal.size(), journal.size());
231 for(int i = 0; i < expJournal.size(); i++) {
232 ReplicatedLogEntry expected = expJournal.get(i);
233 ReplicatedLogEntry actual = journal.get(i);
234 verifyReplicatedLogEntry(expected, actual.getTerm(), actual.getIndex(), actual.getData());
238 protected MockPayload sendPayloadData(ActorRef leaderActor, String data) {
239 return sendPayloadData(leaderActor, data, 0);
242 protected MockPayload sendPayloadData(ActorRef leaderActor, String data, int size) {
245 payload = new MockPayload(data, size);
247 payload = new MockPayload(data);
250 leaderActor.tell(payload, ActorRef.noSender());
254 protected void verifyApplyState(ApplyState applyState, ActorRef expClientActor,
255 String expId, long expTerm, long expIndex, MockPayload payload) {
256 assertEquals("ApplyState getClientActor", expClientActor, applyState.getClientActor());
257 assertEquals("ApplyState getIdentifier", expId, applyState.getIdentifier());
258 ReplicatedLogEntry replicatedLogEntry = applyState.getReplicatedLogEntry();
259 verifyReplicatedLogEntry(replicatedLogEntry, expTerm, expIndex, payload);
262 protected void verifyReplicatedLogEntry(ReplicatedLogEntry replicatedLogEntry, long expTerm, long expIndex,
264 assertEquals("ReplicatedLogEntry getTerm", expTerm, replicatedLogEntry.getTerm());
265 assertEquals("ReplicatedLogEntry getIndex", expIndex, replicatedLogEntry.getIndex());
266 assertEquals("ReplicatedLogEntry getData", payload, replicatedLogEntry.getData());
269 protected String testActorPath(String id){
270 return "akka://test/user" + id;