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;
38 private SnapshotManager snapshotManager;
40 public MockRaftActorContext(){
41 electionTerm = new ElectionTerm() {
42 private long currentTerm = 1;
43 private String votedFor = "";
46 public long getCurrentTerm() {
51 public String getVotedFor() {
56 public void update(long currentTerm, String votedFor){
57 this.currentTerm = currentTerm;
58 this.votedFor = votedFor;
60 // TODO : Write to some persistent state
63 @Override public void updateAndPersist(long currentTerm,
65 update(currentTerm, votedFor);
69 configParams = new DefaultConfigParamsImpl();
72 public MockRaftActorContext(String id, ActorSystem system, ActorRef actor){
82 public void initReplicatedLog(){
83 this.replicatedLog = new SimpleReplicatedLog();
84 long term = getTermInformation().getCurrentTerm();
85 this.replicatedLog.append(new MockReplicatedLogEntry(term, 0, new MockPayload("1")));
86 this.replicatedLog.append(new MockReplicatedLogEntry(term, 1, new MockPayload("2")));
89 @Override public ActorRef actorOf(Props props) {
90 return system.actorOf(props);
93 @Override public ActorSelection actorSelection(String path) {
94 return system.actorSelection(path);
97 @Override public String getId() {
101 @Override public ActorRef getActor() {
105 @Override public ElectionTerm getTermInformation() {
109 public void setIndex(long index){
113 @Override public long getCommitIndex() {
117 @Override public void setCommitIndex(long commitIndex) {
118 this.index = commitIndex;
121 @Override public void setLastApplied(long lastApplied){
122 this.lastApplied = lastApplied;
125 @Override public long getLastApplied() {
130 // FIXME : A lot of tests try to manipulate the replicated log by setting it using this method
131 // This is OK to do if the underlyingActor is not RafActor or a derived class. If not then you should not
132 // used this way to manipulate the log because the RaftActor actually has a field replicatedLog
133 // which it creates internally and sets on the RaftActorContext
134 // The only right way to manipulate the replicated log therefore is to get it from either the RaftActor
135 // or the RaftActorContext and modify the entries in there instead of trying to replace it by using this setter
136 // Simple assertion that will fail if you do so
137 // ReplicatedLog log = new ReplicatedLogImpl();
138 // raftActor.underlyingActor().getRaftActorContext().setReplicatedLog(log);
139 // assertEquals(log, raftActor.underlyingActor().getReplicatedLog())
140 public void setReplicatedLog(ReplicatedLog replicatedLog) {
141 this.replicatedLog = replicatedLog;
144 @Override public ReplicatedLog getReplicatedLog() {
145 return replicatedLog;
148 @Override public ActorSystem getActorSystem() {
152 @Override public Logger getLogger() {
153 return LoggerFactory.getLogger(getClass());
156 @Override public Map<String, String> getPeerAddresses() {
157 return peerAddresses;
160 @Override public String getPeerAddress(String peerId) {
161 return peerAddresses.get(peerId);
164 @Override public void addToPeers(String name, String address) {
165 peerAddresses.put(name, address);
168 @Override public void removePeer(String name) {
169 peerAddresses.remove(name);
172 @Override public ActorSelection getPeerActorSelection(String peerId) {
173 String peerAddress = getPeerAddress(peerId);
174 if(peerAddress != null){
175 return actorSelection(peerAddress);
180 @Override public void setPeerAddress(String peerId, String peerAddress) {
181 Preconditions.checkState(peerAddresses.containsKey(peerId));
182 peerAddresses.put(peerId, peerAddress);
185 public void setPeerAddresses(Map<String, String> peerAddresses) {
186 this.peerAddresses = peerAddresses;
190 public ConfigParams getConfigParams() {
195 public SnapshotManager getSnapshotManager() {
196 if(this.snapshotManager == null){
197 this.snapshotManager = new SnapshotManager(this, getLogger());
199 return this.snapshotManager;
202 public void setConfigParams(ConfigParams configParams) {
203 this.configParams = configParams;
206 public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
207 @Override public void appendAndPersist(
208 ReplicatedLogEntry replicatedLogEntry) {
209 append(replicatedLogEntry);
213 public int dataSize() {
217 @Override public void removeFromAndPersist(long index) {
222 public static class MockPayload extends Payload implements Serializable {
223 private static final long serialVersionUID = 3121380393130864247L;
224 private String value = "";
227 public MockPayload() {
230 public MockPayload(String s) {
232 size = value.length();
235 public MockPayload(String s, int size) {
240 @Override public Map<GeneratedMessage.GeneratedExtension, String> encode() {
241 Map<GeneratedMessage.GeneratedExtension, String> map = new HashMap<GeneratedMessage.GeneratedExtension, String>();
242 map.put(MockPayloadMessages.value, value);
246 @Override public Payload decode(
247 AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
248 String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
258 @Override public String getClientPayloadClassName() {
259 return MockPayload.class.getName();
263 public String toString() {
268 public int hashCode() {
269 final int prime = 31;
271 result = prime * result + ((value == null) ? 0 : value.hashCode());
276 public boolean equals(Object obj) {
283 if (getClass() != obj.getClass()) {
286 MockPayload other = (MockPayload) obj;
288 if (other.value != null) {
291 } else if (!value.equals(other.value)) {
298 public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
299 private static final long serialVersionUID = 1L;
301 private final long term;
302 private final long index;
303 private final Payload data;
305 public MockReplicatedLogEntry(long term, long index, Payload data){
312 @Override public Payload getData() {
316 @Override public long getTerm() {
320 @Override public long getIndex() {
326 return getData().size();
330 public int hashCode() {
331 final int prime = 31;
333 result = prime * result + ((data == null) ? 0 : data.hashCode());
334 result = prime * result + (int) (index ^ (index >>> 32));
335 result = prime * result + (int) (term ^ (term >>> 32));
340 public boolean equals(Object obj) {
347 if (getClass() != obj.getClass()) {
350 MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
352 if (other.data != null) {
355 } else if (!data.equals(other.data)) {
358 if (index != other.index) {
361 if (term != other.term) {
368 public String toString() {
369 StringBuilder builder = new StringBuilder();
370 builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
371 .append(", data=").append(data).append("]");
372 return builder.toString();
376 public static class MockReplicatedLogBuilder {
377 private final ReplicatedLog mockLog = new SimpleReplicatedLog();
379 public MockReplicatedLogBuilder createEntries(int start, int end, int term) {
380 for (int i=start; i<end; i++) {
381 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
386 public MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
387 this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
391 public ReplicatedLog build() {