Add unit test for FrontedMetadata memory leaks
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / ThreePhaseCommitCohortProxyTest.java
index 54a6f1ce232a1e51fe001924d10b00ef6ebcae0e..b7a303e8d2eec6729e8952065566923f1fc152bd 100644 (file)
@@ -13,16 +13,17 @@ import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.fail;
 import static org.mockito.Mockito.doReturn;
 import static org.opendaylight.controller.cluster.datastore.DataStoreVersions.CURRENT_VERSION;
+
 import akka.actor.ActorSelection;
 import akka.actor.Props;
-import akka.actor.UntypedActor;
+import akka.actor.UntypedAbstractActor;
 import akka.dispatch.Dispatchers;
 import akka.dispatch.Futures;
 import akka.testkit.TestActorRef;
 import com.codahale.metrics.Snapshot;
 import com.codahale.metrics.Timer;
 import com.google.common.base.Preconditions;
-import com.google.common.base.Supplier;
+import com.google.common.base.Throwables;
 import com.google.common.util.concurrent.ListenableFuture;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -44,7 +45,7 @@ import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransacti
 import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransactionReply;
 import org.opendaylight.controller.cluster.datastore.messages.CommitTransaction;
 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
-import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
+import org.opendaylight.controller.cluster.datastore.utils.ActorUtils;
 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
 import org.opendaylight.controller.cluster.datastore.utils.PrimaryShardInfoFutureCache;
@@ -57,7 +58,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
     static class TestException extends RuntimeException {
     }
 
-    private ActorContext actorContext;
+    private ActorUtils actorUtils;
 
     @Mock
     private Timer commitTimer;
@@ -77,23 +78,23 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
     public void setUp() {
         MockitoAnnotations.initMocks(this);
 
-        actorContext = new ActorContext(getSystem(), actorFactory.createActor(Props.create(DoNothingActor.class)),
-                new MockClusterWrapper(), new MockConfiguration(),
-                DatastoreContext.newBuilder().build(), new PrimaryShardInfoFutureCache()) {
-                    @Override
-                    public Timer getOperationTimer(String operationName) {
-                        return commitTimer;
-                    }
+        actorUtils = new ActorUtils(getSystem(), actorFactory.createActor(Props.create(DoNothingActor.class)),
+                new MockClusterWrapper(), new MockConfiguration(), DatastoreContext.newBuilder().build(),
+                new PrimaryShardInfoFutureCache()) {
+            @Override
+            public Timer getOperationTimer(final String operationName) {
+                return commitTimer;
+            }
 
-                    @Override
-                    public double getTxCreationLimit() {
-                        return 10.0;
-                    }
-                };
+            @Override
+            public double getTxCreationLimit() {
+                return 10.0;
+            }
+        };
 
         doReturn(commitTimerContext).when(commitTimer).time();
         doReturn(commitSnapshot).when(commitTimer).getSnapshot();
-        for(int i=1;i<11;i++){
+        for (int i = 1; i < 11; i++) {
             // Keep on increasing the amount of time it takes to complete transaction for each tenth of a
             // percentile. Essentially this would be 1ms for the 10th percentile, 2ms for 20th percentile and so on.
             doReturn(TimeUnit.MILLISECONDS.toNanos(i) * 1D).when(commitSnapshot).getValue(i * 0.1);
@@ -102,7 +103,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
 
     @Test
     public void testCanCommitYesWithOneCohort() throws Exception {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx).expectCanCommit(
                         CanCommitTransactionReply.yes(CURRENT_VERSION)))), tx);
 
@@ -112,7 +113,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
 
     @Test
     public void testCanCommitNoWithOneCohort() throws Exception {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx).expectCanCommit(
                         CanCommitTransactionReply.no(CURRENT_VERSION)))), tx);
 
@@ -127,7 +128,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
                         CanCommitTransactionReply.yes(CURRENT_VERSION))),
                 newCohortInfo(new CohortActor.Builder(tx).expectCanCommit(
                         CanCommitTransactionReply.yes(CURRENT_VERSION))));
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, cohorts, tx);
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, cohorts, tx);
 
         verifyCanCommit(proxy.canCommit(), true);
         verifyCohortActors();
@@ -141,35 +142,35 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
                 newCohortInfo(new CohortActor.Builder(tx).expectCanCommit(
                         CanCommitTransactionReply.no(CURRENT_VERSION))),
                 newCohortInfo(new CohortActor.Builder(tx)));
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, cohorts, tx);
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, cohorts, tx);
 
         verifyCanCommit(proxy.canCommit(), false);
         verifyCohortActors();
     }
 
     @Test(expected = TestException.class)
