Convert DatastoreSnapshotRestore to OSGi DS
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / AbstractTransactionProxyTest.java
index ade30223e9a11e58499d7c433b9b784a42a9dd59..a40739f1145f6aba1f0e348968025f95c0913bce 100644 (file)
@@ -9,11 +9,12 @@ package org.opendaylight.controller.cluster.datastore;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
-import static org.mockito.Matchers.any;
-import static org.mockito.Matchers.argThat;
-import static org.mockito.Matchers.eq;
-import static org.mockito.Matchers.isA;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.argThat;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.ArgumentMatchers.isA;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
@@ -23,21 +24,21 @@ import akka.actor.ActorSelection;
 import akka.actor.ActorSystem;
 import akka.actor.Props;
 import akka.dispatch.Futures;
-import akka.testkit.JavaTestKit;
+import akka.testkit.javadsl.TestKit;
 import akka.util.Timeout;
 import com.codahale.metrics.MetricRegistry;
 import com.codahale.metrics.Timer;
 import com.google.common.base.Throwables;
 import com.google.common.collect.ImmutableMap;
-import com.google.common.util.concurrent.CheckedFuture;
+import com.google.common.util.concurrent.FluentFuture;
 import com.typesafe.config.Config;
 import com.typesafe.config.ConfigFactory;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import org.junit.AfterClass;
 import org.junit.Before;
@@ -70,12 +71,13 @@ import org.opendaylight.controller.cluster.datastore.modification.WriteModificat
 import org.opendaylight.controller.cluster.datastore.shardstrategy.DefaultShardStrategy;
 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
 import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
-import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
+import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
 import org.opendaylight.controller.md.cluster.datastore.model.CarsModel;
 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
-import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.common.api.ReadFailedException;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
@@ -83,7 +85,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import scala.concurrent.Await;
 import scala.concurrent.Future;
