Do not use Strings for internal messages
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / entityownership / DistributedEntityOwnershipServiceTest.java
index 9608b812e402fc419299e6804890ac0a26f0764b..e9d837c17ff1e41263e1b839d881cc30dcb554a8 100644 (file)
@@ -14,27 +14,31 @@ 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.mockito.Mockito.reset;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 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.candidatePath;
 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityEntryWithOwner;
+import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityOwnersWithCandidate;
 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;
+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.datastore.DatastoreContext;
 import org.opendaylight.controller.cluster.datastore.DatastoreContextFactory;
@@ -42,8 +46,7 @@ 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;
-import org.opendaylight.controller.cluster.datastore.config.ModuleShardConfigProvider;
+import org.opendaylight.controller.cluster.datastore.config.EmptyModuleShardConfigProvider;
 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterCandidateLocal;
 import org.opendaylight.controller.cluster.datastore.entityownership.messages.RegisterListenerLocal;
 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterCandidateLocal;
@@ -60,8 +63,8 @@ import org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipL
 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.api.schema.tree.TreeType;
 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import scala.concurrent.Await;
 import scala.concurrent.Future;
@@ -73,31 +76,31 @@ import scala.concurrent.duration.Duration;
  * @author Thomas Pantelis
  */
 public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnershipTest {
-    static String ENTITY_TYPE = "test";
-    static String ENTITY_TYPE2 = "test2";
-    static int ID_COUNTER = 1;
+    static final String ENTITY_TYPE = "test";
+    static final String ENTITY_TYPE2 = "test2";
     static final QName QNAME = QName.create("test", "2015-08-11", "foo");
+    static int ID_COUNTER = 1;
 
-    private final String dataStoreType = "config" + ID_COUNTER++;
+    private final String dataStoreName = "config" + ID_COUNTER++;
     private DistributedDataStore dataStore;
 
     @Before
     public void setUp() {
-        DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreType(dataStoreType).
+        DatastoreContext datastoreContext = DatastoreContext.newBuilder().dataStoreName(dataStoreName).
                 shardInitializationTimeout(10, TimeUnit.SECONDS).build();
 
-        Configuration configuration = new ConfigurationImpl(new ModuleShardConfigProvider() {
+        Configuration configuration = new ConfigurationImpl(new EmptyModuleShardConfigProvider()) {
             @Override
-            public Map<String, ModuleConfig> retrieveModuleConfigs(Configuration configuration) {
-                return Collections.emptyMap();
+            public Collection<String> getUniqueMemberNamesForAllShards() {
+                return Sets.newHashSet("member-1");
             }
-        });
+        };
 
-        DatastoreContextFactory mockContextFactory = Mockito.mock(DatastoreContextFactory.class);
+        DatastoreContextFactory mockContextFactory = mock(DatastoreContextFactory.class);
         Mockito.doReturn(datastoreContext).when(mockContextFactory).getBaseDatastoreContext();
         Mockito.doReturn(datastoreContext).when(mockContextFactory).getShardDatastoreContext(Mockito.anyString());
 
-        dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory);
+        dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory, null);
 
         dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
     }
@@ -107,11 +110,16 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         dataStore.getActorContext().getShardManager().tell(PoisonPill.getInstance(), ActorRef.noSender());
     }
 
+    private static <T> T verifyMessage(final DistributedEntityOwnershipService mock, final Class<T> type) {
+        final ArgumentCaptor<T> message = ArgumentCaptor.forClass(type);
+        verify(mock).executeLocalEntityOwnershipShardOperation(message.capture());
+        return message.getValue();
+    }
+
     @Test
     public void testEntityOwnershipShardCreated() throws Exception {
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
+        DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
                 EntityOwnerSelectionStrategyConfig.newBuilder().build());
-        service.start();
 
         Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
                 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
@@ -123,26 +131,15 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
     @Test
     public void testRegisterCandidate() throws Exception {
-        final TestShardBuilder shardBuilder = new TestShardBuilder();
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
-                EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
-            @Override
-            protected EntityOwnershipShard.Builder newShardBuilder() {
-                return shardBuilder;
-            }
-        };
-
-        service.start();
-
-        shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
+        DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
+            dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
         Entity entity = new Entity(ENTITY_TYPE, entityId);
 
         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