-    public void testCanCommitWithExceptionFailure() throws Throwable {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
+    public void testCanCommitWithExceptionFailure() throws Exception {
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx).expectCanCommit(new TestException()))), tx);
 
         propagateExecutionExceptionCause(proxy.canCommit());
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void testCanCommitWithInvalidResponseType() throws Throwable {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
+    public void testCanCommitWithInvalidResponseType() throws Exception {
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx).expectCanCommit("invalid"))), tx);
 
         propagateExecutionExceptionCause(proxy.canCommit());
     }
 
     @Test(expected = TestException.class)
-    public void testCanCommitWithFailedCohortFuture() throws Throwable {
+    public void testCanCommitWithFailedCohortFuture() throws Exception {
         List<CohortInfo> cohorts = Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx)),
                 newCohortInfoWithFailedFuture(new TestException()),
                 newCohortInfo(new CohortActor.Builder(tx)));
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, cohorts, tx);
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, cohorts, tx);
 
         propagateExecutionExceptionCause(proxy.canCommit());
     }
@@ -177,13 +178,13 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
     @Test
     public void testAllThreePhasesSuccessful() throws Exception {
         List<CohortInfo> cohorts = Arrays.asList(
-                newCohortInfo(new CohortActor.Builder(tx).
-                        expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION)).
-                        expectCommit(CommitTransactionReply.instance(CURRENT_VERSION))),
-                newCohortInfo(new CohortActor.Builder(tx).
-                        expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION)).
-                        expectCommit(CommitTransactionReply.instance(CURRENT_VERSION))));
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, cohorts, tx);
+                newCohortInfo(
+                        new CohortActor.Builder(tx).expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION))
+                                .expectCommit(CommitTransactionReply.instance(CURRENT_VERSION))),
+                newCohortInfo(
+                        new CohortActor.Builder(tx).expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION))
+                                .expectCommit(CommitTransactionReply.instance(CURRENT_VERSION))));
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, cohorts, tx);
 
         verifyCanCommit(proxy.canCommit(), true);
         verifySuccessfulFuture(proxy.preCommit());
@@ -192,15 +193,15 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
     }
 
     @Test(expected = TestException.class)
-    public void testCommitWithExceptionFailure() throws Throwable {
+    public void testCommitWithExceptionFailure() throws Exception {
         List<CohortInfo> cohorts = Arrays.asList(
-                newCohortInfo(new CohortActor.Builder(tx).
-                        expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION)).
-                        expectCommit(CommitTransactionReply.instance(CURRENT_VERSION))),
-                newCohortInfo(new CohortActor.Builder(tx).
-                        expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION)).
-                        expectCommit(new TestException())));
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, cohorts, tx);
+                newCohortInfo(
+                        new CohortActor.Builder(tx).expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION))
+                                .expectCommit(CommitTransactionReply.instance(CURRENT_VERSION))),
+                newCohortInfo(
+                        new CohortActor.Builder(tx).expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION))
+                                .expectCommit(new TestException())));
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, cohorts, tx);
 
         verifyCanCommit(proxy.canCommit(), true);
         verifySuccessfulFuture(proxy.preCommit());
@@ -208,11 +209,10 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
     }
 
     @Test(expected = IllegalArgumentException.class)
-    public void testCommitWithInvalidResponseType() throws Throwable {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
-                newCohortInfo(new CohortActor.Builder(tx).
-                        expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION)).
-                        expectCommit("invalid"))), tx);
+    public void testCommitWithInvalidResponseType() throws Exception {
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils,
+                Arrays.asList(newCohortInfo(new CohortActor.Builder(tx)
+                        .expectCanCommit(CanCommitTransactionReply.yes(CURRENT_VERSION)).expectCommit("invalid"))), tx);
 
         verifyCanCommit(proxy.canCommit(), true);
         verifySuccessfulFuture(proxy.preCommit());
@@ -221,7 +221,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
 
     @Test
     public void testAbort() throws Exception {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx).expectAbort(
                         AbortTransactionReply.instance(CURRENT_VERSION)))), tx);
 
@@ -231,7 +231,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
 
     @Test
     public void testAbortWithFailure() throws Exception {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, Arrays.asList(
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, Arrays.asList(
                 newCohortInfo(new CohortActor.Builder(tx).expectAbort(new RuntimeException("mock")))), tx);
 
         // The exception should not get propagated.
@@ -240,10 +240,10 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
     }
 
     @Test
-    public void testAbortWithFailedCohortFuture() throws Throwable {
+    public void testAbortWithFailedCohortFuture() throws Exception {
         List<CohortInfo> cohorts = Arrays.asList(
                 newCohortInfoWithFailedFuture(new TestException()), newCohortInfo(new CohortActor.Builder(tx)));
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext, cohorts, tx);
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils, cohorts, tx);
 
         verifySuccessfulFuture(proxy.abort());
         verifyCohortActors();
