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         }
 204         return this.snapshotManager;
 205     }
 206
 207     public void setConfigParams(ConfigParams configParams) {
 208         this.configParams = configParams;
 209     }
 210
 211     @Override
 212     public long getTotalMemory() {
 213         return Runtime.getRuntime().totalMemory();
 214     }
 215
 216     @Override
 217     public void setTotalMemoryRetriever(Supplier<Long> retriever) {
 218     }
 219
 220     @Override
 221     public boolean hasFollowers() {
 222         return getPeerAddresses().keySet().size() > 0;
 223     }
 224
 225     @Override
 226     public DataPersistenceProvider getPersistenceProvider() {
 227         return persistenceProvider;
 228     }
 229
 230     public void setPersistenceProvider(DataPersistenceProvider persistenceProvider) {
 231         this.persistenceProvider = persistenceProvider;
 232     }
 233
 234     public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
 235         @Override public void appendAndPersist(
 236             ReplicatedLogEntry replicatedLogEntry) {
 237             append(replicatedLogEntry);
 238         }
 239
 240         @Override
 241         public int dataSize() {
 242             return -1;
 243         }
 244
 245         @Override public void removeFromAndPersist(long index) {
 246             removeFrom(index);
 247         }
 248
 249         @Override
 250         public void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback) {
 251             append(replicatedLogEntry);
 252
 253             if(callback != null) {
 254                 try {
 255                     callback.apply(replicatedLogEntry);
 256                 } catch (Exception e) {
 257                     e.printStackTrace();
 258                 }
 259             }
 260         }
 261     }
 262
 263     public static class MockPayload extends Payload implements Serializable {
 264         private static final long serialVersionUID = 3121380393130864247L;
 265         private String value = "";
 266         private int size;
 267
 268         public MockPayload() {
 269         }
 270
 271         public MockPayload(String s) {
 272             this.value = s;
 273             size = value.length();
 274         }
 275
 276         public MockPayload(String s, int size) {
 277             this(s);
 278             this.size = size;
 279         }
 280
 281         @Override public Map<GeneratedMessage.GeneratedExtension<?, ?>, String> encode() {
 282             Map<GeneratedMessage.GeneratedExtension<?, ?>, String> map = new HashMap<>();
 283             map.put(MockPayloadMessages.value, value);
 284             return map;
 285         }
 286
 287         @Override public Payload decode(
 288             AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
 289             String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
 290             this.value = value;
 291             return this;
 292         }
 293
 294         @Override
 295         public int size() {
 296             return size;
 297         }
 298
 299         @Override public String getClientPayloadClassName() {
 300             return MockPayload.class.getName();
 301         }
 302
 303         @Override
 304         public String toString() {
 305             return value;
 306         }
 307
 308         @Override
 309         public int hashCode() {
 310             final int prime = 31;
 311             int result = 1;
 312             result = prime * result + ((value == null) ? 0 : value.hashCode());
 313             return result;
 314         }
 315
 316         @Override
 317         public boolean equals(Object obj) {
 318             if (this == obj) {
 319                 return true;
 320             }
 321             if (obj == null) {
 322                 return false;
 323             }
 324             if (getClass() != obj.getClass()) {
 325                 return false;
 326             }
 327             MockPayload other = (MockPayload) obj;
 328             if (value == null) {
 329                 if (other.value != null) {
 330                     return false;
 331                 }
 332             } else if (!value.equals(other.value)) {
 333                 return false;
 334             }
 335             return true;
 336         }
 337     }
 338
 339     public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
 340         private static final long serialVersionUID = 1L;
 341
 342         private final long term;
 343         private final long index;
 344         private final Payload data;
 345
 346         public MockReplicatedLogEntry(long term, long index, Payload data){
 347
 348             this.term = term;
 349             this.index = index;
 350             this.data = data;
 351         }
 352
 353         @Override public Payload getData() {
 354             return data;
 355         }
 356
 357         @Override public long getTerm() {
 358             return term;
 359         }
 360
 361         @Override public long getIndex() {
 362             return index;
 363         }
 364
 365         @Override
 366         public int size() {
 367             return getData().size();
 368         }
 369
 370         @Override
 371         public int hashCode() {
 372             final int prime = 31;
 373             int result = 1;
 374             result = prime * result + ((data == null) ? 0 : data.hashCode());
 375             result = prime * result + (int) (index ^ (index >>> 32));
 376             result = prime * result + (int) (term ^ (term >>> 32));
 377             return result;
 378         }
 379
 380         @Override
 381         public boolean equals(Object obj) {
 382             if (this == obj) {
 383                 return true;
 384             }
 385             if (obj == null) {
 386                 return false;
 387             }
 388             if (getClass() != obj.getClass()) {
 389                 return false;
 390             }
 391             MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
 392             if (data == null) {
 393                 if (other.data != null) {
 394                     return false;
 395                 }
 396             } else if (!data.equals(other.data)) {
 397                 return false;
 398             }
 399             if (index != other.index) {
 400                 return false;
 401             }
 402             if (term != other.term) {
 403                 return false;
 404             }
 405             return true;
 406         }
 407
 408         @Override
 409         public String toString() {
 410             StringBuilder builder = new StringBuilder();
 411             builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
 412                     .append(", data=").append(data).append("]");
 413             return builder.toString();
 414         }
 415     }
 416
 417     public static class MockReplicatedLogBuilder {
 418         private final ReplicatedLog mockLog = new SimpleReplicatedLog();
 419
 420         public  MockReplicatedLogBuilder createEntries(int start, int end, int term) {
 421             for (int i=start; i<end; i++) {
 422                 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
 423             }
 424             return this;
 425         }
 426
 427         public  MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
 428             this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
 429             return this;
 430         }
 431
 432         public ReplicatedLog build() {
 433             return this.mockLog;
 434         }
 435     }
 436 }