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.any;
  12 import static org.mockito.Mockito.mock;
  13 import static org.mockito.Mockito.never;
  14 import static org.mockito.Mockito.reset;
  15 import static org.mockito.Mockito.timeout;
  16 import static org.mockito.Mockito.verify;
  17 import akka.actor.ActorContext;
  18 import akka.actor.ActorRef;
  19 import akka.actor.Props;
  20 import akka.testkit.JavaTestKit;
  21 import akka.testkit.TestActorRef;
  22 import com.google.common.util.concurrent.Uninterruptibles;
  23 import java.util.ArrayList;
  24 import java.util.List;
  25 import java.util.concurrent.TimeUnit;
  26 import org.junit.After;
  27 import org.junit.Before;
  28 import org.junit.Test;
  29 import org.opendaylight.controller.cluster.raft.TestActorFactory;
  30 import org.opendaylight.controller.cluster.raft.utils.DoNothingActor;
  31 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  32 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange;
  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 AbstractEntityOwnershipTest {
  45     private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
  46     private ActorContext actorContext;
  47
  48     @Before
  49     public void setup() {
  50         TestActorRef<DoNothingActor> actor = actorFactory.createTestActor(
  51                 Props.create(DoNothingActor.class), actorFactory.generateActorId("test"));
  52
  53         actorContext = actor.underlyingActor().getContext();
  54     }
  55
  56     @After
  57     public void tearDown() {
  58         actorFactory.close();
  59     }
  60
  61     @Test
  62     public void testNotifyEntityOwnershipListeners() {
  63         EntityOwnershipListenerSupport support = new EntityOwnershipListenerSupport(actorContext, "test");
  64
  65         EntityOwnershipListener mockListener1 = mock(EntityOwnershipListener.class, "EntityOwnershipListener1");
  66         EntityOwnershipListener mockListener2 = mock(EntityOwnershipListener.class, "EntityOwnershipListener2");
  67         EntityOwnershipListener mockListener1_2 = mock(EntityOwnershipListener.class, "EntityOwnershipListener1_2");
  68         String entityType1 = "type1";
  69         String entityType2 = "type2";
  70         Entity entity1 = new Entity(entityType1, YangInstanceIdentifier.of(QName.create("test", "id1")));
  71         Entity entity2 = new Entity(entityType2, YangInstanceIdentifier.of(QName.create("test", "id2")));
  72         Entity entity3 = new Entity("noListener", YangInstanceIdentifier.of(QName.create("test", "id5")));
  73
  74         // Add EntityOwnershipListener registrations.
  75
  76         support.addEntityOwnershipListener(entityType1, mockListener1);
  77         support.addEntityOwnershipListener(entityType1, mockListener1); // register again - should be noop
  78         support.addEntityOwnershipListener(entityType1, mockListener1_2);
  79         support.addEntityOwnershipListener(entityType2, mockListener2);
  80
  81         // Notify entity1 changed and verify appropriate listeners are notified.
  82
  83         support.notifyEntityOwnershipListeners(entity1, false, true, true);
  84
  85         verify(mockListener1, timeout(5000)).ownershipChanged(ownershipChange(entity1, false, true, true));
  86         verify(mockListener1_2, timeout(5000)).ownershipChanged(ownershipChange(entity1, false, true, true));
  87         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
  88         verify(mockListener2, never()).ownershipChanged(any(EntityOwnershipChange.class));
  89         assertEquals("# of listener actors", 2, actorContext.children().size());
  90         reset(mockListener1, mockListener2, mockListener1_2);
  91
  92         // Notify entity2 changed and verify appropriate listeners are notified.
  93
  94         support.notifyEntityOwnershipListeners(entity2, false, true, true);
  95
  96         verify(mockListener2, timeout(5000)).ownershipChanged(ownershipChange(entity2, false, true, true));
  97         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
  98         verify(mockListener1, never()).ownershipChanged(any(EntityOwnershipChange.class));
  99         verify(mockListener1_2, never()).ownershipChanged(any(EntityOwnershipChange.class));
 100         assertEquals("# of listener actors", 3, actorContext.children().size());
 101         reset(mockListener1, mockListener2, mockListener1_2);
 102
 103         // Notify entity3 changed and verify no listeners are notified.
 104
 105         support.notifyEntityOwnershipListeners(entity3, true, false, true);
 106
 107         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 108         verify(mockListener1, never()).ownershipChanged(any(EntityOwnershipChange.class));
 109         verify(mockListener2, never()).ownershipChanged(any(EntityOwnershipChange.class));
 110         verify(mockListener1_2, never()).ownershipChanged(any(EntityOwnershipChange.class));
 111         reset(mockListener1, mockListener2, mockListener1_2);
 112
 113         Iterable<ActorRef> listenerActors = actorContext.children();
 114         assertEquals("# of listener actors", 3, listenerActors.size());
 115
 116         // Unregister mockListener1, issue a change for entity1 and verify only remaining listeners are notified.
 117
 118         support.removeEntityOwnershipListener(entityType1, mockListener1);
 119         support.notifyEntityOwnershipListeners(entity1, true, false, true);
 120
 121         verify(mockListener1_2, timeout(5000)).ownershipChanged(ownershipChange(entity1, true, false, true));
 122         Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
 123         verify(mockListener1, never()).ownershipChanged(any(EntityOwnershipChange.class));
 124         reset(mockListener1, mockListener2, mockListener1_2);
 125
 126         // Unregister all listeners and verify their listener actors are destroyed.
 127
 128         List<JavaTestKit> watchers = new ArrayList<>();
 129         for(Iterator<ActorRef> iter = listenerActors.iterator(); iter.hasNext();) {
 130             JavaTestKit kit = new JavaTestKit(getSystem());
 131             kit.watch(iter.next());
 132             watchers.add(kit);
 133         }
 134
 135         support.removeEntityOwnershipListener(entityType1, mockListener1_2);
 136         support.removeEntityOwnershipListener(entityType1, mockListener1_2); // un-register again - should be noop
 137         support.removeEntityOwnershipListener(entityType2, mockListener2);
 138
 139         Iterator<ActorRef> iter = listenerActors.iterator();
 140         for(JavaTestKit kit: watchers) {
 141             kit.expectTerminated(JavaTestKit.duration("3 seconds"), iter.next());
 142         }
 143
 144         assertEquals("# of listener actors", 0, actorContext.children().size());
 145
 146         // Re-register mockListener1 and verify it is notified.
 147
 148         reset(mockListener1, mockListener2);
 149
 150         support.addEntityOwnershipListener(entityType1, mockListener1);
 151         support.notifyEntityOwnershipListeners(entity1, false, false, true);
 152
 153         verify(mockListener1, timeout(5000)).ownershipChanged(ownershipChange(entity1, false, false, true));
 154         verify(mockListener1_2, never()).ownershipChanged(any(EntityOwnershipChange.class));
 155         verify(mockListener2, never()).ownershipChanged(any(EntityOwnershipChange.class));
 156
 157         // Quickly register and unregister mockListener2 - expecting no exceptions.
 158
 159         support.addEntityOwnershipListener(entityType1, mockListener2);
 160         support.removeEntityOwnershipListener(entityType1, mockListener2);
 161     }
 162
 163     @Test
 164     public void testHasCandidateForEntity() {
 165         EntityOwnershipListenerSupport support = new EntityOwnershipListenerSupport(actorContext, "test");
 166         Entity entity = new Entity("type", YangInstanceIdentifier.of(QName.create("test", "id")));
 167
 168         assertEquals("hasCandidateForEntity", false, support.hasCandidateForEntity(entity));
 169
 170         support.setHasCandidateForEntity(entity);
 171         support.setHasCandidateForEntity(entity); // set again - should be noop
 172         assertEquals("hasCandidateForEntity", true, support.hasCandidateForEntity(entity));
 173
 174         support.unsetHasCandidateForEntity(entity);
 175         assertEquals("hasCandidateForEntity", false, support.hasCandidateForEntity(entity));
 176
 177         support.unsetHasCandidateForEntity(entity); // unset again - should be noop
 178         assertEquals("hasCandidateForEntity", false, support.hasCandidateForEntity(entity));
 179
 180         support.setHasCandidateForEntity(entity);
 181         assertEquals("hasCandidateForEntity", true, support.hasCandidateForEntity(entity));
 182     }
 183 }