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 c1c16a98b9b8bac2a965c1038ce0a59f8199b15f..52adc5af42c3fa3d0911055cf2d69b24f3df8d2a 100644 (file)
@@ -8,46 +8,61 @@
 package org.opendaylight.controller.cluster.datastore.entityownership;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 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 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.util.concurrent.Uninterruptibles;
-import java.util.Collections;
-import java.util.Map;
-import java.util.concurrent.CountDownLatch;
+import com.google.common.base.Optional;
+import com.google.common.collect.Sets;
+import java.util.Collection;
 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;
-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;
 import org.opendaylight.controller.cluster.datastore.entityownership.messages.UnregisterListenerLocal;
-import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
+import org.opendaylight.controller.cluster.datastore.entityownership.selectionstrategy.EntityOwnerSelectionStrategyConfig;
 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.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.NormalizedNode;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+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;
 import scala.concurrent.duration.Duration;
@@ -58,40 +73,50 @@ 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<MemberName> getUniqueMemberNamesForAllShards() {
+                return Sets.newHashSet(MemberName.forName("member-1"));
             }
-        });
+        };
+
+        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, datastoreContext );
+        dataStore = new DistributedDataStore(getSystem(), new MockClusterWrapper(), configuration, mockContextFactory, null);
 
         dataStore.onGlobalContextUpdated(SchemaContextHelper.entityOwners());
     }
 
     @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) {
+        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);
-        service.start();
+        DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
+                EntityOwnerSelectionStrategyConfig.newBuilder().build());
 
         Future<ActorRef> future = dataStore.getActorContext().findLocalShardAsync(
                 DistributedEntityOwnershipService.ENTITY_OWNERSHIP_SHARD_NAME);
@@ -103,27 +128,17 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
 
     @Test
     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);
+        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);
+        DOMEntity entity = new DOMEntity(ENTITY_TYPE, entityId);
 
+        DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
+        verifyRegisterCandidateLocal(service, entity);
         verifyEntityOwnershipCandidateRegistration(entity, reg);
-        verifyRegisterCandidateLocal(shardPropsCreator, entity);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE, entityId,
-                dataStore.getActorContext().getCurrentMemberName());
+                dataStore.getActorContext().getCurrentMemberName().getName());
 
         // Register the same entity - should throw exception
 
@@ -136,180 +151,157 @@ public class DistributedEntityOwnershipServiceTest extends AbstractEntityOwnersh
         }
 
         // Register a different entity - should succeed
+        reset(service);
 
-        Entity entity2 = new Entity(ENTITY_TYPE2, entityId);
-        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
-
-        EntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
+        DOMEntity entity2 = new DOMEntity(ENTITY_TYPE2, entityId);
+        DOMEntityOwnershipCandidateRegistration reg2 = service.registerCandidate(entity2);
 
         verifyEntityOwnershipCandidateRegistration(entity2, reg2);
-        verifyRegisterCandidateLocal(shardPropsCreator, entity2);
         verifyEntityCandidate(service.getLocalEntityOwnershipShard(), ENTITY_TYPE2, entityId,
-                dataStore.getActorContext().getCurrentMemberName());
+                dataStore.getActorContext().getCurrentMemberName().getName());
 
         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();
+        DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
+            dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
 
-        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
+        DOMEntity entity = new DOMEntity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
 
-        Entity entity = new Entity(ENTITY_TYPE, YangInstanceIdentifier.of(QNAME));
-
-        EntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
+        DOMEntityOwnershipCandidateRegistration reg = service.registerCandidate(entity);
 
         verifyEntityOwnershipCandidateRegistration(entity, reg);
-        verifyRegisterCandidateLocal(shardPropsCreator, entity);
-
-        shardPropsCreator.expectShardMessage(UnregisterCandidateLocal.class);
+        verifyRegisterCandidateLocal(service, entity);
 
+        reset(service);
         reg.close();
-
-        UnregisterCandidateLocal unregCandidate = shardPropsCreator.waitForShardMessage();
+        UnregisterCandidateLocal unregCandidate = verifyMessage(service, UnregisterCandidateLocal.class);
         assertEquals("getEntity", entity, unregCandidate.getEntity());
 
         // Re-register - should succeed.
-
-        shardPropsCreator.expectShardMessage(RegisterCandidateLocal.class);
-
+        reset(service);
         service.registerCandidate(entity);
-
-        verifyRegisterCandidateLocal(shardPropsCreator, entity);
+        verifyRegisterCandidateLocal(service, entity);
 
         service.close();
     }
 
     @Test
     public void testListenerRegistration() {
-        final TestShardPropsCreator shardPropsCreator = new TestShardPropsCreator();
-        DistributedEntityOwnershipService service = new DistributedEntityOwnershipService(dataStore) {
-            @Override
-            protected EntityOwnershipShardPropsCreator newShardPropsCreator() {
-                return shardPropsCreator;
-            }
-        };
-
-        service.start();
-
-        shardPropsCreator.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);
-        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());
         assertEquals("getInstance", listener, reg.getInstance());
 
