BUG-5280: expand ShardDataTree to cover transaction mechanics
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / entityownership / DistributedEntityOwnershipServiceTest.java
index e9d837c17ff1e41263e1b839d881cc30dcb554a8..52adc5af42c3fa3d0911055cf2d69b24f3df8d2a 100644 (file)
@@ -28,21 +28,20 @@ import static org.opendaylight.controller.cluster.datastore.entityownership.Enti
 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 com.google.common.base.Optional;
 import com.google.common.collect.Sets;
 import java.util.Collection;
-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.mockito.ArgumentCaptor;
 import org.mockito.Mockito;
+import org.opendaylight.controller.cluster.access.concepts.MemberName;
 import org.opendaylight.controller.cluster.datastore.DatastoreContext;
 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
 import org.opendaylight.controller.cluster.datastore.DistributedDataStore;
+import org.opendaylight.controller.cluster.datastore.Shard;
 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
 import org.opendaylight.controller.cluster.datastore.config.Configuration;
 import org.opendaylight.controller.cluster.datastore.config.ConfigurationImpl;
@@ -52,18 +51,16 @@ 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.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
-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.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.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
+import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipCandidateRegistration;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
+import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.TreeType;
 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import scala.concurrent.Await;
@@ -91,8 +88,8 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
         Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
             @Override
-            public Collection<String> getUniqueMemberNamesForAllShards() {
-                return Sets.newHashSet("member-1");
+            public Collection<MemberName> getUniqueMemberNamesForAllShards() {
+                return Sets.newHashSet(MemberName.forName("member-1"));
             }
         };
 
@@ -107,7 +104,7 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
     @After
     public void tearDown() {
-        dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
+        dataStore.close();
     }
 
     private static <T> T verifyMessage(final DistributedEntityOwnershipService mock, final Class<T> type) {
@@ -135,13 +132,13 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
             dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
-        Entity entity = new Entity(ENTITY_TYPE, entityId);
+        DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
 
-        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
+        DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
         verifyRegisterCandidateLocal(service, entity);
         verifyEntityOwnershipCandidateRegistration(entity, reg);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
-                dataStore.getActorContext().getCurrentMemberName());
+                dataStore.getActorContext().getCurrentMemberName().getName());
 
         // Register the same entity - should throw exception
 
@@ -156,12 +153,12 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         // Register a different entity - should succeed
         reset(service);
 
-        Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
-        EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
-        verifyRegisterCandidateLocal(service, entity2);
+        DOMEntity entity2 = new DOMEntity(ENTITY_TYPE2, entityId);
+        DOMEntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
+
         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
-                dataStore.getActorContext().getCurrentMemberName());
+                dataStore.getActorContext().getCurrentMemberName().getName());
 
         service.close();
     }
@@ -171,8 +168,9 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
             dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
-        Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
-        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
+        DOMEntity entity = new DOMEntity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
+
+        DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 
         verifyEntityOwnershipCandidateRegistration(entity, reg);
         verifyRegisterCandidateLocal(service, entity);
@@ -196,10 +194,10 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
             dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
-        Entity entity = new Entity(ENTITY_TYPE, entityId);
-        EntityOwnershipListener listener = mock(EntityOwnershipListener.class);
+        DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
+        DOMEntityOwnershipListener listener = mock(DOMEntityOwnershipListener.class);
 
-        EntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
+        DOMEntityOwnershipListenerRegistration reg = service.registerListener(entity.getType(), listener);
 
         assertNotNull("EntityOwnershipListenerRegistration null", reg);
         assertEquals("getEntityType", entity.getType(), reg.getEntityType());
@@ -223,35 +221,39 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
             dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
-        ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners(), TreeType.OPERATIONAL);
+        final Shard mockShard = Mockito.mock(Shard.class);
+        ShardDataTree shardDataTree = new ShardDataTree(mockShard, SchemaContextHelper.entityOwners(),
+            TreeType.OPERATIONAL);
 
         when(service.getLocalEntityOwnershipShardDataTree()).thenReturn(shardDataTree.getDataTree());
 
-        Entity entity1 = new Entity(ENTITY_TYPE, "one");
-        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getId(), "member-1"), shardDataTree);
+        DOMEntity entity1 = new DOMEntity(ENTITY_TYPE, "one");
+        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getIdentifier(), "member-1"), shardDataTree);
         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
-                entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
-        verifyGetOwnershipState(service, entity1, true, true);
+                entityEntryWithOwner(entity1.getIdentifier(), "member-1"))), shardDataTree);
+        verifyGetOwnershipState(service, entity1, EntityOwnershipState.IS_OWNER);
 
-        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity1.getId(), "member-2"), shardDataTree);
-        writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), "member-2"),
-                shardDataTree);
-        verifyGetOwnershipState(service, entity1, false, true);
+        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE,
+                entity1.getIdentifier(), "member-2"), shardDataTree);
+        writeNode(entityPath(entity1.getType(), entity1.getIdentifier()),
+                entityEntryWithOwner(entity1.getIdentifier(), "member-2"), shardDataTree);
+        verifyGetOwnershipState(service, entity1, EntityOwnershipState.OWNED_BY_OTHER);
 
