2 * Copyright (c) 2015 Brocade Communications 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
8 package org.opendaylight.controller.cluster.datastore;
10 import static org.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertNotNull;
12 import static org.junit.Assert.fail;
13 import static org.mockito.Matchers.any;
14 import static org.mockito.Matchers.argThat;
15 import static org.mockito.Matchers.eq;
16 import static org.mockito.Matchers.isA;
17 import static org.mockito.Mockito.doReturn;
18 import static org.mockito.Mockito.mock;
19 import static org.mockito.Mockito.verify;
20 import akka.actor.ActorRef;
21 import akka.actor.ActorSelection;
22 import akka.actor.ActorSystem;
23 import akka.actor.Props;
24 import akka.dispatch.Futures;
25 import akka.testkit.JavaTestKit;
26 import akka.util.Timeout;
27 import com.codahale.metrics.MetricRegistry;
28 import com.codahale.metrics.Timer;
29 import com.google.common.base.Objects;
30 import com.google.common.base.Optional;
31 import com.google.common.collect.ImmutableMap;
32 import com.google.common.util.concurrent.CheckedFuture;
33 import com.typesafe.config.Config;
34 import com.typesafe.config.ConfigFactory;
35 import java.io.IOException;
36 import java.util.ArrayList;
37 import java.util.Iterator;
38 import java.util.List;
40 import java.util.concurrent.TimeUnit;
41 import org.junit.AfterClass;
42 import org.junit.Before;
43 import org.junit.BeforeClass;
44 import org.mockito.ArgumentCaptor;
45 import org.mockito.ArgumentMatcher;
46 import org.mockito.Mock;
47 import org.mockito.Mockito;
48 import org.mockito.MockitoAnnotations;
49 import org.opendaylight.controller.cluster.datastore.DatastoreContext.Builder;
50 import org.opendaylight.controller.cluster.datastore.TransactionProxyTest.TestException;
51 import org.opendaylight.controller.cluster.datastore.config.Configuration;
52 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
53 import org.opendaylight.controller.cluster.datastore.messages.BatchedModificationsReply;
54 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
55 import org.opendaylight.controller.cluster.datastore.messages.CreateTransaction;
56 import org.opendaylight.controller.cluster.datastore.messages.CreateTransactionReply;
57 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
58 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
59 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
60 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
61 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
62 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
63 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
64 import org.opendaylight.controller.cluster.datastore.modification.AbstractModification;
65 import org.opendaylight.controller.cluster.datastore.modification.Modification;
66 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
67 import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy;
68 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
69 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
70 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
71 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
72 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
73 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
74 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
75 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
76 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
77 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
78 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
79 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
80 import org.slf4j.Logger;
81 import org.slf4j.LoggerFactory;
82 import scala.concurrent.Await;
83 import scala.concurrent.Future;
84 import scala.concurrent.duration.Duration;
87 * Abstract base class for TransactionProxy unit tests.
89 * @author Thomas Pantelis
91 public abstract class AbstractTransactionProxyTest {
92 protected final Logger log = LoggerFactory.getLogger(getClass());
94 private static ActorSystem system;
96 private final Configuration configuration = new MockConfiguration() {
97 Map<String, ShardStrategy> strategyMap = ImmutableMap.<String, ShardStrategy>builder().put(
98 "junk", new ShardStrategy() {
100 public String findShard(YangInstanceIdentifier path) {
104 "cars", new ShardStrategy() {
106 public String findShard(YangInstanceIdentifier path) {
112 public ShardStrategy getStrategyForModule(String moduleName) {
113 return strategyMap.get(moduleName);
117 public String getModuleNameFromNameSpace(String nameSpace) {
118 if(TestModel.JUNK_QNAME.getNamespace().toASCIIString().equals(nameSpace)) {
120 } else if(CarsModel.BASE_QNAME.getNamespace().toASCIIString().equals(nameSpace)){
128 protected ActorContext mockActorContext;
130 protected TransactionContextFactory mockComponentFactory;
132 private SchemaContext schemaContext;
135 private ClusterWrapper mockClusterWrapper;
137 protected final String memberName = "mock-member";
139 private final int operationTimeoutInSeconds = 2;
140 protected final Builder dataStoreContextBuilder = DatastoreContext.newBuilder()
141 .operationTimeoutInSeconds(operationTimeoutInSeconds);
144 public static void setUpClass() throws IOException {
146 Config config = ConfigFactory.parseMap(ImmutableMap.<String, Object>builder().
147 put("akka.actor.default-dispatcher.type",
148 "akka.testkit.CallingThreadDispatcherConfigurator").build()).
149 withFallback(ConfigFactory.load());
150 system = ActorSystem.create("test", config);
154 public static void tearDownClass() throws IOException {
155 JavaTestKit.shutdownActorSystem(system);
161 MockitoAnnotations.initMocks(this);
163 schemaContext = TestModel.createTestContext();
165 doReturn(getSystem()).when(mockActorContext).getActorSystem();
166 doReturn(getSystem().dispatchers().defaultGlobalDispatcher()).when(mockActorContext).getClientDispatcher();
167 doReturn(memberName).when(mockActorContext).getCurrentMemberName();
168 doReturn(new ShardStrategyFactory(configuration)).when(mockActorContext).getShardStrategyFactory();
169 doReturn(schemaContext).when(mockActorContext).getSchemaContext();
170 doReturn(new Timeout(operationTimeoutInSeconds, TimeUnit.SECONDS)).when(mockActorContext).getOperationTimeout();
171 doReturn(mockClusterWrapper).when(mockActorContext).getClusterWrapper();
172 doReturn(mockClusterWrapper).when(mockActorContext).getClusterWrapper();
173 doReturn(dataStoreContextBuilder.build()).when(mockActorContext).getDatastoreContext();
175 mockComponentFactory = TransactionContextFactory.create(mockActorContext);
177 Timer timer = new MetricRegistry().timer("test");
178 doReturn(timer).when(mockActorContext).getOperationTimer(any(String.class));
181 protected ActorSystem getSystem() {
185 protected CreateTransaction eqCreateTransaction(final String memberName,
186 final TransactionType type) {
187 ArgumentMatcher<CreateTransaction> matcher = new ArgumentMatcher<CreateTransaction>() {
189 public boolean matches(Object argument) {
190 if(CreateTransaction.class.equals(argument.getClass())) {
191 CreateTransaction obj = CreateTransaction.fromSerializable(argument);
192 return obj.getTransactionId().startsWith(memberName) &&
193 obj.getTransactionType() == type.ordinal();
200 return argThat(matcher);
203 protected DataExists eqDataExists() {
204 ArgumentMatcher<DataExists> matcher = new ArgumentMatcher<DataExists>() {
206 public boolean matches(Object argument) {
207 return (argument instanceof DataExists) &&
208 ((DataExists)argument).getPath().equals(TestModel.TEST_PATH);
212 return argThat(matcher);
215 protected ReadData eqReadData() {
216 return eqReadData(TestModel.TEST_PATH);
219 protected ReadData eqReadData(final YangInstanceIdentifier path) {
220 ArgumentMatcher<ReadData> matcher = new ArgumentMatcher<ReadData>() {
222 public boolean matches(Object argument) {
223 return (argument instanceof ReadData) && ((ReadData)argument).getPath().equals(path);
227 return argThat(matcher);
230 protected Future<Object> readyTxReply(String path) {
231 return Futures.successful((Object)new ReadyTransactionReply(path));
235 protected Future<ReadDataReply> readDataReply(NormalizedNode<?, ?> data) {
236 return Futures.successful(new ReadDataReply(data, DataStoreVersions.CURRENT_VERSION));
239 protected Future<DataExistsReply> dataExistsReply(boolean exists) {
240 return Futures.successful(new DataExistsReply(exists, DataStoreVersions.CURRENT_VERSION));
243 protected Future<BatchedModificationsReply> batchedModificationsReply(int count) {
244 return Futures.successful(new BatchedModificationsReply(count));
247 @SuppressWarnings("unchecked")
248 protected Future<Object> incompleteFuture() {
249 return mock(Future.class);
252 protected ActorSelection actorSelection(ActorRef actorRef) {
253 return getSystem().actorSelection(actorRef.path());
256 protected void expectBatchedModifications(ActorRef actorRef, int count) {
257 doReturn(batchedModificationsReply(count)).when(mockActorContext).executeOperationAsync(
258 eq(actorSelection(actorRef)), isA(BatchedModifications.class), any(Timeout.class));
261 protected void expectBatchedModificationsReady(ActorRef actorRef) {
262 expectBatchedModificationsReady(actorRef, false);
265 protected void expectBatchedModificationsReady(ActorRef actorRef, boolean doCommitOnReady) {
266 doReturn(doCommitOnReady ? Futures.successful(new CommitTransactionReply().toSerializable()) :
267 readyTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
268 eq(actorSelection(actorRef)), isA(BatchedModifications.class), any(Timeout.class));
271 protected void expectBatchedModifications(int count) {
272 doReturn(batchedModificationsReply(count)).when(mockActorContext).executeOperationAsync(
273 any(ActorSelection.class), isA(BatchedModifications.class), any(Timeout.class));
276 protected void expectIncompleteBatchedModifications() {
277 doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
278 any(ActorSelection.class), isA(BatchedModifications.class), any(Timeout.class));
281 protected void expectFailedBatchedModifications(ActorRef actorRef) {
282 doReturn(Futures.failed(new TestException())).when(mockActorContext).executeOperationAsync(
283 eq(actorSelection(actorRef)), isA(BatchedModifications.class), any(Timeout.class));
286 protected void expectReadyLocalTransaction(ActorRef actorRef, boolean doCommitOnReady) {
287 doReturn(doCommitOnReady ? Futures.successful(new CommitTransactionReply().toSerializable()) :
288 readyTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
289 eq(actorSelection(actorRef)), isA(ReadyLocalTransaction.class), any(Timeout.class));
292 protected CreateTransactionReply createTransactionReply(ActorRef actorRef, short transactionVersion){
293 return new CreateTransactionReply(actorRef.path().toString(), "txn-1", transactionVersion);
296 protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem) {
297 return setupActorContextWithoutInitialCreateTransaction(actorSystem, DefaultShardStrategy.DEFAULT_SHARD);
300 protected Future<PrimaryShardInfo> primaryShardInfoReply(ActorSystem actorSystem, ActorRef actorRef) {
301 return primaryShardInfoReply(actorSystem, actorRef, DataStoreVersions.CURRENT_VERSION);
304 protected Future<PrimaryShardInfo> primaryShardInfoReply(ActorSystem actorSystem, ActorRef actorRef,
305 short transactionVersion) {
306 return Futures.successful(new PrimaryShardInfo(actorSystem.actorSelection(actorRef.path()),
307 transactionVersion, Optional.<DataTree>absent()));
310 protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem, String shardName) {
311 return setupActorContextWithoutInitialCreateTransaction(actorSystem, shardName, DataStoreVersions.CURRENT_VERSION);
314 protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem, String shardName,
315 short transactionVersion) {
316 ActorRef actorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
317 log.info("Created mock shard actor {}", actorRef);
319 doReturn(actorSystem.actorSelection(actorRef.path())).
320 when(mockActorContext).actorSelection(actorRef.path().toString());
322 doReturn(primaryShardInfoReply(actorSystem, actorRef, transactionVersion)).
323 when(mockActorContext).findPrimaryShardAsync(eq(shardName));
328 protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem,
329 TransactionType type, short transactionVersion, String shardName) {
330 ActorRef shardActorRef = setupActorContextWithoutInitialCreateTransaction(actorSystem, shardName,
333 return setupActorContextWithInitialCreateTransaction(actorSystem, type, transactionVersion,
334 memberName, shardActorRef);
337 protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem,
338 TransactionType type, short transactionVersion, String prefix, ActorRef shardActorRef) {
341 if(type == TransactionType.WRITE_ONLY &&
342 dataStoreContextBuilder.build().isWriteOnlyTransactionOptimizationsEnabled()) {
343 txActorRef = shardActorRef;
345 txActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
346 log.info("Created mock shard Tx actor {}", txActorRef);
348 doReturn(actorSystem.actorSelection(txActorRef.path())).
349 when(mockActorContext).actorSelection(txActorRef.path().toString());
351 doReturn(Futures.successful(createTransactionReply(txActorRef, transactionVersion))).when(mockActorContext).
352 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
353 eqCreateTransaction(prefix, type), any(Timeout.class));
359 protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type) {
360 return setupActorContextWithInitialCreateTransaction(actorSystem, type, DataStoreVersions.CURRENT_VERSION,
361 DefaultShardStrategy.DEFAULT_SHARD);
364 protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type,
366 return setupActorContextWithInitialCreateTransaction(actorSystem, type, DataStoreVersions.CURRENT_VERSION,
370 protected void propagateReadFailedExceptionCause(CheckedFuture<?, ReadFailedException> future)
374 future.checkedGet(5, TimeUnit.SECONDS);
375 fail("Expected ReadFailedException");
376 } catch(ReadFailedException e) {
377 assertNotNull("Expected a cause", e.getCause());
378 if(e.getCause().getCause() != null) {
379 throw e.getCause().getCause();
386 protected List<BatchedModifications> captureBatchedModifications(ActorRef actorRef) {
387 ArgumentCaptor<BatchedModifications> batchedModificationsCaptor =
388 ArgumentCaptor.forClass(BatchedModifications.class);
389 verify(mockActorContext, Mockito.atLeastOnce()).executeOperationAsync(
390 eq(actorSelection(actorRef)), batchedModificationsCaptor.capture(), any(Timeout.class));
392 List<BatchedModifications> batchedModifications = filterCaptured(
393 batchedModificationsCaptor, BatchedModifications.class);
394 return batchedModifications;
397 protected <T> List<T> filterCaptured(ArgumentCaptor<T> captor, Class<T> type) {
398 List<T> captured = new ArrayList<>();
399 for(T c: captor.getAllValues()) {
400 if(type.isInstance(c)) {
408 protected void verifyOneBatchedModification(ActorRef actorRef, Modification expected, boolean expIsReady) {
409 List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
410 assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
412 verifyBatchedModifications(batchedModifications.get(0), expIsReady, expIsReady, expected);
415 protected void verifyBatchedModifications(Object message, boolean expIsReady, Modification... expected) {
416 verifyBatchedModifications(message, expIsReady, false, expected);
419 protected void verifyBatchedModifications(Object message, boolean expIsReady, boolean expIsDoCommitOnReady,
420 Modification... expected) {
421 assertEquals("Message type", BatchedModifications.class, message.getClass());
422 BatchedModifications batchedModifications = (BatchedModifications)message;
423 assertEquals("BatchedModifications size", expected.length, batchedModifications.getModifications().size());
424 assertEquals("isReady", expIsReady, batchedModifications.isReady());
425 assertEquals("isDoCommitOnReady", expIsDoCommitOnReady, batchedModifications.isDoCommitOnReady());
426 for(int i = 0; i < batchedModifications.getModifications().size(); i++) {
427 Modification actual = batchedModifications.getModifications().get(i);
428 assertEquals("Modification type", expected[i].getClass(), actual.getClass());
429 assertEquals("getPath", ((AbstractModification)expected[i]).getPath(),
430 ((AbstractModification)actual).getPath());
431 if(actual instanceof WriteModification) {
432 assertEquals("getData", ((WriteModification)expected[i]).getData(),
433 ((WriteModification)actual).getData());
438 protected void verifyCohortFutures(AbstractThreePhaseCommitCohort<?> proxy,
439 Object... expReplies) throws Exception {
440 assertEquals("getReadyOperationFutures size", expReplies.length,
441 proxy.getCohortFutures().size());
443 List<Object> futureResults = new ArrayList<>();
444 for( Future<?> future: proxy.getCohortFutures()) {
445 assertNotNull("Ready operation Future is null", future);
447 futureResults.add(Await.result(future, Duration.create(5, TimeUnit.SECONDS)));
448 } catch(Exception e) {
449 futureResults.add(e);
453 for(int i = 0; i < expReplies.length; i++) {
454 Object expReply = expReplies[i];
455 boolean found = false;
456 Iterator<?> iter = futureResults.iterator();
457 while(iter.hasNext()) {
458 Object actual = iter.next();
459 if(CommitTransactionReply.isSerializedType(expReply) &&
460 CommitTransactionReply.isSerializedType(actual)) {
462 } else if(expReply instanceof ActorSelection && Objects.equal(expReply, actual)) {
464 } else if(expReply instanceof Class && ((Class<?>)expReply).isInstance(actual)) {
475 fail(String.format("No cohort Future response found for %s. Actual: %s", expReply, futureResults));