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.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertSame;
14 import static org.junit.Assert.assertTrue;
15 import static org.junit.Assert.fail;
16 import static org.mockito.Mockito.mock;
17 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
18 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
19 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME;
20 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath;
21 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityEntryWithOwner;
22 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate;
23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
24 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
25 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
26 import akka.actor.ActorRef;
27 import akka.actor.PoisonPill;
28 import akka.actor.Props;
29 import com.google.common.base.Function;
30 import com.google.common.base.Optional;
31 import com.google.common.collect.Sets;
32 import com.google.common.util.concurrent.Uninterruptibles;
33 import java.util.Collection;
34 import java.util.concurrent.CountDownLatch;
35 import java.util.concurrent.TimeUnit;
36 import java.util.concurrent.atomic.AtomicReference;
37 import org.junit.After;
38 import org.junit.Before;
39 import org.junit.Test;
40 import org.mockito.Mockito;
41 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
42 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
43 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
44 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
45 import org.opendaylight.controller.cluster.datastore.config.Configuration;
46 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
47 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
48 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
49 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
50 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
51 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
52 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
53 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
54 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
55 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
56 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
57 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
58 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
59 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
60 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
61 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
62 import org.opendaylight.yangtools.yang.common.QName;
63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
64 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
65 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
66 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
67 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
68 import scala.concurrent.Await;
69 import scala.concurrent.Future;
70 import scala.concurrent.duration.Duration;
73 * Unit tests for DistributedEntityOwnershipService.
75 * @author Thomas Pantelis
77 public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnershipTest {
78 static String ENTITY_TYPE = "test";
79 static String ENTITY_TYPE2 = "test2";
80 static int ID_COUNTER = 1;
81 static final QName QNAME = QName.create("test", "2015-08-11", "foo");
83 private final String dataStoreName = "config" + ID_COUNTER++;
84 private DistributedDataStore dataStore;
88 DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreName(dataStoreName).
89 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
91 Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
93 public Collection<String> getUniqueMemberNamesForAllShards() {
94 return Sets.newHashSet("member-1");
98 DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
99 Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
100 Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
102 dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory, null);
104 dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
108 public void tearDown() {
109 dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
113 public void testEntityOwnershipShardCreated() throws Exception {
114 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
115 EntityOwnerSelectionStrategyConfig.newBuilder().build());
118 Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
119 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
120 ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
121 assertNotNull(DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME + " not found", shardActor);
127 public void testRegisterCandidate() throws Exception {
128 final TestShardBuilder shardBuilder = new TestShardBuilder();
129 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
130 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
132 protected EntityOwnershipShard.Builder newShardBuilder() {
139 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
141 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
142 Entity entity = new Entity(ENTITY_TYPE, entityId);
144 EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
146 verifyEntityOwnershipCandidateRegistration(entity, reg);
147 verifyRegisterCandidateLocal(shardBuilder, entity);
148 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
149 dataStore.getActorContext().getCurrentMemberName());
151 // Register the same entity - should throw exception
154 service.registerCandidate(entity);
155 fail("Expected CandidateAlreadyRegisteredException");
156 } catch(CandidateAlreadyRegisteredException e) {
158 assertEquals("getEntity", entity, e.getEntity());
161 // Register a different entity - should succeed
163 Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
164 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
166 EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
168 verifyEntityOwnershipCandidateRegistration(entity2, reg2);
169 verifyRegisterCandidateLocal(shardBuilder, entity2);
170 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
171 dataStore.getActorContext().getCurrentMemberName());
177 public void testCloseCandidateRegistration() throws Exception {
178 final TestShardBuilder shardBuilder = new TestShardBuilder();
179 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
180 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
182 protected EntityOwnershipShard.Builder newShardBuilder() {
189 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
191 Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
193 EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
195 verifyEntityOwnershipCandidateRegistration(entity, reg);
196 verifyRegisterCandidateLocal(shardBuilder, entity);
198 shardBuilder.expectShardMessage(UnregisterCandidateLocal.class);
202 UnregisterCandidateLocal unregCandidate = shardBuilder.waitForShardMessage();
203 assertEquals("getEntity", entity, unregCandidate.getEntity());
205 // Re-register - should succeed.
207 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
209 service.registerCandidate(entity);
211 verifyRegisterCandidateLocal(shardBuilder, entity);
217 public void testListenerRegistration() {
218 final TestShardBuilder shardBuilder = new TestShardBuilder();
219 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
220 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
222 protected EntityOwnershipShard.Builder newShardBuilder() {
229 shardBuilder.expectShardMessage(RegisterListenerLocal.class);
231 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
232 Entity entity = new Entity(ENTITY_TYPE, entityId);
233 EntityOwnershipListener listener = mock(EntityOwnershipListener.class);
235 EntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
237 assertNotNull("EntityOwnershipListenerRegistration null", reg);
238 assertEquals("getEntityType", entity.getType(), reg.getEntityType());
239 assertEquals("getInstance", listener, reg.getInstance());
241 RegisterListenerLocal regListener = shardBuilder.waitForShardMessage();
242 assertSame("getListener", listener, regListener.getListener());
243 assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
245 shardBuilder.expectShardMessage(UnregisterListenerLocal.class);
249 UnregisterListenerLocal unregListener = shardBuilder.waitForShardMessage();
250 assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
251 assertSame("getListener", listener, unregListener.getListener());
257 public void testGetOwnershipState() throws Exception {
258 final TestShardBuilder shardBuilder = new TestShardBuilder();
259 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
260 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
262 protected EntityOwnershipShard.Builder newShardBuilder() {
269 ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners(), TreeType.OPERATIONAL);
270 shardBuilder.setDataTree(shardDataTree.getDataTree());
272 Entity entity1 = new Entity(ENTITY_TYPE, "one");
273 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getId(), "member-1"), shardDataTree);
274 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
275 entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
276 verifyGetOwnershipState(service, entity1, true, true);
278 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getId(), "member-2"), shardDataTree);
279 writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
281 verifyGetOwnershipState(service, entity1, false, true);
283 writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
285 verifyGetOwnershipState(service, entity1, false, false);
287 Entity entity2 = new Entity(ENTITY_TYPE, "two");
288 Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
289 assertEquals("getOwnershipState present", false, state.isPresent());
291 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity2.getId(), "member-1"), shardDataTree);
292 writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
293 ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
294 verifyGetOwnershipState(service, entity2, false, false);
296 deleteNode(candidatePath(entityPath(entity2.getType(), entity2.getId()), "member-1"), shardDataTree);
297 Optional<EntityOwnershipState> state2 = service.getOwnershipState(entity2);
298 assertEquals("getOwnershipState present", false, state2.isPresent());
303 public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
304 final TestShardBuilder shardBuilder = new TestShardBuilder();
305 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
306 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
308 protected EntityOwnershipShard.Builder newShardBuilder() {
315 final Entity test = new Entity("test-type", "test");
317 assertFalse(service.isCandidateRegistered(test));
319 service.registerCandidate(test);
321 assertTrue(service.isCandidateRegistered(test));
326 private static void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
327 boolean isOwner, boolean hasOwner) {
328 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
329 assertEquals("getOwnershipState present", true, state.isPresent());
330 assertEquals("isOwner", isOwner, state.get().isOwner());
331 assertEquals("hasOwner", hasOwner, state.get().hasOwner());
334 private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
335 YangInstanceIdentifier entityId, String candidateName) {
336 verifyEntityCandidate(entityType, entityId, candidateName,
337 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
339 public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
341 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
342 } catch (Exception e) {
349 private static void verifyRegisterCandidateLocal(final TestShardBuilder shardBuilder, Entity entity) {
350 RegisterCandidateLocal regCandidate = shardBuilder.waitForShardMessage();
351 assertEquals("getEntity", entity, regCandidate.getEntity());
354 private static void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
355 assertNotNull("EntityOwnershipCandidateRegistration null", reg);
356 assertEquals("getInstance", entity, reg.getInstance());
359 static class TestShardBuilder extends EntityOwnershipShard.Builder {
361 localMemberName("member-1").ownerSelectionStrategyConfig(
362 EntityOwnerSelectionStrategyConfig.newBuilder().build());
365 private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
366 private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
367 private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
368 private final AtomicReference<DataTree> dataTree = new AtomicReference<>();
371 public Props props() {
373 return Props.create(TestEntityOwnershipShard.class,this, messageClass, messageReceived,
374 receivedMessage, dataTree);
377 @SuppressWarnings("unchecked")
378 <T> T waitForShardMessage() {
379 assertTrue("Message " + messageClass.get().getSimpleName() + " was not received",
380 Uninterruptibles.awaitUninterruptibly(messageReceived.get(), 5, TimeUnit.SECONDS));
381 assertEquals("Message type", messageClass.get(), receivedMessage.get().getClass());
382 return (T) receivedMessage.get();
385 void expectShardMessage(Class<?> ofType) {
386 messageReceived.set(new CountDownLatch(1));
387 receivedMessage.set(null);
388 messageClass.set(ofType);
391 void setDataTree(DataTree tree) {
392 this.dataTree.set(tree);
396 static class TestEntityOwnershipShard extends EntityOwnershipShard {
397 private final AtomicReference<CountDownLatch> messageReceived;
398 private final AtomicReference<Object> receivedMessage;
399 private final AtomicReference<Class<?>> messageClass;
400 private final AtomicReference<DataTree> dataTree;
402 protected TestEntityOwnershipShard(EntityOwnershipShard.Builder builder,
403 AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
404 AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
406 this.messageClass = messageClass;
407 this.messageReceived = messageReceived;
408 this.receivedMessage = receivedMessage;
409 this.dataTree = dataTree;
413 public void onReceiveCommand(final Object message) throws Exception {
415 if(dataTree.get() != null && message instanceof GetShardDataTree) {
416 sender().tell(dataTree.get(), self());
418 super.onReceiveCommand(message);
421 Class<?> expMsgClass = messageClass.get();
422 if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
423 receivedMessage.set(message);
424 messageReceived.get().countDown();