2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.controller.cluster.raft;
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;
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;
26 public class MockRaftActorContext implements RaftActorContext {
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;
39 public MockRaftActorContext(){
40 electionTerm = new ElectionTerm() {
41 private long currentTerm = 1;
42 private String votedFor = "";
45 public long getCurrentTerm() {
50 public String getVotedFor() {
55 public void update(long currentTerm, String votedFor){
56 this.currentTerm = currentTerm;
57 this.votedFor = votedFor;
59 // TODO : Write to some persistent state
62 @Override public void updateAndPersist(long currentTerm,
64 update(currentTerm, votedFor);
68 configParams = new DefaultConfigParamsImpl();
71 public MockRaftActorContext(String id, ActorSystem system, ActorRef actor){
81 public void initReplicatedLog(){
82 this.replicatedLog = new SimpleReplicatedLog();
83 long term = getTermInformation().getCurrentTerm();
84 this.replicatedLog.append(new MockReplicatedLogEntry(term, 0, new MockPayload("1")));
85 this.replicatedLog.append(new MockReplicatedLogEntry(term, 1, new MockPayload("2")));
88 @Override public ActorRef actorOf(Props props) {
89 return system.actorOf(props);
92 @Override public ActorSelection actorSelection(String path) {
93 return system.actorSelection(path);
96 @Override public String getId() {
100 @Override public ActorRef getActor() {
104 @Override public ElectionTerm getTermInformation() {
108 public void setIndex(long index){
112 @Override public long getCommitIndex() {
116 @Override public void setCommitIndex(long commitIndex) {
117 this.index = commitIndex;
120 @Override public void setLastApplied(long lastApplied){
121 this.lastApplied = lastApplied;
124 @Override public long getLastApplied() {
129 // FIXME : A lot of tests try to manipulate the replicated log by setting it using this method
130 // This is OK to do if the underlyingActor is not RafActor or a derived class. If not then you should not
131 // used this way to manipulate the log because the RaftActor actually has a field replicatedLog
132 // which it creates internally and sets on the RaftActorContext
133 // The only right way to manipulate the replicated log therefore is to get it from either the RaftActor
134 // or the RaftActorContext and modify the entries in there instead of trying to replace it by using this setter
135 // Simple assertion that will fail if you do so
136 // ReplicatedLog log = new ReplicatedLogImpl();
137 // raftActor.underlyingActor().getRaftActorContext().setReplicatedLog(log);
138 // assertEquals(log, raftActor.underlyingActor().getReplicatedLog())
139 public void setReplicatedLog(ReplicatedLog replicatedLog) {
140 this.replicatedLog = replicatedLog;
143 @Override public ReplicatedLog getReplicatedLog() {
144 return replicatedLog;
147 @Override public ActorSystem getActorSystem() {
151 @Override public Logger getLogger() {
152 return LoggerFactory.getLogger(getClass());
155 @Override public Map<String, String> getPeerAddresses() {
156 return peerAddresses;
159 @Override public String getPeerAddress(String peerId) {
160 return peerAddresses.get(peerId);
163 @Override public void addToPeers(String name, String address) {
164 peerAddresses.put(name, address);
167 @Override public void removePeer(String name) {
168 peerAddresses.remove(name);
171 @Override public ActorSelection getPeerActorSelection(String peerId) {
172 String peerAddress = getPeerAddress(peerId);
173 if(peerAddress != null){
174 return actorSelection(peerAddress);
179 @Override public void setPeerAddress(String peerId, String peerAddress) {
180 Preconditions.checkState(peerAddresses.containsKey(peerId));
181 peerAddresses.put(peerId, peerAddress);
184 public void setPeerAddresses(Map<String, String> peerAddresses) {
185 this.peerAddresses = peerAddresses;
189 public ConfigParams getConfigParams() {
194 public void setSnapshotCaptureInitiated(boolean snapshotCaptureInitiated) {
195 this.snapshotCaptureInitiated = snapshotCaptureInitiated;
199 public boolean isSnapshotCaptureInitiated() {
200 return snapshotCaptureInitiated;
203 public void setConfigParams(ConfigParams configParams) {
204 this.configParams = configParams;
207 public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
208 @Override public void appendAndPersist(
209 ReplicatedLogEntry replicatedLogEntry) {
210 append(replicatedLogEntry);
214 public int dataSize() {
218 @Override public void removeFromAndPersist(long index) {
223 public static class MockPayload extends Payload implements Serializable {
224 private static final long serialVersionUID = 3121380393130864247L;
225 private String value = "";
227 public MockPayload(){
231 public MockPayload(String s) {
235 @Override public Map<GeneratedMessage.GeneratedExtension, String> encode() {
236 Map<GeneratedMessage.GeneratedExtension, String> map = new HashMap<GeneratedMessage.GeneratedExtension, String>();
237 map.put(MockPayloadMessages.value, value);
241 @Override public Payload decode(
242 AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
243 String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
250 return value.length();
253 @Override public String getClientPayloadClassName() {
254 return MockPayload.class.getName();
258 public String toString() {
263 public int hashCode() {
264 final int prime = 31;
266 result = prime * result + ((value == null) ? 0 : value.hashCode());
271 public boolean equals(Object obj) {
278 if (getClass() != obj.getClass()) {
281 MockPayload other = (MockPayload) obj;
283 if (other.value != null) {
286 } else if (!value.equals(other.value)) {
293 public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
294 private static final long serialVersionUID = 1L;
296 private final long term;
297 private final long index;
298 private final Payload data;
300 public MockReplicatedLogEntry(long term, long index, Payload data){
307 @Override public Payload getData() {
311 @Override public long getTerm() {
315 @Override public long getIndex() {
321 return getData().size();
325 public int hashCode() {
326 final int prime = 31;
328 result = prime * result + ((data == null) ? 0 : data.hashCode());
329 result = prime * result + (int) (index ^ (index >>> 32));
330 result = prime * result + (int) (term ^ (term >>> 32));
335 public boolean equals(Object obj) {
342 if (getClass() != obj.getClass()) {
345 MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
347 if (other.data != null) {
350 } else if (!data.equals(other.data)) {
353 if (index != other.index) {
356 if (term != other.term) {
363 public String toString() {
364 StringBuilder builder = new StringBuilder();
365 builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
366 .append(", data=").append(data).append("]");
367 return builder.toString();
371 public static class MockReplicatedLogBuilder {
372 private final ReplicatedLog mockLog = new SimpleReplicatedLog();
374 public MockReplicatedLogBuilder createEntries(int start, int end, int term) {
375 for (int i=start; i<end; i++) {
376 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
381 public MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
382 this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
386 public ReplicatedLog build() {