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 = 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, 0, new MockPayload("1")));
  92         this.replicatedLog.append(new MockReplicatedLogEntry(1, 1, new MockPayload("2")));
  93     }
  94
  95     @Override public ActorRef actorOf(Props props) {
  96         return system.actorOf(props);
  97     }
  98
  99     @Override public ActorSelection actorSelection(String path) {
 100         return system.actorSelection(path);
 101     }
 102
 103     @Override public String getId() {
 104         return id;
 105     }
 106
 107     @Override public ActorRef getActor() {
 108         return actor;
 109     }
 110
 111     @Override public ElectionTerm getTermInformation() {
 112         return electionTerm;
 113     }
 114
 115     public void setIndex(long index){
 116         this.index = index;
 117     }
 118
 119     @Override public long getCommitIndex() {
 120         return index;
 121     }
 122
 123     @Override public void setCommitIndex(long commitIndex) {
 124         this.index = commitIndex;
 125     }
 126
 127     @Override public void setLastApplied(long lastApplied){
 128         this.lastApplied = lastApplied;
 129     }
 130
 131     @Override public long getLastApplied() {
 132         return lastApplied;
 133     }
 134
 135     @Override
 136     public void setReplicatedLog(ReplicatedLog replicatedLog) {
 137         this.replicatedLog = replicatedLog;
 138     }
 139
 140     @Override public ReplicatedLog getReplicatedLog() {
 141         return replicatedLog;
 142     }
 143
 144     @Override public ActorSystem getActorSystem() {
 145         return this.system;
 146     }
 147
 148     @Override public Logger getLogger() {
 149         return LoggerFactory.getLogger(getClass());
 150     }
 151
 152     @Override public Map<String, String> getPeerAddresses() {
 153         return peerAddresses;
 154     }
 155
 156     @Override public String getPeerAddress(String peerId) {
 157         return peerAddresses.get(peerId);
 158     }
 159
 160     @Override public void addToPeers(String name, String address) {
 161         peerAddresses.put(name, address);
 162     }
 163
 164     @Override public void removePeer(String name) {
 165         peerAddresses.remove(name);
 166     }
 167
 168     @Override public ActorSelection getPeerActorSelection(String peerId) {
 169         String peerAddress = getPeerAddress(peerId);
 170         if(peerAddress != null){
 171             return actorSelection(peerAddress);
 172         }
 173         return null;
 174     }
 175
 176     @Override public void setPeerAddress(String peerId, String peerAddress) {
 177         Preconditions.checkState(peerAddresses.containsKey(peerId));
 178         peerAddresses.put(peerId, peerAddress);
 179     }
 180
 181     public void setPeerAddresses(Map<String, String> peerAddresses) {
 182         this.peerAddresses = peerAddresses;
 183     }
 184
 185     @Override
 186     public ConfigParams getConfigParams() {
 187         return configParams;
 188     }
 189
 190     @Override
 191     public void setSnapshotCaptureInitiated(boolean snapshotCaptureInitiated) {
 192         this.snapshotCaptureInitiated = snapshotCaptureInitiated;
 193     }
 194
 195     @Override
 196     public boolean isSnapshotCaptureInitiated() {
 197         return snapshotCaptureInitiated;
 198     }
 199
 200     public void setConfigParams(ConfigParams configParams) {
 201         this.configParams = configParams;
 202     }
 203
 204     public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
 205         @Override public void appendAndPersist(
 206             ReplicatedLogEntry replicatedLogEntry) {
 207             append(replicatedLogEntry);
 208         }
 209
 210         @Override
 211         public int dataSize() {
 212             return -1;
 213         }
 214
 215         @Override public void removeFromAndPersist(long index) {
 216             removeFrom(index);
 217         }
 218     }
 219
 220     public static class MockPayload extends Payload implements Serializable {
 221         private static final long serialVersionUID = 3121380393130864247L;
 222         private String value = "";
 223
 224         public MockPayload(){
 225
 226         }
 227
 228         public MockPayload(String s) {
 229             this.value = s;
 230         }
 231
 232         @Override public  Map<GeneratedMessage.GeneratedExtension, String> encode() {
 233             Map<GeneratedMessage.GeneratedExtension, String> map = new HashMap<GeneratedMessage.GeneratedExtension, String>();
 234             map.put(MockPayloadMessages.value, value);
 235             return map;
 236         }
 237
 238         @Override public Payload decode(
 239             AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
 240             String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
 241             this.value = value;
 242             return this;
 243         }
 244
 245         @Override
 246         public int size() {
 247             return value.length();
 248         }
 249
 250         @Override public String getClientPayloadClassName() {
 251             return MockPayload.class.getName();
 252         }
 253
 254         @Override
 255         public String toString() {
 256             return value;
 257         }
 258     }
 259
 260     public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
 261         private static final long serialVersionUID = 1L;
 262
 263         private final long term;
 264         private final long index;
 265         private final Payload data;
 266
 267         public MockReplicatedLogEntry(long term, long index, Payload data){
 268
 269             this.term = term;
 270             this.index = index;
 271             this.data = data;
 272         }
 273
 274         @Override public Payload getData() {
 275             return data;
 276         }
 277
 278         @Override public long getTerm() {
 279             return term;
 280         }
 281
 282         @Override public long getIndex() {
 283             return index;
 284         }
 285
 286         @Override
 287         public int size() {
 288             return getData().size();
 289         }
 290     }
 291
 292     public static class MockReplicatedLogBuilder {
 293         private final ReplicatedLog mockLog = new SimpleReplicatedLog();
 294
 295         public  MockReplicatedLogBuilder createEntries(int start, int end, int term) {
 296             for (int i=start; i<end; i++) {
 297                 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
 298             }
 299             return this;
 300         }
 301
 302         public  MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
 303             this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
 304             return this;
 305         }
 306
 307         public ReplicatedLog build() {
 308             return this.mockLog;
 309         }
 310     }
 311 }