Refactor Register*ListenerReply classes
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / DataChangeListenerRegistrationProxyTest.java
index aaf080bdf7d8d50de4a3f31713143389994872a6..64f088f1369d6fac8b1aab9c6a601ee64982d586 100644 (file)
+/*
+ * Copyright (c) 2014 Brocade Communications Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 package org.opendaylight.controller.cluster.datastore;
 
+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;
-import junit.framework.Assert;
+import akka.actor.Terminated;
+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.opendaylight.controller.cluster.datastore.messages.CloseDataChangeListenerRegistration;
+import org.mockito.Mockito;
+import org.mockito.stubbing.Answer;
+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.RegisterDataTreeNotificationListenerReply;
 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
-import org.opendaylight.controller.cluster.datastore.utils.DoNothingActor;
-import org.opendaylight.controller.cluster.datastore.utils.MessageCollectorActor;
-import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
-import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
-import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
+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 scala.concurrent.ExecutionContextExecutor;
+import scala.concurrent.Future;
+import scala.concurrent.duration.FiniteDuration;
 
-import java.util.List;
+/**
+ * Unit tests for DataChangeListenerRegistrationProxy.
+ *
+ * @author Thomas Pantelis
+ */
+public class DataChangeListenerRegistrationProxyTest extends AbstractActorTest {
 
-import static junit.framework.TestCase.assertEquals;
-import static junit.framework.TestCase.assertNotNull;
-import static junit.framework.TestCase.assertTrue;
+    @SuppressWarnings("unchecked")
+    private final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> mockListener =
+            Mockito.mock(AsyncDataChangeListener.class);
 
-public class DataChangeListenerRegistrationProxyTest extends AbstractActorTest{
+    @Test
+    public void testGetInstance() throws Exception {
+        try (DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                "shard", Mockito.mock(ActorContext.class), mockListener)) {
+            Assert.assertEquals(mockListener, proxy.getInstance());
+        }
+    }
 
-    private ActorRef dataChangeListenerActor = getSystem().actorOf(Props.create(DoNothingActor.class));
+    @Test(timeout = 10000)
+    public void testSuccessfulRegistration() {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = new ActorContext(getSystem(), getRef(),
+                        mock(ClusterWrapper.class), mock(Configuration.class));
 
-    private static class MockDataChangeListener implements
-        AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> {
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        "shard-1", actorContext, mockListener);
 
-        @Override public void onDataChanged(
-            AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
-            throw new UnsupportedOperationException("onDataChanged");
-        }
+                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", false, registerMsg.isRegisterOnAllInstances());
+
+                reply(new RegisterDataTreeNotificationListenerReply(getRef()));
+
+                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());
+
+                watch(proxy.getDataChangeListenerActor());
+
+                proxy.close();
+
+                // 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
-    public void testGetInstance() throws Exception {
-        final Props props = Props.create(MessageCollectorActor.class);
-        final ActorRef actorRef = getSystem().actorOf(props);
+    @Test(timeout = 10000)
+    public void testSuccessfulRegistrationForClusteredListener() {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = new ActorContext(getSystem(), getRef(),
+                    mock(ClusterWrapper.class), mock(Configuration.class));
+
+                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()));
 
-        MockDataChangeListener listener =
-            new MockDataChangeListener();
-        DataChangeListenerRegistrationProxy proxy =
-            new DataChangeListenerRegistrationProxy(
-                getSystem().actorSelection(actorRef.path()),
-                listener, dataChangeListenerActor);
+                RegisterChangeListener registerMsg = expectMsgClass(timeout, RegisterChangeListener.class);
+                Assert.assertEquals("getPath", path, registerMsg.getPath());
+                Assert.assertEquals("getScope", scope, registerMsg.getScope());
+                Assert.assertEquals("isRegisterOnAllInstances", true, registerMsg.isRegisterOnAllInstances());
 
-        Assert.assertEquals(listener, proxy.getInstance());
+                reply(new RegisterDataTreeNotificationListenerReply(getRef()));
 
+                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());
+
+                watch(proxy.getDataChangeListenerActor());
+
+                proxy.close();
+
+                // 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 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 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 LocalShardNotFound("shard-1"));
+
+                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 testClose() throws Exception {
-        final Props props = Props.create(MessageCollectorActor.class);
-        final ActorRef actorRef = getSystem().actorOf(props);
+    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.directExecutor());
 
