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.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import akka.actor.ActorRef;
13 import akka.actor.InvalidActorNameException;
14 import akka.actor.PoisonPill;
15 import akka.actor.Props;
16 import akka.actor.Terminated;
17 import akka.dispatch.Dispatchers;
18 import akka.testkit.JavaTestKit;
19 import akka.testkit.TestActorRef;
20 import com.google.common.base.Predicate;
21 import com.google.common.base.Supplier;
22 import com.google.common.collect.ImmutableMap;
23 import com.google.common.util.concurrent.Uninterruptibles;
24 import java.util.ArrayList;
25 import java.util.Collections;
26 import java.util.List;
28 import java.util.concurrent.ConcurrentHashMap;
29 import java.util.concurrent.TimeUnit;
30 import org.junit.After;
31 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
32 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
33 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
34 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
35 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
36 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
37 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
38 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
39 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
40 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import scala.concurrent.duration.FiniteDuration;
46 * Abstract base for an integration test that tests end-to-end RaftActor and behavior functionality.
48 * @author Thomas Pantelis
50 public abstract class AbstractRaftActorIntegrationTest extends AbstractActorTest {
52 public static class SetPeerAddress {
53 private final String peerId;
54 private final String peerAddress;
56 public SetPeerAddress(String peerId, String peerAddress) {
58 this.peerAddress = peerAddress;
61 public String getPeerId() {
65 public String getPeerAddress() {
70 public static class TestRaftActor extends MockRaftActor {
72 private final TestActorRef<MessageCollectorActor> collectorActor;
73 private final Map<Class<?>, Boolean> dropMessages = new ConcurrentHashMap<>();
75 private TestRaftActor(String id, Map<String, String> peerAddresses, ConfigParams config,
76 TestActorRef<MessageCollectorActor> collectorActor) {
77 super(builder().id(id).peerAddresses(peerAddresses).config(config));
78 this.collectorActor = collectorActor;
81 public static Props props(String id, Map<String, String> peerAddresses, ConfigParams config,
82 TestActorRef<MessageCollectorActor> collectorActor) {
83 return Props.create(TestRaftActor.class, id, peerAddresses, config, collectorActor).
84 withDispatcher(Dispatchers.DefaultDispatcherId());
87 void startDropMessages(Class<?> msgClass) {
88 dropMessages.put(msgClass, Boolean.TRUE);
91 void stopDropMessages(Class<?> msgClass) {
92 dropMessages.remove(msgClass);
95 void setMockTotalMemory(final long mockTotalMemory) {
96 if(mockTotalMemory > 0) {
97 getRaftActorContext().setTotalMemoryRetriever(new Supplier<Long>() {
100 return mockTotalMemory;
105 getRaftActorContext().setTotalMemoryRetriever(null);
110 public void handleCommand(Object message) {
111 if(message instanceof MockPayload) {
112 MockPayload payload = (MockPayload)message;
113 super.persistData(collectorActor, payload.toString(), payload);
117 if(message instanceof SetPeerAddress) {
118 setPeerAddress(((SetPeerAddress) message).getPeerId().toString(),
119 ((SetPeerAddress) message).getPeerAddress());
124 if(!dropMessages.containsKey(message.getClass())) {
125 super.handleCommand(message);
128 if(!(message instanceof SendHeartBeat)) {
130 collectorActor.tell(message, ActorRef.noSender());
131 } catch (Exception e) {
132 LOG.error("MessageCollectorActor error", e);
139 public void createSnapshot(ActorRef actorRef) {
141 actorRef.tell(new CaptureSnapshotReply(RaftActorTest.fromObject(getState()).toByteArray()), actorRef);
142 } catch (Exception e) {
147 public ActorRef collectorActor() {
148 return collectorActor;
152 protected final Logger testLog = LoggerFactory.getLogger(getClass());
154 protected final TestActorFactory factory = new TestActorFactory(getSystem());
156 protected String leaderId = factory.generateActorId("leader");
157 protected DefaultConfigParamsImpl leaderConfigParams;
158 protected TestActorRef<TestRaftActor> leaderActor;
159 protected ActorRef leaderCollectorActor;
160 protected RaftActorContext leaderContext;
161 protected RaftActorBehavior leader;
163 protected String follower1Id = factory.generateActorId("follower");
164 protected TestActorRef<TestRaftActor> follower1Actor;
165 protected ActorRef follower1CollectorActor;
166 protected RaftActorBehavior follower1;
167 protected RaftActorContext follower1Context;
169 protected String follower2Id = factory.generateActorId("follower");
170 protected TestActorRef<TestRaftActor> follower2Actor;
171 protected ActorRef follower2CollectorActor;
172 protected RaftActorBehavior follower2;
173 protected RaftActorContext follower2Context;
175 protected ImmutableMap<String, String> peerAddresses;
177 protected long initialTerm = 5;
178 protected long currentTerm;
180 protected int snapshotBatchCount = 4;
182 protected List<MockPayload> expSnapshotState = new ArrayList<>();
185 public void tearDown() {
186 InMemoryJournal.clear();
187 InMemorySnapshotStore.clear();
191 protected DefaultConfigParamsImpl newLeaderConfigParams() {
192 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
193 configParams.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
194 configParams.setElectionTimeoutFactor(1);
195 configParams.setSnapshotBatchCount(snapshotBatchCount);
196 configParams.setSnapshotDataThresholdPercentage(70);
197 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
201 protected DefaultConfigParamsImpl newFollowerConfigParams() {
202 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
203 configParams.setHeartBeatInterval(new FiniteDuration(500, TimeUnit.MILLISECONDS));
204 configParams.setElectionTimeoutFactor(1000);
208 protected void waitUntilLeader(ActorRef actorRef) {
209 RaftActorTestKit.waitUntilLeader(actorRef);
212 protected TestActorRef<TestRaftActor> newTestRaftActor(String id, Map<String, String> peerAddresses,
213 ConfigParams configParams) {
214 TestActorRef<MessageCollectorActor> collectorActor = factory.createTestActor(
215 MessageCollectorActor.props().withDispatcher(Dispatchers.DefaultDispatcherId()),
216 factory.generateActorId(id + "-collector"));
218 InvalidActorNameException lastEx = null;
219 for(int i = 0; i < 10; i++) {
221 return factory.createTestActor(TestRaftActor.props(id,
222 peerAddresses != null ? peerAddresses : Collections.<String, String>emptyMap(),
223 configParams, collectorActor), id);
224 } catch (InvalidActorNameException e) {
226 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
230 assertNotNull(lastEx);
234 protected void killActor(TestActorRef<TestRaftActor> leaderActor) {
235 JavaTestKit testkit = new JavaTestKit(getSystem());
236 testkit.watch(leaderActor);
238 leaderActor.tell(PoisonPill.getInstance(), null);
239 testkit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
241 testkit.unwatch(leaderActor);
244 protected void verifyApplyJournalEntries(ActorRef actor, final long expIndex) {
245 MessageCollectorActor.expectFirstMatching(actor, ApplyJournalEntries.class, new Predicate<ApplyJournalEntries>() {
247 public boolean apply(ApplyJournalEntries msg) {
248 return msg.getToIndex() == expIndex;
253 @SuppressWarnings("unchecked")
254 protected void verifySnapshot(String prefix, Snapshot snapshot, long lastAppliedTerm,
255 long lastAppliedIndex, long lastTerm, long lastIndex)
257 assertEquals(prefix + " Snapshot getLastAppliedTerm", lastAppliedTerm, snapshot.getLastAppliedTerm());
258 assertEquals(prefix + " Snapshot getLastAppliedIndex", lastAppliedIndex, snapshot.getLastAppliedIndex());
259 assertEquals(prefix + " Snapshot getLastTerm", lastTerm, snapshot.getLastTerm());
260 assertEquals(prefix + " Snapshot getLastIndex", lastIndex, snapshot.getLastIndex());
262 List<Object> actualState = (List<Object>)MockRaftActor.toObject(snapshot.getState());
263 assertEquals(String.format("%s Snapshot getState size. Expected %s: . Actual: %s", prefix, expSnapshotState,
264 actualState), expSnapshotState.size(), actualState.size());
265 for(int i = 0; i < expSnapshotState.size(); i++) {
266 assertEquals(prefix + " Snapshot state " + i, expSnapshotState.get(i), actualState.get(i));
270 protected void verifyPersistedJournal(String persistenceId, List<? extends ReplicatedLogEntry> expJournal) {
271 List<ReplicatedLogEntry> journal = InMemoryJournal.get(persistenceId, ReplicatedLogEntry.class);
272 assertEquals("Journal ReplicatedLogEntry count", expJournal.size(), journal.size());
273 for(int i = 0; i < expJournal.size(); i++) {
274 ReplicatedLogEntry expected = expJournal.get(i);
275 ReplicatedLogEntry actual = journal.get(i);
276 verifyReplicatedLogEntry(expected, actual.getTerm(), actual.getIndex(), actual.getData());
280 protected MockPayload sendPayloadData(ActorRef leaderActor, String data) {
281 return sendPayloadData(leaderActor, data, 0);
284 protected MockPayload sendPayloadData(ActorRef leaderActor, String data, int size) {
287 payload = new MockPayload(data, size);
289 payload = new MockPayload(data);
292 leaderActor.tell(payload, ActorRef.noSender());
296 protected void verifyApplyState(ApplyState applyState, ActorRef expClientActor,
297 String expId, long expTerm, long expIndex, MockPayload payload) {
298 assertEquals("ApplyState getClientActor", expClientActor, applyState.getClientActor());
299 assertEquals("ApplyState getIdentifier", expId, applyState.getIdentifier());
300 ReplicatedLogEntry replicatedLogEntry = applyState.getReplicatedLogEntry();
301 verifyReplicatedLogEntry(replicatedLogEntry, expTerm, expIndex, payload);
304 protected void verifyReplicatedLogEntry(ReplicatedLogEntry replicatedLogEntry, long expTerm, long expIndex,
306 assertEquals("ReplicatedLogEntry getTerm", expTerm, replicatedLogEntry.getTerm());
307 assertEquals("ReplicatedLogEntry getIndex", expIndex, replicatedLogEntry.getIndex());
308 assertEquals("ReplicatedLogEntry getData", payload, replicatedLogEntry.getData());
311 protected String testActorPath(String id){
312 return "akka://test/user" + id;
315 protected void verifyLeadersTrimmedLog(long lastIndex) {
316 verifyTrimmedLog("Leader", leaderActor, lastIndex, lastIndex - 1);
319 protected void verifyLeadersTrimmedLog(long lastIndex, long replicatedToAllIndex) {
320 verifyTrimmedLog("Leader", leaderActor, lastIndex, replicatedToAllIndex);
323 protected void verifyFollowersTrimmedLog(int num, TestActorRef<TestRaftActor> actorRef, long lastIndex) {
324 verifyTrimmedLog("Follower " + num, actorRef, lastIndex, lastIndex - 1);
327 protected void verifyTrimmedLog(String name, TestActorRef<TestRaftActor> actorRef, long lastIndex,
328 long replicatedToAllIndex) {
329 TestRaftActor actor = actorRef.underlyingActor();
330 RaftActorContext context = actor.getRaftActorContext();
331 long snapshotIndex = lastIndex - 1;
332 assertEquals(name + " snapshot term", snapshotIndex < 0 ? -1 : currentTerm,
333 context.getReplicatedLog().getSnapshotTerm());
334 assertEquals(name + " snapshot index", snapshotIndex, context.getReplicatedLog().getSnapshotIndex());
335 assertEquals(name + " journal log size", 1, context.getReplicatedLog().size());
336 assertEquals(name + " journal last index", lastIndex, context.getReplicatedLog().lastIndex());
337 assertEquals(name + " commit index", lastIndex, context.getCommitIndex());
338 assertEquals(name + " last applied", lastIndex, context.getLastApplied());
339 assertEquals(name + " replicatedToAllIndex", replicatedToAllIndex,
340 actor.getCurrentBehavior().getReplicatedToAllIndex());