Refactor Register*ListenerReply classes
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / DataChangeListenerRegistrationProxyTest.java
index 9ac30095a5d9da2075168e946afa893f7e8c8eeb..64f088f1369d6fac8b1aab9c6a601ee64982d586 100644 (file)
@@ -7,7 +7,12 @@
  */
 package org.opendaylight.controller.cluster.datastore;
 
-import java.util.concurrent.TimeUnit;
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+
 import akka.actor.ActorRef;
 import akka.actor.ActorSystem;
 import akka.actor.Props;
@@ -16,36 +21,34 @@ import akka.dispatch.ExecutionContexts;
 import akka.dispatch.Futures;
 import akka.testkit.JavaTestKit;
 import akka.util.Timeout;
+import com.google.common.util.concurrent.MoreExecutors;
+import com.google.common.util.concurrent.Uninterruptibles;
+import java.util.concurrent.TimeUnit;
 import org.junit.Assert;
 import org.junit.Test;
 import org.mockito.Mockito;
-import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
-import org.opendaylight.controller.cluster.datastore.messages.ActorNotInitialized;
-import org.opendaylight.controller.cluster.datastore.messages.CloseDataChangeListenerRegistration;
+import org.opendaylight.controller.cluster.datastore.config.Configuration;
+import org.opendaylight.controller.cluster.datastore.exceptions.NotInitializedException;
+import org.opendaylight.controller.cluster.datastore.messages.CloseDataTreeNotificationListenerRegistration;
 import org.opendaylight.controller.cluster.datastore.messages.FindLocalShard;
 import org.opendaylight.controller.cluster.datastore.messages.LocalShardFound;
 import org.opendaylight.controller.cluster.datastore.messages.LocalShardNotFound;
 import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListener;
-import org.opendaylight.controller.cluster.datastore.messages.RegisterChangeListenerReply;
+import org.opendaylight.controller.cluster.datastore.messages.RegisterDataTreeNotificationListenerReply;
 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
-import org.opendaylight.controller.cluster.datastore.utils.DoNothingActor;
+import org.opendaylight.controller.cluster.datastore.utils.Dispatchers;
+import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
 import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
+import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataChangeListener;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import com.google.common.util.concurrent.MoreExecutors;
-import com.google.common.util.concurrent.Uninterruptibles;
 import scala.concurrent.ExecutionContextExecutor;
 import scala.concurrent.Future;
 import scala.concurrent.duration.FiniteDuration;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.any;
