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.collect.ImmutableMap;
  20 import com.google.common.util.concurrent.Uninterruptibles;
  21 import java.util.ArrayList;
  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.base.messages.ApplyJournalEntries;
  30 import org.opendaylight.controller.cluster.raft.base.messages.ApplyState;
  31 import org.opendaylight.controller.cluster.raft.base.messages.CaptureSnapshotReply;
  32 import org.opendaylight.controller.cluster.raft.base.messages.SendHeartBeat;
  33 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
  34 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
  35 import org.opendaylight.controller.cluster.raft.utils.InMemoryJournal;
  36 import org.opendaylight.controller.cluster.raft.utils.InMemorySnapshotStore;
  37 import org.opendaylight.controller.cluster.raft.utils.MessageCollectorActor;
  38 import org.opendaylight.yangtools.concepts.Identifier;
  39 import org.opendaylight.yangtools.util.AbstractStringIdentifier;
  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     private static final class MockIdentifier extends AbstractStringIdentifier<MockIdentifier> {
  52         private static final long serialVersionUID = 1L;
  53
  54         protected MockIdentifier(String string) {
  55             super(string);
  56         }
  57     }
  58
  59     public static class SetPeerAddress {
  60         private final String peerId;
  61         private final String peerAddress;
  62
  63         public SetPeerAddress(String peerId, String peerAddress) {
  64             this.peerId = peerId;
  65             this.peerAddress = peerAddress;
  66         }
  67
  68         public String getPeerId() {
  69             return peerId;
  70         }
  71
  72         public String getPeerAddress() {
  73             return peerAddress;
  74         }
  75     }
  76
  77     public static class TestRaftActor extends MockRaftActor {
  78
  79         private final TestActorRef<MessageCollectorActor> collectorActor;
  80         private final Map<Class<?>, Boolean> dropMessages = new ConcurrentHashMap<>();
  81
  82         private TestRaftActor(Builder builder) {
  83             super(builder);
  84             this.collectorActor = builder.collectorActor;
  85         }
  86
  87         void startDropMessages(Class<?> msgClass) {
  88             dropMessages.put(msgClass, Boolean.TRUE);
  89         }
  90
  91         void stopDropMessages(Class<?> msgClass) {
  92             dropMessages.remove(msgClass);
  93         }
  94
  95         void setMockTotalMemory(final long mockTotalMemory) {
  96             getRaftActorContext().setTotalMemoryRetriever(mockTotalMemory > 0 ? () -> mockTotalMemory : null);
  97         }
  98
  99         @Override
 100         public void handleCommand(Object message) {
 101             if(message instanceof MockPayload) {
 102                 MockPayload payload = (MockPayload)message;
 103                 super.persistData(collectorActor, new MockIdentifier(payload.toString()), payload);
 104                 return;
 105             }
 106
 107             if(message instanceof SetPeerAddress) {
 108                 setPeerAddress(((SetPeerAddress) message).getPeerId().toString(),
 109                         ((SetPeerAddress) message).getPeerAddress());
 110                 return;
 111             }
 112
 113             try {
 114                 if(!dropMessages.containsKey(message.getClass())) {
 115                     super.handleCommand(message);
 116                 }
 117             } finally {
 118                 if(!(message instanceof SendHeartBeat)) {
 119                     try {
 120                         collectorActor.tell(message, ActorRef.noSender());
 121                     } catch (Exception e) {
 122                         LOG.error("MessageCollectorActor error", e);
 123                     }
 124                 }
 125             }
 126         }
 127
 128         @Override
 129         public void createSnapshot(ActorRef actorRef) {
 130             try {
 131                 actorRef.tell(new CaptureSnapshotReply(RaftActorTest.fromObject(getState()).toByteArray()), actorRef);
 132             } catch (Exception e) {
 133                 e.printStackTrace();
 134             }
 135         }
 136
 137         public ActorRef collectorActor() {
 138             return collectorActor;
 139         }
 140
 141         public static Builder newBuilder() {
 142             return new Builder();
 143         }
 144
 145         public static class Builder extends AbstractBuilder<Builder, TestRaftActor> {
 146             private TestActorRef<MessageCollectorActor> collectorActor;
 147
 148             public Builder collectorActor(TestActorRef<MessageCollectorActor> collectorActor) {
 149                 this.collectorActor = collectorActor;
 150                 return this;
 151             }
 152
 153             private Builder() {
 154                 super(TestRaftActor.class);
 155             }
 156         }
 157     }
 158
 159     protected static final int SNAPSHOT_CHUNK_SIZE = 100;
 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         configParams.setSnapshotChunkSize(SNAPSHOT_CHUNK_SIZE);
 208         return configParams;
 209     }
 210
 211     protected DefaultConfigParamsImpl newFollowerConfigParams() {
 212         DefaultConfigParamsImpl configParams = new DefaultConfigParamsImpl();
 213         configParams.setHeartBeatInterval(new FiniteDuration(500, TimeUnit.MILLISECONDS));
 214         configParams.setElectionTimeoutFactor(1000);
 215         return configParams;
 216     }
 217
 218     protected void waitUntilLeader(ActorRef actorRef) {
 219         RaftActorTestKit.waitUntilLeader(actorRef);
 220     }
 221
 222     protected TestActorRef<TestRaftActor> newTestRaftActor(String id, Map<String, String> peerAddresses,
 223             ConfigParams configParams) {
 224         return newTestRaftActor(id, TestRaftActor.newBuilder().peerAddresses(peerAddresses != null ? peerAddresses :
 225             Collections.<String, String>emptyMap()).config(configParams));
 226     }
 227
 228     protected TestActorRef<TestRaftActor> newTestRaftActor(String id, TestRaftActor.Builder builder) {
 229         builder.collectorActor(factory.<MessageCollectorActor>createTestActor(
 230                 MessageCollectorActor.props().withDispatcher(Dispatchers.DefaultDispatcherId()),
 231                         factory.generateActorId(id + "-collector"))).id(id);
 232
 233         InvalidActorNameException lastEx = null;
 234         for(int i = 0; i < 10; i++) {
 235             try {
 236                 return factory.createTestActor(builder.props().withDispatcher(Dispatchers.DefaultDispatcherId()), id);
 237             } catch (InvalidActorNameException e) {
 238                 lastEx = e;
 239                 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 240             }
 241         }
 242
 243         assertNotNull(lastEx);
 244         throw lastEx;
 245     }
 246
 247     protected void killActor(TestActorRef<TestRaftActor> leaderActor) {
 248         JavaTestKit testkit = new JavaTestKit(getSystem());
 249         testkit.watch(leaderActor);
 250
 251         leaderActor.tell(PoisonPill.getInstance(), null);
 252         testkit.expectMsgClass(JavaTestKit.duration("5 seconds"), Terminated.class);
 253
 254         testkit.unwatch(leaderActor);
 255     }
 256
 257     protected void verifyApplyJournalEntries(ActorRef actor, final long expIndex) {
 258         MessageCollectorActor.expectFirstMatching(actor, ApplyJournalEntries.class, msg -> msg.getToIndex() == expIndex);
 259     }
 260
 261     @SuppressWarnings("unchecked")
 262     protected void verifySnapshot(String prefix, Snapshot snapshot, long lastAppliedTerm,
 263             long lastAppliedIndex, long lastTerm, long lastIndex)
 264                     throws Exception {
 265         assertEquals(prefix + " Snapshot getLastAppliedTerm", lastAppliedTerm, snapshot.getLastAppliedTerm());
 266         assertEquals(prefix + " Snapshot getLastAppliedIndex", lastAppliedIndex, snapshot.getLastAppliedIndex());
 267         assertEquals(prefix + " Snapshot getLastTerm", lastTerm, snapshot.getLastTerm());
 268         assertEquals(prefix + " Snapshot getLastIndex", lastIndex, snapshot.getLastIndex());
 269
 270         List<Object> actualState = (List<Object>)MockRaftActor.toObject(snapshot.getState());
 271         assertEquals(String.format("%s Snapshot getState size. Expected %s: . Actual: %s", prefix, expSnapshotState,
 272                 actualState), expSnapshotState.size(), actualState.size());
 273         for(int i = 0; i < expSnapshotState.size(); i++) {
 274             assertEquals(prefix + " Snapshot state " + i, expSnapshotState.get(i), actualState.get(i));
 275         }
 276     }
 277
 278     protected void verifyPersistedJournal(String persistenceId, List<? extends ReplicatedLogEntry> expJournal) {
 279         List<ReplicatedLogEntry> journal = InMemoryJournal.get(persistenceId, ReplicatedLogEntry.class);
 280         assertEquals("Journal ReplicatedLogEntry count", expJournal.size(), journal.size());
 281         for(int i = 0; i < expJournal.size(); i++) {
 282             ReplicatedLogEntry expected = expJournal.get(i);
 283             ReplicatedLogEntry actual = journal.get(i);
 284             verifyReplicatedLogEntry(expected, actual.getTerm(), actual.getIndex(), actual.getData());
 285         }
 286     }
 287
 288     protected MockPayload sendPayloadData(ActorRef leaderActor, String data) {
 289         return sendPayloadData(leaderActor, data, 0);
 290     }
 291
 292     protected MockPayload sendPayloadData(ActorRef leaderActor, String data, int size) {
 293         MockPayload payload;
 294         if(size > 0) {
 295             payload = new MockPayload(data, size);
 296         } else {
 297             payload = new MockPayload(data);
 298         }
 299
 300         leaderActor.tell(payload, ActorRef.noSender());
 301         return payload;
 302     }
 303
 304     protected void verifyApplyState(ApplyState applyState, ActorRef expClientActor,
 305             String expId, long expTerm, long expIndex, MockPayload payload) {
 306         assertEquals("ApplyState getClientActor", expClientActor, applyState.getClientActor());
 307
 308         final Identifier id = expId == null ? null : new MockIdentifier(expId);
 309         assertEquals("ApplyState getIdentifier", id, applyState.getIdentifier());
 310         ReplicatedLogEntry replicatedLogEntry = applyState.getReplicatedLogEntry();
 311         verifyReplicatedLogEntry(replicatedLogEntry, expTerm, expIndex, payload);
 312     }
 313
 314     protected void verifyReplicatedLogEntry(ReplicatedLogEntry replicatedLogEntry, long expTerm, long expIndex,
 315             Payload payload) {
 316         assertEquals("ReplicatedLogEntry getTerm", expTerm, replicatedLogEntry.getTerm());
 317         assertEquals("ReplicatedLogEntry getIndex", expIndex, replicatedLogEntry.getIndex());
 318         assertEquals("ReplicatedLogEntry getData", payload, replicatedLogEntry.getData());
 319     }
 320
 321     protected String testActorPath(String id){
 322         return factory.createTestActorPath(id);
 323     }
 324
 325     protected void verifyLeadersTrimmedLog(long lastIndex) {
 326         verifyTrimmedLog("Leader", leaderActor, lastIndex, lastIndex - 1);
 327     }
 328
 329     protected void verifyLeadersTrimmedLog(long lastIndex, long replicatedToAllIndex) {
 330         verifyTrimmedLog("Leader", leaderActor, lastIndex, replicatedToAllIndex);
 331     }
 332
 333     protected void verifyFollowersTrimmedLog(int num, TestActorRef<TestRaftActor> actorRef, long lastIndex) {
 334         verifyTrimmedLog("Follower " + num, actorRef, lastIndex, lastIndex - 1);
 335     }
 336
 337     protected void verifyTrimmedLog(String name, TestActorRef<TestRaftActor> actorRef, long lastIndex,
 338             long replicatedToAllIndex) {
 339         TestRaftActor actor = actorRef.underlyingActor();
 340         RaftActorContext context = actor.getRaftActorContext();
 341         long snapshotIndex = lastIndex - 1;
 342         assertEquals(name + " snapshot term", snapshotIndex < 0 ? -1 : currentTerm,
 343                 context.getReplicatedLog().getSnapshotTerm());
 344         assertEquals(name + " snapshot index", snapshotIndex, context.getReplicatedLog().getSnapshotIndex());
 345         assertEquals(name + " journal log size", 1, context.getReplicatedLog().size());
 346         assertEquals(name + " journal last index", lastIndex, context.getReplicatedLog().lastIndex());
 347         assertEquals(name + " commit index", lastIndex, context.getCommitIndex());
 348         assertEquals(name + " last applied", lastIndex, context.getLastApplied());
 349         assertEquals(name + " replicatedToAllIndex", replicatedToAllIndex,
 350                 actor.getCurrentBehavior().getReplicatedToAllIndex());
 351     }
 352 }