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.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;
  30 import java.util.Map;
  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.messages.GetShardDataTree;
  51 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
  52 import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
  53 import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
  54 import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
  55 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
  56 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener;
  57 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
  58 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
  59 import org.opendaylight.yangtools.yang.common.QName;
  60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  61 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  62 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  63 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  64 import scala.concurrent.Await;
  65 import scala.concurrent.Future;
  66 import scala.concurrent.duration.Duration;
  67
  68 /**
  69  * Unit tests for DistributedEntityOwnershipService.
  70  *
  71  * @author Thomas Pantelis
  72  */
  73 public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnershipTest {
  74     static String ENTITY_TYPE = "test";
  75     static String ENTITY_TYPE2 = "test2";
  76     static int ID_COUNTER = 1;
  77     static final QName QNAME = QName.create("test", "2015-08-11", "foo");
  78
  79     private final String dataStoreType = "config" + ID_COUNTER++;
  80     private DistributedDataStore dataStore;
  81
  82     @Before
  83     public void setUp() {
  84         DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreType(dataStoreType).
  85                 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
  86
  87         Configuration configuration = new ConfigurationImpl(new ModuleShardConfigProvider() {
  88             @Override
  89             public Map<String, ModuleConfig> retrieveModuleConfigs(Configuration configuration) {
  90                 return Collections.emptyMap();
  91             }
  92         });
  93
  94         DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
  95         Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
  96         Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
  97
  98         dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory);
  99
 100         dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
 101     }
 102
 103     @After
 104     public void tearDown() {
 105         dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
 106     }
 107
 108     @Test
 109     public void testEntityOwnershipShardCreated() throws Exception {
 110         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore);
 111         service.start();
 112
 113         Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
 114                 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
 115         ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
 116         assertNotNull(DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME + " not found", shardActor);
 117
 118         service.close();
 119     }
 120
 121     @Test
 122     public void testRegisterCandidate() throws Exception {
 123         final TestShardBuilder shardBuilder = new TestShardBuilder();
 124         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
 125             @Override
 126             protected EntityOwnershipShard.Builder newShardBuilder() {
 127                 return shardBuilder;
 128             }
 129         };
 130
 131         service.start();
 132
 133         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 134
 135         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
 136         Entity entity = new Entity(ENTITY_TYPE, entityId);
 137
 138         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 139
 140         verifyEntityOwnershipCandidateRegistration(entity, reg);
 141         verifyRegisterCandidateLocal(shardBuilder, entity);
 142         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
 143                 dataStore.getActorContext().getCurrentMemberName());
 144
 145         // Register the same entity - should throw exception
 146
 147         try {
 148             service.registerCandidate(entity);
 149             fail("Expected CandidateAlreadyRegisteredException");
 150         } catch(CandidateAlreadyRegisteredException e) {
 151             // expected
 152             assertEquals("getEntity", entity, e.getEntity());
 153         }
 154
 155         // Register a different entity - should succeed
 156
 157         Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
 158         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 159
 160         EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
 161
 162         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
 163         verifyRegisterCandidateLocal(shardBuilder, entity2);
 164         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
 165                 dataStore.getActorContext().getCurrentMemberName());
 166
 167         service.close();
 168     }
 169
 170     @Test
 171     public void testCloseCandidateRegistration() throws Exception {
 172         final TestShardBuilder shardBuilder = new TestShardBuilder();
 173         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
 174             @Override
 175             protected EntityOwnershipShard.Builder newShardBuilder() {
 176                 return shardBuilder;
 177             }
 178         };
 179
 180         service.start();
 181
 182         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 183
 184         Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
 185
 186         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 187
 188         verifyEntityOwnershipCandidateRegistration(entity, reg);
 189         verifyRegisterCandidateLocal(shardBuilder, entity);
 190
 191         shardBuilder.expectShardMessage(UnregisterCandidateLocal.class);
 192
 193         reg.close();
 194
 195         UnregisterCandidateLocal unregCandidate = shardBuilder.waitForShardMessage();
 196         assertEquals("getEntity", entity, unregCandidate.getEntity());
 197
 198         // Re-register - should succeed.
 199
 200         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 201
 202         service.registerCandidate(entity);
 203
 204         verifyRegisterCandidateLocal(shardBuilder, entity);
 205
 206         service.close();
 207     }
 208
 209     @Test
 210     public void testListenerRegistration() {
 211         final TestShardBuilder shardBuilder = new TestShardBuilder();
 212         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
 213             @Override
 214             protected EntityOwnershipShard.Builder newShardBuilder() {
 215                 return shardBuilder;
 216             }
 217         };
 218
 219         service.start();
 220
 221         shardBuilder.expectShardMessage(RegisterListenerLocal.class);
 222
 223         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
 224         Entity entity = new Entity(ENTITY_TYPE, entityId);
 225         EntityOwnershipListener listener = mock(EntityOwnershipListener.class);
 226
 227         EntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
 228
 229         assertNotNull("EntityOwnershipListenerRegistration null", reg);
 230         assertEquals("getEntityType", entity.getType(), reg.getEntityType());
 231         assertEquals("getInstance", listener, reg.getInstance());
 232
 233         RegisterListenerLocal regListener = shardBuilder.waitForShardMessage();
 234         assertSame("getListener", listener, regListener.getListener());
 235         assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
 236
 237         shardBuilder.expectShardMessage(UnregisterListenerLocal.class);
 238
 239         reg.close();
 240
 241         UnregisterListenerLocal unregListener = shardBuilder.waitForShardMessage();
 242         assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
 243         assertSame("getListener", listener, unregListener.getListener());
 244
 245         service.close();
 246     }
 247
 248     @Test
 249     public void testGetOwnershipState() throws Exception {
 250         final TestShardBuilder shardBuilder = new TestShardBuilder();
 251         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
 252             @Override
 253             protected EntityOwnershipShard.Builder newShardBuilder() {
 254                 return shardBuilder;
 255             }
 256         };
 257
 258         service.start();
 259
 260         ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners());
 261         shardBuilder.setDataTree(shardDataTree.getDataTree());
 262
 263         Entity entity1 = new Entity(ENTITY_TYPE, "one");
 264         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
 265                 entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
 266         verifyGetOwnershipState(service, entity1, true, true);
 267
 268         writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
 269                 shardDataTree);
 270         verifyGetOwnershipState(service, entity1, false, true);
 271
 272         writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
 273                 shardDataTree);
 274         verifyGetOwnershipState(service, entity1, false, false);
 275
 276         Entity entity2 = new Entity(ENTITY_TYPE, "two");
 277         Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
 278         assertEquals("getOwnershipState present", false, state.isPresent());
 279
 280         writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
 281                 ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
 282         verifyGetOwnershipState(service, entity2, false, false);
 283
 284         service.close();
 285     }
 286
 287     private static void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
 288             boolean isOwner, boolean hasOwner) {
 289         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
 290         assertEquals("getOwnershipState present", true, state.isPresent());
 291         assertEquals("isOwner", isOwner, state.get().isOwner());
 292         assertEquals("hasOwner", hasOwner, state.get().hasOwner());
 293     }
 294
 295     private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
 296             YangInstanceIdentifier entityId, String candidateName) {
 297         verifyEntityCandidate(entityType, entityId, candidateName,
 298                 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
 299                     @Override
 300                     public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
 301                         try {
 302                             return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 303                         } catch (Exception e) {
 304                             return null;
 305                         }
 306                     }
 307                 });
 308     }
 309
 310     private static void verifyRegisterCandidateLocal(final TestShardBuilder shardBuilder, Entity entity) {
 311         RegisterCandidateLocal regCandidate = shardBuilder.waitForShardMessage();
 312         assertEquals("getEntity", entity, regCandidate.getEntity());
 313     }
 314
 315     private static void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
 316         assertNotNull("EntityOwnershipCandidateRegistration null", reg);
 317         assertEquals("getInstance", entity, reg.getInstance());
 318     }
 319
 320     static class TestShardBuilder extends EntityOwnershipShard.Builder {
 321         TestShardBuilder() {
 322             localMemberName("member-1");
 323         }
 324
 325         private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
 326         private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
 327         private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
 328         private final AtomicReference<DataTree> dataTree = new AtomicReference<>();
 329
 330         @Override
 331         public Props props() {
 332             return Props.create(TestEntityOwnershipShard.class,this, messageClass, messageReceived,
 333                     receivedMessage, dataTree);
 334         }
 335
 336         @SuppressWarnings("unchecked")
 337         <T> T waitForShardMessage() {
 338             assertTrue("Message " + messageClass.get().getSimpleName() + " was not received",
 339                     Uninterruptibles.awaitUninterruptibly(messageReceived.get(), 5, TimeUnit.SECONDS));
 340             assertEquals("Message type", messageClass.get(), receivedMessage.get().getClass());
 341             return (T) receivedMessage.get();
 342         }
 343
 344         void expectShardMessage(Class<?> ofType) {
 345             messageReceived.set(new CountDownLatch(1));
 346             receivedMessage.set(null);
 347             messageClass.set(ofType);
 348         }
 349
 350         void setDataTree(DataTree tree) {
 351             this.dataTree.set(tree);
 352         }
 353     }
 354
 355     static class TestEntityOwnershipShard extends EntityOwnershipShard {
 356         private final AtomicReference<CountDownLatch> messageReceived;
 357         private final AtomicReference<Object> receivedMessage;
 358         private final AtomicReference<Class<?>> messageClass;
 359         private final AtomicReference<DataTree> dataTree;
 360
 361         protected TestEntityOwnershipShard(EntityOwnershipShard.Builder builder,
 362                 AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
 363                 AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
 364             super(builder);
 365             this.messageClass = messageClass;
 366             this.messageReceived = messageReceived;
 367             this.receivedMessage = receivedMessage;
 368             this.dataTree = dataTree;
 369         }
 370
 371         @Override
 372         public void onReceiveCommand(final Object message) throws Exception {
 373             try {
 374                 if(dataTree.get() != null && message instanceof GetShardDataTree) {
 375                     sender().tell(dataTree.get(), self());
 376                 } else {
 377                     super.onReceiveCommand(message);
 378                 }
 379             } finally {
 380                 Class<?> expMsgClass = messageClass.get();
 381                 if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
 382                     receivedMessage.set(message);
 383                     messageReceived.get().countDown();
 384                 }
 385             }
 386         }
 387     }
 388 }