-import scala.concurrent.duration.Duration;
+import scala.concurrent.duration.FiniteDuration;
 
 /**
  * Abstract base class for TransactionProxy unit tests.
@@ -94,35 +96,54 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
     protected final Logger log = LoggerFactory.getLogger(getClass());
 
     private static ActorSystem system;
+    private static SchemaContext SCHEMA_CONTEXT;
 
     private final Configuration configuration = new MockConfiguration() {
         Map<String, ShardStrategy> strategyMap = ImmutableMap.<String, ShardStrategy>builder().put(
-                "junk", path -> "junk").put(
-                "cars", path -> "cars").build();
+                TestModel.JUNK_QNAME.getLocalName(), new ShardStrategy() {
+                    @Override
+                    public String findShard(final YangInstanceIdentifier path) {
+                        return TestModel.JUNK_QNAME.getLocalName();
+                    }
+
+                    @Override
+                    public YangInstanceIdentifier getPrefixForPath(final YangInstanceIdentifier path) {
+                        return YangInstanceIdentifier.empty();
+                    }
+                }).put(
+                CarsModel.BASE_QNAME.getLocalName(), new ShardStrategy() {
+                    @Override
+                    public String findShard(final YangInstanceIdentifier path) {
+                        return CarsModel.BASE_QNAME.getLocalName();
+                    }
+
+                    @Override
+                    public YangInstanceIdentifier getPrefixForPath(final YangInstanceIdentifier path) {
+                        return YangInstanceIdentifier.empty();
+                    }
+                }).build();
 
         @Override
-        public ShardStrategy getStrategyForModule(String moduleName) {
+        public ShardStrategy getStrategyForModule(final String moduleName) {
             return strategyMap.get(moduleName);
         }
 
         @Override
-        public String getModuleNameFromNameSpace(String nameSpace) {
+        public String getModuleNameFromNameSpace(final String nameSpace) {
             if (TestModel.JUNK_QNAME.getNamespace().toASCIIString().equals(nameSpace)) {
-                return "junk";
+                return TestModel.JUNK_QNAME.getLocalName();
             } else if (CarsModel.BASE_QNAME.getNamespace().toASCIIString().equals(nameSpace)) {
-                return "cars";
+                return CarsModel.BASE_QNAME.getLocalName();
             }
             return null;
         }
     };
 
     @Mock
-    protected ActorContext mockActorContext;
+    protected ActorUtils mockActorContext;
 
     protected TransactionContextFactory mockComponentFactory;
 
-    private SchemaContext schemaContext;
-
     @Mock
     private ClusterWrapper mockClusterWrapper;
 
@@ -133,36 +154,38 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
             .operationTimeoutInSeconds(operationTimeoutInSeconds);
 
     @BeforeClass
-    public static void setUpClass() throws IOException {
+    public static void setUpClass() {
 
         Config config = ConfigFactory.parseMap(ImmutableMap.<String, Object>builder()
                 .put("akka.actor.default-dispatcher.type",
                         "akka.testkit.CallingThreadDispatcherConfigurator").build())
                 .withFallback(ConfigFactory.load());
         system = ActorSystem.create("test", config);
+        SCHEMA_CONTEXT = TestModel.createTestContext();
     }
 
     @AfterClass
-    public static void tearDownClass() throws IOException {
-        JavaTestKit.shutdownActorSystem(system);
+    public static void tearDownClass() {
+        TestKit.shutdownActorSystem(system);
         system = null;
+        SCHEMA_CONTEXT = null;
     }
 
     @Before
     public void setUp() {
         MockitoAnnotations.initMocks(this);
 
-        schemaContext = TestModel.createTestContext();
-
         doReturn(getSystem()).when(mockActorContext).getActorSystem();
         doReturn(getSystem().dispatchers().defaultGlobalDispatcher()).when(mockActorContext).getClientDispatcher();
         doReturn(MemberName.forName(memberName)).when(mockActorContext).getCurrentMemberName();
-        doReturn(new ShardStrategyFactory(configuration)).when(mockActorContext).getShardStrategyFactory();
-        doReturn(schemaContext).when(mockActorContext).getSchemaContext();
+        doReturn(new ShardStrategyFactory(configuration,
+                LogicalDatastoreType.CONFIGURATION)).when(mockActorContext).getShardStrategyFactory();
+        doReturn(SCHEMA_CONTEXT).when(mockActorContext).getSchemaContext();
         doReturn(new Timeout(operationTimeoutInSeconds, TimeUnit.SECONDS)).when(mockActorContext).getOperationTimeout();
         doReturn(mockClusterWrapper).when(mockActorContext).getClusterWrapper();
         doReturn(mockClusterWrapper).when(mockActorContext).getClusterWrapper();
         doReturn(dataStoreContextBuilder.build()).when(mockActorContext).getDatastoreContext();
+        doReturn(new Timeout(5, TimeUnit.SECONDS)).when(mockActorContext).getTransactionCommitOperationTimeout();
 
         final ClientIdentifier mockClientId = MockIdentifiers.clientIdentifier(getClass(), memberName);
         mockComponentFactory = new TransactionContextFactory(mockActorContext, mockClientId);
@@ -177,31 +200,26 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
 
     protected CreateTransaction eqCreateTransaction(final String expMemberName,
             final TransactionType type) {
-        ArgumentMatcher<CreateTransaction> matcher = new ArgumentMatcher<CreateTransaction>() {
+        class CreateTransactionArgumentMatcher implements ArgumentMatcher<CreateTransaction> {
             @Override
-            public boolean matches(Object argument) {
-                if (CreateTransaction.class.equals(argument.getClass())) {
-                    CreateTransaction obj = CreateTransaction.fromSerializable(argument);
-                    return obj.getTransactionId().getHistoryId().getClientId().getFrontendId().getMemberName()
-                            .getName().equals(expMemberName) && obj.getTransactionType() == type.ordinal();
-                }
-
-                return false;
+            public boolean matches(CreateTransaction argument) {
+                return argument.getTransactionId().getHistoryId().getClientId().getFrontendId().getMemberName()
+                        .getName().equals(expMemberName) && argument.getTransactionType() == type.ordinal();
             }
-        };
+        }
 
-        return argThat(matcher);
+        return argThat(new CreateTransactionArgumentMatcher());
     }
 
     protected DataExists eqDataExists() {
-        ArgumentMatcher<DataExists> matcher = new ArgumentMatcher<DataExists>() {
+        class DataExistsArgumentMatcher implements ArgumentMatcher<DataExists> {
             @Override
-            public boolean matches(Object argument) {
-                return argument instanceof DataExists && ((DataExists)argument).getPath().equals(TestModel.TEST_PATH);
+            public boolean matches(DataExists argument) {
+                return argument.getPath().equals(TestModel.TEST_PATH);
             }
-        };
+        }
 
-        return argThat(matcher);
+        return argThat(new DataExistsArgumentMatcher());
     }
 
     protected ReadData eqReadData() {
@@ -209,30 +227,30 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
     }
 
     protected ReadData eqReadData(final YangInstanceIdentifier path) {
-        ArgumentMatcher<ReadData> matcher = new ArgumentMatcher<ReadData>() {
+        class ReadDataArgumentMatcher implements ArgumentMatcher<ReadData> {
             @Override
-            public boolean matches(Object argument) {
-                return argument instanceof ReadData && ((ReadData)argument).getPath().equals(path);
+            public boolean matches(ReadData argument) {
+                return argument.getPath().equals(path);
             }
-        };
+        }
 
-        return argThat(matcher);
+        return argThat(new ReadDataArgumentMatcher());
     }
 
-    protected Future<Object> readyTxReply(String path) {
+    protected Future<Object> readyTxReply(final String path) {
         return Futures.successful((Object)new ReadyTransactionReply(path));
     }
 
 
-    protected Future<ReadDataReply> readDataReply(NormalizedNode<?, ?> data) {
+    protected Future<ReadDataReply> readDataReply(final NormalizedNode<?, ?> data) {
         return Futures.successful(new ReadDataReply(data, DataStoreVersions.CURRENT_VERSION));
     }
 
-    protected Future<DataExistsReply> dataExistsReply(boolean exists) {
+    protected Future<DataExistsReply> dataExistsReply(final boolean exists) {
         return Futures.successful(new DataExistsReply(exists, DataStoreVersions.CURRENT_VERSION));
     }
 
-    protected Future<BatchedModificationsReply> batchedModificationsReply(int count) {
+    protected Future<BatchedModificationsReply> batchedModificationsReply(final int count) {
         return Futures.successful(new BatchedModificationsReply(count));
     }
 
@@ -241,25 +259,25 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
         return mock(Future.class);
     }
 
-    protected ActorSelection actorSelection(ActorRef actorRef) {
+    protected ActorSelection actorSelection(final ActorRef actorRef) {
         return getSystem().actorSelection(actorRef.path());
     }
 
-    protected void expectBatchedModifications(ActorRef actorRef, int count) {
+    protected void expectBatchedModifications(final ActorRef actorRef, final int count) {
         doReturn(batchedModificationsReply(count)).when(mockActorContext).executeOperationAsync(
                 eq(actorSelection(actorRef)), isA(BatchedModifications.class), any(Timeout.class));
     }
 
-    protected void expectBatchedModifications(int count) {
+    protected void expectBatchedModifications(final int count) {
         doReturn(batchedModificationsReply(count)).when(mockActorContext).executeOperationAsync(
                 any(ActorSelection.class), isA(BatchedModifications.class), any(Timeout.class));
     }
 
-    protected void expectBatchedModificationsReady(ActorRef actorRef) {
+    protected void expectBatchedModificationsReady(final ActorRef actorRef) {
         expectBatchedModificationsReady(actorRef, false);
     }
 
-    protected void expectBatchedModificationsReady(ActorRef actorRef, boolean doCommitOnReady) {
+    protected void expectBatchedModificationsReady(final ActorRef actorRef, final boolean doCommitOnReady) {
         doReturn(doCommitOnReady ? Futures.successful(new CommitTransactionReply().toSerializable()) :
             readyTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
                     eq(actorSelection(actorRef)), isA(BatchedModifications.class), any(Timeout.class));
@@ -270,32 +288,33 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
                 any(ActorSelection.class), isA(BatchedModifications.class), any(Timeout.class));
     }
 
-    protected void expectFailedBatchedModifications(ActorRef actorRef) {
+    protected void expectFailedBatchedModifications(final ActorRef actorRef) {
         doReturn(Futures.failed(new TestException())).when(mockActorContext).executeOperationAsync(
                 eq(actorSelection(actorRef)), isA(BatchedModifications.class), any(Timeout.class));
     }
 
-    protected void expectReadyLocalTransaction(ActorRef actorRef, boolean doCommitOnReady) {
+    protected void expectReadyLocalTransaction(final ActorRef actorRef, final boolean doCommitOnReady) {
         doReturn(doCommitOnReady ? Futures.successful(new CommitTransactionReply().toSerializable()) :
             readyTxReply(actorRef.path().toString())).when(mockActorContext).executeOperationAsync(
                     eq(actorSelection(actorRef)), isA(ReadyLocalTransaction.class), any(Timeout.class));
     }
 
-    protected CreateTransactionReply createTransactionReply(ActorRef actorRef, short transactionVersion) {
+    protected CreateTransactionReply createTransactionReply(final ActorRef actorRef, final short transactionVersion) {
         return new CreateTransactionReply(actorRef.path().toString(), nextTransactionId(), transactionVersion);
     }
 
-    protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem) {
+    protected ActorRef setupActorContextWithoutInitialCreateTransaction(final ActorSystem actorSystem) {
         return setupActorContextWithoutInitialCreateTransaction(actorSystem, DefaultShardStrategy.DEFAULT_SHARD);
     }
 
-    protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem, String shardName) {
+    protected ActorRef setupActorContextWithoutInitialCreateTransaction(final ActorSystem actorSystem,
+            final String shardName) {
         return setupActorContextWithoutInitialCreateTransaction(actorSystem, shardName,
                 DataStoreVersions.CURRENT_VERSION);
     }
 
-    protected ActorRef setupActorContextWithoutInitialCreateTransaction(ActorSystem actorSystem, String shardName,
-            short transactionVersion) {
+    protected ActorRef setupActorContextWithoutInitialCreateTransaction(final ActorSystem actorSystem,
+            final String shardName, final short transactionVersion) {
         ActorRef actorRef = actorSystem.actorOf(Props.create(DoNothingActor.class));
         log.info("Created mock shard actor {}", actorRef);
 
@@ -308,18 +327,18 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
         return actorRef;
     }
 
-    protected Future<PrimaryShardInfo> primaryShardInfoReply(ActorSystem actorSystem, ActorRef actorRef) {
+    protected Future<PrimaryShardInfo> primaryShardInfoReply(final ActorSystem actorSystem, final ActorRef actorRef) {
         return primaryShardInfoReply(actorSystem, actorRef, DataStoreVersions.CURRENT_VERSION);
     }
 
-    protected Future<PrimaryShardInfo> primaryShardInfoReply(ActorSystem actorSystem, ActorRef actorRef,
-            short transactionVersion) {
+    protected Future<PrimaryShardInfo> primaryShardInfoReply(final ActorSystem actorSystem, final ActorRef actorRef,
+            final short transactionVersion) {
         return Futures.successful(new PrimaryShardInfo(actorSystem.actorSelection(actorRef.path()),
                 transactionVersion));
     }
 
-    protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem,
-            TransactionType type, short transactionVersion, String shardName) {
+    protected ActorRef setupActorContextWithInitialCreateTransaction(final ActorSystem actorSystem,
+            final TransactionType type, final short transactionVersion, final String shardName) {
         ActorRef shardActorRef = setupActorContextWithoutInitialCreateTransaction(actorSystem, shardName,
                 transactionVersion);
 
@@ -327,8 +346,9 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
                 memberName, shardActorRef);
     }
 
-    protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem,
-            TransactionType type, short transactionVersion, String prefix, ActorRef shardActorRef) {
+    protected ActorRef setupActorContextWithInitialCreateTransaction(final ActorSystem actorSystem,
+            final TransactionType type, final short transactionVersion, final String prefix,
+            final ActorRef shardActorRef) {
 
         ActorRef txActorRef;
         if (type == TransactionType.WRITE_ONLY
@@ -349,36 +369,32 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
         return txActorRef;
     }
 
-    protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type) {
+    protected ActorRef setupActorContextWithInitialCreateTransaction(final ActorSystem actorSystem,
+            final TransactionType type) {
         return setupActorContextWithInitialCreateTransaction(actorSystem, type, DataStoreVersions.CURRENT_VERSION,
                 DefaultShardStrategy.DEFAULT_SHARD);
     }
 
-    protected ActorRef setupActorContextWithInitialCreateTransaction(ActorSystem actorSystem, TransactionType type,
-            String shardName) {
+    protected ActorRef setupActorContextWithInitialCreateTransaction(final ActorSystem actorSystem,
+            final TransactionType type,
+            final String shardName) {
         return setupActorContextWithInitialCreateTransaction(actorSystem, type, DataStoreVersions.CURRENT_VERSION,
                 shardName);
     }
 
-    protected void propagateReadFailedExceptionCause(CheckedFuture<?, ReadFailedException> future) throws Exception {
+    @SuppressWarnings({"checkstyle:avoidHidingCauseException", "checkstyle:IllegalThrows"})
+    protected void propagateReadFailedExceptionCause(final FluentFuture<?> future) throws Throwable {
         try {
-            future.checkedGet(5, TimeUnit.SECONDS);
+            future.get(5, TimeUnit.SECONDS);
             fail("Expected ReadFailedException");
-        } catch (ReadFailedException e) {
-            assertNotNull("Expected a cause", e.getCause());
-            Throwable cause;
-            if (e.getCause().getCause() != null) {
-                cause = e.getCause().getCause();
-            } else {
-                cause = e.getCause();
-            }
-
-            Throwables.propagateIfInstanceOf(cause, Exception.class);
-            Throwables.propagate(cause);
+        } catch (ExecutionException e) {
+            final Throwable cause = e.getCause();
+            assertTrue("Unexpected cause: " + cause.getClass(), cause instanceof ReadFailedException);
+            throw Throwables.getRootCause(cause);
         }
     }
 
-    protected List<BatchedModifications> captureBatchedModifications(ActorRef actorRef) {
+    protected List<BatchedModifications> captureBatchedModifications(final ActorRef actorRef) {
         ArgumentCaptor<BatchedModifications> batchedModificationsCaptor =
                 ArgumentCaptor.forClass(BatchedModifications.class);
         verify(mockActorContext, Mockito.atLeastOnce()).executeOperationAsync(
@@ -389,7 +405,7 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
         return batchedModifications;
     }
 
-    protected <T> List<T> filterCaptured(ArgumentCaptor<T> captor, Class<T> type) {
+    protected <T> List<T> filterCaptured(final ArgumentCaptor<T> captor, final Class<T> type) {
         List<T> captured = new ArrayList<>();
         for (T c: captor.getAllValues()) {
             if (type.isInstance(c)) {
@@ -400,19 +416,21 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
         return captured;
     }
 
-    protected void verifyOneBatchedModification(ActorRef actorRef, Modification expected, boolean expIsReady) {
+    protected void verifyOneBatchedModification(final ActorRef actorRef, final Modification expected,
+            final boolean expIsReady) {
         List<BatchedModifications> batchedModifications = captureBatchedModifications(actorRef);
         assertEquals("Captured BatchedModifications count", 1, batchedModifications.size());
 
         verifyBatchedModifications(batchedModifications.get(0), expIsReady, expIsReady, expected);
     }
 
-    protected void verifyBatchedModifications(Object message, boolean expIsReady, Modification... expected) {
+    protected void verifyBatchedModifications(final Object message, final boolean expIsReady,
+            final Modification... expected) {
         verifyBatchedModifications(message, expIsReady, false, expected);
     }
 
-    protected void verifyBatchedModifications(Object message, boolean expIsReady, boolean expIsDoCommitOnReady,
-            Modification... expected) {
+    protected void verifyBatchedModifications(final Object message, final boolean expIsReady,
+            final boolean expIsDoCommitOnReady, final Modification... expected) {
         assertEquals("Message type", BatchedModifications.class, message.getClass());
         BatchedModifications batchedModifications = (BatchedModifications)message;
         assertEquals("BatchedModifications size", expected.length, batchedModifications.getModifications().size());
@@ -431,8 +449,8 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
     }
 
     @SuppressWarnings("checkstyle:IllegalCatch")
-    protected void verifyCohortFutures(AbstractThreePhaseCommitCohort<?> proxy,
-            Object... expReplies) throws Exception {
+    protected void verifyCohortFutures(final AbstractThreePhaseCommitCohort<?> proxy,
+            final Object... expReplies) {
         assertEquals("getReadyOperationFutures size", expReplies.length,
                 proxy.getCohortFutures().size());
 
@@ -440,7 +458,7 @@ public abstract class AbstractTransactionProxyTest extends AbstractTest {
         for (Future<?> future : proxy.getCohortFutures()) {
             assertNotNull("Ready operation Future is null", future);
             try {
-                futureResults.add(Await.result(future, Duration.create(5, TimeUnit.SECONDS)));
+                futureResults.add(Await.result(future, FiniteDuration.create(5, TimeUnit.SECONDS)));
             } catch (Exception e) {
                 futureResults.add(e);
             }