-        RegisterListenerLocal regListener = shardPropsCreator.waitForShardMessage();
+        RegisterListenerLocal regListener = verifyMessage(service, RegisterListenerLocal.class);
         assertSame("getListener", listener, regListener.getListener());
         assertEquals("getEntityType", entity.getType(), regListener.getEntityType());
 
-        shardPropsCreator.expectShardMessage(UnregisterListenerLocal.class);
-
+        reset(service);
         reg.close();
-
-        UnregisterListenerLocal unregListener = shardPropsCreator.waitForShardMessage();
+        UnregisterListenerLocal unregListener = verifyMessage(service, UnregisterListenerLocal.class);
         assertEquals("getEntityType", entity.getType(), unregListener.getEntityType());
         assertSame("getListener", listener, unregListener.getListener());
 
         service.close();
     }
 
-    private void verifyEntityCandidate(ActorRef entityOwnershipShard, String entityType,
-            YangInstanceIdentifier entityId, 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;
-                        }
-                    }
-                });
+    @Test
+    public void testGetOwnershipState() throws Exception {
+        DistributedEntityOwnershipService service = spy(DistributedEntityOwnershipService.start(
+            dataStore.getActorContext(), EntityOwnerSelectionStrategyConfig.newBuilder().build()));
+
+        final Shard mockShard = Mockito.mock(Shard.class);
+        ShardDataTree shardDataTree = new ShardDataTree(mockShard, SchemaContextHelper.entityOwners(),
+            TreeType.OPERATIONAL);
+
+        when(service.getLocalEntityOwnershipShardDataTree()).thenReturn(shardDataTree.getDataTree());
+
+        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.getIdentifier(), "member-1"))), shardDataTree);
+        verifyGetOwnershipState(service, entity1, EntityOwnershipState.IS_OWNER);
+
+        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.getIdentifier()), entityEntryWithOwner(entity1.getIdentifier(), ""),
+                shardDataTree);
+        verifyGetOwnershipState(service, entity1, EntityOwnershipState.NO_OWNER);
+
+        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.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.getIdentifier()), "member-1"), shardDataTree);
+        Optional<EntityOwnershipState> state2 = service.getOwnershipState(entity2);
+        assertEquals("getOwnershipState present", false, state2.isPresent());
+        service.close();
     }
 
-    private void verifyRegisterCandidateLocal(final TestShardPropsCreator shardPropsCreator, Entity entity) {
-        RegisterCandidateLocal regCandidate = shardPropsCreator.waitForShardMessage();
-        assertEquals("getEntity", entity, regCandidate.getEntity());
-    }
+    @Test
+    public void testIsCandidateRegistered() throws CandidateAlreadyRegisteredException {
+        DistributedEntityOwnershipService service = DistributedEntityOwnershipService.start(dataStore.getActorContext(),
+                EntityOwnerSelectionStrategyConfig.newBuilder().build());
 
-    private void verifyEntityOwnershipCandidateRegistration(Entity entity, EntityOwnershipCandidateRegistration reg) {
-        assertNotNull("EntityOwnershipCandidateRegistration null", reg);
-        assertEquals("getInstance", entity, reg.getInstance());
-    }
+        final DOMEntity test = new DOMEntity("test-type", "test");
 
-    static class TestShardPropsCreator extends EntityOwnershipShardPropsCreator {
-        TestShardPropsCreator() {
-            super("member-1");
-        }
+        assertFalse(service.isCandidateRegistered(test));
 
-        private final AtomicReference<CountDownLatch> messageReceived = new AtomicReference<>();
-        private final AtomicReference<Object> receivedMessage = new AtomicReference<>();
-        private final AtomicReference<Class<?>> messageClass = new AtomicReference<>();
+        service.registerCandidate(test);
 
-        @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);
-        }
+        assertTrue(service.isCandidateRegistered(test));
 
-        @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();
-        }
+        service.close();
+    }
 
-        void expectShardMessage(Class<?> ofType) {
-            messageReceived.set(new CountDownLatch(1));
-            receivedMessage.set(null);
-            messageClass.set(ofType);
-        }
+    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("EntityOwnershipState", expState, state.get());
     }
 
-    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;
-        }
+    private void verifyEntityCandidate(final ActorRef entityOwnershipShard, final String entityType,
+            final YangInstanceIdentifier entityId, final String candidateName) {
+        verifyEntityCandidate(entityType, entityId, candidateName,
+                path -> {
+                    try {
+                        return dataStore.newReadOnlyTransaction().read(path).get(5, TimeUnit.SECONDS).get();
+                    } catch (Exception e) {
+                        return null;
+                    }
+                });
+    }
 
-        @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();
-                }
-            }
-        }
+    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 DOMEntity entity,
+            final DOMEntityOwnershipCandidateRegistration reg) {
+        assertNotNull("EntityOwnershipCandidateRegistration null", reg);
+        assertEquals("getInstance", entity, reg.getInstance());
     }
 }