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

   1 /*
   2  * Copyright (c) 2014 Cisco 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
   9 package org.opendaylight.controller.cluster.raft;
  10
  11 import akka.actor.ActorRef;
  12 import akka.actor.ActorSelection;
  13 import akka.actor.ActorSystem;
  14 import akka.actor.Props;
  15 import akka.japi.Procedure;
  16 import com.google.common.base.Preconditions;
  17 import com.google.common.base.Supplier;
  18 import com.google.protobuf.GeneratedMessage;
  19 import java.io.Serializable;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import org.opendaylight.controller.cluster.DataPersistenceProvider;
  23 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
  24 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
  25 import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages;
  26 import org.opendaylight.controller.protobuff.messages.cluster.raft.test.MockPayloadMessages;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 public class MockRaftActorContext implements RaftActorContext {
  31
  32     private String id;
  33     private ActorSystem system;
  34     private ActorRef actor;
  35     private long index = 0;
  36     private long lastApplied = 0;
  37     private final ElectionTerm electionTerm;
  38     private ReplicatedLog replicatedLog;
  39     private Map<String, String> peerAddresses = new HashMap<>();
  40     private ConfigParams configParams;
  41     private boolean snapshotCaptureInitiated;
  42     private SnapshotManager snapshotManager;
  43     private DataPersistenceProvider persistenceProvider = new NonPersistentDataProvider();
  44
  45     public MockRaftActorContext(){
  46         electionTerm = new ElectionTerm() {
  47             private long currentTerm = 1;
  48             private String votedFor = "";
  49
  50             @Override
  51             public long getCurrentTerm() {
  52                 return currentTerm;
  53             }
  54
  55             @Override
  56             public String getVotedFor() {
  57                 return votedFor;
  58             }
  59
  60             @Override
  61             public void update(long currentTerm, String votedFor){
  62                 this.currentTerm = currentTerm;
  63                 this.votedFor = votedFor;
  64
  65                 // TODO : Write to some persistent state
  66             }
  67
  68             @Override public void updateAndPersist(long currentTerm,
  69                 String votedFor) {
  70                 update(currentTerm, votedFor);
  71             }
  72         };
  73
  74         configParams = new DefaultConfigParamsImpl();
  75     }
  76
  77     public MockRaftActorContext(String id, ActorSystem system, ActorRef actor){
  78         this();
  79         this.id = id;
  80         this.system = system;
  81         this.actor = actor;
  82
  83         initReplicatedLog();
  84     }
  85
  86
  87     public void initReplicatedLog(){
  88         this.replicatedLog = new SimpleReplicatedLog();
  89         long term = getTermInformation().getCurrentTerm();
  90         this.replicatedLog.append(new MockReplicatedLogEntry(term, 0, new MockPayload("1")));
  91         this.replicatedLog.append(new MockReplicatedLogEntry(term, 1, new MockPayload("2")));
  92     }
  93
  94     @Override public ActorRef actorOf(Props props) {
  95         return system.actorOf(props);
  96     }
  97
  98     @Override public ActorSelection actorSelection(String path) {
  99         return system.actorSelection(path);
 100     }
 101
 102     @Override public String getId() {
 103         return id;
 104     }
 105
 106     @Override public ActorRef getActor() {
 107         return actor;
 108     }
 109
 110     @Override public ElectionTerm getTermInformation() {
 111         return electionTerm;
 112     }
 113
 114     public void setIndex(long index){
 115         this.index = index;
 116     }
 117
 118     @Override public long getCommitIndex() {
 119         return index;
 120     }
 121
 122     @Override public void setCommitIndex(long commitIndex) {
 123         this.index = commitIndex;
 124     }
 125
 126     @Override public void setLastApplied(long lastApplied){
 127         this.lastApplied = lastApplied;
 128     }
 129
 130     @Override public long getLastApplied() {
 131         return lastApplied;
 132     }
 133
 134     @Override
 135     // FIXME : A lot of tests try to manipulate the replicated log by setting it using this method
 136     // This is OK to do if the underlyingActor is not RafActor or a derived class. If not then you should not
 137     // used this way to manipulate the log because the RaftActor actually has a field replicatedLog
 138     // which it creates internally and sets on the RaftActorContext
 139     // The only right way to manipulate the replicated log therefore is to get it from either the RaftActor
 140     // or the RaftActorContext and modify the entries in there instead of trying to replace it by using this setter
 141     // Simple assertion that will fail if you do so
 142     // ReplicatedLog log = new ReplicatedLogImpl();
 143     // raftActor.underlyingActor().getRaftActorContext().setReplicatedLog(log);
 144     // assertEquals(log, raftActor.underlyingActor().getReplicatedLog())
 145     public void setReplicatedLog(ReplicatedLog replicatedLog) {
 146         this.replicatedLog = replicatedLog;
 147     }
 148
 149     @Override public ReplicatedLog getReplicatedLog() {
 150         return replicatedLog;
 151     }
 152
 153     @Override public ActorSystem getActorSystem() {
 154         return this.system;
 155     }
 156
 157     @Override public Logger getLogger() {
 158         return LoggerFactory.getLogger(getClass());
 159     }
 160
 161     @Override public Map<String, String> getPeerAddresses() {
 162         return peerAddresses;
 163     }
 164
 165     @Override public String getPeerAddress(String peerId) {
 166         return peerAddresses.get(peerId);
 167     }
 168
 169     @Override public void addToPeers(String name, String address) {
 170         peerAddresses.put(name, address);
 171     }
 172
 173     @Override public void removePeer(String name) {
 174         peerAddresses.remove(name);
 175     }
 176
 177     @Override public ActorSelection getPeerActorSelection(String peerId) {
 178         String peerAddress = getPeerAddress(peerId);
 179         if(peerAddress != null){
 180             return actorSelection(peerAddress);
 181         }
 182         return null;
 183     }
 184
 185     @Override public void setPeerAddress(String peerId, String peerAddress) {
 186         Preconditions.checkState(peerAddresses.containsKey(peerId));
 187         peerAddresses.put(peerId, peerAddress);
 188     }
 189
 190     public void setPeerAddresses(Map<String, String> peerAddresses) {
 191         this.peerAddresses = peerAddresses;
 192     }
 193
 194     @Override
 195     public ConfigParams getConfigParams() {
 196         return configParams;
 197     }
 198
 199     @Override
 200     public SnapshotManager getSnapshotManager() {
 201         if(this.snapshotManager == null){
 202             this.snapshotManager = new SnapshotManager(this, getLogger());
 203             this.snapshotManager.setCreateSnapshotCallable(NoopProcedure.<Void>instance());
 204         }
 205         return this.snapshotManager;
 206     }
 207
 208     public void setConfigParams(ConfigParams configParams) {
 209         this.configParams = configParams;
 210     }
 211
 212     @Override
 213     public long getTotalMemory() {
 214         return Runtime.getRuntime().totalMemory();
 215     }
 216
 217     @Override
 218     public void setTotalMemoryRetriever(Supplier<Long> retriever) {
 219     }
 220
 221     @Override
 222     public boolean hasFollowers() {
 223         return getPeerAddresses().keySet().size() > 0;
 224     }
 225
 226     @Override
 227     public DataPersistenceProvider getPersistenceProvider() {
 228         return persistenceProvider;
 229     }
 230
 231     public void setPersistenceProvider(DataPersistenceProvider persistenceProvider) {
 232         this.persistenceProvider = persistenceProvider;
 233     }
 234
 235     public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
 236         @Override public void appendAndPersist(
 237             ReplicatedLogEntry replicatedLogEntry) {
 238             append(replicatedLogEntry);
 239         }
 240
 241         @Override
 242         public int dataSize() {
 243             return -1;
 244         }
 245
 246         @Override public void removeFromAndPersist(long index) {
 247             removeFrom(index);
 248         }
 249
 250         @Override
 251         public void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback) {
 252             append(replicatedLogEntry);
 253
 254             if(callback != null) {
 255                 try {
 256                     callback.apply(replicatedLogEntry);
 257                 } catch (Exception e) {
 258                     e.printStackTrace();
 259                 }
 260             }
 261         }
 262     }
 263
 264     public static class MockPayload extends Payload implements Serializable {
 265         private static final long serialVersionUID = 3121380393130864247L;
 266         private String value = "";
 267         private int size;
 268
 269         public MockPayload() {
 270         }
 271
 272         public MockPayload(String s) {
 273             this.value = s;
 274             size = value.length();
 275         }
 276
 277         public MockPayload(String s, int size) {
 278             this(s);
 279             this.size = size;
 280         }
 281
 282         @Override public Map<GeneratedMessage.GeneratedExtension<?, ?>, String> encode() {
 283             Map<GeneratedMessage.GeneratedExtension<?, ?>, String> map = new HashMap<>();
 284             map.put(MockPayloadMessages.value, value);
 285             return map;
 286         }
 287
 288         @Override public Payload decode(
 289             AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
 290             String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
 291             this.value = value;
 292             return this;
 293         }
 294
 295         @Override
 296         public int size() {
 297             return size;
 298         }
 299
 300         @Override public String getClientPayloadClassName() {
 301             return MockPayload.class.getName();
 302         }
 303
 304         @Override
 305         public String toString() {
 306             return value;
 307         }
 308
 309         @Override
 310         public int hashCode() {
 311             final int prime = 31;
 312             int result = 1;
 313             result = prime * result + ((value == null) ? 0 : value.hashCode());
 314             return result;
 315         }
 316
 317         @Override
 318         public boolean equals(Object obj) {
 319             if (this == obj) {
 320                 return true;
 321             }
 322             if (obj == null) {
 323                 return false;
 324             }
 325             if (getClass() != obj.getClass()) {
 326                 return false;
 327             }
 328             MockPayload other = (MockPayload) obj;
 329             if (value == null) {
 330                 if (other.value != null) {
 331                     return false;
 332                 }
 333             } else if (!value.equals(other.value)) {
 334                 return false;
 335             }
 336             return true;
 337         }
 338     }
 339
 340     public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
 341         private static final long serialVersionUID = 1L;
 342
 343         private final long term;
 344         private final long index;
 345         private final Payload data;
 346
 347         public MockReplicatedLogEntry(long term, long index, Payload data){
 348
 349             this.term = term;
 350             this.index = index;
 351             this.data = data;
 352         }
 353
 354         @Override public Payload getData() {
 355             return data;
 356         }
 357
 358         @Override public long getTerm() {
 359             return term;
 360         }
 361
 362         @Override public long getIndex() {
 363             return index;
 364         }
 365
 366         @Override
 367         public int size() {
 368             return getData().size();
 369         }
 370
 371         @Override
 372         public int hashCode() {
 373             final int prime = 31;
 374             int result = 1;
 375             result = prime * result + ((data == null) ? 0 : data.hashCode());
 376             result = prime * result + (int) (index ^ (index >>> 32));
 377             result = prime * result + (int) (term ^ (term >>> 32));
 378             return result;
 379         }
 380
 381         @Override
 382         public boolean equals(Object obj) {
 383             if (this == obj) {
 384                 return true;
 385             }
 386             if (obj == null) {
 387                 return false;
 388             }
 389             if (getClass() != obj.getClass()) {
 390                 return false;
 391             }
 392             MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
 393             if (data == null) {
 394                 if (other.data != null) {
 395                     return false;
 396                 }
 397             } else if (!data.equals(other.data)) {
 398                 return false;
 399             }
 400             if (index != other.index) {
 401                 return false;
 402             }
 403             if (term != other.term) {
 404                 return false;
 405             }
 406             return true;
 407         }
 408
 409         @Override
 410         public String toString() {
 411             StringBuilder builder = new StringBuilder();
 412             builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
 413                     .append(", data=").append(data).append("]");
 414             return builder.toString();
 415         }
 416     }
 417
 418     public static class MockReplicatedLogBuilder {
 419         private final ReplicatedLog mockLog = new SimpleReplicatedLog();
 420
 421         public  MockReplicatedLogBuilder createEntries(int start, int end, int term) {
 422             for (int i=start; i<end; i++) {
 423                 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
 424             }
 425             return this;
 426         }
 427
 428         public  MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
 429             this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
 430             return this;
 431         }
 432
 433         public ReplicatedLog build() {
 434             return this.mockLog;
 435         }
 436     }
 437 }