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.assertNotNull;
12 import static org.junit.Assert.assertSame;
13 import static org.junit.Assert.assertTrue;
14 import static org.junit.Assert.fail;
15 import static org.mockito.Mockito.mock;
16 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
17 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
18 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME;
19 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityEntryWithOwner;
20 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
21 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
22 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
23 import akka.actor.ActorRef;
24 import akka.actor.PoisonPill;
25 import akka.actor.Props;
26 import com.google.common.base.Function;
27 import com.google.common.base.Optional;
28 import com.google.common.util.concurrent.Uninterruptibles;
29 import java.util.Collections;
31 import java.util.concurrent.CountDownLatch;
32 import java.util.concurrent.TimeUnit;
33 import java.util.concurrent.atomic.AtomicReference;
34 import org.junit.After;
35 import org.junit.Before;
36 import org.junit.Test;
37 import org.mockito.Mockito;
38 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
39 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
40 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
41 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
42 import org.opendaylight.controller.cluster.datastore.config.Configuration;
43 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
44 import org.opendaylight.controller.cluster.datastore.config.ModuleConfig;
45 import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfigProvider;
46 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
47 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
48 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
49 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
50 import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
51 import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
52 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
53 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
54 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
55 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
56 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
57 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
58 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
59 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
60 import org.opendaylight.yangtools.yang.common.QName;
61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
62 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
63 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
64 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
65 import scala.concurrent.Await;
66 import scala.concurrent.Future;
67 import scala.concurrent.duration.Duration;
70 * Unit tests for DistributedEntityOwnershipService.
72 * @author Thomas Pantelis
74 public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnershipTest {
75 static String ENTITY_TYPE = "test";
76 static String ENTITY_TYPE2 = "test2";
77 static int ID_COUNTER = 1;
78 static final QName QNAME = QName.create("test", "2015-08-11", "foo");
80 private final String dataStoreType = "config" + ID_COUNTER++;
81 private DistributedDataStore dataStore;
85 DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreType(dataStoreType).
86 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
88 Configuration configuration = new ConfigurationImpl(new ModuleShardConfigProvider() {
90 public Map<String, ModuleConfig> retrieveModuleConfigs(Configuration configuration) {
91 return Collections.emptyMap();
95 DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
96 Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
97 Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
99 dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory);
101 dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
105 public void tearDown() {
106 dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
110 public void testEntityOwnershipShardCreated() throws Exception {
111 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
112 EntityOwnerSelectionStrategyConfig.newBuilder().build());
115 Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
116 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
117 ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
118 assertNotNull(DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME + " not found", shardActor);
124 public void testRegisterCandidate() throws Exception {
125 final TestShardBuilder shardBuilder = new TestShardBuilder();
126 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
127 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
129 protected EntityOwnershipShard.Builder newShardBuilder() {
136 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
138 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
139 Entity entity = new Entity(ENTITY_TYPE, entityId);
141 EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
143 verifyEntityOwnershipCandidateRegistration(entity, reg);
144 verifyRegisterCandidateLocal(shardBuilder, entity);
145 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
146 dataStore.getActorContext().getCurrentMemberName());
148 // Register the same entity - should throw exception
151 service.registerCandidate(entity);
152 fail("Expected CandidateAlreadyRegisteredException");
153 } catch(CandidateAlreadyRegisteredException e) {
155 assertEquals("getEntity", entity, e.getEntity());
158 // Register a different entity - should succeed
160 Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
161 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
163 EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
165 verifyEntityOwnershipCandidateRegistration(entity2, reg2);
166 verifyRegisterCandidateLocal(shardBuilder, entity2);
167 verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
168 dataStore.getActorContext().getCurrentMemberName());
174 public void testCloseCandidateRegistration() throws Exception {
175 final TestShardBuilder shardBuilder = new TestShardBuilder();
176 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
177 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
179 protected EntityOwnershipShard.Builder newShardBuilder() {
186 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
188 Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
190 EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
192 verifyEntityOwnershipCandidateRegistration(entity, reg);
193 verifyRegisterCandidateLocal(shardBuilder, entity);
195 shardBuilder.expectShardMessage(UnregisterCandidateLocal.class);
199 UnregisterCandidateLocal unregCandidate = shardBuilder.waitForShardMessage();
200 assertEquals("getEntity", entity, unregCandidate.getEntity());
202 // Re-register - should succeed.
204 shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
206 service.registerCandidate(entity);
208 verifyRegisterCandidateLocal(shardBuilder, entity);
214 public void testListenerRegistration() {
215 final TestShardBuilder shardBuilder = new TestShardBuilder();
216 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
217 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
219 protected EntityOwnershipShard.Builder newShardBuilder() {
226 shardBuilder.expectShardMessage(RegisterListenerLocal.class);
228 YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
229 Entity entity = new Entity(ENTITY_TYPE, entityId);
230 EntityOwnershipListener listener = mock(EntityOwnershipListener.class);
232 EntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
234 assertNotNull("EntityOwnershipListenerRegistration null", reg);
235 assertEquals("getEntityType", entity.getType(), reg.getEntityType());
236 assertEquals("getInstance", listener, reg.getInstance());
238 RegisterListenerLocal regListener = shardBuilder.waitForShardMessage();
239 assertSame("getListener", listener, regListener.getListener());
240 assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
242 shardBuilder.expectShardMessage(UnregisterListenerLocal.class);
246 UnregisterListenerLocal unregListener = shardBuilder.waitForShardMessage();
247 assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
248 assertSame("getListener", listener, unregListener.getListener());
254 public void testGetOwnershipState() throws Exception {
255 final TestShardBuilder shardBuilder = new TestShardBuilder();
256 DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
257 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
259 protected EntityOwnershipShard.Builder newShardBuilder() {
266 ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners());
267 shardBuilder.setDataTree(shardDataTree.getDataTree());
269 Entity entity1 = new Entity(ENTITY_TYPE, "one");
270 writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
271 entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
272 verifyGetOwnershipState(service, entity1, true, true);
274 writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
276 verifyGetOwnershipState(service, entity1, false, true);
278 writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
280 verifyGetOwnershipState(service, entity1, false, false);
282 Entity entity2 = new Entity(ENTITY_TYPE, "two");
283 Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
284 assertEquals("getOwnershipState present", false, state.isPresent());
286 writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
287 ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
288 verifyGetOwnershipState(service, entity2, false, false);
293 private static void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
294 boolean isOwner, boolean hasOwner) {
295 Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
296 assertEquals("getOwnershipState present", true, state.isPresent());
297 assertEquals("isOwner", isOwner, state.get().isOwner());
298 assertEquals("hasOwner", hasOwner, state.get().hasOwner());
301 private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
302 YangInstanceIdentifier entityId, String candidateName) {
303 verifyEntityCandidate(entityType, entityId, candidateName,
304 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
306 public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
308 return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
309 } catch (Exception e) {
316 private static void verifyRegisterCandidateLocal(final TestShardBuilder shardBuilder, Entity entity) {
317 RegisterCandidateLocal regCandidate = shardBuilder.waitForShardMessage();
318 assertEquals("getEntity", entity, regCandidate.getEntity());
321 private static void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
322 assertNotNull("EntityOwnershipCandidateRegistration null", reg);
323 assertEquals("getInstance", entity, reg.getInstance());
326 static class TestShardBuilder extends EntityOwnershipShard.Builder {
328 localMemberName("member-1").ownerSelectionStrategyConfig(
329 EntityOwnerSelectionStrategyConfig.newBuilder().build());
332 private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
333 private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
334 private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
335 private final AtomicReference<DataTree> dataTree = new AtomicReference<>();
338 public Props props() {
340 return Props.create(TestEntityOwnershipShard.class,this, messageClass, messageReceived,
341 receivedMessage, dataTree);
344 @SuppressWarnings("unchecked")
345 <T> T waitForShardMessage() {
346 assertTrue("Message " + messageClass.get().getSimpleName() + " was not received",
347 Uninterruptibles.awaitUninterruptibly(messageReceived.get(), 5, TimeUnit.SECONDS));
348 assertEquals("Message type", messageClass.get(), receivedMessage.get().getClass());
349 return (T) receivedMessage.get();
352 void expectShardMessage(Class<?> ofType) {
353 messageReceived.set(new CountDownLatch(1));
354 receivedMessage.set(null);
355 messageClass.set(ofType);
358 void setDataTree(DataTree tree) {
359 this.dataTree.set(tree);
363 static class TestEntityOwnershipShard extends EntityOwnershipShard {
364 private final AtomicReference<CountDownLatch> messageReceived;
365 private final AtomicReference<Object> receivedMessage;
366 private final AtomicReference<Class<?>> messageClass;
367 private final AtomicReference<DataTree> dataTree;
369 protected TestEntityOwnershipShard(EntityOwnershipShard.Builder builder,
370 AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
371 AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
373 this.messageClass = messageClass;
374 this.messageReceived = messageReceived;
375 this.receivedMessage = receivedMessage;
376 this.dataTree = dataTree;
380 public void onReceiveCommand(final Object message) throws Exception {
382 if(dataTree.get() != null && message instanceof GetShardDataTree) {
383 sender().tell(dataTree.get(), self());
385 super.onReceiveCommand(message);
388 Class<?> expMsgClass = messageClass.get();
389 if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
390 receivedMessage.set(message);
391 messageReceived.get().countDown();