Merge "Bug 1965: Fixed DataChangedReply sent to deadletters"
authorMoiz Raja <moraja@cisco.com>
Thu, 16 Oct 2014 20:51:59 +0000 (20:51 +0000)
committerGerrit Code Review <gerrit@opendaylight.org>
Thu, 16 Oct 2014 20:51:59 +0000 (20:51 +0000)
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListener.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/DataChangeListenerProxy.java
opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/DataChangeListenerTest.java

index f1c0df4c3ad2a336a6aa8edc7282aa399f160c13..a498826e98977d8b3fba89348e3284f0a4781ef3 100644 (file)
@@ -10,10 +10,8 @@ package org.opendaylight.controller.cluster.datastore;
 
 import akka.actor.Props;
 import akka.japi.Creator;
-
 import com.google.common.base.Preconditions;
 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
-
 import org.opendaylight.controller.cluster.datastore.messages.DataChanged;
 import org.opendaylight.controller.cluster.datastore.messages.DataChangedReply;
 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
@@ -24,7 +22,7 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 
 public class DataChangeListener extends AbstractUntypedActor {
     private final AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> listener;
-    private volatile boolean notificationsEnabled = false;
+    private boolean notificationsEnabled = false;
 
     public DataChangeListener(AsyncDataChangeListener<YangInstanceIdentifier,
                                                       NormalizedNode<?, ?>> listener) {
@@ -55,7 +53,9 @@ public class DataChangeListener extends AbstractUntypedActor {
             change = reply.getChange();
         this.listener.onDataChanged(change);
 
-        if(getSender() != null){
+        // It seems the sender is never null but it doesn't hurt to check. If the caller passes in
+        // a null sender (ActorRef.noSender()), akka translates that to the deadLetters actor.
+        if(getSender() != null && !getContext().system().deadLetters().equals(getSender())) {
             getSender().tell(new DataChangedReply(), getSelf());
         }
     }
index a1b6b9252eb452082f101fe1bb748fb2d6b28536..1a0ee8c2fa6866dfdab97cfeab7087ce37d52ca6 100644 (file)
@@ -8,10 +8,9 @@
 
 package org.opendaylight.controller.cluster.datastore;
 
+import akka.actor.ActorRef;
 import akka.actor.ActorSelection;
-
 import com.google.common.base.Preconditions;
-
 import org.opendaylight.controller.cluster.datastore.messages.DataChanged;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
@@ -33,6 +32,6 @@ public class DataChangeListenerProxy implements AsyncDataChangeListener<YangInst
 
     @Override public void onDataChanged(
         AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
-        dataChangeListenerActor.tell(new DataChanged(schemaContext, change), null);
+        dataChangeListenerActor.tell(new DataChanged(schemaContext, change), ActorRef.noSender());
     }
 }
index b39cc84ceff6943d045c7a609afcbb996e212b31..101a73782b498943acb14b0cb03be2dde5df1f87 100644 (file)
 package org.opendaylight.controller.cluster.datastore;
 
 import akka.actor.ActorRef;
+import akka.actor.DeadLetter;
 import akka.actor.Props;
 import akka.testkit.JavaTestKit;
 import org.junit.Test;
+import org.mockito.Mockito;
 import org.opendaylight.controller.cluster.datastore.messages.DataChanged;
 import org.opendaylight.controller.cluster.datastore.messages.DataChangedReply;
 import org.opendaylight.controller.cluster.datastore.messages.EnableNotification;
 import org.opendaylight.controller.md.cluster.datastore.model.CompositeModel;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeEvent;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataChangeListener;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
 
 public class DataChangeListenerTest extends AbstractActorTest {
 
-    private static class MockDataChangedEvent implements AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> {
-       Map<YangInstanceIdentifier,NormalizedNode<?,?>> createdData = new HashMap<>();
-       Map<YangInstanceIdentifier,NormalizedNode<?,?>> updatedData = new HashMap<>();
-       Map<YangInstanceIdentifier,NormalizedNode<?,?>> originalData = new HashMap<>();
-
-
-
-        @Override
-        public Map<YangInstanceIdentifier, NormalizedNode<?, ?>> getCreatedData() {
-            createdData.put(CompositeModel.FAMILY_PATH, CompositeModel.createFamily());
-            return createdData;
-        }
-
-        @Override
-        public Map<YangInstanceIdentifier, NormalizedNode<?, ?>> getUpdatedData() {
-            updatedData.put(CompositeModel.FAMILY_PATH, CompositeModel.createFamily());
-            return updatedData;
-
-        }
-
-        @Override
-        public Set<YangInstanceIdentifier> getRemovedPaths() {
-               Set<YangInstanceIdentifier>ids = new HashSet();
-               ids.add( CompositeModel.TEST_PATH);
-              return ids;
-        }
-
-        @Override
-        public Map<YangInstanceIdentifier, NormalizedNode<?, ?>> getOriginalData() {
-          originalData.put(CompositeModel.FAMILY_PATH, CompositeModel.createFamily());
-          return originalData;
-        }
-
-        @Override public NormalizedNode<?, ?> getOriginalSubtree() {
-
-
-          return originalData.put(CompositeModel.FAMILY_PATH, CompositeModel.createFamily());
-        }
-
-        @Override public NormalizedNode<?, ?> getUpdatedSubtree() {
+    @SuppressWarnings({ "rawtypes", "unchecked" })
+    @Test
+    public void testDataChangedWhenNotificationsAreEnabled(){
+        new JavaTestKit(getSystem()) {{
+            final AsyncDataChangeEvent mockChangeEvent = Mockito.mock(AsyncDataChangeEvent.class);
+            final AsyncDataChangeListener mockListener = Mockito.mock(AsyncDataChangeListener.class);
+            final Props props = DataChangeListener.props(mockListener);
+            final ActorRef subject = getSystem().actorOf(props, "testDataChangedNotificationsEnabled");
 
-          //fixme: need to have some valid data here
-          return originalData.put(CompositeModel.FAMILY_PATH, CompositeModel.createFamily());
-        }
-    }
+            // Let the DataChangeListener know that notifications should be enabled
+            subject.tell(new EnableNotification(true), getRef());
 
-    private class MockDataChangeListener implements AsyncDataChangeListener<YangInstanceIdentifier, NormalizedNode<?, ?>> {
-        private boolean gotIt = false;
-        private   AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change;
+            subject.tell(new DataChanged(CompositeModel.createTestContext(), mockChangeEvent),
+                    getRef());
 
-        @Override public void onDataChanged(
-            AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> change) {
-            gotIt = true;this.change=change;
-        }
+            expectMsgClass(DataChangedReply.class);
 
-        public boolean gotIt() {
-            return gotIt;
-        }
-        public  AsyncDataChangeEvent<YangInstanceIdentifier, NormalizedNode<?, ?>> getChange(){
-          return change;
-        }
+            Mockito.verify(mockListener).onDataChanged(mockChangeEvent);
+        }};
     }
 
+    @SuppressWarnings({ "rawtypes", "unchecked" })
     @Test
-    public void testDataChangedWhenNotificationsAreEnabled(){
+    public void testDataChangedWhenNotificationsAreDisabled(){
         new JavaTestKit(getSystem()) {{
-            final MockDataChangeListener listener = new MockDataChangeListener();
-            final Props props = DataChangeListener.props(listener);
+            final AsyncDataChangeEvent mockChangeEvent = Mockito.mock(AsyncDataChangeEvent.class);
+            final AsyncDataChangeListener mockListener = Mockito.mock(AsyncDataChangeListener.class);
+            final Props props = DataChangeListener.props(mockListener);
             final ActorRef subject =
-                getSystem().actorOf(props, "testDataChangedNotificationsEnabled");
+                getSystem().actorOf(props, "testDataChangedNotificationsDisabled");
+
+            subject.tell(new DataChanged(CompositeModel.createTestContext(), mockChangeEvent),
+                    getRef());
 
             new Within(duration("1 seconds")) {
                 @Override
                 protected void run() {
-
-                    // Let the DataChangeListener know that notifications should
-                    // be enabled
-                    subject.tell(new EnableNotification(true), getRef());
-
-                    subject.tell(
-                        new DataChanged(CompositeModel.createTestContext(),new MockDataChangedEvent()),
-                        getRef());
-
-                    final Boolean out = new ExpectMsg<Boolean>(duration("800 millis"), "dataChanged") {
-                        // do not put code outside this method, will run afterwards
-                        @Override
-                        protected Boolean match(Object in) {
-                            if (in != null && in.getClass().equals(DataChangedReply.class)) {
-
-                                return true;
-                            } else {
-                                throw noMatch();
-                            }
-                        }
-                    }.get(); // this extracts the received message
-
-                    assertTrue(out);
-                    assertTrue(listener.gotIt());
-                    assertNotNull(listener.getChange().getCreatedData());
-
                     expectNoMsg();
+
+                    Mockito.verify(mockListener, Mockito.never()).onDataChanged(
+                            Mockito.any(AsyncDataChangeEvent.class));
                 }
             };
         }};
     }
 
+    @SuppressWarnings({ "rawtypes", "unchecked" })
     @Test
-    public void testDataChangedWhenNotificationsAreDisabled(){
+    public void testDataChangedWithNoSender(){
         new JavaTestKit(getSystem()) {{
-            final MockDataChangeListener listener = new MockDataChangeListener();
-            final Props props = DataChangeListener.props(listener);
-            final ActorRef subject =
-                getSystem().actorOf(props, "testDataChangedNotificationsDisabled");
+            final AsyncDataChangeEvent mockChangeEvent = Mockito.mock(AsyncDataChangeEvent.class);
+            final AsyncDataChangeListener mockListener = Mockito.mock(AsyncDataChangeListener.class);
+            final Props props = DataChangeListener.props(mockListener);
+            final ActorRef subject = getSystem().actorOf(props, "testDataChangedWithNoSender");
 
+            // Let the DataChangeListener know that notifications should be enabled
+            subject.tell(new EnableNotification(true), ActorRef.noSender());
+
+            subject.tell(new DataChanged(CompositeModel.createTestContext(), mockChangeEvent),
+                    ActorRef.noSender());
+
+            getSystem().eventStream().subscribe(getRef(), DeadLetter.class);
             new Within(duration("1 seconds")) {
                 @Override
                 protected void run() {
-
-                    subject.tell(
-                        new DataChanged(CompositeModel.createTestContext(),new MockDataChangedEvent()),
-                        getRef());
-
                     expectNoMsg();
                 }
             };