opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/DistributedEntityOwnershipServiceTest.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.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.entityEntryWithOwner;
  21 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
  22 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
  23 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
  24 import akka.actor.ActorRef;
  25 import akka.actor.PoisonPill;
  26 import akka.actor.Props;
  27 import com.google.common.base.Function;
  28 import com.google.common.base.Optional;
  29 import com.google.common.collect.Sets;
  30 import com.google.common.util.concurrent.Uninterruptibles;
  31 import java.util.Collection;
  32 import java.util.concurrent.CountDownLatch;
  33 import java.util.concurrent.TimeUnit;
  34 import java.util.concurrent.atomic.AtomicReference;
  35 import org.junit.After;
  36 import org.junit.Before;
  37 import org.junit.Test;
  38 import org.mockito.Mockito;
  39 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
  40 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
  41 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
  42 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
  43 import org.opendaylight.controller.cluster.datastore.config.Configuration;
  44 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
  45 import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
  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;
  68
  69 /**
  70  * Unit tests for DistributedEntityOwnershipService.
  71  *
  72  * @author Thomas Pantelis
  73  */
  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");
  79
  80     private final String dataStoreType = "config" + ID_COUNTER++;
  81     private DistributedDataStore dataStore;
  82
  83     @Before
  84     public void setUp() {
  85         DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreType(dataStoreType).
  86                 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
  87
  88         Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
  89             @Override
  90             public Collection<String> getUniqueMemberNamesForAllShards() {
  91                 return Sets.newHashSet("member-1");
  92             }
  93         };
  94
  95         DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
  96         Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
  97         Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
  98
  99         dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory, null);
 100
 101         dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
 102     }
 103
 104     @After
 105     public void tearDown() {
 106         dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
 107     }
 108
 109     @Test
 110     public void testEntityOwnershipShardCreated() throws Exception {
 111         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 112                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
 113         service.start();
 114
 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);
 119
 120         service.close();
 121     }
 122
 123     @Test
 124     public void testRegisterCandidate() throws Exception {
 125         final TestShardBuilder shardBuilder = new TestShardBuilder();
 126         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 127                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 128             @Override
 129             protected EntityOwnershipShard.Builder newShardBuilder() {
 130                 return shardBuilder;
 131             }
 132         };
 133
 134         service.start();
 135
 136         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 137
 138         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
 139         Entity entity = new Entity(ENTITY_TYPE, entityId);
 140
 141         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 142
 143         verifyEntityOwnershipCandidateRegistration(entity, reg);
 144         verifyRegisterCandidateLocal(shardBuilder, entity);
 145         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
 146                 dataStore.getActorContext().getCurrentMemberName());
 147
 148         // Register the same entity - should throw exception
 149
 150         try {
 151             service.registerCandidate(entity);
 152             fail("Expected CandidateAlreadyRegisteredException");
 153         } catch(CandidateAlreadyRegisteredException e) {
 154             // expected
 155             assertEquals("getEntity", entity, e.getEntity());
 156         }
 157
 158         // Register a different entity - should succeed
 159
 160         Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
 161         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 162
 163         EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
 164
 165         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
 166         verifyRegisterCandidateLocal(shardBuilder, entity2);
 167         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
 168                 dataStore.getActorContext().getCurrentMemberName());
 169
 170         service.close();
 171     }
 172
 173     @Test
 174     public void testCloseCandidateRegistration() throws Exception {
 175         final TestShardBuilder shardBuilder = new TestShardBuilder();
 176         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 177                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 178             @Override
 179             protected EntityOwnershipShard.Builder newShardBuilder() {
 180                 return shardBuilder;
 181             }
 182         };
 183
 184         service.start();
 185
 186         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 187
 188         Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
 189
 190         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 191
 192         verifyEntityOwnershipCandidateRegistration(entity, reg);
 193         verifyRegisterCandidateLocal(shardBuilder, entity);
 194
 195         shardBuilder.expectShardMessage(UnregisterCandidateLocal.class);
 196
 197         reg.close();
 198
 199         UnregisterCandidateLocal unregCandidate = shardBuilder.waitForShardMessage();
 200         assertEquals("getEntity", entity, unregCandidate.getEntity());
 201
 202         // Re-register - should succeed.
 203
 204         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 205
 206         service.registerCandidate(entity);
 207
 208         verifyRegisterCandidateLocal(shardBuilder, entity);
 209
 210         service.close();
 211     }
 212
 213     @Test
 214     public void testListenerRegistration() {
 215         final TestShardBuilder shardBuilder = new TestShardBuilder();
 216         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 217                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 218             @Override
 219             protected EntityOwnershipShard.Builder newShardBuilder() {
 220                 return shardBuilder;
 221             }
 222         };
 223
 224         service.start();
 225
 226         shardBuilder.expectShardMessage(RegisterListenerLocal.class);
 227
 228         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
 229         Entity entity = new Entity(ENTITY_TYPE, entityId);
 230         EntityOwnershipListener listener = mock(EntityOwnershipListener.class);
 231
 232         EntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
 233
 234         assertNotNull("EntityOwnershipListenerRegistration null", reg);
 235         assertEquals("getEntityType", entity.getType(), reg.getEntityType());
 236         assertEquals("getInstance", listener, reg.getInstance());
 237
 238         RegisterListenerLocal regListener = shardBuilder.waitForShardMessage();
 239         assertSame("getListener", listener, regListener.getListener());
 240         assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
 241
 242         shardBuilder.expectShardMessage(UnregisterListenerLocal.class);
 243
 244         reg.close();
 245
 246         UnregisterListenerLocal unregListener = shardBuilder.waitForShardMessage();
 247         assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
 248         assertSame("getListener", listener, unregListener.getListener());
 249
 250         service.close();
 251     }
 252
 253     @Test
 254     public void testGetOwnershipState() throws Exception {
 255         final TestShardBuilder shardBuilder = new TestShardBuilder();
 256         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 257                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 258             @Override
 259             protected EntityOwnershipShard.Builder newShardBuilder() {
 260                 return shardBuilder;
 261             }
 262         };
 263
 264         service.start();
 265
 266         ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners());
 267         shardBuilder.setDataTree(shardDataTree.getDataTree());
 268
 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);
 273
 274         writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
 275                 shardDataTree);
 276         verifyGetOwnershipState(service, entity1, false, true);
 277
 278         writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
 279                 shardDataTree);
 280         verifyGetOwnershipState(service, entity1, false, false);
 281
 282         Entity entity2 = new Entity(ENTITY_TYPE, "two");
 283         Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
 284         assertEquals("getOwnershipState present", false, state.isPresent());
 285
 286         writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
 287                 ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
 288         verifyGetOwnershipState(service, entity2, false, false);
 289
 290         service.close();
 291     }
 292
 293     @Test
 294     public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
 295         final TestShardBuilder shardBuilder = new TestShardBuilder();
 296         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 297                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 298             @Override
 299             protected EntityOwnershipShard.Builder newShardBuilder() {
 300                 return shardBuilder;
 301             }
 302         };
 303
 304         service.start();
 305
 306         final Entity test = new Entity("test-type", "test");
 307
 308         assertFalse(service.isCandidateRegistered(test));
 309
 310         service.registerCandidate(test);
 311
 312         assertTrue(service.isCandidateRegistered(test));
 313
 314         service.close();
 315     }
 316
 317     private static void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
 318             boolean isOwner, boolean hasOwner) {
 319         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 320         assertEquals("getOwnershipState present", true, state.isPresent());
 321         assertEquals("isOwner", isOwner, state.get().isOwner());
 322         assertEquals("hasOwner", hasOwner, state.get().hasOwner());
 323     }
 324
 325     private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
 326             YangInstanceIdentifier entityId, String candidateName) {
 327         verifyEntityCandidate(entityType, entityId, candidateName,
 328                 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
 329                     @Override
 330                     public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
 331                         try {
 332                             return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 333                         } catch (Exception e) {
 334                             return null;
 335                         }
 336                     }
 337                 });
 338     }
 339
 340     private static void verifyRegisterCandidateLocal(final TestShardBuilder shardBuilder, Entity entity) {
 341         RegisterCandidateLocal regCandidate = shardBuilder.waitForShardMessage();
 342         assertEquals("getEntity", entity, regCandidate.getEntity());
 343     }
 344
 345     private static void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
 346         assertNotNull("EntityOwnershipCandidateRegistration null", reg);
 347         assertEquals("getInstance", entity, reg.getInstance());
 348     }
 349
 350     static class TestShardBuilder extends EntityOwnershipShard.Builder {
 351         TestShardBuilder() {
 352             localMemberName("member-1").ownerSelectionStrategyConfig(
 353                     EntityOwnerSelectionStrategyConfig.newBuilder().build());
 354         }
 355
 356         private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
 357         private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
 358         private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
 359         private final AtomicReference<DataTree> dataTree = new AtomicReference<>();
 360
 361         @Override
 362         public Props props() {
 363             verify();
 364             return Props.create(TestEntityOwnershipShard.class,this, messageClass, messageReceived,
 365                     receivedMessage, dataTree);
 366         }
 367
 368         @SuppressWarnings("unchecked")
 369         <T> T waitForShardMessage() {
 370             assertTrue("Message " + messageClass.get().getSimpleName() + " was not received",
 371                     Uninterruptibles.awaitUninterruptibly(messageReceived.get(), 5, TimeUnit.SECONDS));
 372             assertEquals("Message type", messageClass.get(), receivedMessage.get().getClass());
 373             return (T) receivedMessage.get();
 374         }
 375
 376         void expectShardMessage(Class<?> ofType) {
 377             messageReceived.set(new CountDownLatch(1));
 378             receivedMessage.set(null);
 379             messageClass.set(ofType);
 380         }
 381
 382         void setDataTree(DataTree tree) {
 383             this.dataTree.set(tree);
 384         }
 385     }
 386
 387     static class TestEntityOwnershipShard extends EntityOwnershipShard {
 388         private final AtomicReference<CountDownLatch> messageReceived;
 389         private final AtomicReference<Object> receivedMessage;
 390         private final AtomicReference<Class<?>> messageClass;
 391         private final AtomicReference<DataTree> dataTree;
 392
 393         protected TestEntityOwnershipShard(EntityOwnershipShard.Builder builder,
 394                 AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
 395                 AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
 396             super(builder);
 397             this.messageClass = messageClass;
 398             this.messageReceived = messageReceived;
 399             this.receivedMessage = receivedMessage;
 400             this.dataTree = dataTree;
 401         }
 402
 403         @Override
 404         public void onReceiveCommand(final Object message) throws Exception {
 405             try {
 406                 if(dataTree.get() != null && message instanceof GetShardDataTree) {
 407                     sender().tell(dataTree.get(), self());
 408                 } else {
 409                     super.onReceiveCommand(message);
 410                 }
 411             } finally {
 412                 Class<?> expMsgClass = messageClass.get();
 413                 if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
 414                     receivedMessage.set(message);
 415                     messageReceived.get().countDown();
 416                 }
 417             }
 418         }
 419     }
 420 }