-
+        verifyRegisterCandidateLocal(service, entity);
         verifyEntityOwnershipCandidateRegistration(entity, reg);
-        verifyRegisterCandidateLocal(shardBuilder, entity);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
                 dataStore.getActorContext().getCurrentMemberName());
 
@@ -157,14 +154,12 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         }
 
         // Register a different entity - should succeed
+        reset(service);
 
         Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
-        shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
-
         EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
-
+        verifyRegisterCandidateLocal(service, entity2);
         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
-        verifyRegisterCandidateLocal(shardBuilder, entity2);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
                 dataStore.getActorContext().getCurrentMemberName());
 
@@ -173,58 +168,32 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
     @Test
     public void testCloseCandidateRegistration() throws Exception {
-        final TestShardBuilder shardBuilder = new TestShardBuilder();
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
-                EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
-            @Override
-            protected EntityOwnershipShard.Builder newShardBuilder() {
-                return shardBuilder;
-            }
-        };
-
-        service.start();
-
-        shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
+        DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
+            dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
         Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
-
         EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 
         verifyEntityOwnershipCandidateRegistration(entity, reg);
-        verifyRegisterCandidateLocal(shardBuilder, entity);
-
-        shardBuilder.expectShardMessage(UnregisterCandidateLocal.class);
+        verifyRegisterCandidateLocal(service, entity);
 
+        reset(service);
         reg.close();
-
-        UnregisterCandidateLocal unregCandidate = shardBuilder.waitForShardMessage();
+        UnregisterCandidateLocal unregCandidate = verifyMessage(service, UnregisterCandidateLocal.class);
         assertEquals("getEntity", entity, unregCandidate.getEntity());
 
         // Re-register - should succeed.
-
-        shardBuilder.expectShardMessage(RegisterCandidateLocal.class);
-
+        reset(service);
         service.registerCandidate(entity);
-
-        verifyRegisterCandidateLocal(shardBuilder, entity);
+        verifyRegisterCandidateLocal(service, entity);
 
         service.close();
     }
 
     @Test
     public void testListenerRegistration() {
-        final TestShardBuilder shardBuilder = new TestShardBuilder();
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
-                EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
-            @Override
-            protected EntityOwnershipShard.Builder newShardBuilder() {
-                return shardBuilder;
-            }
-        };
-
-        service.start();
-
-        shardBuilder.expectShardMessage(RegisterListenerLocal.class);
+        DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
+            dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
         YangInstanceIdentifier entityId = YangInstanceIdentifier.of(QNAME);
         Entity entity = new Entity(ENTITY_TYPE, entityId);
@@ -236,15 +205,13 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         assertEquals("getEntityType", entity.getType(), reg.getEntityType());
         assertEquals("getInstance", listener, reg.getInstance());
 
-        RegisterListenerLocal regListener = shardBuilder.waitForShardMessage();
+        RegisterListenerLocal regListener = verifyMessage(service, RegisterListenerLocal.class);
         assertSame("getListener", listener, regListener.getListener());
         assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
 
-        shardBuilder.expectShardMessage(UnregisterListenerLocal.class);
-
+        reset(service);
         reg.close();
-
-        UnregisterListenerLocal unregListener = shardBuilder.waitForShardMessage();
+        UnregisterListenerLocal unregListener = verifyMessage(service, UnregisterListenerLocal.class);
         assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
         assertSame("getListener", listener, unregListener.getListener());
 
@@ -253,25 +220,20 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
     @Test
     public void testGetOwnershipState() throws Exception {
-        final TestShardBuilder shardBuilder = new TestShardBuilder();
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
-                EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
-            @Override
-            protected EntityOwnershipShard.Builder newShardBuilder() {
-                return shardBuilder;
-            }
-        };
+        DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
+            dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
-        service.start();
+        ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners(), TreeType.OPERATIONAL);
 
