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.policy.DefaultRaftPolicy;
25 import org.opendaylight.controller.cluster.raft.policy.RaftPolicy;
26 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
27 import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages;
28 import org.opendaylight.controller.protobuff.messages.cluster.raft.test.MockPayloadMessages;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
32 public class MockRaftActorContext implements RaftActorContext {
35 private ActorSystem system;
36 private ActorRef actor;
37 private long index = 0;
38 private long lastApplied = 0;
39 private final ElectionTerm electionTerm;
40 private ReplicatedLog replicatedLog;
41 private Map<String, String> peerAddresses = new HashMap<>();
42 private ConfigParams configParams;
43 private boolean snapshotCaptureInitiated;
44 private SnapshotManager snapshotManager;
45 private DataPersistenceProvider persistenceProvider = new NonPersistentDataProvider();
46 private short payloadVersion;
47 private RaftPolicy raftPolicy = DefaultRaftPolicy.INSTANCE;
49 public MockRaftActorContext(){
50 electionTerm = new ElectionTerm() {
51 private long currentTerm = 1;
52 private String votedFor = "";
55 public long getCurrentTerm() {
60 public String getVotedFor() {
65 public void update(long currentTerm, String votedFor){
66 this.currentTerm = currentTerm;
67 this.votedFor = votedFor;
69 // TODO : Write to some persistent state
72 @Override public void updateAndPersist(long currentTerm,
74 update(currentTerm, votedFor);
78 configParams = new DefaultConfigParamsImpl();
81 public MockRaftActorContext(String id, ActorSystem system, ActorRef actor){
91 public void initReplicatedLog(){
92 this.replicatedLog = new SimpleReplicatedLog();
93 long term = getTermInformation().getCurrentTerm();
94 this.replicatedLog.append(new MockReplicatedLogEntry(term, 0, new MockPayload("1")));
95 this.replicatedLog.append(new MockReplicatedLogEntry(term, 1, new MockPayload("2")));
98 @Override public ActorRef actorOf(Props props) {
99 return system.actorOf(props);
102 @Override public ActorSelection actorSelection(String path) {
103 return system.actorSelection(path);
106 @Override public String getId() {
110 @Override public ActorRef getActor() {
114 @Override public ElectionTerm getTermInformation() {
118 public void setIndex(long index){
122 @Override public long getCommitIndex() {
126 @Override public void setCommitIndex(long commitIndex) {
127 this.index = commitIndex;
130 @Override public void setLastApplied(long lastApplied){
131 this.lastApplied = lastApplied;
134 @Override public long getLastApplied() {
139 // FIXME : A lot of tests try to manipulate the replicated log by setting it using this method
140 // This is OK to do if the underlyingActor is not RafActor or a derived class. If not then you should not
141 // used this way to manipulate the log because the RaftActor actually has a field replicatedLog
142 // which it creates internally and sets on the RaftActorContext
143 // The only right way to manipulate the replicated log therefore is to get it from either the RaftActor
144 // or the RaftActorContext and modify the entries in there instead of trying to replace it by using this setter
145 // Simple assertion that will fail if you do so
146 // ReplicatedLog log = new ReplicatedLogImpl();
147 // raftActor.underlyingActor().getRaftActorContext().setReplicatedLog(log);
148 // assertEquals(log, raftActor.underlyingActor().getReplicatedLog())
149 public void setReplicatedLog(ReplicatedLog replicatedLog) {
150 this.replicatedLog = replicatedLog;
153 @Override public ReplicatedLog getReplicatedLog() {
154 return replicatedLog;
157 @Override public ActorSystem getActorSystem() {
161 @Override public Logger getLogger() {
162 return LoggerFactory.getLogger(getClass());
165 @Override public Map<String, String> getPeerAddresses() {
166 return peerAddresses;
169 @Override public String getPeerAddress(String peerId) {
170 return peerAddresses.get(peerId);
173 @Override public void addToPeers(String name, String address) {
174 peerAddresses.put(name, address);
177 @Override public void removePeer(String name) {
178 peerAddresses.remove(name);
181 @Override public ActorSelection getPeerActorSelection(String peerId) {
182 String peerAddress = getPeerAddress(peerId);
183 if(peerAddress != null){
184 return actorSelection(peerAddress);
189 @Override public void setPeerAddress(String peerId, String peerAddress) {
190 Preconditions.checkState(peerAddresses.containsKey(peerId));
191 peerAddresses.put(peerId, peerAddress);
194 public void setPeerAddresses(Map<String, String> peerAddresses) {
195 this.peerAddresses = peerAddresses;
199 public ConfigParams getConfigParams() {
204 public SnapshotManager getSnapshotManager() {
205 if(this.snapshotManager == null){
206 this.snapshotManager = new SnapshotManager(this, getLogger());
207 this.snapshotManager.setCreateSnapshotCallable(NoopProcedure.<Void>instance());
209 return this.snapshotManager;
212 public void setConfigParams(ConfigParams configParams) {
213 this.configParams = configParams;
217 public long getTotalMemory() {
218 return Runtime.getRuntime().totalMemory();
222 public void setTotalMemoryRetriever(Supplier<Long> retriever) {
226 public boolean hasFollowers() {
227 return getPeerAddresses().keySet().size() > 0;
231 public DataPersistenceProvider getPersistenceProvider() {
232 return persistenceProvider;
235 public void setPersistenceProvider(DataPersistenceProvider persistenceProvider) {
236 this.persistenceProvider = persistenceProvider;
240 public short getPayloadVersion() {
241 return payloadVersion;
245 public RaftPolicy getRaftPolicy() {
246 return this.raftPolicy;
249 public void setRaftPolicy(RaftPolicy raftPolicy){
250 this.raftPolicy = raftPolicy;
253 public void setPayloadVersion(short payloadVersion) {
254 this.payloadVersion = payloadVersion;
257 public static class SimpleReplicatedLog extends AbstractReplicatedLogImpl {
259 public void appendAndPersist(
260 ReplicatedLogEntry replicatedLogEntry) {
261 append(replicatedLogEntry);
265 public int dataSize() {
270 public void captureSnapshotIfReady(ReplicatedLogEntry replicatedLogEntry) {
273 @Override public void removeFromAndPersist(long index) {
278 public void appendAndPersist(ReplicatedLogEntry replicatedLogEntry, Procedure<ReplicatedLogEntry> callback) {
279 append(replicatedLogEntry);
281 if(callback != null) {
283 callback.apply(replicatedLogEntry);
284 } catch (Exception e) {
291 public static class MockPayload extends Payload implements Serializable {
292 private static final long serialVersionUID = 3121380393130864247L;
293 private String value = "";
296 public MockPayload() {
299 public MockPayload(String s) {
301 size = value.length();
304 public MockPayload(String s, int size) {
309 @Override public Map<GeneratedMessage.GeneratedExtension<?, ?>, String> encode() {
310 Map<GeneratedMessage.GeneratedExtension<?, ?>, String> map = new HashMap<>();
311 map.put(MockPayloadMessages.value, value);
315 @Override public Payload decode(
316 AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payloadProtoBuff) {
317 String value = payloadProtoBuff.getExtension(MockPayloadMessages.value);
327 @Override public String getClientPayloadClassName() {
328 return MockPayload.class.getName();
332 public String toString() {
337 public int hashCode() {
338 final int prime = 31;
340 result = prime * result + ((value == null) ? 0 : value.hashCode());
345 public boolean equals(Object obj) {
352 if (getClass() != obj.getClass()) {
355 MockPayload other = (MockPayload) obj;
357 if (other.value != null) {
360 } else if (!value.equals(other.value)) {
367 public static class MockReplicatedLogEntry implements ReplicatedLogEntry, Serializable {
368 private static final long serialVersionUID = 1L;
370 private final long term;
371 private final long index;
372 private final Payload data;
374 public MockReplicatedLogEntry(long term, long index, Payload data){
381 @Override public Payload getData() {
385 @Override public long getTerm() {
389 @Override public long getIndex() {
395 return getData().size();
399 public int hashCode() {
400 final int prime = 31;
402 result = prime * result + ((data == null) ? 0 : data.hashCode());
403 result = prime * result + (int) (index ^ (index >>> 32));
404 result = prime * result + (int) (term ^ (term >>> 32));
409 public boolean equals(Object obj) {
416 if (getClass() != obj.getClass()) {
419 MockReplicatedLogEntry other = (MockReplicatedLogEntry) obj;
421 if (other.data != null) {
424 } else if (!data.equals(other.data)) {
427 if (index != other.index) {
430 if (term != other.term) {
437 public String toString() {
438 StringBuilder builder = new StringBuilder();
439 builder.append("MockReplicatedLogEntry [term=").append(term).append(", index=").append(index)
440 .append(", data=").append(data).append("]");
441 return builder.toString();
445 public static class MockReplicatedLogBuilder {
446 private final ReplicatedLog mockLog = new SimpleReplicatedLog();
448 public MockReplicatedLogBuilder createEntries(int start, int end, int term) {
449 for (int i=start; i<end; i++) {
450 this.mockLog.append(new ReplicatedLogImplEntry(i, term, new MockRaftActorContext.MockPayload(Integer.toString(i))));
455 public MockReplicatedLogBuilder addEntry(int index, int term, MockPayload payload) {
456 this.mockLog.append(new ReplicatedLogImplEntry(index, term, payload));
460 public ReplicatedLog build() {