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.event.Logging;
  16 import akka.event.LoggingAdapter;
  17 import com.google.common.base.Preconditions;
  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
  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 = 0;
  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         this.replicatedLog.append(new MockReplicatedLogEntry(1, 1, new MockPayload("")));
  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     public void setReplicatedLog(ReplicatedLog replicatedLog) {
 136         this.replicatedLog = replicatedLog;
 137     }
 138
 139     @Override public ReplicatedLog getReplicatedLog() {
 140         return replicatedLog;
 141     }
 142
 143     @Override public ActorSystem getActorSystem() {
 144         return this.system;
 145     }
 146
 147     @Override public LoggingAdapter getLogger() {
 148         return Logging.getLogger(system, this);
 149     }
 150
 151     @Override public Map<String, String> getPeerAddresses() {
 152         return peerAddresses;
 153     }
 154
 155     @Override public String getPeerAddress(String peerId) {
 156         return peerAddresses.get(peerId);
 157     }
 158
 159     @Override public void addToPeers(String name, String address) {
 160         peerAddresses.put(name, address);
 161     }
 162
 163     @Override public void removePeer(String name) {
 164         peerAddresses.remove(name);
 165     }
 166
 167     @Override public ActorSelection getPeerActorSelection(String peerId) {
 168         String peerAddress = getPeerAddress(peerId);
 169         if(peerAddress != null){
 170             return actorSelection(peerAddress);
 171         }
 172         return null;
 173     }
 174
 175     @Override public void setPeerAddress(String peerId, String peerAddress) {
 176         Preconditions.checkState(peerAddresses.containsKey(peerId));
 177         peerAddresses.put(peerId, peerAddress);
 178     }
 179
 180     public void setPeerAddresses(Map<String, String> peerAddresses) {
 181         this.peerAddresses = peerAddresses;
 182     }
 183
 184     @Override
 185     public ConfigParams getConfigParams() {
 186         return configParams;
 187     }
 188
 189     @Override
 190     public void setSnapshotCaptureInitiated(boolean snapshotCaptureInitiated) {
 191         this.snapshotCaptureInitiated = snapshotCaptureInitiated;
 192     }
 193
 194     @Override
 195     public boolean isSnapshotCaptureInitiated() {
 196         return snapshotCaptureInitiated;
 197     }
 198
 199     public void setConfigParams(ConfigParams configParams) {
 200         this.configParams = configParams;
 201     }
 202
 203     public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
 204         @Override public void appendAndPersist(
 205             ReplicatedLogEntry replicatedLogEntry) {
 206             append(replicatedLogEntry);
 207         }
 208
 209         @Override
 210         public int dataSize() {
 211             return -1;
 212         }
 213
 214         @Override public void removeFromAndPersist(long index) {
 215             removeFrom(index);
 216         }
 217     }
 218
 219     public static class MockPayload extends Payload implements Serializable {
 220         private static final long serialVersionUID = 3121380393130864247L;
 221         private String value = "";
 222
 223         public MockPayload(){
 224
 225         }
 226
 227         public MockPayload(String s) {
 228             this.value = s;
 229         }
 230
 231         @Override public  Map<GeneratedMessage.GeneratedExtension, String> encode() {
 232             Map<GeneratedMessage.GeneratedExtension, String> map = new HashMap<GeneratedMessage.GeneratedExtension, String>();
 233             map.put(MockPayloadMessages.value, value);
 234             return map;
 235         }
 236
 237         @Override public Payload decode(
 238             AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
 239             String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
 240             this.value = value;
 241             return this;
 242         }
 243
 244         @Override
 245         public int size() {
 246             return value.length();
 247         }
 248
 249         @Override public String getClientPayloadClassName() {
 250             return MockPayload.class.getName();
 251         }
 252
 253         @Override
 254         public String toString() {
 255             return value;
 256         }
 257     }
 258
 259     public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
 260         private static final long serialVersionUID = 1L;
 261
 262         private final long term;
 263         private final long index;
 264         private final Payload data;
 265
 266         public MockReplicatedLogEntry(long term, long index, Payload data){
 267
 268             this.term = term;
 269             this.index = index;
 270             this.data = data;
 271         }
 272
 273         @Override public Payload getData() {
 274             return data;
 275         }
 276
 277         @Override public long getTerm() {
 278             return term;
 279         }
 280
 281         @Override public long getIndex() {
 282             return index;
 283         }
 284
 285         @Override
 286         public int size() {
 287             return getData().size();
 288         }
 289     }
 290
 291     public static class MockReplicatedLogBuilder {
 292         private final ReplicatedLog mockLog = new SimpleReplicatedLog();
 293
 294         public  MockReplicatedLogBuilder createEntries(int start, int end, int term) {
 295             for (int i=start; i<end; i++) {
 296                 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
 297             }
 298             return this;
 299         }
 300
 301         public  MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
 302             this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
 303             return this;
 304         }
 305
 306         public ReplicatedLog build() {
 307             return this.mockLog;
 308         }
 309     }
 310 }