-        writeNode(entityPath(entity1.getType(), entity1.getId()), entityEntryWithOwner(entity1.getId(), ""),
+        writeNode(entityPath(entity1.getType(), entity1.getIdentifier()), entityEntryWithOwner(entity1.getIdentifier(), ""),
                 shardDataTree);
-        verifyGetOwnershipState(service, entity1, false, false);
+        verifyGetOwnershipState(service, entity1, EntityOwnershipState.NO_OWNER);
 
-        Entity entity2 = new Entity(ENTITY_TYPE, "two");
+        DOMEntity entity2 = new DOMEntity(ENTITY_TYPE, "two");
         Optional<EntityOwnershipState> state = service.getOwnershipState(entity2);
         assertEquals("getOwnershipState present", false, state.isPresent());
 
-        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity2.getId(), "member-1"), shardDataTree);
-        writeNode(entityPath(entity2.getType(), entity2.getId()), ImmutableNodes.mapEntry(ENTITY_QNAME,
-                ENTITY_ID_QNAME, entity2.getId()), shardDataTree);
-        verifyGetOwnershipState(service, entity2, false, false);
+        writeNode(ENTITY_OWNERS_PATH, entityOwnersWithCandidate(ENTITY_TYPE, entity2.getIdentifier(), "member-1"),
+                shardDataTree);
+        writeNode(entityPath(entity2.getType(), entity2.getIdentifier()), ImmutableNodes.mapEntry(ENTITY_QNAME,
+                ENTITY_ID_QNAME, entity2.getIdentifier()), shardDataTree);
+        verifyGetOwnershipState(service, entity2, EntityOwnershipState.NO_OWNER);
 
-        deleteNode(candidatePath(entityPath(entity2.getType(), entity2.getId()), "member-1"), shardDataTree);
+        deleteNode(candidatePath(entityPath(entity2.getType(), entity2.getIdentifier()), "member-1"), shardDataTree);
         Optional<EntityOwnershipState> state2 = service.getOwnershipState(entity2);
         assertEquals("getOwnershipState present", false, state2.isPresent());
         service.close();
@@ -262,7 +264,7 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
 
-        final Entity test = new Entity("test-type", "test");
+        final DOMEntity test = new DOMEntity("test-type", "test");
 
         assertFalse(service.isCandidateRegistered(test));
 
@@ -273,12 +275,11 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         service.close();
     }
 
-    private static void verifyGetOwnershipState(final DistributedEntityOwnershipService service, final Entity entity,
-            final boolean isOwner, final boolean hasOwner) {
+    private static void verifyGetOwnershipState(final DistributedEntityOwnershipService service, final DOMEntity entity,
+            final EntityOwnershipState expState) {
         Optional<EntityOwnershipState> state = service.getOwnershipState(entity);
         assertEquals("getOwnershipState present", true, state.isPresent());
-        assertEquals("isOwner", isOwner, state.get().isOwner());
-        assertEquals("hasOwner", hasOwner, state.get().hasOwner());
+        assertEquals("EntityOwnershipState", expState, state.get());
     }
 
     private void verifyEntityCandidate(final ActorRef entityOwnershipShard, final String entityType,
@@ -293,47 +294,14 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
                 });
     }
 
-    private static void verifyRegisterCandidateLocal(final DistributedEntityOwnershipService service, final Entity entity) {
+    private static void verifyRegisterCandidateLocal(final DistributedEntityOwnershipService service, final DOMEntity entity) {
         RegisterCandidateLocal regCandidate = verifyMessage(service, RegisterCandidateLocal.class);
         assertEquals("getEntity", entity, regCandidate.getEntity());
     }
 
-    private static void verifyEntityOwnershipCandidateRegistration(final Entity entity, final EntityOwnershipCandidateRegistration reg) {
+    private static void verifyEntityOwnershipCandidateRegistration(final DOMEntity entity,
+            final DOMEntityOwnershipCandidateRegistration reg) {
         assertNotNull("EntityOwnershipCandidateRegistration null", reg);
         assertEquals("getInstance", entity, reg.getInstance());
     }
-
-    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(final EntityOwnershipShard.Builder builder,
-                final AtomicReference<Class<?>> messageClass, final AtomicReference<CountDownLatch> messageReceived,
-                final AtomicReference<Object> receivedMessage, final AtomicReference<DataTree> dataTree) {
-            super(builder);
-            this.messageClass = messageClass;
-            this.messageReceived = messageReceived;
-            this.receivedMessage = receivedMessage;
-            this.dataTree = dataTree;
-        }
-
-        @Override
-        public void handleCommand(final Object message) {
-            try {
-                if(dataTree.get() != null && message instanceof GetShardDataTree) {
-                    sender().tell(dataTree.get(), self());
-                } else {
-                    super.handleCommand(message);
-                }
-            } finally {
-                Class<?> expMsgClass = messageClass.get();
-                if(expMsgClass != null && expMsgClass.equals(message.getClass())) {
-                    receivedMessage.set(message);
-                    messageReceived.get().countDown();
-                }
-            }
-        }
-    }
 }