-        ShardDataTree shardDataTree = new ShardDataTree(SchemaContextHelper.entityOwners());
-        shardBuilder.setDataTree(shardDataTree.getDataTree());
+        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);
         writeNode(ENTITY_OWNERS_PATH, entityOwnersWithEntityTypeEntry(entityTypeEntryWithEntityEntry(entity1.getType(),
                 entityEntryWithOwner(entity1.getId(), "member-1"))), shardDataTree);
         verifyGetOwnershipState(service, entity1, true, true);
 
+        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);
@@ -284,25 +246,21 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         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);
 
+        deleteNode(candidatePath(entityPath(entity2.getType(), entity2.getId()), "member-1"), shardDataTree);
+        Optional<EntityOwnershipState> state2 = service.getOwnershipState(entity2);
+        assertEquals("getOwnershipState present", false, state2.isPresent());
         service.close();
     }
 
     @Test
     public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
-        final TestShardBuilder shardBuilder = new TestShardBuilder();
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore,
-                EntityOwnerSelectionStrategyConfig.newBuilder().build()) {
-            @Override
-            protected EntityOwnershipShard.Builder newShardBuilder() {
-                return shardBuilder;
-            }
-        };
-
-        service.start();
+        DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
+                EntityOwnerSelectionStrategyConfig.newBuilder().build());
 
         final Entity test = new Entity("test-type", "test");
 
@@ -315,85 +273,45 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         service.close();
     }
 
-    private static void verifyGetOwnershipState(DistributedEntityOwnershipService service, Entity entity,
-            boolean isOwner, boolean hasOwner) {
+    private static void verifyGetOwnershipState(final DistributedEntityOwnershipService service, final Entity entity,
+            final boolean isOwner, final 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) {
+    private void verifyEntityCandidate(final ActorRef entityOwnershipShard, final String entityType,
+            final YangInstanceIdentifier entityId, final String candidateName) {
         verifyEntityCandidate(entityType, entityId, candidateName,
-                new Function<YangInstanceIdentifier, NormalizedNode<?,?>>() {
-                    @Override
-                    public NormalizedNode<?, ?> apply(YangInstanceIdentifier path) {
-                        try {
-                            return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
-                        } catch (Exception e) {
-                            return null;
-                        }
+                path -> {
+                    try {
+                        return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
+                    } catch (Exception e) {
+                        return null;
                     }
                 });
     }
 
-    private static void verifyRegisterCandidateLocal(final TestShardBuilder shardBuilder, Entity entity) {
-        RegisterCandidateLocal regCandidate = shardBuilder.waitForShardMessage();
+    private static void verifyRegisterCandidateLocal(final DistributedEntityOwnershipService service, final Entity entity) {
+        RegisterCandidateLocal regCandidate = verifyMessage(service, RegisterCandidateLocal.class);
         assertEquals("getEntity", entity, regCandidate.getEntity());
     }
 
-    private static void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
+    private static void verifyEntityOwnershipCandidateRegistration(final Entity entity, final EntityOwnershipCandidateRegistration reg) {
         assertNotNull("EntityOwnershipCandidateRegistration null", reg);
         assertEquals("getInstance", entity, reg.getInstance());
     }
 
-    static class TestShardBuilder extends EntityOwnershipShard.Builder {
-        TestShardBuilder() {
-            localMemberName("member-1").ownerSelectionStrategyConfig(
-                    EntityOwnerSelectionStrategyConfig.newBuilder().build());
-        }
-
-        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 props() {
-            verify();
-            return Props.create(TestEntityOwnershipShard.class,this, messageClass, messageReceived,
-                    receivedMessage, dataTree);
-        }
-
-        @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);
-        }
-
-        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(EntityOwnershipShard.Builder builder,
-                AtomicReference<Class<?>> messageClass, AtomicReference<CountDownLatch> messageReceived,
-                AtomicReference<Object> receivedMessage, 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;
@@ -402,12 +320,12 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         }
 
         @Override
-        public void onReceiveCommand(final Object message) throws Exception {
+        public void handleCommand(final Object message) {
             try {
                 if(dataTree.get() != null && message instanceof GetShardDataTree) {
                     sender().tell(dataTree.get(), self());
                 } else {
-                    super.onReceiveCommand(message);
+                    super.handleCommand(message);
                 }
             } finally {
                 Class<?> expMsgClass = messageClass.get();