opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/EntityOwnershipListenerSupportTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.entityownership;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.Matchers.anyBoolean;
  12 import static org.mockito.Matchers.eq;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.never;
  15 import static org.mockito.Mockito.reset;
  16 import static org.mockito.Mockito.timeout;
  17 import static org.mockito.Mockito.verify;
  18 import akka.actor.ActorRef;
  19 import akka.actor.Props;
  20 import akka.actor.UntypedActorContext;
  21 import akka.testkit.JavaTestKit;
  22 import akka.testkit.TestActorRef;
  23 import com.google.common.util.concurrent.Uninterruptibles;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26 import java.util.concurrent.TimeUnit;
  27 import org.junit.After;
  28 import org.junit.Test;
  29 import org.opendaylight.controller.cluster.datastore.AbstractActorTest;
  30 import org.opendaylight.controller.cluster.raft.TestActorFactory;
  31 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
  32 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  33 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  34 import org.opendaylight.yangtools.yang.common.QName;
  35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  36 import scala.collection.Iterator;
  37 import scala.collection.immutable.Iterable;
  38
  39 /**
  40  * Unit tests for EntityOwnershipListenerSupport.
  41  *
  42  * @author Thomas Pantelis
  43  */
  44 public class EntityOwnershipListenerSupportTest extends AbstractActorTest {
  45     private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
  46
  47     @After
  48     public void tearDown() {
  49         actorFactory.close();
  50     }
  51
  52     @Test
  53     public void testNotifyEntityOwnershipListeners() {
  54         TestActorRef<DoNothingActor> actor = actorFactory.createTestActor(
  55                 Props.create(DoNothingActor.class), actorFactory.generateActorId("test"));
  56
  57         UntypedActorContext actorContext = actor.underlyingActor().getContext();
  58         EntityOwnershipListenerSupport support = new EntityOwnershipListenerSupport(actorContext);
  59
  60         EntityOwnershipListener mockListener1 = mock(EntityOwnershipListener.class, "EntityOwnershipListener1");
  61         EntityOwnershipListener mockListener2 = mock(EntityOwnershipListener.class, "EntityOwnershipListener2");
  62         EntityOwnershipListener mockListener3 = mock(EntityOwnershipListener.class, "EntityOwnershipListener3");
  63         Entity entity1 = new Entity("type1", YangInstanceIdentifier.of(QName.create("test", "id1")));
  64         Entity entity2 = new Entity("type1", YangInstanceIdentifier.of(QName.create("test", "id2")));
  65         Entity entity3 = new Entity("type1", YangInstanceIdentifier.of(QName.create("test", "id3")));
  66         Entity entity4 = new Entity("type2", YangInstanceIdentifier.of(QName.create("test", "id4")));
  67         Entity entity5 = new Entity("noListener", YangInstanceIdentifier.of(QName.create("test", "id5")));
  68
  69         // Add EntityOwnershipListener registrations.
  70
  71         support.addEntityOwnershipListener(entity1, mockListener1);
  72         support.addEntityOwnershipListener(entity1, mockListener1); // register again - should be noop
  73         support.addEntityOwnershipListener(entity2, mockListener1);
  74         support.addEntityOwnershipListener(entity1, mockListener2);
  75         support.addEntityOwnershipListener(entity1.getType(), mockListener3);
  76
  77         // Notify entity1 changed and verify listeners are notified.
  78
  79         support.notifyEntityOwnershipListeners(entity1, false, true);
  80
  81         verify(mockListener1, timeout(5000)).ownershipChanged(entity1, false, true);
  82         verify(mockListener2, timeout(5000)).ownershipChanged(entity1, false, true);
  83         verify(mockListener3, timeout(5000)).ownershipChanged(entity1, false, true);
  84         assertEquals("# of listener actors", 3, actorContext.children().size());
  85
  86         // Notify entity2 changed and verify only mockListener1 and mockListener3 are notified.
  87
  88         support.notifyEntityOwnershipListeners(entity2, false, true);
  89
  90         verify(mockListener1, timeout(5000)).ownershipChanged(entity2, false, true);
  91         verify(mockListener3, timeout(5000)).ownershipChanged(entity2, false, true);
  92         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
  93         verify(mockListener2, never()).ownershipChanged(eq(entity2), anyBoolean(), anyBoolean());
  94         assertEquals("# of listener actors", 3, actorContext.children().size());
  95
  96         // Notify entity3 changed and verify only mockListener3 is notified.
  97
  98         support.notifyEntityOwnershipListeners(entity3, false, true);
  99
 100         verify(mockListener3, timeout(5000)).ownershipChanged(entity3, false, true);
 101         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 102         verify(mockListener1, never()).ownershipChanged(eq(entity3), anyBoolean(), anyBoolean());
 103         verify(mockListener2, never()).ownershipChanged(eq(entity3), anyBoolean(), anyBoolean());
 104
 105         // Notify entity4 changed and verify no listeners are notified.
 106
 107         support.notifyEntityOwnershipListeners(entity4, false, true);
 108
 109         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 110         verify(mockListener1, never()).ownershipChanged(eq(entity4), anyBoolean(), anyBoolean());
 111         verify(mockListener2, never()).ownershipChanged(eq(entity4), anyBoolean(), anyBoolean());
 112         verify(mockListener3, never()).ownershipChanged(eq(entity4), anyBoolean(), anyBoolean());
 113
 114         // Notify entity5 changed and verify no listener is notified.
 115
 116         support.notifyEntityOwnershipListeners(entity5, false, true);
 117
 118         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 119         verify(mockListener1, never()).ownershipChanged(eq(entity4), anyBoolean(), anyBoolean());
 120         verify(mockListener2, never()).ownershipChanged(eq(entity4), anyBoolean(), anyBoolean());
 121         verify(mockListener3, never()).ownershipChanged(eq(entity4), anyBoolean(), anyBoolean());
 122
 123         reset(mockListener1, mockListener2, mockListener3);
 124
 125         // Unregister mockListener1 for entity1, issue a change and verify only mockListeners 2 & 3 are notified.
 126
 127         support.removeEntityOwnershipListener(entity1, mockListener1);
 128         support.notifyEntityOwnershipListeners(entity1, false, true);
 129
 130         verify(mockListener2, timeout(5000)).ownershipChanged(entity1, false, true);
 131         verify(mockListener3, timeout(5000)).ownershipChanged(entity1, false, true);
 132         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 133         verify(mockListener1, never()).ownershipChanged(eq(entity1), anyBoolean(), anyBoolean());
 134
 135         // Unregister mockListener3, issue a change for entity1 and verify only mockListeners2 is notified.
 136
 137         reset(mockListener1, mockListener2, mockListener3);
 138
 139         support.removeEntityOwnershipListener(entity1.getType(), mockListener3);
 140         support.notifyEntityOwnershipListeners(entity1, false, true);
 141
 142         verify(mockListener2, timeout(5000)).ownershipChanged(entity1, false, true);
 143         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 144         verify(mockListener1, never()).ownershipChanged(eq(entity1), anyBoolean(), anyBoolean());
 145         verify(mockListener3, never()).ownershipChanged(eq(entity1), anyBoolean(), anyBoolean());
 146
 147         // Completely unregister all listeners and verify their listener actors are destroyed.
 148
 149         Iterable<ActorRef> listenerActors = actorContext.children();
 150         assertEquals("# of listener actors", 2, listenerActors.size());
 151
 152         List<JavaTestKit> watchers = new ArrayList<>();
 153         for(Iterator<ActorRef> iter = listenerActors.iterator(); iter.hasNext();) {
 154             JavaTestKit kit = new JavaTestKit(getSystem());
 155             kit.watch(iter.next());
 156             watchers.add(kit);
 157         }
 158
 159         support.removeEntityOwnershipListener(entity2, mockListener1);
 160         support.removeEntityOwnershipListener(entity2, mockListener1); // un-register again - shoild be noop
 161         support.removeEntityOwnershipListener(entity1, mockListener2);
 162
 163         Iterator<ActorRef> iter = listenerActors.iterator();
 164         for(JavaTestKit kit: watchers) {
 165             kit.expectTerminated(JavaTestKit.duration("3 seconds"), iter.next());
 166         }
 167
 168         assertEquals("# of listener actors", 0, actorContext.children().size());
 169
 170         // Re-register mockListener1 for entity1 and verify it is notified.
 171
 172         reset(mockListener1, mockListener2);
 173
 174         support.addEntityOwnershipListener(entity1, mockListener1);
 175
 176         support.notifyEntityOwnershipListeners(entity1, false, true);
 177
 178         verify(mockListener1, timeout(5000)).ownershipChanged(entity1, false, true);
 179         verify(mockListener2, never()).ownershipChanged(eq(entity1), anyBoolean(), anyBoolean());
 180         verify(mockListener3, never()).ownershipChanged(eq(entity1), anyBoolean(), anyBoolean());
 181
 182         // Quickly register and unregister mockListener2 - expecting no exceptions.
 183
 184         support.addEntityOwnershipListener(entity1, mockListener2);
 185         support.removeEntityOwnershipListener(entity1, mockListener2);
 186     }
 187 }