2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.entityownership;
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.mdsal.eos.dom.api.DOMEntity;
32 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
33 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
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;
40 * Unit tests for EntityOwnershipListenerSupport.
42 * @author Thomas Pantelis
44 public class EntityOwnershipListenerSupportTest extends AbstractEntityOwnershipTest {
45 private final TestActorFactory actorFactory = new TestActorFactory(getSystem());
46 private ActorContext actorContext;
50 TestActorRef<DoNothingActor> actor = actorFactory.createTestActor(
51 Props.create(DoNothingActor.class), actorFactory.generateActorId("test"));
53 actorContext = actor.underlyingActor().getContext();
57 public void tearDown() {
62 public void testNotifyEntityOwnershipListeners() {
63 EntityOwnershipListenerSupport support = new EntityOwnershipListenerSupport(actorContext, "test");
65 DOMEntityOwnershipListener mockListener1 = mock(DOMEntityOwnershipListener.class, "EntityOwnershipListener1");
66 DOMEntityOwnershipListener mockListener2 = mock(DOMEntityOwnershipListener.class, "EntityOwnershipListener2");
67 DOMEntityOwnershipListener mockListener1_2 = mock(DOMEntityOwnershipListener.class, "EntityOwnershipListener1_2");
68 String entityType1 = "type1";
69 String entityType2 = "type2";
70 DOMEntity entity1 = new DOMEntity(entityType1, YangInstanceIdentifier.of(QName.create("test", "id1")));
71 DOMEntity entity2 = new DOMEntity(entityType2, YangInstanceIdentifier.of(QName.create("test", "id2")));
72 DOMEntity entity3 = new DOMEntity("noListener", YangInstanceIdentifier.of(QName.create("test", "id5")));
74 // Add EntityOwnershipListener registrations.
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);
81 // Notify entity1 changed and verify appropriate listeners are notified.
83 support.notifyEntityOwnershipListeners(entity1, false, true, true);
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(DOMEntityOwnershipChange.class));
89 assertEquals("# of listener actors", 2, actorContext.children().size());
90 reset(mockListener1, mockListener2, mockListener1_2);
92 // Notify entity2 changed and verify appropriate listeners are notified.
94 support.notifyEntityOwnershipListeners(entity2, false, true, true);
96 verify(mockListener2, timeout(5000)).ownershipChanged(ownershipChange(entity2, false, true, true));
97 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
98 verify(mockListener1, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
99 verify(mockListener1_2, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
100 assertEquals("# of listener actors", 3, actorContext.children().size());
101 reset(mockListener1, mockListener2, mockListener1_2);
103 // Notify entity3 changed and verify no listeners are notified.
105 support.notifyEntityOwnershipListeners(entity3, true, false, true);
107 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
108 verify(mockListener1, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
109 verify(mockListener2, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
110 verify(mockListener1_2, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
111 reset(mockListener1, mockListener2, mockListener1_2);
113 Iterable<ActorRef> listenerActors = actorContext.children();
114 assertEquals("# of listener actors", 3, listenerActors.size());
116 // Unregister mockListener1, issue a change for entity1 and verify only remaining listeners are notified.
118 support.removeEntityOwnershipListener(entityType1, mockListener1);
119 support.notifyEntityOwnershipListeners(entity1, true, false, true);
121 verify(mockListener1_2, timeout(5000)).ownershipChanged(ownershipChange(entity1, true, false, true));
122 Uninterruptibles.sleepUninterruptibly(300, TimeUnit.MILLISECONDS);
123 verify(mockListener1, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
124 reset(mockListener1, mockListener2, mockListener1_2);
126 // Unregister all listeners and verify their listener actors are destroyed.
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());
135 support.removeEntityOwnershipListener(entityType1, mockListener1_2);
136 support.removeEntityOwnershipListener(entityType1, mockListener1_2); // un-register again - should be noop
137 support.removeEntityOwnershipListener(entityType2, mockListener2);
139 Iterator<ActorRef> iter = listenerActors.iterator();
140 for(JavaTestKit kit: watchers) {
141 kit.expectTerminated(JavaTestKit.duration("3 seconds"), iter.next());
144 assertEquals("# of listener actors", 0, actorContext.children().size());
146 // Re-register mockListener1 and verify it is notified.
148 reset(mockListener1, mockListener2);
150 support.addEntityOwnershipListener(entityType1, mockListener1);
151 support.notifyEntityOwnershipListeners(entity1, false, false, true);
153 verify(mockListener1, timeout(5000)).ownershipChanged(ownershipChange(entity1, false, false, true));
154 verify(mockListener1_2, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
155 verify(mockListener2, never()).ownershipChanged(any(DOMEntityOwnershipChange.class));
157 // Quickly register and unregister mockListener2 - expecting no exceptions.
159 support.addEntityOwnershipListener(entityType1, mockListener2);
160 support.removeEntityOwnershipListener(entityType1, mockListener2);
164 public void testHasCandidateForEntity() {
165 EntityOwnershipListenerSupport support = new EntityOwnershipListenerSupport(actorContext, "test");
166 DOMEntity entity = new DOMEntity("type", YangInstanceIdentifier.of(QName.create("test", "id")));
168 assertEquals("hasCandidateForEntity", false, support.hasCandidateForEntity(entity));
170 support.setHasCandidateForEntity(entity);
171 support.setHasCandidateForEntity(entity); // set again - should be noop
172 assertEquals("hasCandidateForEntity", true, support.hasCandidateForEntity(entity));
174 support.unsetHasCandidateForEntity(entity);
175 assertEquals("hasCandidateForEntity", false, support.hasCandidateForEntity(entity));
177 support.unsetHasCandidateForEntity(entity); // unset again - should be noop
178 assertEquals("hasCandidateForEntity", false, support.hasCandidateForEntity(entity));
180 support.setHasCandidateForEntity(entity);
181 assertEquals("hasCandidateForEntity", true, support.hasCandidateForEntity(entity));