-        DataChangeListenerRegistrationProxy proxy =
-            new DataChangeListenerRegistrationProxy(
-                getSystem().actorSelection(actorRef.path()),
-                new MockDataChangeListener(), dataChangeListenerActor);
 
-        proxy.close();
+                ActorContext actorContext = mock(ActorContext.class);
 
-        //Check if it was received by the remote actor
-        ActorContext
-            testContext = new ActorContext(getSystem(), getSystem().actorOf(Props.create(DoNothingActor.class)),new MockClusterWrapper(), new MockConfiguration());
-        Object messages = testContext
-            .executeOperation(actorRef, "messages");
+                doReturn(executor).when(actorContext).getClientDispatcher();
 
-        assertNotNull(messages);
+                String shardName = "shard-1";
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        shardName, actorContext, mockListener);
 
-        assertTrue(messages instanceof List);
+                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();
 
-        List<Object> listMessages = (List<Object>) messages;
+                proxy.init(YangInstanceIdentifier.of(TestModel.TEST_QNAME),
+                        AsyncDataBroker.DataChangeScope.ONE);
 
-        assertEquals(1, listMessages.size());
+                Assert.assertEquals("getListenerRegistrationActor", null, proxy.getListenerRegistrationActor());
 
-        assertTrue(listMessages.get(0).getClass()
-            .equals(CloseDataChangeListenerRegistration.SERIALIZABLE_CLASS));
+                proxy.close();
+            }
+        };
     }
 
     @Test
-    public void testCloseWhenRegistrationIsNull() throws Exception {
-        final Props props = Props.create(MessageCollectorActor.class);
-        final ActorRef actorRef = getSystem().actorOf(props);
+    public void testCloseBeforeRegistration() {
+        new JavaTestKit(getSystem()) {
+            {
+                ActorContext actorContext = mock(ActorContext.class);
 
-        DataChangeListenerRegistrationProxy proxy =
-            new DataChangeListenerRegistrationProxy(
-                new MockDataChangeListener(), dataChangeListenerActor);
+                String shardName = "shard-1";
+                final DataChangeListenerRegistrationProxy proxy = new DataChangeListenerRegistrationProxy(
+                        shardName, actorContext, mockListener);
 
-        proxy.close();
+                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));
 
-        //Check if it was received by the remote actor
-        ActorContext
-            testContext = new ActorContext(getSystem(), getSystem().actorOf(Props.create(DoNothingActor.class)),new MockClusterWrapper(), new MockConfiguration());
-        Object messages = testContext
-            .executeOperation(actorRef, "messages");
+                Answer<Future<Object>> answer = invocation -> {
+                    proxy.close();
+                    return Futures.successful((Object)new RegisterDataTreeNotificationListenerReply(getRef()));
+                };
 
-        assertNotNull(messages);
+                doAnswer(answer).when(actorContext).executeOperationAsync(any(ActorRef.class),
+                        any(Object.class), any(Timeout.class));
 
-        assertTrue(messages instanceof List);
+                proxy.init(YangInstanceIdentifier.of(TestModel.TEST_QNAME),
+                        AsyncDataBroker.DataChangeScope.ONE);
 
-        List<Object> listMessages = (List<Object>) messages;
+                expectMsgClass(duration("5 seconds"), CloseDataTreeNotificationListenerRegistration.class);
 
-        assertEquals(0, listMessages.size());
+                Assert.assertEquals("getListenerRegistrationActor", null, proxy.getListenerRegistrationActor());
+                proxy.close();
+            }
+        };
     }
 }