-import static org.mockito.Mockito.doReturn;
-import static org.mockito.Mockito.doAnswer;
-import static org.mockito.Mockito.eq;
 
 /**
  * Unit tests for DataChangeListenerRegistrationProxy.
@@ -60,198 +63,274 @@ public class DataChangeListenerRegistrationProxyTest extends AbstractActorTest {
 
     @Test
     public void testGetInstance() throws Exception {
-        DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
-                "shard", Mockito.mock(ActorContext.class), mockListener);
-
-        Assert.assertEquals(mockListener, proxy.getInstance());
+        try (DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                "shard", Mockito.mock(ActorContext.class), mockListener)) {
+            Assert.assertEquals(mockListener, proxy.getInstance());
+        }
     }
 
-    @SuppressWarnings("unchecked")
-    @Test(timeout=10000)
+    @Test(timeout = 10000)
     public void testSuccessfulRegistration() {
-        new JavaTestKit(getSystem()) {{
-            ActorContext actorContext = new ActorContext(getSystem(), getRef(),
-                    mock(ClusterWrapper.class), mock(Configuration.class));
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = new ActorContext(getSystem(), getRef(),
+                        mock(ClusterWrapper.class), mock(Configuration.class));
 
-            final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
-                    "shard-1", actorContext, mockListener);
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        "shard-1", actorContext, mockListener);
 
-            final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
-            final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
-            new Thread() {
-                @Override
-                public void run() {
-                    proxy.init(path, scope);
-                }
+                final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
+                final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
+                new Thread() {
+                    @Override
+                    public void run() {
+                        proxy.init(path, scope);
+                    }
 
-            }.start();
+                }.start();
 
-            FiniteDuration timeout = duration("5 seconds");
-            FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
-            Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
+                FiniteDuration timeout = duration("5 seconds");
+                FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
+                Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
 
-            reply(new LocalShardFound(getRef()));
+                reply(new LocalShardFound(getRef()));
 
-            RegisterChangeListener registerMsg = expectMsgClass(timeout, RegisterChangeListener.class);
-            Assert.assertEquals("getPath", path, registerMsg.getPath());
-            Assert.assertEquals("getScope", scope, registerMsg.getScope());
+                RegisterChangeListener registerMsg = expectMsgClass(timeout, RegisterChangeListener.class);
+                Assert.assertEquals("getPath", path, registerMsg.getPath());
+                Assert.assertEquals("getScope", scope, registerMsg.getScope());
+                Assert.assertEquals("isRegisterOnAllInstances", false, registerMsg.isRegisterOnAllInstances());
 
-            reply(new RegisterChangeListenerReply(getRef().path()));
+                reply(new RegisterDataTreeNotificationListenerReply(getRef()));
 
-            for(int i = 0; (i < 20 * 5) && proxy.getListenerRegistrationActor() == null; i++) {
-                Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
-            }
+                for (int i = 0; i < 20 * 5 && proxy.getListenerRegistrationActor() == null; i++) {
+                    Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
+                }
 
-            Assert.assertEquals("getListenerRegistrationActor", getSystem().actorSelection(getRef().path()),
-                    proxy.getListenerRegistrationActor());
+                Assert.assertEquals("getListenerRegistrationActor", getSystem().actorSelection(getRef().path()),
+                        proxy.getListenerRegistrationActor());
 
-            watch(proxy.getDataChangeListenerActor());
+                watch(proxy.getDataChangeListenerActor());
 
-            proxy.close();
+                proxy.close();
 
-            // The listener registration actor should get a Close message
-            expectMsgClass(timeout, CloseDataChangeListenerRegistration.SERIALIZABLE_CLASS);
+                // The listener registration actor should get a Close message
+                expectMsgClass(timeout, CloseDataTreeNotificationListenerRegistration.class);
 
-            // The DataChangeListener actor should be terminated
-            expectMsgClass(timeout, Terminated.class);
+                // The DataChangeListener actor should be terminated
+                expectMsgClass(timeout, Terminated.class);
 
-            proxy.close();
+                proxy.close();
 
-            expectNoMsg();
-        }};
+                expectNoMsg();
+            }
+        };
     }
 
-    @Test(timeout=10000)
-    public void testLocalShardNotFound() {
-        new JavaTestKit(getSystem()) {{
-            ActorContext actorContext = new ActorContext(getSystem(), getRef(),
+    @Test(timeout = 10000)
+    public void testSuccessfulRegistrationForClusteredListener() {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = new ActorContext(getSystem(), getRef(),
                     mock(ClusterWrapper.class), mock(Configuration.class));
 
-            final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
-                    "shard-1", actorContext, mockListener);
+                AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> mockClusteredListener =
+                        Mockito.mock(ClusteredDOMDataChangeListener.class);
+
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        "shard-1", actorContext, mockClusteredListener);
+
+                final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
+                final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
+                new Thread() {
+                    @Override
+                    public void run() {
+                        proxy.init(path, scope);
+                    }
+
+                }.start();
+
+                FiniteDuration timeout = duration("5 seconds");
+                FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
+                Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
+
+                reply(new LocalShardFound(getRef()));
+
+                RegisterChangeListener registerMsg = expectMsgClass(timeout, RegisterChangeListener.class);
+                Assert.assertEquals("getPath", path, registerMsg.getPath());
+                Assert.assertEquals("getScope", scope, registerMsg.getScope());
+                Assert.assertEquals("isRegisterOnAllInstances", true, registerMsg.isRegisterOnAllInstances());
+
+                reply(new RegisterDataTreeNotificationListenerReply(getRef()));
 
-            final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
-            final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
-            new Thread() {
-                @Override
-                public void run() {
-                    proxy.init(path, scope);
+                for (int i = 0; i < 20 * 5 && proxy.getListenerRegistrationActor() == null; i++) {
+                    Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
                 }
 
-            }.start();
+                Assert.assertEquals("getListenerRegistrationActor", getSystem().actorSelection(getRef().path()),
+                        proxy.getListenerRegistrationActor());
 
-            FiniteDuration timeout = duration("5 seconds");
-            FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
-            Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
+                watch(proxy.getDataChangeListenerActor());
 
-            reply(new LocalShardNotFound("shard-1"));
+                proxy.close();
 
-            expectNoMsg(duration("1 seconds"));
-        }};
+                // The listener registration actor should get a Close message
+                expectMsgClass(timeout, CloseDataTreeNotificationListenerRegistration.class);
+
+                // The DataChangeListener actor should be terminated
+                expectMsgClass(timeout, Terminated.class);
+
+                proxy.close();
+
+                expectNoMsg();
+            }
+        };
     }
 
-    @Test(timeout=10000)
-    public void testLocalShardNotInitialized() {
-        new JavaTestKit(getSystem()) {{
-            ActorContext actorContext = new ActorContext(getSystem(), getRef(),
-                    mock(ClusterWrapper.class), mock(Configuration.class));
+    @Test(timeout = 10000)
+    public void testLocalShardNotFound() {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = new ActorContext(getSystem(), getRef(),
+                        mock(ClusterWrapper.class), mock(Configuration.class));
 
-            final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
-                    "shard-1", actorContext, mockListener);
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        "shard-1", actorContext, mockListener);
 
-            final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
-            final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
-            new Thread() {
-                @Override
-                public void run() {
-                    proxy.init(path, scope);
-                }
+                final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
+                final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
+                new Thread() {
+                    @Override
+                    public void run() {
+                        proxy.init(path, scope);
+                    }
 
-            }.start();
+                }.start();
 
-            FiniteDuration timeout = duration("5 seconds");
-            FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
-            Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
+                FiniteDuration timeout = duration("5 seconds");
+                FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
+                Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
 
-            reply(new ActorNotInitialized());
+                reply(new LocalShardNotFound("shard-1"));
 
-            new Within(duration("1 seconds")) {
-                @Override
-                protected void run() {
-                    expectNoMsg();
-                }
-            };
-        }};
+                expectNoMsg(duration("1 seconds"));
+
+                proxy.close();
+            }
+        };
+    }
+
+    @Test(timeout = 10000)
+    public void testLocalShardNotInitialized() {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = new ActorContext(getSystem(), getRef(),
+                        mock(ClusterWrapper.class), mock(Configuration.class));
+
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        "shard-1", actorContext, mockListener);
+
+                final YangInstanceIdentifier path = YangInstanceIdentifier.of(TestModel.TEST_QNAME);
+                final DataChangeScope scope = AsyncDataBroker.DataChangeScope.ONE;
+                new Thread() {
+                    @Override
+                    public void run() {
+                        proxy.init(path, scope);
+                    }
+
+                }.start();
+
+                FiniteDuration timeout = duration("5 seconds");
+                FindLocalShard findLocalShard = expectMsgClass(timeout, FindLocalShard.class);
+                Assert.assertEquals("getShardName", "shard-1", findLocalShard.getShardName());
+
+                reply(new NotInitializedException("not initialized"));
+
+                new Within(duration("1 seconds")) {
+                    @Override
+                    protected void run() {
+                        expectNoMsg();
+                    }
+                };
+
+                proxy.close();
+            }
+        };
     }
 
     @Test
     public void testFailedRegistration() {
-        new JavaTestKit(getSystem()) {{
-            ActorSystem mockActorSystem = mock(ActorSystem.class);
-
-            ActorRef mockActor = getSystem().actorOf(Props.create(DoNothingActor.class),
-                    "testFailedRegistration");
-            doReturn(mockActor).when(mockActorSystem).actorOf(any(Props.class));
-            ExecutionContextExecutor executor = ExecutionContexts.fromExecutor(
-                    MoreExecutors.sameThreadExecutor());
-            doReturn(executor).when(mockActorSystem).dispatcher();
-
-            ActorContext actorContext = mock(ActorContext.class);
-
-            String shardName = "shard-1";
-            final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
-                    shardName, actorContext, mockListener);
-
-            doReturn(mockActorSystem).when(actorContext).getActorSystem();
-            doReturn(duration("5 seconds")).when(actorContext).getOperationDuration();
-            doReturn(Futures.successful(getRef())).when(actorContext).findLocalShardAsync(eq(shardName));
-            doReturn(Futures.failed(new RuntimeException("mock"))).
-                    when(actorContext).executeOperationAsync(any(ActorRef.class),
-                            any(Object.class), any(Timeout.class));
-
-            proxy.init(YangInstanceIdentifier.of(TestModel.TEST_QNAME),
-                    AsyncDataBroker.DataChangeScope.ONE);
-
-            Assert.assertEquals("getListenerRegistrationActor", null,
-                    proxy.getListenerRegistrationActor());
-        }};
+        new JavaTestKit(getSystem()) {
+            {
+                ActorSystem mockActorSystem = mock(ActorSystem.class);
+
+                ActorRef mockActor = getSystem().actorOf(Props.create(DoNothingActor.class),
+                        "testFailedRegistration");
+                doReturn(mockActor).when(mockActorSystem).actorOf(any(Props.class));
+                ExecutionContextExecutor executor = ExecutionContexts.fromExecutor(
+                        MoreExecutors.directExecutor());
+
+
+                ActorContext actorContext = mock(ActorContext.class);
+
+                doReturn(executor).when(actorContext).getClientDispatcher();
+
+                String shardName = "shard-1";
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        shardName, actorContext, mockListener);
+
+                doReturn(mockActorSystem).when(actorContext).getActorSystem();
+                doReturn(duration("5 seconds")).when(actorContext).getOperationDuration();
+                doReturn(Futures.successful(getRef())).when(actorContext).findLocalShardAsync(eq(shardName));
+                doReturn(Futures.failed(new RuntimeException("mock")))
+                    .when(actorContext).executeOperationAsync(any(ActorRef.class),
+                        any(Object.class), any(Timeout.class));
+                doReturn(mock(DatastoreContext.class)).when(actorContext).getDatastoreContext();
+
+                proxy.init(YangInstanceIdentifier.of(TestModel.TEST_QNAME),
+                        AsyncDataBroker.DataChangeScope.ONE);
+
+                Assert.assertEquals("getListenerRegistrationActor", null, proxy.getListenerRegistrationActor());
+
+                proxy.close();
+            }
+        };
     }
 
-    @SuppressWarnings("unchecked")
     @Test
     public void testCloseBeforeRegistration() {
-        new JavaTestKit(getSystem()) {{
-            ActorContext actorContext = mock(ActorContext.class);
-
-            String shardName = "shard-1";
-            final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
-                    shardName, actorContext, mockListener);
-
-            doReturn(DatastoreContext.newBuilder().build()).when(actorContext).getDatastoreContext();
-            doReturn(getSystem()).when(actorContext).getActorSystem();
-            doReturn(getSystem().actorSelection(getRef().path())).
-                    when(actorContext).actorSelection(getRef().path());
-            doReturn(duration("5 seconds")).when(actorContext).getOperationDuration();
-            doReturn(Futures.successful(getRef())).when(actorContext).findLocalShardAsync(eq(shardName));
-
-            Answer<Future<Object>> answer = new Answer<Future<Object>>() {
-                @Override
-                public Future<Object> answer(InvocationOnMock invocation) {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = mock(ActorContext.class);
+
+                String shardName = "shard-1";
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        shardName, actorContext, mockListener);
+
+                doReturn(DatastoreContext.newBuilder().build()).when(actorContext).getDatastoreContext();
+                doReturn(getSystem().dispatchers().defaultGlobalDispatcher()).when(actorContext).getClientDispatcher();
+                doReturn(getSystem()).when(actorContext).getActorSystem();
+                doReturn(Dispatchers.DEFAULT_DISPATCHER_PATH).when(actorContext).getNotificationDispatcherPath();
+                doReturn(getSystem().actorSelection(getRef().path()))
+                    .when(actorContext).actorSelection(getRef().path());
+                doReturn(duration("5 seconds")).when(actorContext).getOperationDuration();
+                doReturn(Futures.successful(getRef())).when(actorContext).findLocalShardAsync(eq(shardName));
+
+                Answer<Future<Object>> answer = invocation -> {
                     proxy.close();
-                    return Futures.successful((Object)new RegisterChangeListenerReply(getRef().path()));
-                }
-            };
+                    return Futures.successful((Object)new RegisterDataTreeNotificationListenerReply(getRef()));
+                };
 
-            doAnswer(answer).when(actorContext).executeOperationAsync(any(ActorRef.class),
-                    any(Object.class), any(Timeout.class));
+                doAnswer(answer).when(actorContext).executeOperationAsync(any(ActorRef.class),
+                        any(Object.class), any(Timeout.class));
 
-            proxy.init(YangInstanceIdentifier.of(TestModel.TEST_QNAME),
-                    AsyncDataBroker.DataChangeScope.ONE);
+                proxy.init(YangInstanceIdentifier.of(TestModel.TEST_QNAME),
+                        AsyncDataBroker.DataChangeScope.ONE);
 
-            expectMsgClass(duration("5 seconds"), CloseDataChangeListenerRegistration.SERIALIZABLE_CLASS);
+                expectMsgClass(duration("5 seconds"), CloseDataTreeNotificationListenerRegistration.class);
 
-            Assert.assertEquals("getListenerRegistrationActor", null,
-                    proxy.getListenerRegistrationActor());
-        }};
+                Assert.assertEquals("getListenerRegistrationActor", null, proxy.getListenerRegistrationActor());
+                proxy.close();
+            }
+        };
     }
 }