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.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;
  71
  72 /**
  73  * Unit tests for DistributedEntityOwnershipService.
  74  *
  75  * @author Thomas Pantelis
  76  */
  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");
  82
  83     private final String dataStoreName = "config" + ID_COUNTER++;
  84     private DistributedDataStore dataStore;
  85
  86     @Before
  87     public void setUp() {
  88         DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreName(dataStoreName).
  89                 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
  90
  91         Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
  92             @Override
  93             public Collection<String> getUniqueMemberNamesForAllShards() {
  94                 return Sets.newHashSet("member-1");
  95             }
  96         };
  97
  98         DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
  99         Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
 100         Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
 101
 102         dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory, null);
 103
 104         dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
 105     }
 106
 107     @After
 108     public void tearDown() {
 109         dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
 110     }
 111
 112     @Test
 113     public void testEntityOwnershipShardCreated() throws Exception {
 114         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 115                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
 116         service.start();
 117
 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);
 122
 123         service.close();
 124     }
 125
 126     @Test
 127     public void testRegisterCandidate() throws Exception {
 128         final TestShardBuilder shardBuilder = new TestShardBuilder();
 129         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 130                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 131             @Override
 132             protected EntityOwnershipShard.Builder newShardBuilder() {
 133                 return shardBuilder;
 134             }
 135         };
 136
 137         service.start();
 138
 139         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 140
 141         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
 142         Entity entity = new Entity(ENTITY_TYPE, entityId);
 143
 144         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 145
 146         verifyEntityOwnershipCandidateRegistration(entity, reg);
 147         verifyRegisterCandidateLocal(shardBuilder, entity);
 148         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
 149                 dataStore.getActorContext().getCurrentMemberName());
 150
 151         // Register the same entity - should throw exception
 152
 153         try {
 154             service.registerCandidate(entity);
 155             fail("Expected CandidateAlreadyRegisteredException");
 156         } catch(CandidateAlreadyRegisteredException e) {
 157             // expected
 158             assertEquals("getEntity", entity, e.getEntity());
 159         }
 160
 161         // Register a different entity - should succeed
 162
 163         Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
 164         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 165
 166         EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
 167
 168         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
 169         verifyRegisterCandidateLocal(shardBuilder, entity2);
 170         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
 171                 dataStore.getActorContext().getCurrentMemberName());
 172
 173         service.close();
 174     }
 175
 176     @Test
 177     public void testCloseCandidateRegistration() throws Exception {
 178         final TestShardBuilder shardBuilder = new TestShardBuilder();
 179         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 180                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 181             @Override
 182             protected EntityOwnershipShard.Builder newShardBuilder() {
 183                 return shardBuilder;
 184             }
 185         };
 186
 187         service.start();
 188
 189         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 190
 191         Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
 192
 193         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 194
 195         verifyEntityOwnershipCandidateRegistration(entity, reg);
 196         verifyRegisterCandidateLocal(shardBuilder, entity);
 197
 198         shardBuilder.expectShardMessage(UnregisterCandidateLocal.class);
 199
 200         reg.close();
 201
 202         UnregisterCandidateLocal unregCandidate = shardBuilder.waitForShardMessage();
 203         assertEquals("getEntity", entity, unregCandidate.getEntity());
 204
 205         // Re-register - should succeed.
 206
 207         shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
 208
 209         service.registerCandidate(entity);
 210
 211         verifyRegisterCandidateLocal(shardBuilder, entity);
 212
 213         service.close();
 214     }
 215
 216     @Test
 217     public void testListenerRegistration() {
 218         final TestShardBuilder shardBuilder = new TestShardBuilder();
 219         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 220                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 221             @Override
 222             protected EntityOwnershipShard.Builder newShardBuilder() {
 223                 return shardBuilder;
 224             }
 225         };
 226
 227         service.start();
 228
 229         shardBuilder.expectShardMessage(RegisterListenerLocal.class);
 230
 231         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
 232         Entity entity = new Entity(ENTITY_TYPE, entityId);
 233         EntityOwnershipListener listener = mock(EntityOwnershipListener.class);
 234
 235         EntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
 236
 237         assertNotNull("EntityOwnershipListenerRegistration null", reg);
 238         assertEquals("getEntityType", entity.getType(), reg.getEntityType());
 239         assertEquals("getInstance", listener, reg.getInstance());
 240
 241         RegisterListenerLocal regListener = shardBuilder.waitForShardMessage();
 242         assertSame("getListener", listener, regListener.getListener());
 243         assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
 244
 245         shardBuilder.expectShardMessage(UnregisterListenerLocal.class);
 246
 247         reg.close();
 248
 249         UnregisterListenerLocal unregListener = shardBuilder.waitForShardMessage();
 250         assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
 251         assertSame("getListener", listener, unregListener.getListener());
 252
 253         service.close();
 254     }
 255
 256     @Test
 257     public void testGetOwnershipState() throws Exception {
 258         final TestShardBuilder shardBuilder = new TestShardBuilder();
 259         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 260                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 261             @Override
 262             protected EntityOwnershipShard.Builder newShardBuilder() {
 263                 return shardBuilder;
 264             }
 265         };
 266
 267         service.start();
 268
 269         ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners(), TreeType.OPERATIONAL);
 270         shardBuilder.setDataTree(shardDataTree.getDataTree());
 271
 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);
 277
 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"),
 280                 shardDataTree);
 281         verifyGetOwnershipState(service, entity1, false, true);
 282
 283         writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
 284                 shardDataTree);
 285         verifyGetOwnershipState(service, entity1, false, false);
 286
 287         Entity entity2 = new Entity(ENTITY_TYPE, "two");
 288         Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
 289         assertEquals("getOwnershipState present", false, state.isPresent());
 290
 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);
 295
 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());
 299         service.close();
 300     }
 301
 302     @Test
 303     public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
 304         final TestShardBuilder shardBuilder = new TestShardBuilder();
 305         DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
 306                 EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
 307             @Override
 308             protected EntityOwnershipShard.Builder newShardBuilder() {
 309                 return shardBuilder;
 310             }
 311         };
 312
 313         service.start();
 314
 315         final Entity test = new Entity("test-type", "test");
 316
 317         assertFalse(service.isCandidateRegistered(test));
 318
 319         service.registerCandidate(test);
 320
 321         assertTrue(service.isCandidateRegistered(test));
 322
 323         service.close();
 324     }
 325
 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());
 332     }
 333
 334     private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
 335             YangInstanceIdentifier entityId, String candidateName) {
 336         verifyEntityCandidate(entityType, entityId, candidateName,
 337                 new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
 338                     @Override
 339                     public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
 340                         try {
 341                             return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
 342                         } catch (Exception e) {
 343                             return null;
 344                         }
 345                     }
 346                 });
 347     }
 348
 349     private static void verifyRegisterCandidateLocal(final TestShardBuilder shardBuilder, Entity entity) {
 350         RegisterCandidateLocal regCandidate = shardBuilder.waitForShardMessage();
 351         assertEquals("getEntity", entity, regCandidate.getEntity());
 352     }
 353
 354     private static void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
 355         assertNotNull("EntityOwnershipCandidateRegistration null", reg);
 356         assertEquals("getInstance", entity, reg.getInstance());
 357     }
 358
 359     static class TestShardBuilder extends EntityOwnershipShard.Builder {
 360         TestShardBuilder() {
 361             localMemberName("member-1").ownerSelectionStrategyConfig(
 362                     EntityOwnerSelectionStrategyConfig.newBuilder().build());
 363         }
 364
 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<>();
 369
 370         @Override
 371         public Props props() {
 372             verify();
 373             return Props.create(TestEntityOwnershipShard.class,this, messageClass, messageReceived,
 374                     receivedMessage, dataTree);
 375         }
 376
 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();
 383         }
 384
 385         void expectShardMessage(Class<?> ofType) {
 386             messageReceived.set(new CountDownLatch(1));
 387             receivedMessage.set(null);
 388             messageClass.set(ofType);
 389         }
 390
 391         void setDataTree(DataTree tree) {
 392             this.dataTree.set(tree);
 393         }
 394     }
 395
 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;
 401
 402         protected TestEntityOwnershipShard(EntityOwnershipShard.Builder builder,
 403                 AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
 404                 AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
 405             super(builder);
 406             this.messageClass = messageClass;
 407             this.messageReceived = messageReceived;
 408             this.receivedMessage = receivedMessage;
 409             this.dataTree = dataTree;
 410         }
 411
 412         @Override
 413         public void onReceiveCommand(final Object message) throws Exception {
 414             try {
 415                 if(dataTree.get() != null && message instanceof GetShardDataTree) {
 416                     sender().tell(dataTree.get(), self());
 417                 } else {
 418                     super.onReceiveCommand(message);
 419                 }
 420             } finally {
 421                 Class<?> expMsgClass = messageClass.get();
 422                 if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
 423                     receivedMessage.set(message);
 424                     messageReceived.get().countDown();
 425                 }
 426             }
 427         }
 428     }
 429 }