X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-distributed-datastore%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fdatastore%2Fentityownership%2FAbstractEntityOwnershipTest.java;h=6b148af4fa1195150ce03d6ae42def94e4c46b5e;hp=c6ef27545a3a389af008d9a8ba208cddcb0654b1;hb=20a32e6459fd1e27e7669bf1ebc7742b96787b94;hpb=81cc10db365aa8cde38a3d2777488bb83bd69ef5 diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/AbstractEntityOwnershipTest.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/AbstractEntityOwnershipTest.java index c6ef27545a..6b148af4fa 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/AbstractEntityOwnershipTest.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/AbstractEntityOwnershipTest.java @@ -13,10 +13,37 @@ import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_QNAME; 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_OWNER_QNAME; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME; import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_TYPE_QNAME; -import com.google.common.base.Optional; +import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath; +import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath; + +import akka.pattern.Patterns; +import akka.testkit.TestActorRef; +import akka.util.Timeout; +import com.google.common.base.Function; +import com.google.common.base.Stopwatch; +import com.google.common.util.concurrent.Uninterruptibles; +import java.util.Optional; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.function.Consumer; +import org.hamcrest.Description; +import org.junit.Assert; +import org.mockito.ArgumentMatcher; +import org.mockito.Matchers; +import org.opendaylight.controller.cluster.access.concepts.MemberName; import org.opendaylight.controller.cluster.datastore.AbstractActorTest; +import org.opendaylight.controller.cluster.datastore.AbstractShardTest; +import org.opendaylight.controller.cluster.datastore.ShardDataTree; +import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier; +import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState; +import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState; +import org.opendaylight.mdsal.eos.common.api.EntityOwnershipChangeState; +import org.opendaylight.mdsal.eos.dom.api.DOMEntity; +import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.EntityOwners; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.EntityType; import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.entity.type.entity.Candidate; @@ -31,6 +58,15 @@ import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; import org.opendaylight.yangtools.yang.data.api.schema.MapNode; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification; +import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import scala.concurrent.Await; +import scala.concurrent.Future; +import scala.concurrent.duration.Duration; +import scala.concurrent.duration.FiniteDuration; /** * Abstract base class providing utility methods. @@ -38,8 +74,12 @@ import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; * @author Thomas Pantelis */ public class AbstractEntityOwnershipTest extends AbstractActorTest { - protected void verifyEntityCandidate(NormalizedNode node, String entityType, - YangInstanceIdentifier entityId, String candidateName) { + protected final Logger testLog = LoggerFactory.getLogger(getClass()); + + private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger(); + + protected void verifyEntityCandidate(final NormalizedNode node, final String entityType, + final YangInstanceIdentifier entityId, final String candidateName, final boolean expectPresent) { try { assertNotNull("Missing " + EntityOwners.QNAME.toString(), node); assertTrue(node instanceof ContainerNode); @@ -47,18 +87,43 @@ public class AbstractEntityOwnershipTest extends AbstractActorTest { ContainerNode entityOwnersNode = (ContainerNode) node; MapEntryNode entityTypeEntry = getMapEntryNodeChild(entityOwnersNode, EntityType.QNAME, - ENTITY_TYPE_QNAME, entityType); + ENTITY_TYPE_QNAME, entityType, true); - MapEntryNode entityEntry = getMapEntryNodeChild(entityTypeEntry, ENTITY_QNAME, ENTITY_ID_QNAME, entityId); + MapEntryNode entityEntry = getMapEntryNodeChild(entityTypeEntry, ENTITY_QNAME, ENTITY_ID_QNAME, + entityId, true); - getMapEntryNodeChild(entityEntry, Candidate.QNAME, CANDIDATE_NAME_QNAME, candidateName); - } catch(AssertionError e) { - throw new AssertionError("Verification of enitity candidate failed - returned data was: " + node, e); + getMapEntryNodeChild(entityEntry, Candidate.QNAME, CANDIDATE_NAME_QNAME, candidateName, expectPresent); + } catch (AssertionError e) { + throw new AssertionError("Verification of entity candidate failed - returned data was: " + node, e); } } - protected MapEntryNode getMapEntryNodeChild(DataContainerNode parent, QName childMap, - QName child, Object key) { + protected void verifyEntityCandidate(final String entityType, final YangInstanceIdentifier entityId, + final String candidateName, final Function> reader, + final boolean expectPresent) { + AssertionError lastError = null; + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) { + NormalizedNode node = reader.apply(ENTITY_OWNERS_PATH); + try { + verifyEntityCandidate(node, entityType, entityId, candidateName, expectPresent); + return; + } catch (AssertionError e) { + lastError = e; + Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS); + } + } + + throw lastError; + } + + protected void verifyEntityCandidate(final String entityType, final YangInstanceIdentifier entityId, + final String candidateName, final Function> reader) { + verifyEntityCandidate(entityType, entityId, candidateName, reader, true); + } + + protected MapEntryNode getMapEntryNodeChild(final DataContainerNode parent, + final QName childMap, final QName child, final Object key, final boolean expectPresent) { Optional> childNode = parent.getChild(new NodeIdentifier(childMap)); assertEquals("Missing " + childMap.toString(), true, childNode.isPresent()); @@ -66,9 +131,202 @@ public class AbstractEntityOwnershipTest extends AbstractActorTest { MapNode entityTypeMapNode = (MapNode) childNode.get(); Optional entityTypeEntry = entityTypeMapNode.getChild(new NodeIdentifierWithPredicates( childMap, child, key)); - if(!entityTypeEntry.isPresent()) { + if (expectPresent && !entityTypeEntry.isPresent()) { fail("Missing " + childMap.toString() + " entry for " + key + ". Actual: " + entityTypeMapNode.getValue()); + } else if (!expectPresent && entityTypeEntry.isPresent()) { + fail("Found unexpected " + childMap.toString() + " entry for " + key); + } + + return entityTypeEntry.isPresent() ? entityTypeEntry.get() : null; + } + + static void verifyOwner(final String expected, final String entityType, final YangInstanceIdentifier entityId, + final Function> reader) { + AssertionError lastError = null; + YangInstanceIdentifier entityPath = entityPath(entityType, entityId).node(ENTITY_OWNER_QNAME); + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) { + try { + NormalizedNode node = reader.apply(entityPath); + Assert.assertNotNull("Owner was not set for entityId: " + entityId, node); + Assert.assertEquals("Entity owner", expected, node.getValue().toString()); + return; + } catch (AssertionError e) { + lastError = e; + Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS); + } } - return entityTypeEntry.get(); + + throw lastError; + } + + @SuppressWarnings("checkstyle:IllegalCatch") + static void verifyOwner(final TestActorRef shard, final String entityType, + final YangInstanceIdentifier entityId, final String localMemberName) { + verifyOwner(localMemberName, entityType, entityId, path -> { + try { + return AbstractShardTest.readStore(shard, path); + } catch (Exception e) { + return null; + } + }); + } + + protected void verifyNodeRemoved(final YangInstanceIdentifier path, + final Function> reader) { + AssertionError lastError = null; + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) { + try { + NormalizedNode node = reader.apply(path); + Assert.assertNull("Node was not removed at path: " + path, node); + return; + } catch (AssertionError e) { + lastError = e; + Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS); + } + } + + throw lastError; + } + + static void writeNode(final YangInstanceIdentifier path, final NormalizedNode node, + final ShardDataTree shardDataTree) throws DataValidationFailedException { + DataTreeModification modification = shardDataTree.newModification(); + modification.merge(path, node); + commit(shardDataTree, modification); + } + + static void deleteNode(final YangInstanceIdentifier path, final ShardDataTree shardDataTree) + throws DataValidationFailedException { + DataTreeModification modification = shardDataTree.newModification(); + modification.delete(path); + commit(shardDataTree, modification); + } + + static void commit(final ShardDataTree shardDataTree, final DataTreeModification modification) + throws DataValidationFailedException { + modification.ready(); + shardDataTree.getDataTree().validate(modification); + final DataTreeCandidate candidate = shardDataTree.getDataTree().prepare(modification); + shardDataTree.getDataTree().commit(candidate); + shardDataTree.notifyListeners(candidate); + } + + static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity, final boolean expWasOwner, + final boolean expIsOwner, final boolean expHasOwner) { + return ownershipChange(expEntity, expWasOwner, expIsOwner, expHasOwner, false); + } + + static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity, final boolean expWasOwner, + final boolean expIsOwner, final boolean expHasOwner, final boolean expInJeopardy) { + return Matchers.argThat(new ArgumentMatcher() { + @Override + public boolean matches(final Object argument) { + DOMEntityOwnershipChange change = (DOMEntityOwnershipChange) argument; + return expEntity.equals(change.getEntity()) && expWasOwner == change.getState().wasOwner() + && expIsOwner == change.getState().isOwner() && expHasOwner == change.getState().hasOwner() + && expInJeopardy == change.inJeopardy(); + } + + @Override + public void describeTo(final Description description) { + description.appendValue(new DOMEntityOwnershipChange(expEntity, EntityOwnershipChangeState.from( + expWasOwner, expIsOwner, expHasOwner), expInJeopardy)); + } + }); + } + + static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity) { + return Matchers.argThat(new ArgumentMatcher() { + @Override + public boolean matches(final Object argument) { + DOMEntityOwnershipChange change = (DOMEntityOwnershipChange) argument; + return expEntity.equals(change.getEntity()); + } + + @Override + public void describeTo(final Description description) { + description.appendValue(new DOMEntityOwnershipChange(expEntity, EntityOwnershipChangeState.from( + false, false, false))); + } + }); + } + + @SuppressWarnings("checkstyle:IllegalCatch") + static void verifyNoOwnerSet(final TestActorRef shard, final String entityType, + final YangInstanceIdentifier entityId) { + YangInstanceIdentifier entityPath = entityPath(entityType, entityId).node(ENTITY_OWNER_QNAME); + try { + NormalizedNode node = AbstractShardTest.readStore(shard, entityPath); + if (node != null) { + Assert.fail("Owner " + node.getValue() + " was set for " + entityPath); + } + + } catch (Exception e) { + throw new AssertionError("read failed", e); + } + } + + static void verifyRaftState(final TestActorRef shard, + final Consumer verifier) + throws Exception { + AssertionError lastError = null; + Stopwatch sw = Stopwatch.createStarted(); + while (sw.elapsed(TimeUnit.SECONDS) <= 5) { + FiniteDuration operationDuration = Duration.create(5, TimeUnit.SECONDS); + Future future = Patterns.ask(shard, GetOnDemandRaftState.INSTANCE, new Timeout(operationDuration)); + OnDemandRaftState raftState = (OnDemandRaftState)Await.result(future, operationDuration); + try { + verifier.accept(raftState); + return; + } catch (AssertionError e) { + lastError = e; + Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS); + } + } + + throw lastError; + } + + static ShardIdentifier newShardId(final String memberName) { + return ShardIdentifier.create("entity-ownership", MemberName.forName(memberName), + "operational" + NEXT_SHARD_NUM.getAndIncrement()); + } + + @SuppressWarnings("checkstyle:IllegalCatch") + void verifyEntityCandidateRemoved(final TestActorRef shard, final String entityType, + final YangInstanceIdentifier entityId, final String candidateName) { + verifyNodeRemoved(candidatePath(entityType, entityId, candidateName), path -> { + try { + return AbstractShardTest.readStore(shard, path); + } catch (Exception e) { + throw new AssertionError("Failed to read " + path, e); + } + }); + } + + @SuppressWarnings("checkstyle:IllegalCatch") + void verifyCommittedEntityCandidate(final TestActorRef shard, + final String entityType, final YangInstanceIdentifier entityId, final String candidateName) { + verifyEntityCandidate(entityType, entityId, candidateName, path -> { + try { + return AbstractShardTest.readStore(shard, path); + } catch (Exception e) { + throw new AssertionError("Failed to read " + path, e); + } + }); + } + + @SuppressWarnings("checkstyle:IllegalCatch") + void verifyNoEntityCandidate(final TestActorRef shard, final String entityType, + final YangInstanceIdentifier entityId, final String candidateName) { + verifyEntityCandidate(entityType, entityId, candidateName, path -> { + try { + return AbstractShardTest.readStore(shard, path); + } catch (Exception e) { + throw new AssertionError("Failed to read " + path, e); + } + }, false); } }