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.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.collect.ImmutableMap;
  22 import java.util.Collections;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.concurrent.ConcurrentHashMap;
  26 import java.util.concurrent.TimeUnit;
  27 import org.junit.After;
  28 import org.opendaylight.controller.cluster.raft.MockRaftActorContext.MockPayload;
  29 import org.opendaylight.controller.cluster.raft.RaftActorTest.MockRaftActor;
  30 import org.opendaylight.controller.cluster.raft.base.messages.ApplyJournalEntries;
  31 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
  32 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
  33 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
  34 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
  35 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
  36 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  37 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  38 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41 import scala.concurrent.duration.FiniteDuration;
  42
  43 /**
  44  * Abstract base for an integration test that tests end-to-end RaftActor and behavior functionality.
  45  *
  46  * @author Thomas Pantelis
  47  */
  48 public abstract class AbstractRaftActorIntegrationTest extends AbstractActorTest {
  49
  50     public static class TestRaftActor extends MockRaftActor {
  51
  52         private final TestActorRef<MessageCollectorActor> collectorActor;
  53         private final Map<Class<?>, Boolean> dropMessages = new ConcurrentHashMap<>();
  54         private volatile byte[] snapshot;
  55         private volatile long mockTotalMemory;
  56
  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;
  61         }
  62
  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());
  67         }
  68
  69         void startDropMessages(Class<?> msgClass) {
  70             dropMessages.put(msgClass, Boolean.TRUE);
  71         }
  72
  73         void stopDropMessages(Class<?> msgClass) {
  74             dropMessages.remove(msgClass);
  75         }
  76
  77         void setMockTotalMemory(long mockTotalMemory) {
  78             this.mockTotalMemory = mockTotalMemory;
  79         }
  80
  81         @Override
  82         protected long getTotalMemory() {
  83             return mockTotalMemory > 0 ? mockTotalMemory : super.getTotalMemory();
  84         }
  85
  86         @Override
  87         public void handleCommand(Object message) {
  88             if(message instanceof MockPayload) {
  89                 MockPayload payload = (MockPayload)message;
  90                 super.persistData(collectorActor, payload.toString(), payload);
  91                 return;
  92             }
  93
  94             try {
  95                 if(!dropMessages.containsKey(message.getClass())) {
  96                     super.handleCommand(message);
  97                 }
  98             } finally {
  99                 if(!(message instanceof SendHeartBeat)) {
 100                     try {
 101                         collectorActor.tell(message, ActorRef.noSender());
 102                     } catch (Exception e) {
 103                         LOG.error("MessageCollectorActor error", e);
 104                     }
 105                 }
 106             }
 107         }
 108
 109         @Override
 110         protected void createSnapshot() {
 111             if(snapshot != null) {
 112                 getSelf().tell(new CaptureSnapshotReply(snapshot), ActorRef.noSender());
 113             }
 114         }
 115
 116         @Override
 117         protected void applyRecoverySnapshot(byte[] bytes) {
 118         }
 119
 120         void setSnapshot(byte[] snapshot) {
 121             this.snapshot = snapshot;
 122         }
 123
 124         public ActorRef collectorActor() {
 125             return collectorActor;
 126         }
 127     }
 128
 129     protected final Logger testLog = LoggerFactory.getLogger(getClass());
 130
 131     protected final TestActorFactory factory = new TestActorFactory(getSystem());
 132
 133     protected String leaderId = factory.generateActorId("leader");
 134     protected DefaultConfigParamsImpl leaderConfigParams;
 135     protected TestActorRef<TestRaftActor> leaderActor;
 136     protected ActorRef leaderCollectorActor;
 137     protected RaftActorContext leaderContext;
 138     protected RaftActorBehavior leader;
 139
 140     protected String follower1Id = factory.generateActorId("follower");
 141     protected TestActorRef<TestRaftActor> follower1Actor;
 142     protected ActorRef follower1CollectorActor;
 143     protected RaftActorBehavior follower1;
 144     protected RaftActorContext follower1Context;
 145
 146     protected String follower2Id = factory.generateActorId("follower");
 147     protected TestActorRef<TestRaftActor> follower2Actor;
 148     protected ActorRef follower2CollectorActor;
 149     protected  RaftActorBehavior follower2;
 150     protected RaftActorContext follower2Context;
 151
 152     protected ImmutableMap<String, String> peerAddresses;
 153
 154     protected long initialTerm = 5;
 155     protected long currentTerm;
 156
 157     @After
 158     public void tearDown() {
 159         InMemoryJournal.clear();
 160         InMemorySnapshotStore.clear();
 161         factory.close();
 162     }
 163
 164     protected DefaultConfigParamsImpl newLeaderConfigParams() {
 165         DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
 166         configParams.setHeartBeatInterval(new FiniteDuration(100, TimeUnit.MILLISECONDS));
 167         configParams.setElectionTimeoutFactor(1);
 168         configParams.setSnapshotBatchCount(4);
 169         configParams.setSnapshotDataThresholdPercentage(70);
 170         configParams.setIsolatedLeaderCheckInterval(new FiniteDuration(1, TimeUnit.DAYS));
 171         return configParams;
 172     }
 173
 174     protected DefaultConfigParamsImpl newFollowerConfigParams() {
 175         DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
 176         configParams.setHeartBeatInterval(new FiniteDuration(500, TimeUnit.MILLISECONDS));
 177         configParams.setElectionTimeoutFactor(1000);
 178         return configParams;
 179     }
 180
 181     protected void waitUntilLeader(ActorRef actorRef) {
 182         RaftActorTest.RaftActorTestKit.waitUntilLeader(actorRef);
 183     }
 184
 185     protected TestActorRef<TestRaftActor> newTestRaftActor(String id, Map<String, String> peerAddresses,
 186             ConfigParams configParams) {
 187         TestActorRef<MessageCollectorActor> collectorActor = factory.createTestActor(
 188                 MessageCollectorActor.props().withDispatcher(Dispatchers.DefaultDispatcherId()),
 189                         factory.generateActorId(id + "-collector"));
 190         return factory.createTestActor(TestRaftActor.props(id,
 191                 peerAddresses != null ? peerAddresses : Collections.<String, String>emptyMap(),
 192                         configParams, collectorActor), id);
 193     }
 194
 195     protected void killActor(TestActorRef<TestRaftActor> leaderActor) {
 196         JavaTestKit testkit = new JavaTestKit(getSystem());
 197         testkit.watch(leaderActor);
 198
 199         leaderActor.tell(PoisonPill.getInstance(), null);
 200         testkit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
 201
 202         testkit.unwatch(leaderActor);
 203     }
 204
 205     protected void verifyApplyJournalEntries(ActorRef actor, final long expIndex) {
 206         MessageCollectorActor.expectFirstMatching(actor, ApplyJournalEntries.class, new Predicate<ApplyJournalEntries>() {
 207             @Override
 208             public boolean apply(ApplyJournalEntries msg) {
 209                 return msg.getToIndex() == expIndex;
 210             }
 211         });
 212     }
 213
 214     protected void verifySnapshot(String prefix, Snapshot snapshot, long lastAppliedTerm,
 215             int lastAppliedIndex, long lastTerm, long lastIndex, byte[] data) {
 216         assertEquals(prefix + " Snapshot getLastAppliedTerm", lastAppliedTerm, snapshot.getLastAppliedTerm());
 217         assertEquals(prefix + " Snapshot getLastAppliedIndex", lastAppliedIndex, snapshot.getLastAppliedIndex());
 218         assertEquals(prefix + " Snapshot getLastTerm", lastTerm, snapshot.getLastTerm());
 219         assertEquals(prefix + " Snapshot getLastIndex", lastIndex, snapshot.getLastIndex());
 220         assertArrayEquals(prefix + " Snapshot getState", data, snapshot.getState());
 221     }
 222
 223     protected void verifyPersistedJournal(String persistenceId, List<? extends ReplicatedLogEntry> expJournal) {
 224         List<ReplicatedLogEntry> journal = InMemoryJournal.get(persistenceId, ReplicatedLogEntry.class);
 225         assertEquals("Journal ReplicatedLogEntry count", expJournal.size(), journal.size());
 226         for(int i = 0; i < expJournal.size(); i++) {
 227             ReplicatedLogEntry expected = expJournal.get(i);
 228             ReplicatedLogEntry actual = journal.get(i);
 229             verifyReplicatedLogEntry(expected, actual.getTerm(), actual.getIndex(), actual.getData());
 230         }
 231     }
 232
 233     protected MockPayload sendPayloadData(ActorRef leaderActor, String data) {
 234         return sendPayloadData(leaderActor, data, 0);
 235     }
 236
 237     protected MockPayload sendPayloadData(ActorRef leaderActor, String data, int size) {
 238         MockPayload payload;
 239         if(size > 0) {
 240             payload = new MockPayload(data, size);
 241         } else {
 242             payload = new MockPayload(data);
 243         }
 244
 245         leaderActor.tell(payload, ActorRef.noSender());
 246         return payload;
 247     }
 248
 249     protected void verifyApplyState(ApplyState applyState, ActorRef expClientActor,
 250             String expId, long expTerm, long expIndex, MockPayload payload) {
 251         assertEquals("ApplyState getClientActor", expClientActor, applyState.getClientActor());
 252         assertEquals("ApplyState getIdentifier", expId, applyState.getIdentifier());
 253         ReplicatedLogEntry replicatedLogEntry = applyState.getReplicatedLogEntry();
 254         verifyReplicatedLogEntry(replicatedLogEntry, expTerm, expIndex, payload);
 255     }
 256
 257     protected void verifyReplicatedLogEntry(ReplicatedLogEntry replicatedLogEntry, long expTerm, long expIndex,
 258             Payload payload) {
 259         assertEquals("ReplicatedLogEntry getTerm", expTerm, replicatedLogEntry.getTerm());
 260         assertEquals("ReplicatedLogEntry getIndex", expIndex, replicatedLogEntry.getIndex());
 261         assertEquals("ReplicatedLogEntry getData", payload, replicatedLogEntry.getData());
 262     }
 263
 264     protected String testActorPath(String id){
 265         return "akka://test/user" + id;
 266     }
 267 }