@@ -251,7 +251,7 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
 
     @Test
     public void testWithNoCohorts() throws Exception {
-        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorContext,
+        ThreePhaseCommitCohortProxy proxy = new ThreePhaseCommitCohortProxy(actorUtils,
                 Collections.<CohortInfo>emptyList(), tx);
 
         verifyCanCommit(proxy.canCommit(), true);
@@ -260,84 +260,76 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
         verifyCohortActors();
     }
 
-    private void propagateExecutionExceptionCause(ListenableFuture<?> future) throws Throwable {
-
+    @SuppressWarnings("checkstyle:avoidHidingCauseException")
+    private void propagateExecutionExceptionCause(final ListenableFuture<?> future) throws Exception {
         try {
             future.get(5, TimeUnit.SECONDS);
             fail("Expected ExecutionException");
-        } catch(ExecutionException e) {
+        } catch (ExecutionException e) {
             verifyCohortActors();
-            throw e.getCause();
+            Throwables.propagateIfPossible(e.getCause(), Exception.class);
+            throw new RuntimeException(e.getCause());
         }
     }
 
-    private CohortInfo newCohortInfo(CohortActor.Builder builder, final short version) {
-        TestActorRef<CohortActor> actor = actorFactory.createTestActor(builder.props().
-                withDispatcher(Dispatchers.DefaultDispatcherId()), actorFactory.generateActorId("cohort"));
+    private CohortInfo newCohortInfo(final CohortActor.Builder builder, final short version) {
+        TestActorRef<CohortActor> actor = actorFactory.createTestActor(builder.props()
+                .withDispatcher(Dispatchers.DefaultDispatcherId()), actorFactory.generateActorId("cohort"));
         cohortActors.add(actor);
-        return new CohortInfo(Futures.successful(getSystem().actorSelection(actor.path())), new Supplier<Short>() {
-            @Override
-            public Short get() {
-                return version;
-            }
-        });
+        return new CohortInfo(Futures.successful(getSystem().actorSelection(actor.path())), () -> version);
     }
 
-    private static CohortInfo newCohortInfoWithFailedFuture(Exception failure) {
-        return new CohortInfo(Futures.<ActorSelection>failed(failure), new Supplier<Short>() {
-            @Override
-            public Short get() {
-                return CURRENT_VERSION;
-            }
-        });
+    private CohortInfo newCohortInfo(final CohortActor.Builder builder) {
+        return newCohortInfo(builder, CURRENT_VERSION);
     }
 
-    private CohortInfo newCohortInfo(CohortActor.Builder builder) {
-        return newCohortInfo(builder, CURRENT_VERSION);
+    private static CohortInfo newCohortInfoWithFailedFuture(final Exception failure) {
+        return new CohortInfo(Futures.<ActorSelection>failed(failure), () -> CURRENT_VERSION);
     }
 
     private void verifyCohortActors() {
-        for(TestActorRef<CohortActor> actor: cohortActors) {
+        for (TestActorRef<CohortActor> actor: cohortActors) {
             actor.underlyingActor().verify();
         }
     }
 
-    private <T> T verifySuccessfulFuture(ListenableFuture<T> future) throws Exception {
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    private <T> T verifySuccessfulFuture(final ListenableFuture<T> future) throws Exception {
         try {
             return future.get(5, TimeUnit.SECONDS);
-        } catch(Exception e) {
+        } catch (Exception e) {
             verifyCohortActors();
             throw e;
         }
     }
 
-    private void verifyCanCommit(ListenableFuture<Boolean> future, boolean expected) throws Exception {
+    private void verifyCanCommit(final ListenableFuture<Boolean> future, final boolean expected) throws Exception {
         Boolean actual = verifySuccessfulFuture(future);
         assertEquals("canCommit", expected, actual);
     }
 
-    private static class CohortActor extends UntypedActor {
+    private static class CohortActor extends UntypedAbstractActor {
         private final Builder builder;
         private final AtomicInteger canCommitCount = new AtomicInteger();
         private final AtomicInteger commitCount = new AtomicInteger();
         private final AtomicInteger abortCount = new AtomicInteger();
         private volatile AssertionError assertionError;
 
-        private CohortActor(Builder builder) {
+        CohortActor(final Builder builder) {
             this.builder = builder;
         }
 
         @Override
-        public void onReceive(Object message) {
-            if(CanCommitTransaction.isSerializedType(message)) {
+        public void onReceive(final Object message) {
+            if (CanCommitTransaction.isSerializedType(message)) {
                 canCommitCount.incrementAndGet();
                 onMessage("CanCommitTransaction", message, CanCommitTransaction.fromSerializable(message),
                         builder.expCanCommitType, builder.canCommitReply);
-            } else if(CommitTransaction.isSerializedType(message)) {
+            } else if (CommitTransaction.isSerializedType(message)) {
                 commitCount.incrementAndGet();
                 onMessage("CommitTransaction", message, CommitTransaction.fromSerializable(message),
                         builder.expCommitType, builder.commitReply);
-            } else if(AbortTransaction.isSerializedType(message)) {
+            } else if (AbortTransaction.isSerializedType(message)) {
                 abortCount.incrementAndGet();
                 onMessage("AbortTransaction", message, AbortTransaction.fromSerializable(message),
                         builder.expAbortType, builder.abortReply);
@@ -346,37 +338,37 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
             }
         }
 
-        private void onMessage(String name, Object rawMessage, AbstractThreePhaseCommitMessage actualMessage,
-                Class<?> expType, Object reply) {
+        private void onMessage(final String name, final Object rawMessage,
+                final AbstractThreePhaseCommitMessage actualMessage, final Class<?> expType, final Object reply) {
             try {
                 assertNotNull("Unexpected " + name, expType);
                 assertEquals(name + " type", expType, rawMessage.getClass());
-                assertEquals(name + " transactionId", builder.transactionId, actualMessage.getTransactionID());
+                assertEquals(name + " transactionId", builder.transactionId, actualMessage.getTransactionId());
 
-                if(reply instanceof Throwable) {
+                if (reply instanceof Throwable) {
                     getSender().tell(new akka.actor.Status.Failure((Throwable)reply), self());
                 } else {
                     getSender().tell(reply, self());
                 }
-            } catch(AssertionError e) {
+            } catch (AssertionError e) {
                 assertionError = e;
             }
         }
 
         void verify() {
-            if(assertionError != null) {
+            if (assertionError != null) {
                 throw assertionError;
             }
 
-            if(builder.expCanCommitType != null) {
+            if (builder.expCanCommitType != null) {
                 assertEquals("CanCommitTransaction count", 1, canCommitCount.get());
             }
 
-            if(builder.expCommitType != null) {
+            if (builder.expCommitType != null) {
                 assertEquals("CommitTransaction count", 1, commitCount.get());
             }
 
-            if(builder.expAbortType != null) {
+            if (builder.expAbortType != null) {
                 assertEquals("AbortTransaction count", 1, abortCount.get());
             }
         }
@@ -390,38 +382,38 @@ public class ThreePhaseCommitCohortProxyTest extends AbstractActorTest {
             private Object abortReply;
             private final TransactionIdentifier transactionId;
 
-            Builder(TransactionIdentifier transactionId) {
+            Builder(final TransactionIdentifier transactionId) {
                 this.transactionId = Preconditions.checkNotNull(transactionId);
             }
 
-            Builder expectCanCommit(Class<?> expCanCommitType, Object canCommitReply) {
-                this.expCanCommitType = expCanCommitType;
-                this.canCommitReply = canCommitReply;
+            Builder expectCanCommit(final Class<?> newExpCanCommitType, final Object newCanCommitReply) {
+                this.expCanCommitType = newExpCanCommitType;
+                this.canCommitReply = newCanCommitReply;
                 return this;
             }
 
-            Builder expectCanCommit(Object canCommitReply) {
-                return expectCanCommit(CanCommitTransaction.class, canCommitReply);
+            Builder expectCanCommit(final Object newCanCommitReply) {
+                return expectCanCommit(CanCommitTransaction.class, newCanCommitReply);
             }
 
-            Builder expectCommit(Class<?> expCommitType, Object commitReply) {
-                this.expCommitType = expCommitType;
-                this.commitReply = commitReply;
+            Builder expectCommit(final Class<?> newExpCommitType, final Object newCommitReply) {
+                this.expCommitType = newExpCommitType;
+                this.commitReply = newCommitReply;
                 return this;
             }
 
-            Builder expectCommit(Object commitReply) {
-                return expectCommit(CommitTransaction.class, commitReply);
+            Builder expectCommit(final Object newCommitReply) {
+                return expectCommit(CommitTransaction.class, newCommitReply);
             }
 
-            Builder expectAbort(Class<?> expAbortType, Object abortReply) {
-                this.expAbortType = expAbortType;
-                this.abortReply = abortReply;
+            Builder expectAbort(final Class<?> newExpAbortType, final Object newAbortReply) {
+                this.expAbortType = newExpAbortType;
+                this.abortReply = newAbortReply;
                 return this;
             }
 
-            Builder expectAbort(Object abortReply) {
-                return expectAbort(AbortTransaction.class, abortReply);
+            Builder expectAbort(final Object newAbortReply) {
+                return expectAbort(AbortTransaction.class, newAbortReply);
             }
 
             Props props() {