Bug 4105: Implement RegisterCandidate in EntityOwnershipShard
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / entityownership / DistributedEntityOwnershipServiceTest.java
index b7f75c98f3b49276be2ed4dc96bb768792627df3..c2d997f7029b922a6f5247ec045ceee45b605b38 100644 (file)
@@ -7,19 +7,47 @@
  */
 package org.opendaylight.controller.cluster.datastore.entityownership;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+import static org.mockito.Mockito.mock;
 import akka.actor.ActorRef;
+import akka.actor.PoisonPill;
+import akka.actor.Props;
+import com.google.common.base.Optional;
+import com.google.common.base.Stopwatch;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.util.concurrent.Uninterruptibles;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
+import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
-import org.opendaylight.controller.cluster.datastore.AbstractActorTest;
 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
+import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
+import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
+import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
+import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategy;
+import org.opendaylight.controller.cluster.datastore.shardstrategy.ShardStrategyFactory;
 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
 import org.opendaylight.controller.cluster.datastore.utils.MockConfiguration;
-import org.opendaylight.controller.md.cluster.datastore.model.TestModel;
+import org.opendaylight.controller.md.cluster.datastore.model.SchemaContextHelper;
+import org.opendaylight.controller.md.sal.common.api.clustering.CandidateAlreadyRegisteredException;
+import org.opendaylight.controller.md.sal.common.api.clustering.Entity;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidate;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipCandidateRegistration;
+import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import scala.concurrent.Await;
 import scala.concurrent.Future;
 import scala.concurrent.duration.Duration;
@@ -29,40 +57,245 @@ import scala.concurrent.duration.Duration;
  *
  * @author Thomas Pantelis
  */
-public class DistributedEntityOwnershipServiceTest extends AbstractActorTest {
-    private static int ID_COUNTER = 1;
+public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnershipTest {
+    static String ENTITY_TYPE = "test";
+    static String ENTITY_TYPE2 = "test2";
+    static int ID_COUNTER = 1;
+    static final QName QNAME = QName.create("test", "2015-08-11", "foo");
 
     private final String dataStoreType = "config" + ID_COUNTER++;
-    private DistributedEntityOwnershipService service;
     private DistributedDataStore dataStore;
 
     @Before
-    public void setUp() throws Exception {
+    public void setUp() {
         DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreType(dataStoreType).
                 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
-        dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(),
-                new MockConfiguration(Collections.<String, List<String>>emptyMap()), datastoreContext );
 
-        dataStore.onGlobalContextUpdated(TestModel.createTestContext());
+        // FIXME - remove this MockConfiguration and use the production ConfigurationImpl class when the
+        // DistributedEntityOwnershipService is changed to setup the ShardStrategy for the entity-owners module.
+        MockConfiguration configuration = new MockConfiguration(Collections.<String, List<String>>emptyMap()) {
+            @Override
+            public Optional<String> getModuleNameFromNameSpace(String nameSpace) {
+                return Optional.of("entity-owners");
+            }
 
-        service = new DistributedEntityOwnershipService(dataStore);
+            @Override
+            public Map<String, ShardStrategy> getModuleNameToShardStrategyMap() {
+                return ImmutableMap.<String, ShardStrategy>builder().put("entity-owners", new ShardStrategy() {
+                    @Override
+                    public String findShard(YangInstanceIdentifier path) {
+                        return DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME;
+                    }
+                }).build();
+            }
+        };
+
+        dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, datastoreContext );
+
+        dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
+
+        ShardStrategyFactory.setConfiguration(configuration);
+    }
+
+    @After
+    public void tearDown() {
+        dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
     }
 
     @Test
     public void testEntityOwnershipShardCreated() throws Exception {
+        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore);
         service.start();
 
         Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
                 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
         ActorRef shardActor = Await.result(future, Duration.create(10, TimeUnit.SECONDS));
         assertNotNull(DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME + " not found", shardActor);
+
+        service.close();
     }
 
     @Test
