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 akka.japi.Procedure;
16 import com.google.common.base.Preconditions;
17 import com.google.common.base.Supplier;
18 import com.google.protobuf.GeneratedMessage;
19 import java.io.Serializable;
20 import java.util.HashMap;
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 import org.slf4j.Logger;
26 import org.slf4j.LoggerFactory;
28 public class MockRaftActorContext implements RaftActorContext {
31 private ActorSystem system;
32 private ActorRef actor;
33 private long index = 0;
34 private long lastApplied = 0;
35 private final ElectionTerm electionTerm;
36 private ReplicatedLog replicatedLog;
37 private Map<String, String> peerAddresses = new HashMap<>();
38 private ConfigParams configParams;
39 private boolean snapshotCaptureInitiated;
40 private SnapshotManager snapshotManager;
42 public MockRaftActorContext(){
43 electionTerm = new ElectionTerm() {
44 private long currentTerm = 1;
45 private String votedFor = "";
48 public long getCurrentTerm() {
53 public String getVotedFor() {
58 public void update(long currentTerm, String votedFor){
59 this.currentTerm = currentTerm;
60 this.votedFor = votedFor;
62 // TODO : Write to some persistent state
65 @Override public void updateAndPersist(long currentTerm,
67 update(currentTerm, votedFor);
71 configParams = new DefaultConfigParamsImpl();
74 public MockRaftActorContext(String id, ActorSystem system, ActorRef actor){
84 public void initReplicatedLog(){
85 this.replicatedLog = new SimpleReplicatedLog();
86 long term = getTermInformation().getCurrentTerm();
87 this.replicatedLog.append(new MockReplicatedLogEntry(term, 0, new MockPayload("1")));
88 this.replicatedLog.append(new MockReplicatedLogEntry(term, 1, new MockPayload("2")));
91 @Override public ActorRef actorOf(Props props) {
92 return system.actorOf(props);
95 @Override public ActorSelection actorSelection(String path) {
96 return system.actorSelection(path);
99 @Override public String getId() {
103 @Override public ActorRef getActor() {
107 @Override public ElectionTerm getTermInformation() {
111 public void setIndex(long index){
115 @Override public long getCommitIndex() {
119 @Override public void setCommitIndex(long commitIndex) {
120 this.index = commitIndex;
123 @Override public void setLastApplied(long lastApplied){
124 this.lastApplied = lastApplied;
127 @Override public long getLastApplied() {
132 // FIXME : A lot of tests try to manipulate the replicated log by setting it using this method
133 // This is OK to do if the underlyingActor is not RafActor or a derived class. If not then you should not
134 // used this way to manipulate the log because the RaftActor actually has a field replicatedLog
135 // which it creates internally and sets on the RaftActorContext
136 // The only right way to manipulate the replicated log therefore is to get it from either the RaftActor
137 // or the RaftActorContext and modify the entries in there instead of trying to replace it by using this setter
138 // Simple assertion that will fail if you do so
139 // ReplicatedLog log = new ReplicatedLogImpl();
140 // raftActor.underlyingActor().getRaftActorContext().setReplicatedLog(log);
141 // assertEquals(log, raftActor.underlyingActor().getReplicatedLog())
142 public void setReplicatedLog(ReplicatedLog replicatedLog) {
143 this.replicatedLog = replicatedLog;
146 @Override public ReplicatedLog getReplicatedLog() {
147 return replicatedLog;
150 @Override public ActorSystem getActorSystem() {
154 @Override public Logger getLogger() {
155 return LoggerFactory.getLogger(getClass());
158 @Override public Map<String, String> getPeerAddresses() {
159 return peerAddresses;
162 @Override public String getPeerAddress(String peerId) {
163 return peerAddresses.get(peerId);
166 @Override public void addToPeers(String name, String address) {
167 peerAddresses.put(name, address);
170 @Override public void removePeer(String name) {
171 peerAddresses.remove(name);
174 @Override public ActorSelection getPeerActorSelection(String peerId) {
175 String peerAddress = getPeerAddress(peerId);
176 if(peerAddress != null){
177 return actorSelection(peerAddress);
182 @Override public void setPeerAddress(String peerId, String peerAddress) {
183 Preconditions.checkState(peerAddresses.containsKey(peerId));
184 peerAddresses.put(peerId, peerAddress);
187 public void setPeerAddresses(Map<String, String> peerAddresses) {
188 this.peerAddresses = peerAddresses;
192 public ConfigParams getConfigParams() {
197 public SnapshotManager getSnapshotManager() {
198 if(this.snapshotManager == null){
199 this.snapshotManager = new SnapshotManager(this, getLogger());
201 return this.snapshotManager;
204 public void setConfigParams(ConfigParams configParams) {
205 this.configParams = configParams;
209 public long getTotalMemory() {
210 return Runtime.getRuntime().totalMemory();
214 public void setTotalMemoryRetriever(Supplier<Long> retriever) {
218 public boolean hasFollowers() {
219 return getPeerAddresses().keySet().size() > 0;
222 public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
223 @Override public void appendAndPersist(
224 ReplicatedLogEntry replicatedLogEntry) {
225 append(replicatedLogEntry);
229 public int dataSize() {
233 @Override public void removeFromAndPersist(long index) {
238 public void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback) {
239 append(replicatedLogEntry);
241 if(callback != null) {
243 callback.apply(replicatedLogEntry);
244 } catch (Exception e) {
251 public static class MockPayload extends Payload implements Serializable {
252 private static final long serialVersionUID = 3121380393130864247L;
253 private String value = "";
256 public MockPayload() {
259 public MockPayload(String s) {
261 size = value.length();
264 public MockPayload(String s, int size) {
269 @Override public Map<GeneratedMessage.GeneratedExtension<?, ?>, String> encode() {
270 Map<GeneratedMessage.GeneratedExtension<?, ?>, String> map = new HashMap<>();
271 map.put(MockPayloadMessages.value, value);
275 @Override public Payload decode(
276 AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
277 String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
287 @Override public String getClientPayloadClassName() {
288 return MockPayload.class.getName();
292 public String toString() {
297 public int hashCode() {
298 final int prime = 31;
300 result = prime * result + ((value == null) ? 0 : value.hashCode());
305 public boolean equals(Object obj) {
312 if (getClass() != obj.getClass()) {
315 MockPayload other = (MockPayload) obj;
317 if (other.value != null) {
320 } else if (!value.equals(other.value)) {
327 public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
328 private static final long serialVersionUID = 1L;
330 private final long term;
331 private final long index;
332 private final Payload data;
334 public MockReplicatedLogEntry(long term, long index, Payload data){
341 @Override public Payload getData() {
345 @Override public long getTerm() {
349 @Override public long getIndex() {
355 return getData().size();
359 public int hashCode() {
360 final int prime = 31;
362 result = prime * result + ((data == null) ? 0 : data.hashCode());
363 result = prime * result + (int) (index ^ (index >>> 32));
364 result = prime * result + (int) (term ^ (term >>> 32));
369 public boolean equals(Object obj) {
376 if (getClass() != obj.getClass()) {
379 MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
381 if (other.data != null) {
384 } else if (!data.equals(other.data)) {
387 if (index != other.index) {
390 if (term != other.term) {
397 public String toString() {
398 StringBuilder builder = new StringBuilder();
399 builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
400 .append(", data=").append(data).append("]");
401 return builder.toString();
405 public static class MockReplicatedLogBuilder {
406 private final ReplicatedLog mockLog = new SimpleReplicatedLog();
408 public MockReplicatedLogBuilder createEntries(int start, int end, int term) {
409 for (int i=start; i<end; i++) {
410 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
415 public MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
416 this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
420 public ReplicatedLog build() {