opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/AbstractTransactionProxyTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.cluster.datastore;
   9
  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;
  39 import java.util.Map;
  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.DataExists;
  57 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
  58 import org.opendaylight.controller.cluster.datastore.messages.PrimaryShardInfo;
  59 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
  60 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
  61 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
  62 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
  63 import org.opendaylight.controller.cluster.datastore.modification.AbstractModification;
  64 import org.opendaylight.controller.cluster.datastore.modification.Modification;
  65 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
  66 import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy;
  67 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
  68 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
  69 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
  70 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
  71 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
  72 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
  73 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
  74 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  75 import org.opendaylight.controller.protobuff.messages.transaction.ShardTransactionMessages.CreateTransactionReply;
  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;
  85
  86 /**
  87  * Abstract base class for TransactionProxy unit tests.
  88  *
  89  * @author Thomas Pantelis
  90  */
  91 public abstract class AbstractTransactionProxyTest {
  92     protected final Logger log = LoggerFactory.getLogger(getClass());
  93
  94     private static ActorSystem system;
  95
  96     private final Configuration configuration = new MockConfiguration() {
  97         Map<String, ShardStrategy> strategyMap = ImmutableMap.<String, ShardStrategy>builder().put(
  98                 "junk", new ShardStrategy() {
  99                     @Override
 100                     public String findShard(YangInstanceIdentifier path) {
 101                         return "junk";
 102                     }
 103                 }).put(
 104                 "cars", new ShardStrategy() {
 105                     @Override
 106                     public String findShard(YangInstanceIdentifier path) {
 107                         return "cars";
 108                     }
 109                 }).build();
 110
 111         @Override
 112         public ShardStrategy getStrategyForModule(String moduleName) {
 113             return strategyMap.get(moduleName);
 114         }
 115
 116         @Override
 117         public String getModuleNameFromNameSpace(String nameSpace) {
 118             if(TestModel.JUNK_QNAME.getNamespace().toASCIIString().equals(nameSpace)) {
 119                 return "junk";
 120             } else if(CarsModel.BASE_QNAME.getNamespace().toASCIIString().equals(nameSpace)){
 121                 return "cars";
 122             }
 123             return null;
 124         }
 125     };
 126
 127     @Mock
 128     protected ActorContext mockActorContext;
 129
 130     protected TransactionContextFactory mockComponentFactory;
 131
 132     private SchemaContext schemaContext;
 133
 134     @Mock
 135     private ClusterWrapper mockClusterWrapper;
 136
 137     protected final String memberName = "mock-member";
 138
 139     private final int operationTimeoutInSeconds = 2;
 140     protected final Builder dataStoreContextBuilder = DatastoreContext.newBuilder()
 141             .operationTimeoutInSeconds(operationTimeoutInSeconds);
 142
 143     @BeforeClass
 144     public static void setUpClass() throws IOException {
 145
 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);
 151     }
 152
 153     @AfterClass
 154     public static void tearDownClass() throws IOException {
 155         JavaTestKit.shutdownActorSystem(system);
 156         system = null;
 157     }
 158
 159     @Before
 160     public void setUp(){
 161         MockitoAnnotations.initMocks(this);
 162
 163         schemaContext = TestModel.createTestContext();
 164
 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();
 174
 175         mockComponentFactory = TransactionContextFactory.create(mockActorContext);
 176
 177         Timer timer = new MetricRegistry().timer("test");
 178         doReturn(timer).when(mockActorContext).getOperationTimer(any(String.class));
 179     }
 180
 181     protected ActorSystem getSystem() {
 182         return system;
 183     }
 184
 185     protected CreateTransaction eqCreateTransaction(final String memberName,
 186             final TransactionType type) {
 187         ArgumentMatcher<CreateTransaction> matcher = new ArgumentMatcher<CreateTransaction>() {
 188             @Override
 189             public boolean matches(Object argument) {
 190                 if(CreateTransaction.SERIALIZABLE_CLASS.equals(argument.getClass())) {
 191                     CreateTransaction obj = CreateTransaction.fromSerializable(argument);
 192                     return obj.getTransactionId().startsWith(memberName) &&
 193                             obj.getTransactionType() == type.ordinal();
 194                 }
 195
 196                 return false;
 197             }
 198         };
 199
 200         return argThat(matcher);
 201     }
 202
 203     protected DataExists eqSerializedDataExists() {
 204         ArgumentMatcher<DataExists> matcher = new ArgumentMatcher<DataExists>() {
 205             @Override
 206             public boolean matches(Object argument) {
 207                 return DataExists.SERIALIZABLE_CLASS.equals(argument.getClass()) &&
 208                        DataExists.fromSerializable(argument).getPath().equals(TestModel.TEST_PATH);
 209             }
 210         };
 211
 212         return argThat(matcher);
 213     }
 214
 215     protected DataExists eqDataExists() {
 216         ArgumentMatcher<DataExists> matcher = new ArgumentMatcher<DataExists>() {
 217             @Override
 218             public boolean matches(Object argument) {
 219                 return (argument instanceof DataExists) &&
 220                     ((DataExists)argument).getPath().equals(TestModel.TEST_PATH);
 221             }
 222         };
 223
 224         return argThat(matcher);
 225     }
 226
 227     protected ReadData eqSerializedReadData() {
 228         return eqSerializedReadData(TestModel.TEST_PATH);
 229     }
 230
 231     protected ReadData eqSerializedReadData(final YangInstanceIdentifier path) {
 232         ArgumentMatcher<ReadData> matcher = new ArgumentMatcher<ReadData>() {
 233             @Override
 234             public boolean matches(Object argument) {
 235                 return ReadData.SERIALIZABLE_CLASS.equals(argument.getClass()) &&
 236                        ReadData.fromSerializable(argument).getPath().equals(path);
 237             }
 238         };
 239
 240         return argThat(matcher);
 241     }
 242
 243     protected ReadData eqReadData() {
 244         return eqReadData(TestModel.TEST_PATH);
 245     }
 246
 247     protected ReadData eqReadData(final YangInstanceIdentifier path) {
 248         ArgumentMatcher<ReadData> matcher = new ArgumentMatcher<ReadData>() {
 249             @Override
 250             public boolean matches(Object argument) {
 251                 return (argument instanceof ReadData) && ((ReadData)argument).getPath().equals(path);
 252             }
 253         };
 254
 255         return argThat(matcher);
 256     }
 257
 258     protected Future<Object> readyTxReply(String path) {
 259         return Futures.successful((Object)new ReadyTransactionReply(path));
 260     }
 261
 262
 263     protected Future<ReadDataReply> readDataReply(NormalizedNode<?, ?> data) {
 264         return Futures.successful(new ReadDataReply(data, DataStoreVersions.CURRENT_VERSION));
 265     }
 266
 267     protected Future<DataExistsReply> dataExistsReply(boolean exists) {
 268         return Futures.successful(DataExistsReply.create(exists));
 269     }
 270
 271     protected Future<BatchedModificationsReply> batchedModificationsReply(int count) {
 272         return Futures.successful(new BatchedModificationsReply(count));
 273     }
 274
 275     @SuppressWarnings("unchecked")
 276     protected Future<Object> incompleteFuture() {
 277         return mock(Future.class);
 278     }
 279
 280     protected ActorSelection actorSelection(ActorRef actorRef) {
 281         return getSystem().actorSelection(actorRef.path());
 282     }
 283
 284     protected void expectBatchedModifications(ActorRef actorRef, int count) {
 285         doReturn(batchedModificationsReply(count)).when(mockActorContext).executeOperationAsync(
 286                 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
 287     }
 288
 289     protected void expectBatchedModificationsReady(ActorRef actorRef) {
 290         expectBatchedModificationsReady(actorRef, false);
 291     }
 292
 293     protected void expectBatchedModificationsReady(ActorRef actorRef, boolean doCommitOnReady) {
 294         doReturn(doCommitOnReady ? Futures.successful(new CommitTransactionReply().toSerializable()) :
 295             readyTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
 296                     eq(actorSelection(actorRef)), isA(BatchedModifications.class));
 297     }
 298
 299     protected void expectBatchedModifications(int count) {
 300         doReturn(batchedModificationsReply(count)).when(mockActorContext).executeOperationAsync(
 301                 any(ActorSelection.class), isA(BatchedModifications.class));
 302     }
 303
 304     protected void expectIncompleteBatchedModifications() {
 305         doReturn(incompleteFuture()).when(mockActorContext).executeOperationAsync(
 306                 any(ActorSelection.class), isA(BatchedModifications.class));
 307     }
 308
 309     protected void expectFailedBatchedModifications(ActorRef actorRef) {
 310         doReturn(Futures.failed(new TestException())).when(mockActorContext).executeOperationAsync(
 311                 eq(actorSelection(actorRef)), isA(BatchedModifications.class));
 312     }
 313
 314     protected void expectReadyLocalTransaction(ActorRef actorRef, boolean doCommitOnReady) {
 315         doReturn(doCommitOnReady ? Futures.successful(new CommitTransactionReply().toSerializable()) :
 316             readyTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
 317                     eq(actorSelection(actorRef)), isA(ReadyLocalTransaction.class), any(Timeout.class));
 318     }
 319
 320     protected CreateTransactionReply createTransactionReply(ActorRef actorRef, int transactionVersion){
 321         return CreateTransactionReply.newBuilder()
 322             .setTransactionActorPath(actorRef.path().toString())
 323             .setTransactionId("txn-1")
 324             .setMessageVersion(transactionVersion)
 325             .build();
 326     }
 327
 328     protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem) {
 329         return setupActorContextWithoutInitialCreateTransaction(actorSystem, DefaultShardStrategy.DEFAULT_SHARD);
 330     }
 331
 332     protected Future<PrimaryShardInfo> primaryShardInfoReply(ActorSystem actorSystem, ActorRef actorRef) {
 333         return primaryShardInfoReply(actorSystem, actorRef, DataStoreVersions.CURRENT_VERSION);
 334     }
 335
 336     protected Future<PrimaryShardInfo> primaryShardInfoReply(ActorSystem actorSystem, ActorRef actorRef,
 337             short transactionVersion) {
 338         return Futures.successful(new PrimaryShardInfo(actorSystem.actorSelection(actorRef.path()),
 339                 transactionVersion, Optional.<DataTree>absent()));
 340     }
 341
 342     protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem, String shardName) {
 343         return setupActorContextWithoutInitialCreateTransaction(actorSystem, shardName, DataStoreVersions.CURRENT_VERSION);
 344     }
 345
 346     protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem, String shardName,
 347             short transactionVersion) {
 348         ActorRef actorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
 349         log.info("Created mock shard actor {}", actorRef);
 350
 351         doReturn(actorSystem.actorSelection(actorRef.path())).
 352                 when(mockActorContext).actorSelection(actorRef.path().toString());
 353
 354         doReturn(primaryShardInfoReply(actorSystem, actorRef, transactionVersion)).
 355                 when(mockActorContext).findPrimaryShardAsync(eq(shardName));
 356
 357         doReturn(false).when(mockActorContext).isPathLocal(actorRef.path().toString());
 358
 359         return actorRef;
 360     }
 361
 362     protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem,
 363             TransactionType type, short transactionVersion, String shardName) {
 364         ActorRef shardActorRef = setupActorContextWithoutInitialCreateTransaction(actorSystem, shardName,
 365                 transactionVersion);
 366
 367         return setupActorContextWithInitialCreateTransaction(actorSystem, type, transactionVersion,
 368                 memberName, shardActorRef);
 369     }
 370
 371     protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem,
 372             TransactionType type, short transactionVersion, String prefix, ActorRef shardActorRef) {
 373
 374         ActorRef txActorRef;
 375         if(type == TransactionType.WRITE_ONLY &&
 376                 dataStoreContextBuilder.build().isWriteOnlyTransactionOptimizationsEnabled()) {
 377             txActorRef = shardActorRef;
 378         } else {
 379             txActorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
 380             log.info("Created mock shard Tx actor {}", txActorRef);
 381
 382             doReturn(actorSystem.actorSelection(txActorRef.path())).
 383                 when(mockActorContext).actorSelection(txActorRef.path().toString());
 384
 385             doReturn(Futures.successful(createTransactionReply(txActorRef, transactionVersion))).when(mockActorContext).
 386                 executeOperationAsync(eq(actorSystem.actorSelection(shardActorRef.path())),
 387                         eqCreateTransaction(prefix, type), any(Timeout.class));
 388         }
 389
 390         return txActorRef;
 391     }
 392
 393     protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type) {
 394         return setupActorContextWithInitialCreateTransaction(actorSystem, type, DataStoreVersions.CURRENT_VERSION,
 395                 DefaultShardStrategy.DEFAULT_SHARD);
 396     }
 397
 398     protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type,
 399             String shardName) {
 400         return setupActorContextWithInitialCreateTransaction(actorSystem, type, DataStoreVersions.CURRENT_VERSION,
 401                 shardName);
 402     }
 403
 404     protected void propagateReadFailedExceptionCause(CheckedFuture<?, ReadFailedException> future)
 405             throws Throwable {
 406
 407         try {
 408             future.checkedGet(5, TimeUnit.SECONDS);
 409             fail("Expected ReadFailedException");
 410         } catch(ReadFailedException e) {
 411             assertNotNull("Expected a cause", e.getCause());
 412             if(e.getCause().getCause() != null) {
 413                 throw e.getCause().getCause();
 414             } else {
 415                 throw e.getCause();
 416             }
 417         }
 418     }
 419
 420     protected List<BatchedModifications> captureBatchedModifications(ActorRef actorRef) {
 421         ArgumentCaptor<BatchedModifications> batchedModificationsCaptor =
 422                 ArgumentCaptor.forClass(BatchedModifications.class);
 423         verify(mockActorContext, Mockito.atLeastOnce()).executeOperationAsync(
 424                 eq(actorSelection(actorRef)), batchedModificationsCaptor.capture());
 425
 426         List<BatchedModifications> batchedModifications = filterCaptured(
 427                 batchedModificationsCaptor, BatchedModifications.class);
 428         return batchedModifications;
 429     }
 430
 431     protected <T> List<T> filterCaptured(ArgumentCaptor<T> captor, Class<T> type) {
 432         List<T> captured = new ArrayList<>();
 433         for(T c: captor.getAllValues()) {
 434             if(type.isInstance(c)) {
 435                 captured.add(c);
 436             }
 437         }
 438
 439         return captured;
 440     }
 441
 442     protected void verifyOneBatchedModification(ActorRef actorRef, Modification expected, boolean expIsReady) {
 443         List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
 444         assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
 445
 446         verifyBatchedModifications(batchedModifications.get(0), expIsReady, expIsReady, expected);
 447     }
 448
 449     protected void verifyBatchedModifications(Object message, boolean expIsReady, Modification... expected) {
 450         verifyBatchedModifications(message, expIsReady, false, expected);
 451     }
 452
 453     protected void verifyBatchedModifications(Object message, boolean expIsReady, boolean expIsDoCommitOnReady,
 454             Modification... expected) {
 455         assertEquals("Message type", BatchedModifications.class, message.getClass());
 456         BatchedModifications batchedModifications = (BatchedModifications)message;
 457         assertEquals("BatchedModifications size", expected.length, batchedModifications.getModifications().size());
 458         assertEquals("isReady", expIsReady, batchedModifications.isReady());
 459         assertEquals("isDoCommitOnReady", expIsDoCommitOnReady, batchedModifications.isDoCommitOnReady());
 460         for(int i = 0; i < batchedModifications.getModifications().size(); i++) {
 461             Modification actual = batchedModifications.getModifications().get(i);
 462             assertEquals("Modification type", expected[i].getClass(), actual.getClass());
 463             assertEquals("getPath", ((AbstractModification)expected[i]).getPath(),
 464                     ((AbstractModification)actual).getPath());
 465             if(actual instanceof WriteModification) {
 466                 assertEquals("getData", ((WriteModification)expected[i]).getData(),
 467                         ((WriteModification)actual).getData());
 468             }
 469         }
 470     }
 471
 472     protected void verifyCohortFutures(AbstractThreePhaseCommitCohort<?> proxy,
 473             Object... expReplies) throws Exception {
 474             assertEquals("getReadyOperationFutures size", expReplies.length,
 475                     proxy.getCohortFutures().size());
 476
 477             List<Object> futureResults = new ArrayList<>();
 478             for( Future<?> future: proxy.getCohortFutures()) {
 479                 assertNotNull("Ready operation Future is null", future);
 480                 try {
 481                     futureResults.add(Await.result(future, Duration.create(5, TimeUnit.SECONDS)));
 482                 } catch(Exception e) {
 483                     futureResults.add(e);
 484                 }
 485             }
 486
 487             for(int i = 0; i < expReplies.length; i++) {
 488                 Object expReply = expReplies[i];
 489                 boolean found = false;
 490                 Iterator<?> iter = futureResults.iterator();
 491                 while(iter.hasNext()) {
 492                     Object actual = iter.next();
 493                     if(CommitTransactionReply.SERIALIZABLE_CLASS.isInstance(expReply) &&
 494                        CommitTransactionReply.SERIALIZABLE_CLASS.isInstance(actual)) {
 495                         found = true;
 496                     } else if(expReply instanceof ActorSelection && Objects.equal(expReply, actual)) {
 497                         found = true;
 498                     } else if(expReply instanceof Class && ((Class<?>)expReply).isInstance(actual)) {
 499                         found = true;
 500                     }
 501
 502                     if(found) {
 503                         iter.remove();
 504                         break;
 505                     }
 506                 }
 507
 508                 if(!found) {
 509                     fail(String.format("No cohort Future response found for %s. Actual: %s", expReply, futureResults));
 510                 }
 511             }
 512         }
 513 }