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