-    public void testRegisterCandidate() {
+    public void testRegisterCandidate() throws Exception {
+        final TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
+        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
+            @Override
+            protected EntityOwnershipShardPropsCreator newShardPropsCreator() {
+                return shardPropsCreator;
+            }
+        };
+
+        service.start();
+
+        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
+
+        YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
+        Entity entity = new Entity(ENTITY_TYPE, entityId);
+        EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class);
+
+        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity, candidate);
+
+        verifyEntityOwnershipCandidateRegistration(entity, reg);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity, candidate);
+        verifyEntityCandidate(readEntityOwners(service.getLocalEntityOwnershipShard()), ENTITY_TYPE, entityId,
+                dataStore.getActorContext().getCurrentMemberName());
+
+        // Register the same entity - should throw exception
+
+        EntityOwnershipCandidate candidate2 = mock(EntityOwnershipCandidate.class);
+        try {
+            service.registerCandidate(entity, candidate2);
+            fail("Expected CandidateAlreadyRegisteredException");
+        } catch(CandidateAlreadyRegisteredException e) {
+            // expected
+            assertSame("getCandidate", candidate, e.getRegisteredCandidate());
+            assertEquals("getEntity", entity, e.getEntity());
+        }
+
+        // Register a different entity - should succeed
+
+        Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
+        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
+
+        EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2, candidate);
+
+        verifyEntityOwnershipCandidateRegistration(entity2, reg2);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity2, candidate);
+        verifyEntityCandidate(readEntityOwners(service.getLocalEntityOwnershipShard()), ENTITY_TYPE2, entityId,
+                dataStore.getActorContext().getCurrentMemberName());
+
+        service.close();
+    }
+
+    @Test
+    public void testCloseCandidateRegistration() throws Exception {
+        final TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
+        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
+            @Override
+            protected EntityOwnershipShardPropsCreator newShardPropsCreator() {
+                return shardPropsCreator;
+            }
+        };
+
+        service.start();
+
+        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
+
+        Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
+        EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class);
+
+        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity, candidate);
+
+        verifyEntityOwnershipCandidateRegistration(entity, reg);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity, candidate);
+
+        shardPropsCreator.expectShardMessage(UnregisterCandidateLocal.class);
+
+        reg.close();
+
+        UnregisterCandidateLocal unregCandidate = shardPropsCreator.waitForShardMessage();
+        assertEquals("getEntity", entity, unregCandidate.getEntity());
+
+        // Re-register - should succeed.
+
+        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
+
+        service.registerCandidate(entity, candidate);
+
+        verifyRegisterCandidateLocal(shardPropsCreator, entity, candidate);
+
+        service.close();
     }
 
     @Test
     public void testRegisterListener() {
     }
+
+    private NormalizedNode<?, ?> readEntityOwners(ActorRef shard) throws Exception {
+        Stopwatch sw = Stopwatch.createStarted();
+        while(sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
+            DOMStoreReadTransaction readTx = dataStore.newReadOnlyTransaction();
+            Optional<NormalizedNode<?, ?>> optional = readTx.read(EntityOwnershipShard.ENTITY_OWNERS_PATH).
+                    checkedGet(5, TimeUnit.SECONDS);
+            if(optional.isPresent()) {
+                return optional.get();
+            }
+
+            Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
+        }
+
+        return null;
+    }
+
+    private void verifyRegisterCandidateLocal(final TestShardPropsCreator shardPropsCreator, Entity entity,
+            EntityOwnershipCandidate candidate) {
+        RegisterCandidateLocal regCandidate = shardPropsCreator.waitForShardMessage();
+        assertSame("getCandidate", candidate, regCandidate.getCandidate());
+        assertEquals("getEntity", entity, regCandidate.getEntity());
+    }
+
+    private void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
+        assertNotNull("EntityOwnershipCandidateRegistration null", reg);
+        assertEquals("getEntity", entity, reg.getEntity());
+    }
+
+    static class TestShardPropsCreator extends EntityOwnershipShardPropsCreator {
+        TestShardPropsCreator() {
+            super("member-1");
+        }
+
+        private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
+        private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
+        private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
+
+        @Override
+        public Props newProps(ShardIdentifier shardId, Map<String, String> peerAddresses,
+                DatastoreContext datastoreContext, SchemaContext schemaContext) {
+            return Props.create(TestEntityOwnershipShard.class, shardId, peerAddresses, datastoreContext,
+                    schemaContext, "member-1", messageClass, messageReceived, receivedMessage);
+        }
+
+        @SuppressWarnings("unchecked")
+        <T> T waitForShardMessage() {
+            assertTrue("Message " + messageClass.get().getSimpleName() + " was not received",
+                    Uninterruptibles.awaitUninterruptibly(messageReceived.get(), 5, TimeUnit.SECONDS));
+            assertEquals("Message type", messageClass.get(), receivedMessage.get().getClass());
+            return (T) receivedMessage.get();
+        }
+
+        void expectShardMessage(Class<?> ofType) {
+            messageReceived.set(new CountDownLatch(1));
+            receivedMessage.set(null);
+            messageClass.set(ofType);
+        }
+    }
+
+    static class TestEntityOwnershipShard extends EntityOwnershipShard {
+        private final AtomicReference<CountDownLatch> messageReceived;
+        private final AtomicReference<Object> receivedMessage;
+        private final AtomicReference<Class<?>> messageClass;
+
+        protected TestEntityOwnershipShard(ShardIdentifier name, Map<String, String> peerAddresses,
+                DatastoreContext datastoreContext, SchemaContext schemaContext, String localMemberName,
+                AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
+                AtomicReference<Object> receivedMessage) {
+            super(name, peerAddresses, datastoreContext, schemaContext, localMemberName);
+            this.messageClass = messageClass;
+            this.messageReceived = messageReceived;
+            this.receivedMessage = receivedMessage;
+        }
+
+        @Override
+        public void onReceiveCommand(final Object message) throws Exception {
+            try {
+                super.onReceiveCommand(message);
+            } finally {
+                Class<?> expMsgClass = messageClass.get();
+                if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
+                    receivedMessage.set(message);
+                    messageReceived.get().countDown();
+                }
+            }
+        }
+    }
 }