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.DataPersistenceProvider;
23 import org.opendaylight.controller.cluster.NonPersistentDataProvider;
24 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
25 import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages;
26 import org.opendaylight.controller.protobuff.messages.cluster.raft.test.MockPayloadMessages;
27 import org.slf4j.Logger;
28 import org.slf4j.LoggerFactory;
30 public class MockRaftActorContext implements RaftActorContext {
33 private ActorSystem system;
34 private ActorRef actor;
35 private long index = 0;
36 private long lastApplied = 0;
37 private final ElectionTerm electionTerm;
38 private ReplicatedLog replicatedLog;
39 private Map<String, String> peerAddresses = new HashMap<>();
40 private ConfigParams configParams;
41 private boolean snapshotCaptureInitiated;
42 private SnapshotManager snapshotManager;
43 private DataPersistenceProvider persistenceProvider = new NonPersistentDataProvider();
45 public MockRaftActorContext(){
46 electionTerm = new ElectionTerm() {
47 private long currentTerm = 1;
48 private String votedFor = "";
51 public long getCurrentTerm() {
56 public String getVotedFor() {
61 public void update(long currentTerm, String votedFor){
62 this.currentTerm = currentTerm;
63 this.votedFor = votedFor;
65 // TODO : Write to some persistent state
68 @Override public void updateAndPersist(long currentTerm,
70 update(currentTerm, votedFor);
74 configParams = new DefaultConfigParamsImpl();
77 public MockRaftActorContext(String id, ActorSystem system, ActorRef actor){
87 public void initReplicatedLog(){
88 this.replicatedLog = new SimpleReplicatedLog();
89 long term = getTermInformation().getCurrentTerm();
90 this.replicatedLog.append(new MockReplicatedLogEntry(term, 0, new MockPayload("1")));
91 this.replicatedLog.append(new MockReplicatedLogEntry(term, 1, new MockPayload("2")));
94 @Override public ActorRef actorOf(Props props) {
95 return system.actorOf(props);
98 @Override public ActorSelection actorSelection(String path) {
99 return system.actorSelection(path);
102 @Override public String getId() {
106 @Override public ActorRef getActor() {
110 @Override public ElectionTerm getTermInformation() {
114 public void setIndex(long index){
118 @Override public long getCommitIndex() {
122 @Override public void setCommitIndex(long commitIndex) {
123 this.index = commitIndex;
126 @Override public void setLastApplied(long lastApplied){
127 this.lastApplied = lastApplied;
130 @Override public long getLastApplied() {
135 // FIXME : A lot of tests try to manipulate the replicated log by setting it using this method
136 // This is OK to do if the underlyingActor is not RafActor or a derived class. If not then you should not
137 // used this way to manipulate the log because the RaftActor actually has a field replicatedLog
138 // which it creates internally and sets on the RaftActorContext
139 // The only right way to manipulate the replicated log therefore is to get it from either the RaftActor
140 // or the RaftActorContext and modify the entries in there instead of trying to replace it by using this setter
141 // Simple assertion that will fail if you do so
142 // ReplicatedLog log = new ReplicatedLogImpl();
143 // raftActor.underlyingActor().getRaftActorContext().setReplicatedLog(log);
144 // assertEquals(log, raftActor.underlyingActor().getReplicatedLog())
145 public void setReplicatedLog(ReplicatedLog replicatedLog) {
146 this.replicatedLog = replicatedLog;
149 @Override public ReplicatedLog getReplicatedLog() {
150 return replicatedLog;
153 @Override public ActorSystem getActorSystem() {
157 @Override public Logger getLogger() {
158 return LoggerFactory.getLogger(getClass());
161 @Override public Map<String, String> getPeerAddresses() {
162 return peerAddresses;
165 @Override public String getPeerAddress(String peerId) {
166 return peerAddresses.get(peerId);
169 @Override public void addToPeers(String name, String address) {
170 peerAddresses.put(name, address);
173 @Override public void removePeer(String name) {
174 peerAddresses.remove(name);
177 @Override public ActorSelection getPeerActorSelection(String peerId) {
178 String peerAddress = getPeerAddress(peerId);
179 if(peerAddress != null){
180 return actorSelection(peerAddress);
185 @Override public void setPeerAddress(String peerId, String peerAddress) {
186 Preconditions.checkState(peerAddresses.containsKey(peerId));
187 peerAddresses.put(peerId, peerAddress);
190 public void setPeerAddresses(Map<String, String> peerAddresses) {
191 this.peerAddresses = peerAddresses;
195 public ConfigParams getConfigParams() {
200 public SnapshotManager getSnapshotManager() {
201 if(this.snapshotManager == null){
202 this.snapshotManager = new SnapshotManager(this, getLogger());
204 return this.snapshotManager;
207 public void setConfigParams(ConfigParams configParams) {
208 this.configParams = configParams;
212 public long getTotalMemory() {
213 return Runtime.getRuntime().totalMemory();
217 public void setTotalMemoryRetriever(Supplier<Long> retriever) {
221 public boolean hasFollowers() {
222 return getPeerAddresses().keySet().size() > 0;
226 public DataPersistenceProvider getPersistenceProvider() {
227 return persistenceProvider;
230 public void setPersistenceProvider(DataPersistenceProvider persistenceProvider) {
231 this.persistenceProvider = persistenceProvider;
234 public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
235 @Override public void appendAndPersist(
236 ReplicatedLogEntry replicatedLogEntry) {
237 append(replicatedLogEntry);
241 public int dataSize() {
245 @Override public void removeFromAndPersist(long index) {
250 public void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback) {
251 append(replicatedLogEntry);
253 if(callback != null) {
255 callback.apply(replicatedLogEntry);
256 } catch (Exception e) {
263 public static class MockPayload extends Payload implements Serializable {
264 private static final long serialVersionUID = 3121380393130864247L;
265 private String value = "";
268 public MockPayload() {
271 public MockPayload(String s) {
273 size = value.length();
276 public MockPayload(String s, int size) {
281 @Override public Map<GeneratedMessage.GeneratedExtension<?, ?>, String> encode() {
282 Map<GeneratedMessage.GeneratedExtension<?, ?>, String> map = new HashMap<>();
283 map.put(MockPayloadMessages.value, value);
287 @Override public Payload decode(
288 AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
289 String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
299 @Override public String getClientPayloadClassName() {
300 return MockPayload.class.getName();
304 public String toString() {
309 public int hashCode() {
310 final int prime = 31;
312 result = prime * result + ((value == null) ? 0 : value.hashCode());
317 public boolean equals(Object obj) {
324 if (getClass() != obj.getClass()) {
327 MockPayload other = (MockPayload) obj;
329 if (other.value != null) {
332 } else if (!value.equals(other.value)) {
339 public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
340 private static final long serialVersionUID = 1L;
342 private final long term;
343 private final long index;
344 private final Payload data;
346 public MockReplicatedLogEntry(long term, long index, Payload data){
353 @Override public Payload getData() {
357 @Override public long getTerm() {
361 @Override public long getIndex() {
367 return getData().size();
371 public int hashCode() {
372 final int prime = 31;
374 result = prime * result + ((data == null) ? 0 : data.hashCode());
375 result = prime * result + (int) (index ^ (index >>> 32));
376 result = prime * result + (int) (term ^ (term >>> 32));
381 public boolean equals(Object obj) {
388 if (getClass() != obj.getClass()) {
391 MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
393 if (other.data != null) {
396 } else if (!data.equals(other.data)) {
399 if (index != other.index) {
402 if (term != other.term) {
409 public String toString() {
410 StringBuilder builder = new StringBuilder();
411 builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
412 .append(", data=").append(data).append("]");
413 return builder.toString();
417 public static class MockReplicatedLogBuilder {
418 private final ReplicatedLog mockLog = new SimpleReplicatedLog();
420 public MockReplicatedLogBuilder createEntries(int start, int end, int term) {
421 for (int i=start; i<end; i++) {
422 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload("foo" + i)));
427 public MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
428 this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
432 public ReplicatedLog build() {