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