opendaylight/md-sal/sal-akka-raft/src/test/java/org/opendaylight/controller/cluster/raft/AbstractRaftActorIntegrationTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.raft;
   9
  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.Terminated;
  16 import akka.dispatch.Dispatchers;
  17 import akka.testkit.JavaTestKit;
  18 import akka.testkit.TestActorRef;
  19 import com.google.common.base.Predicate;
  20 import com.google.common.base.Supplier;
  21 import com.google.common.collect.ImmutableMap;
  22 import com.google.common.util.concurrent.Uninterruptibles;
  23 import java.util.ArrayList;
  24 import java.util.Collections;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.concurrent.ConcurrentHashMap;
  28 import java.util.concurrent.TimeUnit;
  29 import org.junit.After;
  30 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
  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;
  43
  44 /**
  45  * Abstract base for an integration test that tests end-to-end RaftActor and behavior functionality.
  46  *
  47  * @author Thomas Pantelis
  48  */
  49 public abstract class AbstractRaftActorIntegrationTest extends AbstractActorTest {
  50
  51     public static class SetPeerAddress {
  52         private final String peerId;
  53         private final String peerAddress;
  54
  55         public SetPeerAddress(String peerId, String peerAddress) {
  56             this.peerId = peerId;
  57             this.peerAddress = peerAddress;
  58         }
  59
  60         public String getPeerId() {
  61             return peerId;
  62         }
  63
  64         public String getPeerAddress() {
  65             return peerAddress;
  66         }
  67     }
  68
  69     public static class TestRaftActor extends MockRaftActor {
  70
  71         private final TestActorRef<MessageCollectorActor> collectorActor;
  72         private final Map<Class<?>, Boolean> dropMessages = new ConcurrentHashMap<>();
  73
  74         private TestRaftActor(Builder builder) {
  75             super(builder);
  76             this.collectorActor = builder.collectorActor;
  77         }
  78
  79         void startDropMessages(Class<?> msgClass) {
  80             dropMessages.put(msgClass, Boolean.TRUE);
  81         }
  82
  83         void stopDropMessages(Class<?> msgClass) {
  84             dropMessages.remove(msgClass);
  85         }
  86
  87         void setMockTotalMemory(final long mockTotalMemory) {
  88             if(mockTotalMemory > 0) {
  89                 getRaftActorContext().setTotalMemoryRetriever(new Supplier<Long>() {
  90                     @Override
  91                     public Long get() {
  92                         return mockTotalMemory;
  93                     }
  94
  95                 });
  96             } else {
  97                 getRaftActorContext().setTotalMemoryRetriever(null);
  98             }
  99         }
 100
 101         @Override
 102         public void handleCommand(Object message) {
 103             if(message instanceof MockPayload) {
 104                 MockPayload payload = (MockPayload)message;
 105                 super.persistData(collectorActor, payload.toString(), payload);
 106                 return;
 107             }
 108
 109             if(message instanceof SetPeerAddress) {
 110                 setPeerAddress(((SetPeerAddress) message).getPeerId().toString(),
 111                         ((SetPeerAddress) message).getPeerAddress());
 112                 return;
 113             }
 114
 115             try {
 116                 if(!dropMessages.containsKey(message.getClass())) {
 117                     super.handleCommand(message);
 118                 }
 119             } finally {
 120                 if(!(message instanceof SendHeartBeat)) {
 121                     try {
 122                         collectorActor.tell(message, ActorRef.noSender());
 123                     } catch (Exception e) {
 124                         LOG.error("MessageCollectorActor error", e);
 125                     }
 126                 }
 127             }
 128         }
 129
 130         @Override
 131         public void createSnapshot(ActorRef actorRef) {
 132             try {
 133                 actorRef.tell(new CaptureSnapshotReply(RaftActorTest.fromObject(getState()).toByteArray()), actorRef);
 134             } catch (Exception e) {
 135                 e.printStackTrace();
 136             }
 137         }
 138
 139         public ActorRef collectorActor() {
 140             return collectorActor;
 141         }
 142
 143         public static Builder newBuilder() {
 144             return new Builder();
 145         }
 146
 147         public static class Builder extends AbstractBuilder<Builder, TestRaftActor> {
 148             private TestActorRef<MessageCollectorActor> collectorActor;
 149
 150             public Builder collectorActor(TestActorRef<MessageCollectorActor> collectorActor) {
 151                 this.collectorActor = collectorActor;
 152                 return this;
 153             }
 154
 155             private Builder() {
 156                 super(TestRaftActor.class);
 157             }
 158         }
 159     }
 160
 161     protected final Logger testLog = LoggerFactory.getLogger(getClass());
 162
 163     protected final TestActorFactory factory = new TestActorFactory(getSystem());
 164
 165     protected String leaderId = factory.generateActorId("leader");
 166     protected DefaultConfigParamsImpl leaderConfigParams;
 167     protected TestActorRef<TestRaftActor> leaderActor;
 168     protected ActorRef leaderCollectorActor;
 169     protected RaftActorContext leaderContext;
 170     protected RaftActorBehavior leader;
 171
 172     protected String follower1Id = factory.generateActorId("follower");
 173     protected TestActorRef<TestRaftActor> follower1Actor;
 174     protected ActorRef follower1CollectorActor;
 175     protected RaftActorBehavior follower1;
 176     protected RaftActorContext follower1Context;
 177
 178     protected String follower2Id = factory.generateActorId("follower");
 179     protected TestActorRef<TestRaftActor> follower2Actor;
 180     protected ActorRef follower2CollectorActor;
 181     protected  RaftActorBehavior follower2;
 182     protected RaftActorContext follower2Context;
 183
 184     protected ImmutableMap<String, String> peerAddresses;
 185
 186     protected long initialTerm = 5;
 187     protected long currentTerm;
 188
 189     protected int snapshotBatchCount = 4;
 190
 191     protected List<MockPayload> expSnapshotState = new ArrayList<>();
 192
 193     @After
 194     public void tearDown() {
 195         InMemoryJournal.clear();
 196         InMemorySnapshotStore.clear();
 197         factory.close();
 198     }
 199
 200     protected DefaultConfigParamsImpl newLeaderConfigParams() {
 201         DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
 202         configParams.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
 203         configParams.setElectionTimeoutFactor(1);
 204         configParams.setSnapshotBatchCount(snapshotBatchCount);
 205         configParams.setSnapshotDataThresholdPercentage(70);
 206         configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 207         return configParams;
 208     }
 209
 210     protected DefaultConfigParamsImpl newFollowerConfigParams() {
 211         DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
 212         configParams.setHeartBeatInterval(new FiniteDuration(500, TimeUnit.MILLISECONDS));
 213         configParams.setElectionTimeoutFactor(1000);
 214         return configParams;
 215     }
 216
 217     protected void waitUntilLeader(ActorRef actorRef) {
 218         RaftActorTestKit.waitUntilLeader(actorRef);
 219     }
 220
 221     protected TestActorRef<TestRaftActor> newTestRaftActor(String id, Map<String, String> peerAddresses,
 222             ConfigParams configParams) {
 223         return newTestRaftActor(id, TestRaftActor.newBuilder().peerAddresses(peerAddresses != null ? peerAddresses :
 224             Collections.<String, String>emptyMap()).config(configParams));
 225     }
 226
 227     protected TestActorRef<TestRaftActor> newTestRaftActor(String id, TestRaftActor.Builder builder) {
 228         builder.collectorActor(factory.<MessageCollectorActor>createTestActor(
 229                 MessageCollectorActor.props().withDispatcher(Dispatchers.DefaultDispatcherId()),
 230                         factory.generateActorId(id + "-collector"))).id(id);
 231
 232         InvalidActorNameException lastEx = null;
 233         for(int i = 0; i < 10; i++) {
 234             try {
 235                 return factory.createTestActor(builder.props().withDispatcher(Dispatchers.DefaultDispatcherId()), id);
 236             } catch (InvalidActorNameException e) {
 237                 lastEx = e;
 238                 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 239             }
 240         }
 241
 242         assertNotNull(lastEx);
 243         throw lastEx;
 244     }
 245
 246     protected void killActor(TestActorRef<TestRaftActor> leaderActor) {
 247         JavaTestKit testkit = new JavaTestKit(getSystem());
 248         testkit.watch(leaderActor);
 249
 250         leaderActor.tell(PoisonPill.getInstance(), null);
 251         testkit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
 252
 253         testkit.unwatch(leaderActor);
 254     }
 255
 256     protected void verifyApplyJournalEntries(ActorRef actor, final long expIndex) {
 257         MessageCollectorActor.expectFirstMatching(actor, ApplyJournalEntries.class, new Predicate<ApplyJournalEntries>() {
 258             @Override
 259             public boolean apply(ApplyJournalEntries msg) {
 260                 return msg.getToIndex() == expIndex;
 261             }
 262         });
 263     }
 264
 265     @SuppressWarnings("unchecked")
 266     protected void verifySnapshot(String prefix, Snapshot snapshot, long lastAppliedTerm,
 267             long lastAppliedIndex, long lastTerm, long lastIndex)
 268                     throws Exception {
 269         assertEquals(prefix + " Snapshot getLastAppliedTerm", lastAppliedTerm, snapshot.getLastAppliedTerm());
 270         assertEquals(prefix + " Snapshot getLastAppliedIndex", lastAppliedIndex, snapshot.getLastAppliedIndex());
 271         assertEquals(prefix + " Snapshot getLastTerm", lastTerm, snapshot.getLastTerm());
 272         assertEquals(prefix + " Snapshot getLastIndex", lastIndex, snapshot.getLastIndex());
 273
 274         List<Object> actualState = (List<Object>)MockRaftActor.toObject(snapshot.getState());
 275         assertEquals(String.format("%s Snapshot getState size. Expected %s: . Actual: %s", prefix, expSnapshotState,
 276                 actualState), expSnapshotState.size(), actualState.size());
 277         for(int i = 0; i < expSnapshotState.size(); i++) {
 278             assertEquals(prefix + " Snapshot state " + i, expSnapshotState.get(i), actualState.get(i));
 279         }
 280     }
 281
 282     protected void verifyPersistedJournal(String persistenceId, List<? extends ReplicatedLogEntry> expJournal) {
 283         List<ReplicatedLogEntry> journal = InMemoryJournal.get(persistenceId, ReplicatedLogEntry.class);
 284         assertEquals("Journal ReplicatedLogEntry count", expJournal.size(), journal.size());
 285         for(int i = 0; i < expJournal.size(); i++) {
 286             ReplicatedLogEntry expected = expJournal.get(i);
 287             ReplicatedLogEntry actual = journal.get(i);
 288             verifyReplicatedLogEntry(expected, actual.getTerm(), actual.getIndex(), actual.getData());
 289         }
 290     }
 291
 292     protected MockPayload sendPayloadData(ActorRef leaderActor, String data) {
 293         return sendPayloadData(leaderActor, data, 0);
 294     }
 295
 296     protected MockPayload sendPayloadData(ActorRef leaderActor, String data, int size) {
 297         MockPayload payload;
 298         if(size > 0) {
 299             payload = new MockPayload(data, size);
 300         } else {
 301             payload = new MockPayload(data);
 302         }
 303
 304         leaderActor.tell(payload, ActorRef.noSender());
 305         return payload;
 306     }
 307
 308     protected void verifyApplyState(ApplyState applyState, ActorRef expClientActor,
 309             String expId, long expTerm, long expIndex, MockPayload payload) {
 310         assertEquals("ApplyState getClientActor", expClientActor, applyState.getClientActor());
 311         assertEquals("ApplyState getIdentifier", expId, applyState.getIdentifier());
 312         ReplicatedLogEntry replicatedLogEntry = applyState.getReplicatedLogEntry();
 313         verifyReplicatedLogEntry(replicatedLogEntry, expTerm, expIndex, payload);
 314     }
 315
 316     protected void verifyReplicatedLogEntry(ReplicatedLogEntry replicatedLogEntry, long expTerm, long expIndex,
 317             Payload payload) {
 318         assertEquals("ReplicatedLogEntry getTerm", expTerm, replicatedLogEntry.getTerm());
 319         assertEquals("ReplicatedLogEntry getIndex", expIndex, replicatedLogEntry.getIndex());
 320         assertEquals("ReplicatedLogEntry getData", payload, replicatedLogEntry.getData());
 321     }
 322
 323     protected String testActorPath(String id){
 324         return factory.createTestActorPath(id);
 325     }
 326
 327     protected void verifyLeadersTrimmedLog(long lastIndex) {
 328         verifyTrimmedLog("Leader", leaderActor, lastIndex, lastIndex - 1);
 329     }
 330
 331     protected void verifyLeadersTrimmedLog(long lastIndex, long replicatedToAllIndex) {
 332         verifyTrimmedLog("Leader", leaderActor, lastIndex, replicatedToAllIndex);
 333     }
 334
 335     protected void verifyFollowersTrimmedLog(int num, TestActorRef<TestRaftActor> actorRef, long lastIndex) {
 336         verifyTrimmedLog("Follower " + num, actorRef, lastIndex, lastIndex - 1);
 337     }
 338
 339     protected void verifyTrimmedLog(String name, TestActorRef<TestRaftActor> actorRef, long lastIndex,
 340             long replicatedToAllIndex) {
 341         TestRaftActor actor = actorRef.underlyingActor();
 342         RaftActorContext context = actor.getRaftActorContext();
 343         long snapshotIndex = lastIndex - 1;
 344         assertEquals(name + " snapshot term", snapshotIndex < 0 ? -1 : currentTerm,
 345                 context.getReplicatedLog().getSnapshotTerm());
 346         assertEquals(name + " snapshot index", snapshotIndex, context.getReplicatedLog().getSnapshotIndex());
 347         assertEquals(name + " journal log size", 1, context.getReplicatedLog().size());
 348         assertEquals(name + " journal last index", lastIndex, context.getReplicatedLog().lastIndex());
 349         assertEquals(name + " commit index", lastIndex, context.getCommitIndex());
 350         assertEquals(name + " last applied", lastIndex, context.getLastApplied());
 351         assertEquals(name + " replicatedToAllIndex", replicatedToAllIndex,
 352                 actor.getCurrentBehavior().getReplicatedToAllIndex());
 353     }
 354 }