2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
3 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.raft;
11 import static org.junit.Assert.assertEquals;
12 import static org.mockito.Mockito.mock;
13 import akka.actor.ActorRef;
14 import akka.actor.Props;
15 import com.google.common.base.Function;
16 import com.google.common.base.Optional;
17 import com.google.common.util.concurrent.Uninterruptibles;
18 import java.io.ByteArrayInputStream;
19 import java.io.IOException;
20 import java.io.ObjectInputStream;
21 import java.util.ArrayList;
22 import java.util.Collections;
23 import java.util.List;
25 import java.util.concurrent.CountDownLatch;
26 import java.util.concurrent.TimeUnit;
27 import javax.annotation.Nonnull;
28 import org.opendaylight.controller.cluster.DataPersistenceProvider;
29 import org.opendaylight.controller.cluster.raft.behaviors.RaftActorBehavior;
30 import org.opendaylight.controller.cluster.raft.protobuff.client.messages.Payload;
32 public class MockRaftActor extends RaftActor implements RaftActorRecoveryCohort, RaftActorSnapshotCohort {
33 public static final short PAYLOAD_VERSION = 5;
35 final RaftActor actorDelegate;
36 final RaftActorRecoveryCohort recoveryCohortDelegate;
37 volatile RaftActorSnapshotCohort snapshotCohortDelegate;
38 private final CountDownLatch recoveryComplete = new CountDownLatch(1);
39 private final List<Object> state;
40 private final ActorRef roleChangeNotifier;
41 protected final CountDownLatch initializeBehaviorComplete = new CountDownLatch(1);
42 private RaftActorRecoverySupport raftActorRecoverySupport;
43 private RaftActorSnapshotMessageSupport snapshotMessageSupport;
44 private final byte[] restoreFromSnapshot;
45 final CountDownLatch snapshotCommitted = new CountDownLatch(1);
46 private final Function<Runnable, Void> pauseLeaderFunction;
48 protected MockRaftActor(AbstractBuilder<?, ?> builder) {
49 super(builder.id, builder.peerAddresses, Optional.fromNullable(builder.config), PAYLOAD_VERSION);
50 state = new ArrayList<>();
51 this.actorDelegate = mock(RaftActor.class);
52 this.recoveryCohortDelegate = mock(RaftActorRecoveryCohort.class);
53 this.snapshotCohortDelegate = mock(RaftActorSnapshotCohort.class);
55 if(builder.dataPersistenceProvider == null){
56 setPersistence(builder.persistent.isPresent() ? builder.persistent.get() : true);
58 setPersistence(builder.dataPersistenceProvider);
61 roleChangeNotifier = builder.roleChangeNotifier;
62 snapshotMessageSupport = builder.snapshotMessageSupport;
63 restoreFromSnapshot = builder.restoreFromSnapshot;
64 pauseLeaderFunction = builder.pauseLeaderFunction;
67 public void setRaftActorRecoverySupport(RaftActorRecoverySupport support) {
68 raftActorRecoverySupport = support;
72 public RaftActorRecoverySupport newRaftActorRecoverySupport() {
73 return raftActorRecoverySupport != null ? raftActorRecoverySupport : super.newRaftActorRecoverySupport();
77 protected RaftActorSnapshotMessageSupport newRaftActorSnapshotMessageSupport() {
78 return snapshotMessageSupport != null ? snapshotMessageSupport :
79 (snapshotMessageSupport = super.newRaftActorSnapshotMessageSupport());
82 public RaftActorSnapshotMessageSupport getSnapshotMessageSupport() {
83 return snapshotMessageSupport;
86 public void waitForRecoveryComplete() {
88 assertEquals("Recovery complete", true, recoveryComplete.await(5, TimeUnit.SECONDS));
89 } catch (InterruptedException e) {
94 public void waitForInitializeBehaviorComplete() {
96 assertEquals("Behavior initialized", true, initializeBehaviorComplete.await(5, TimeUnit.SECONDS));
97 } catch (InterruptedException e) {
103 public void waitUntilLeader(){
104 for(int i = 0;i < 10; i++){
108 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
112 public List<Object> getState() {
117 @Override protected void applyState(ActorRef clientActor, String identifier, Object data) {
118 actorDelegate.applyState(clientActor, identifier, data);
119 LOG.info("{}: applyState called: {}", persistenceId(), data);
126 protected RaftActorRecoveryCohort getRaftActorRecoveryCohort() {
131 protected RaftActorSnapshotCohort getRaftActorSnapshotCohort() {
136 public void startLogRecoveryBatch(int maxBatchSize) {
140 public void appendRecoveredLogEntry(Payload data) {
145 public void applyCurrentLogRecoveryBatch() {
149 protected void onRecoveryComplete() {
150 actorDelegate.onRecoveryComplete();
151 recoveryComplete.countDown();
155 protected void initializeBehavior() {
156 super.initializeBehavior();
157 initializeBehaviorComplete.countDown();
161 public void applyRecoverySnapshot(byte[] bytes) {
162 recoveryCohortDelegate.applyRecoverySnapshot(bytes);
163 applySnapshotBytes(bytes);
166 private void applySnapshotBytes(byte[] bytes) {
168 Object data = toObject(bytes);
169 if (data instanceof List) {
170 state.addAll((List<?>) data);
172 } catch (Exception e) {
178 public void createSnapshot(ActorRef actorRef) {
179 LOG.info("{}: createSnapshot called", persistenceId());
180 snapshotCohortDelegate.createSnapshot(actorRef);
184 public void applySnapshot(byte [] snapshot) {
185 LOG.info("{}: applySnapshot called", persistenceId());
186 applySnapshotBytes(snapshot);
187 snapshotCohortDelegate.applySnapshot(snapshot);
191 protected void onStateChanged() {
192 actorDelegate.onStateChanged();
196 protected Optional<ActorRef> getRoleChangeNotifier() {
197 return Optional.fromNullable(roleChangeNotifier);
200 @Override public String persistenceId() {
204 protected void newBehavior(RaftActorBehavior newBehavior) {
205 self().tell(newBehavior, ActorRef.noSender());
209 protected void handleCommand(final Object message) {
210 if(message instanceof RaftActorBehavior) {
211 super.changeCurrentBehavior((RaftActorBehavior)message);
213 super.handleCommand(message);
215 if(RaftActorSnapshotMessageSupport.COMMIT_SNAPSHOT.equals(message)) {
216 snapshotCommitted.countDown();
222 protected void pauseLeader(Runnable operation) {
223 if(pauseLeaderFunction != null) {
224 pauseLeaderFunction.apply(operation);
226 super.pauseLeader(operation);
230 public static Object toObject(byte[] bs) throws ClassNotFoundException, IOException {
232 ByteArrayInputStream bis = null;
233 ObjectInputStream ois = null;
235 bis = new ByteArrayInputStream(bs);
236 ois = new ObjectInputStream(bis);
237 obj = ois.readObject();
249 public ReplicatedLog getReplicatedLog(){
250 return this.getRaftActorContext().getReplicatedLog();
254 public byte[] getRestoreFromSnapshot() {
255 return restoreFromSnapshot;
258 public static Props props(final String id, final Map<String, String> peerAddresses,
259 ConfigParams config){
260 return builder().id(id).peerAddresses(peerAddresses).config(config).props();
263 public static Props props(final String id, final Map<String, String> peerAddresses,
264 ConfigParams config, DataPersistenceProvider dataPersistenceProvider){
265 return builder().id(id).peerAddresses(peerAddresses).config(config).
266 dataPersistenceProvider(dataPersistenceProvider).props();
269 public static Builder builder() {
270 return new Builder();
273 public static class AbstractBuilder<T extends AbstractBuilder<T, A>, A extends MockRaftActor> {
274 private Map<String, String> peerAddresses = Collections.emptyMap();
276 private ConfigParams config;
277 private DataPersistenceProvider dataPersistenceProvider;
278 private ActorRef roleChangeNotifier;
279 private RaftActorSnapshotMessageSupport snapshotMessageSupport;
280 private byte[] restoreFromSnapshot;
281 private Optional<Boolean> persistent = Optional.absent();
282 private final Class<A> actorClass;
283 private Function<Runnable, Void> pauseLeaderFunction;
285 protected AbstractBuilder(Class<A> actorClass) {
286 this.actorClass = actorClass;
289 @SuppressWarnings("unchecked")
294 public T id(String id) {
299 public T peerAddresses(Map<String, String> peerAddresses) {
300 this.peerAddresses = peerAddresses;
304 public T config(ConfigParams config) {
305 this.config = config;
309 public T dataPersistenceProvider(DataPersistenceProvider dataPersistenceProvider) {
310 this.dataPersistenceProvider = dataPersistenceProvider;
314 public T roleChangeNotifier(ActorRef roleChangeNotifier) {
315 this.roleChangeNotifier = roleChangeNotifier;
319 public T snapshotMessageSupport(RaftActorSnapshotMessageSupport snapshotMessageSupport) {
320 this.snapshotMessageSupport = snapshotMessageSupport;
324 public T restoreFromSnapshot(byte[] restoreFromSnapshot) {
325 this.restoreFromSnapshot = restoreFromSnapshot;
329 public T persistent(Optional<Boolean> persistent) {
330 this.persistent = persistent;
334 public T pauseLeaderFunction(Function<Runnable, Void> pauseLeaderFunction) {
335 this.pauseLeaderFunction = pauseLeaderFunction;
339 public Props props() {
340 return Props.create(actorClass, this);
344 public static class Builder extends AbstractBuilder<Builder, MockRaftActor> {
346 super(MockRaftActor.class);