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.Optional;
21 import com.google.common.base.Predicate;
22 import com.google.common.base.Supplier;
23 import com.google.common.collect.ImmutableMap;
24 import com.google.common.util.concurrent.Uninterruptibles;
25 import java.util.ArrayList;
26 import java.util.Collections;
27 import java.util.List;
29 import java.util.concurrent.ConcurrentHashMap;
30 import java.util.concurrent.TimeUnit;
31 import org.junit.After;
32 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
33 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
34 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
35 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
36 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
37 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
38 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
39 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
40 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
41 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44 import scala.concurrent.duration.FiniteDuration;
47 * Abstract base for an integration test that tests end-to-end RaftActor and behavior functionality.
49 * @author Thomas Pantelis
51 public abstract class AbstractRaftActorIntegrationTest extends AbstractActorTest {
53 public static class SetPeerAddress {
54 private final String peerId;
55 private final String peerAddress;
57 public SetPeerAddress(String peerId, String peerAddress) {
59 this.peerAddress = peerAddress;
62 public String getPeerId() {
66 public String getPeerAddress() {
71 public static class TestRaftActor extends MockRaftActor {
73 private final TestActorRef<MessageCollectorActor> collectorActor;
74 private final Map<Class<?>, Boolean> dropMessages = new ConcurrentHashMap<>();
76 private TestRaftActor(String id, Map<String, String> peerAddresses, ConfigParams config,
77 TestActorRef<MessageCollectorActor> collectorActor) {
78 super(id, peerAddresses, Optional.of(config), null);
79 this.collectorActor = collectorActor;
82 public static Props props(String id, Map<String, String> peerAddresses, ConfigParams config,
83 TestActorRef<MessageCollectorActor> collectorActor) {
84 return Props.create(TestRaftActor.class, id, peerAddresses, config, collectorActor).
85 withDispatcher(Dispatchers.DefaultDispatcherId());
88 void startDropMessages(Class<?> msgClass) {
89 dropMessages.put(msgClass, Boolean.TRUE);
92 void stopDropMessages(Class<?> msgClass) {
93 dropMessages.remove(msgClass);
96 void setMockTotalMemory(final long mockTotalMemory) {
97 if(mockTotalMemory > 0) {
98 getRaftActorContext().setTotalMemoryRetriever(new Supplier<Long>() {
101 return mockTotalMemory;
106 getRaftActorContext().setTotalMemoryRetriever(null);
111 public void handleCommand(Object message) {
112 if(message instanceof MockPayload) {
113 MockPayload payload = (MockPayload)message;
114 super.persistData(collectorActor, payload.toString(), payload);
118 if(message instanceof SetPeerAddress) {
119 setPeerAddress(((SetPeerAddress) message).getPeerId().toString(),
120 ((SetPeerAddress) message).getPeerAddress());
125 if(!dropMessages.containsKey(message.getClass())) {
126 super.handleCommand(message);
129 if(!(message instanceof SendHeartBeat)) {
131 collectorActor.tell(message, ActorRef.noSender());
132 } catch (Exception e) {
133 LOG.error("MessageCollectorActor error", e);
140 public void createSnapshot(ActorRef actorRef) {
142 actorRef.tell(new CaptureSnapshotReply(RaftActorTest.fromObject(getState()).toByteArray()), actorRef);
143 } catch (Exception e) {
148 public ActorRef collectorActor() {
149 return collectorActor;
153 protected final Logger testLog = LoggerFactory.getLogger(getClass());
155 protected final TestActorFactory factory = new TestActorFactory(getSystem());
157 protected String leaderId = factory.generateActorId("leader");
158 protected DefaultConfigParamsImpl leaderConfigParams;
159 protected TestActorRef<TestRaftActor> leaderActor;
160 protected ActorRef leaderCollectorActor;
161 protected RaftActorContext leaderContext;
162 protected RaftActorBehavior leader;
164 protected String follower1Id = factory.generateActorId("follower");
165 protected TestActorRef<TestRaftActor> follower1Actor;
166 protected ActorRef follower1CollectorActor;
167 protected RaftActorBehavior follower1;
168 protected RaftActorContext follower1Context;
170 protected String follower2Id = factory.generateActorId("follower");
171 protected TestActorRef<TestRaftActor> follower2Actor;
172 protected ActorRef follower2CollectorActor;
173 protected RaftActorBehavior follower2;
174 protected RaftActorContext follower2Context;
176 protected ImmutableMap<String, String> peerAddresses;
178 protected long initialTerm = 5;
179 protected long currentTerm;
181 protected int snapshotBatchCount = 4;
183 protected List<MockPayload> expSnapshotState = new ArrayList<>();
186 public void tearDown() {
187 InMemoryJournal.clear();
188 InMemorySnapshotStore.clear();
192 protected DefaultConfigParamsImpl newLeaderConfigParams() {
193 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
194 configParams.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
195 configParams.setElectionTimeoutFactor(1);
196 configParams.setSnapshotBatchCount(snapshotBatchCount);
197 configParams.setSnapshotDataThresholdPercentage(70);
198 configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
202 protected DefaultConfigParamsImpl newFollowerConfigParams() {
203 DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
204 configParams.setHeartBeatInterval(new FiniteDuration(500, TimeUnit.MILLISECONDS));
205 configParams.setElectionTimeoutFactor(1000);
209 protected void waitUntilLeader(ActorRef actorRef) {
210 RaftActorTestKit.waitUntilLeader(actorRef);
213 protected TestActorRef<TestRaftActor> newTestRaftActor(String id, Map<String, String> peerAddresses,
214 ConfigParams configParams) {
215 TestActorRef<MessageCollectorActor> collectorActor = factory.createTestActor(
216 MessageCollectorActor.props().withDispatcher(Dispatchers.DefaultDispatcherId()),
217 factory.generateActorId(id + "-collector"));
219 InvalidActorNameException lastEx = null;
220 for(int i = 0; i < 10; i++) {
222 return factory.createTestActor(TestRaftActor.props(id,
223 peerAddresses != null ? peerAddresses : Collections.<String, String>emptyMap(),
224 configParams, collectorActor), id);
225 } catch (InvalidActorNameException e) {
227 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
231 assertNotNull(lastEx);
235 protected void killActor(TestActorRef<TestRaftActor> leaderActor) {
236 JavaTestKit testkit = new JavaTestKit(getSystem());
237 testkit.watch(leaderActor);
239 leaderActor.tell(PoisonPill.getInstance(), null);
240 testkit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
242 testkit.unwatch(leaderActor);
245 protected void verifyApplyJournalEntries(ActorRef actor, final long expIndex) {
246 MessageCollectorActor.expectFirstMatching(actor, ApplyJournalEntries.class, new Predicate<ApplyJournalEntries>() {
248 public boolean apply(ApplyJournalEntries msg) {
249 return msg.getToIndex() == expIndex;
254 @SuppressWarnings("unchecked")
255 protected void verifySnapshot(String prefix, Snapshot snapshot, long lastAppliedTerm,
256 long lastAppliedIndex, long lastTerm, long lastIndex)
258 assertEquals(prefix + " Snapshot getLastAppliedTerm", lastAppliedTerm, snapshot.getLastAppliedTerm());
259 assertEquals(prefix + " Snapshot getLastAppliedIndex", lastAppliedIndex, snapshot.getLastAppliedIndex());
260 assertEquals(prefix + " Snapshot getLastTerm", lastTerm, snapshot.getLastTerm());
261 assertEquals(prefix + " Snapshot getLastIndex", lastIndex, snapshot.getLastIndex());
263 List<Object> actualState = (List<Object>)MockRaftActor.toObject(snapshot.getState());
264 assertEquals(String.format("%s Snapshot getState size. Expected %s: . Actual: %s", prefix, expSnapshotState,
265 actualState), expSnapshotState.size(), actualState.size());
266 for(int i = 0; i < expSnapshotState.size(); i++) {
267 assertEquals(prefix + " Snapshot state " + i, expSnapshotState.get(i), actualState.get(i));
271 protected void verifyPersistedJournal(String persistenceId, List<? extends ReplicatedLogEntry> expJournal) {
272 List<ReplicatedLogEntry> journal = InMemoryJournal.get(persistenceId, ReplicatedLogEntry.class);
273 assertEquals("Journal ReplicatedLogEntry count", expJournal.size(), journal.size());
274 for(int i = 0; i < expJournal.size(); i++) {
275 ReplicatedLogEntry expected = expJournal.get(i);
276 ReplicatedLogEntry actual = journal.get(i);
277 verifyReplicatedLogEntry(expected, actual.getTerm(), actual.getIndex(), actual.getData());
281 protected MockPayload sendPayloadData(ActorRef leaderActor, String data) {
282 return sendPayloadData(leaderActor, data, 0);
285 protected MockPayload sendPayloadData(ActorRef leaderActor, String data, int size) {
288 payload = new MockPayload(data, size);
290 payload = new MockPayload(data);
293 leaderActor.tell(payload, ActorRef.noSender());
297 protected void verifyApplyState(ApplyState applyState, ActorRef expClientActor,
298 String expId, long expTerm, long expIndex, MockPayload payload) {
299 assertEquals("ApplyState getClientActor", expClientActor, applyState.getClientActor());
300 assertEquals("ApplyState getIdentifier", expId, applyState.getIdentifier());
301 ReplicatedLogEntry replicatedLogEntry = applyState.getReplicatedLogEntry();
302 verifyReplicatedLogEntry(replicatedLogEntry, expTerm, expIndex, payload);
305 protected void verifyReplicatedLogEntry(ReplicatedLogEntry replicatedLogEntry, long expTerm, long expIndex,
307 assertEquals("ReplicatedLogEntry getTerm", expTerm, replicatedLogEntry.getTerm());
308 assertEquals("ReplicatedLogEntry getIndex", expIndex, replicatedLogEntry.getIndex());
309 assertEquals("ReplicatedLogEntry getData", payload, replicatedLogEntry.getData());
312 protected String testActorPath(String id){
313 return "akka://test/user" + id;
316 protected void verifyLeadersTrimmedLog(long lastIndex) {
317 verifyTrimmedLog("Leader", leaderActor, lastIndex, lastIndex - 1);
320 protected void verifyLeadersTrimmedLog(long lastIndex, long replicatedToAllIndex) {
321 verifyTrimmedLog("Leader", leaderActor, lastIndex, replicatedToAllIndex);
324 protected void verifyFollowersTrimmedLog(int num, TestActorRef<TestRaftActor> actorRef, long lastIndex) {
325 verifyTrimmedLog("Follower " + num, actorRef, lastIndex, lastIndex - 1);
328 protected void verifyTrimmedLog(String name, TestActorRef<TestRaftActor> actorRef, long lastIndex,
329 long replicatedToAllIndex) {
330 TestRaftActor actor = actorRef.underlyingActor();
331 RaftActorContext context = actor.getRaftActorContext();
332 long snapshotIndex = lastIndex - 1;
333 assertEquals(name + " snapshot term", snapshotIndex < 0 ? -1 : currentTerm,
334 context.getReplicatedLog().getSnapshotTerm());
335 assertEquals(name + " snapshot index", snapshotIndex, context.getReplicatedLog().getSnapshotIndex());
336 assertEquals(name + " journal log size", 1, context.getReplicatedLog().size());
337 assertEquals(name + " journal last index", lastIndex, context.getReplicatedLog().lastIndex());
338 assertEquals(name + " commit index", lastIndex, context.getCommitIndex());
339 assertEquals(name + " last applied", lastIndex, context.getLastApplied());
340 assertEquals(name + " replicatedToAllIndex", replicatedToAllIndex,
341 actor.getCurrentBehavior().getReplicatedToAllIndex());