Add getOwnershipState method to EntityOwnershipService
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / entityownership / DistributedEntityOwnershipServiceTest.java
index 51f042ddacc10521cebb544b4d8eaa585b0d1596..5591772afcdeafba3cb6f1989bd06610f537e9cc 100644 (file)
@@ -13,10 +13,18 @@ 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 static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityEntryWithOwner;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithEntityTypeEntry;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityTypeEntryWithEntityEntry;
 import akka.actor.ActorRef;
 import akka.actor.PoisonPill;
 import akka.actor.Props;
 import com.google.common.base.Function;
+import com.google.common.base.Optional;
 import com.google.common.util.concurrent.Uninterruptibles;
 import java.util.Collections;
 import java.util.Map;
@@ -28,6 +36,7 @@ import org.junit.Before;
 import org.junit.Test;
 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
+import org.opendaylight.controller.cluster.datastore.ShardDataTree;
 import org.opendaylight.controller.cluster.datastore.config.Configuration;
 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
 import org.opendaylight.controller.cluster.datastore.config.ModuleConfig;
@@ -37,17 +46,20 @@ import org.opendaylight.controller.cluster.datastore.entityownership.messages.Re
 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
+import org.opendaylight.controller.cluster.datastore.messages.GetShardDataTree;
 import org.opendaylight.controller.cluster.datastore.utils.MockClusterWrapper;
 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.md.sal.common.api.clustering.EntityOwnershipListener;
 import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListenerRegistration;
+import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipState;
 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.data.api.schema.tree.DataTree;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
 import scala.concurrent.Await;
 import scala.concurrent.Future;
@@ -118,24 +130,21 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
         Entity entity = new Entity(ENTITY_TYPE, entityId);
-        EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class);
 
-        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity, candidate);
+        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 
         verifyEntityOwnershipCandidateRegistration(entity, reg);
-        verifyRegisterCandidateLocal(shardPropsCreator, entity, candidate);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity);
         verifyEntityCandidate(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);
+            service.registerCandidate(entity);
             fail("Expected CandidateAlreadyRegisteredException");
         } catch(CandidateAlreadyRegisteredException e) {
             // expected
-            assertSame("getCandidate", candidate, e.getRegisteredCandidate());
             assertEquals("getEntity", entity, e.getEntity());
         }
 
@@ -144,10 +153,10 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
         shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
 
-        EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2, candidate);
+        EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
 
         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
-        verifyRegisterCandidateLocal(shardPropsCreator, entity2, candidate);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity2);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
                 dataStore.getActorContext().getCurrentMemberName());
 
@@ -169,12 +178,11 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
 
         Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
-        EntityOwnershipCandidate candidate = mock(EntityOwnershipCandidate.class);
 
-        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity, candidate);
+        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 
         verifyEntityOwnershipCandidateRegistration(entity, reg);
-        verifyRegisterCandidateLocal(shardPropsCreator, entity, candidate);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity);
 
         shardPropsCreator.expectShardMessage(UnregisterCandidateLocal.class);
 
@@ -182,15 +190,14 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
         UnregisterCandidateLocal unregCandidate = shardPropsCreator.waitForShardMessage();
         assertEquals("getEntity", entity, unregCandidate.getEntity());
-        assertSame("getCandidate", candidate, unregCandidate.getCandidate());
 
         // Re-register - should succeed.
 
         shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
 
-        service.registerCandidate(entity, candidate);
+        service.registerCandidate(entity);
 
-        verifyRegisterCandidateLocal(shardPropsCreator, entity, candidate);
+        verifyRegisterCandidateLocal(shardPropsCreator, entity);
 
         service.close();
     }
@@ -234,6 +241,53 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         service.close();
     }
 
+    @Test
+    public void testGetOwnershipState() throws Exception {
+        final TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
+        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
+            @Override
+            protected EntityOwnershipShardPropsCreator newShardPropsCreator() {
+                return shardPropsCreator;
+            }
+        };
+
+        service.start();
+
+        ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners());
+        shardPropsCreator.setDataTree(shardDataTree.getDataTree());
+
+        Entity entity1 = new Entity(ENTITY_TYPE, "one");
+        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
+                entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
+        verifyGetOwnershipState(service, entity1, true, true);
+
+        writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
+                shardDataTree);
+        verifyGetOwnershipState(service, entity1, false, true);
+
+        writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
+                shardDataTree);
+        verifyGetOwnershipState(service, entity1, false, false);
+
+        Entity entity2 = new Entity(ENTITY_TYPE, "two");
+        Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
+        assertEquals("getOwnershipState present", false, state.isPresent());
+
+        writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
+                ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
+        verifyGetOwnershipState(service, entity2, false, false);
+
+        service.close();
+    }
+
+    private void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
+            boolean isOwner, boolean hasOwner) {
+        Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
+        assertEquals("getOwnershipState present", true, state.isPresent());
+        assertEquals("isOwner", isOwner, state.get().isOwner());
+        assertEquals("hasOwner", hasOwner, state.get().hasOwner());
+    }
+
     private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
             YangInstanceIdentifier entityId, String candidateName) {
         verifyEntityCandidate(entityType, entityId, candidateName,
@@ -249,16 +303,14 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
                 });
     }
 
-    private void verifyRegisterCandidateLocal(final TestShardPropsCreator shardPropsCreator, Entity entity,
-            EntityOwnershipCandidate candidate) {
+    private void verifyRegisterCandidateLocal(final TestShardPropsCreator shardPropsCreator, Entity entity) {
         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());
+        assertEquals("getInstance", entity, reg.getInstance());
     }
 
     static class TestShardPropsCreator extends EntityOwnershipShardPropsCreator {
@@ -269,12 +321,13 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
         private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
         private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
+        private final AtomicReference<DataTree> dataTree = 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);
+                    schemaContext, "member-1", messageClass, messageReceived, receivedMessage, dataTree);
         }
 
         @SuppressWarnings("unchecked")
@@ -290,27 +343,37 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
             receivedMessage.set(null);
             messageClass.set(ofType);
         }
+
+        void setDataTree(DataTree tree) {
+            this.dataTree.set(tree);
+        }
     }
 
     static class TestEntityOwnershipShard extends EntityOwnershipShard {
         private final AtomicReference<CountDownLatch> messageReceived;
         private final AtomicReference<Object> receivedMessage;
         private final AtomicReference<Class<?>> messageClass;
+        private final AtomicReference<DataTree> dataTree;
 
         protected TestEntityOwnershipShard(ShardIdentifier name, Map<String, String> peerAddresses,
                 DatastoreContext datastoreContext, SchemaContext schemaContext, String localMemberName,
                 AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
-                AtomicReference<Object> receivedMessage) {
+                AtomicReference<Object> receivedMessage, AtomicReference<DataTree> dataTree) {
             super(name, peerAddresses, datastoreContext, schemaContext, localMemberName);
             this.messageClass = messageClass;
             this.messageReceived = messageReceived;
             this.receivedMessage = receivedMessage;
+            this.dataTree = dataTree;
         }
 
         @Override
         public void onReceiveCommand(final Object message) throws Exception {
             try {
-                super.onReceiveCommand(message);
+                if(dataTree.get() != null && message instanceof GetShardDataTree) {
+                    sender().tell(dataTree.get(), self());
+                } else {
+                    super.onReceiveCommand(message);
+                }
             } finally {
                 Class<?> expMsgClass = messageClass.get();
                 if(expMsgClass != null && expMsgClass.equals(message.getClass())) {