opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/entityownership/AbstractEntityOwnershipTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.cluster.datastore.entityownership;
   9
  10 import static org.junit.Assert.assertNotNull;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.junit.Assert.fail;
  13 import static org.mockito.ArgumentMatchers.argThat;
  14 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.CANDIDATE_NAME_QNAME;
  15 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_ID_QNAME;
  16 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNERS_PATH;
  17 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_OWNER_QNAME;
  18 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_QNAME;
  19 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.ENTITY_TYPE_QNAME;
  20 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.candidatePath;
  21 import static org.opendaylight.controller.cluster.datastore.entityownership.EntityOwnersModel.entityPath;
  22
  23 import akka.pattern.Patterns;
  24 import akka.testkit.TestActorRef;
  25 import akka.util.Timeout;
  26 import com.google.common.base.Function;
  27 import com.google.common.base.Stopwatch;
  28 import com.google.common.util.concurrent.Uninterruptibles;
  29 import java.util.Optional;
  30 import java.util.concurrent.TimeUnit;
  31 import java.util.concurrent.atomic.AtomicInteger;
  32 import java.util.function.Consumer;
  33 import org.junit.Assert;
  34 import org.opendaylight.controller.cluster.access.concepts.MemberName;
  35 import org.opendaylight.controller.cluster.datastore.AbstractActorTest;
  36 import org.opendaylight.controller.cluster.datastore.AbstractShardTest;
  37 import org.opendaylight.controller.cluster.datastore.ShardDataTree;
  38 import org.opendaylight.controller.cluster.datastore.identifiers.ShardIdentifier;
  39 import org.opendaylight.controller.cluster.raft.client.messages.GetOnDemandRaftState;
  40 import org.opendaylight.controller.cluster.raft.client.messages.OnDemandRaftState;
  41 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
  42 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.EntityOwners;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.entity.owners.rev150804.entity.owners.EntityType;
  45 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;
  46 import org.opendaylight.yangtools.yang.common.QName;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  53 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  58 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  59 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  60 import org.slf4j.Logger;
  61 import org.slf4j.LoggerFactory;
  62 import scala.concurrent.Await;
  63 import scala.concurrent.Future;
  64 import scala.concurrent.duration.FiniteDuration;
  65
  66 /**
  67  * Abstract base class providing utility methods.
  68  *
  69  * @author Thomas Pantelis
  70  */
  71 public class AbstractEntityOwnershipTest extends AbstractActorTest {
  72     protected final Logger testLog = LoggerFactory.getLogger(getClass());
  73
  74     private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger();
  75
  76     protected void verifyEntityCandidate(final NormalizedNode<?, ?> node, final String entityType,
  77             final YangInstanceIdentifier entityId, final String candidateName, final boolean expectPresent) {
  78         try {
  79             assertNotNull("Missing " + EntityOwners.QNAME.toString(), node);
  80             assertTrue(node instanceof ContainerNode);
  81
  82             ContainerNode entityOwnersNode = (ContainerNode) node;
  83
  84             MapEntryNode entityTypeEntry = getMapEntryNodeChild(entityOwnersNode, EntityType.QNAME,
  85                     ENTITY_TYPE_QNAME, entityType, true);
  86
  87             MapEntryNode entityEntry = getMapEntryNodeChild(entityTypeEntry, ENTITY_QNAME, ENTITY_ID_QNAME,
  88                     entityId, true);
  89
  90             getMapEntryNodeChild(entityEntry, Candidate.QNAME, CANDIDATE_NAME_QNAME, candidateName, expectPresent);
  91         } catch (AssertionError e) {
  92             throw new AssertionError("Verification of entity candidate failed - returned data was: " + node, e);
  93         }
  94     }
  95
  96     protected void verifyEntityCandidate(final String entityType, final YangInstanceIdentifier entityId,
  97             final String candidateName, final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader,
  98             final boolean expectPresent) {
  99         AssertionError lastError = null;
 100         Stopwatch sw = Stopwatch.createStarted();
 101         while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
 102             NormalizedNode<?, ?> node = reader.apply(ENTITY_OWNERS_PATH);
 103             try {
 104                 verifyEntityCandidate(node, entityType, entityId, candidateName, expectPresent);
 105                 return;
 106             } catch (AssertionError e) {
 107                 lastError = e;
 108                 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 109             }
 110         }
 111
 112         throw lastError;
 113     }
 114
 115     protected void verifyEntityCandidate(final String entityType, final YangInstanceIdentifier entityId,
 116             final String candidateName, final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader) {
 117         verifyEntityCandidate(entityType, entityId, candidateName, reader, true);
 118     }
 119
 120     protected MapEntryNode getMapEntryNodeChild(final DataContainerNode<? extends PathArgument> parent,
 121             final QName childMap, final QName child, final Object key, final boolean expectPresent) {
 122         Optional<DataContainerChild<? extends PathArgument, ?>> childNode =
 123                 parent.getChild(new NodeIdentifier(childMap));
 124         // We have to account for empty maps disappearing. If we expect the entry to be non-present, tolerate a missing
 125         // map.
 126         if (!expectPresent && !childNode.isPresent()) {
 127             return null;
 128         }
 129
 130         assertTrue("Missing " + childMap.toString(), childNode.isPresent());
 131
 132         MapNode entityTypeMapNode = (MapNode) childNode.get();
 133         Optional<MapEntryNode> entityTypeEntry = entityTypeMapNode.getChild(new NodeIdentifierWithPredicates(
 134                 childMap, child, key));
 135         if (expectPresent && !entityTypeEntry.isPresent()) {
 136             fail("Missing " + childMap.toString() + " entry for " + key + ". Actual: " + entityTypeMapNode.getValue());
 137         } else if (!expectPresent && entityTypeEntry.isPresent()) {
 138             fail("Found unexpected " + childMap.toString() + " entry for " + key);
 139         }
 140
 141         return entityTypeEntry.isPresent() ? entityTypeEntry.get() : null;
 142     }
 143
 144     static void verifyOwner(final String expected, final String entityType, final YangInstanceIdentifier entityId,
 145             final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader) {
 146         AssertionError lastError = null;
 147         YangInstanceIdentifier entityPath = entityPath(entityType, entityId).node(ENTITY_OWNER_QNAME);
 148         Stopwatch sw = Stopwatch.createStarted();
 149         while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
 150             try {
 151                 NormalizedNode<?, ?> node = reader.apply(entityPath);
 152                 Assert.assertNotNull("Owner was not set for entityId: " + entityId, node);
 153                 Assert.assertEquals("Entity owner", expected, node.getValue().toString());
 154                 return;
 155             } catch (AssertionError e) {
 156                 lastError = e;
 157                 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 158             }
 159         }
 160
 161         throw lastError;
 162     }
 163
 164     @SuppressWarnings("checkstyle:IllegalCatch")
 165     static void verifyOwner(final TestActorRef<? extends EntityOwnershipShard> shard, final String entityType,
 166             final YangInstanceIdentifier entityId, final String localMemberName) {
 167         verifyOwner(localMemberName, entityType, entityId, path -> {
 168             try {
 169                 return AbstractShardTest.readStore(shard, path);
 170             } catch (Exception e) {
 171                 return null;
 172             }
 173         });
 174     }
 175
 176     protected void verifyNodeRemoved(final YangInstanceIdentifier path,
 177             final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader) {
 178         AssertionError lastError = null;
 179         Stopwatch sw = Stopwatch.createStarted();
 180         while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
 181             try {
 182                 NormalizedNode<?, ?> node = reader.apply(path);
 183                 Assert.assertNull("Node was not removed at path: " + path, node);
 184                 return;
 185             } catch (AssertionError e) {
 186                 lastError = e;
 187                 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
 188             }
 189         }
 190
 191         throw lastError;
 192     }
 193
 194     static void writeNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> node,
 195             final ShardDataTree shardDataTree) throws DataValidationFailedException {
 196         DataTreeModification modification = shardDataTree.newModification();
 197         modification.merge(path, node);
 198         commit(shardDataTree, modification);
 199     }
 200
 201     static void deleteNode(final YangInstanceIdentifier path, final ShardDataTree shardDataTree)
 202             throws DataValidationFailedException {
 203         DataTreeModification modification = shardDataTree.newModification();
 204         modification.delete(path);
 205         commit(shardDataTree, modification);
 206     }
 207
 208     static void commit(final ShardDataTree shardDataTree, final DataTreeModification modification)
 209             throws DataValidationFailedException {
 210         modification.ready();
 211         shardDataTree.getDataTree().validate(modification);
 212         final DataTreeCandidate candidate = shardDataTree.getDataTree().prepare(modification);
 213         shardDataTree.getDataTree().commit(candidate);
 214         shardDataTree.notifyListeners(candidate);
 215     }
 216
 217     static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity, final boolean expWasOwner,
 218             final boolean expIsOwner, final boolean expHasOwner) {
 219         return ownershipChange(expEntity, expWasOwner, expIsOwner, expHasOwner, false);
 220     }
 221
 222     static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity, final boolean expWasOwner,
 223             final boolean expIsOwner, final boolean expHasOwner, final boolean expInJeopardy) {
 224         return argThat(change -> expEntity.equals(change.getEntity()) && expWasOwner == change.getState().wasOwner()
 225                 && expIsOwner == change.getState().isOwner() && expHasOwner == change.getState().hasOwner()
 226                 && expInJeopardy == change.inJeopardy());
 227     }
 228
 229     static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity) {
 230         return argThat(change -> expEntity.equals(change.getEntity()));
 231     }
 232
 233     @SuppressWarnings("checkstyle:IllegalCatch")
 234     static void verifyNoOwnerSet(final TestActorRef<? extends EntityOwnershipShard> shard, final String entityType,
 235             final YangInstanceIdentifier entityId) {
 236         YangInstanceIdentifier entityPath = entityPath(entityType, entityId).node(ENTITY_OWNER_QNAME);
 237         try {
 238             NormalizedNode<?, ?> node = AbstractShardTest.readStore(shard, entityPath);
 239             if (node != null) {
 240                 Assert.fail("Owner " + node.getValue() + " was set for " + entityPath);
 241             }
 242
 243         } catch (Exception e) {
 244             throw new AssertionError("read failed", e);
 245         }
 246     }
 247
 248     static void verifyRaftState(final TestActorRef<? extends EntityOwnershipShard> shard,
 249             final Consumer<OnDemandRaftState> verifier)
 250             throws Exception {
 251         AssertionError lastError = null;
 252         Stopwatch sw = Stopwatch.createStarted();
 253         while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
 254             FiniteDuration operationDuration = FiniteDuration.create(5, TimeUnit.SECONDS);
 255             Future<Object> future = Patterns.ask(shard, GetOnDemandRaftState.INSTANCE, new Timeout(operationDuration));
 256             OnDemandRaftState raftState = (OnDemandRaftState)Await.result(future, operationDuration);
 257             try {
 258                 verifier.accept(raftState);
 259                 return;
 260             } catch (AssertionError e) {
 261                 lastError = e;
 262                 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
 263             }
 264         }
 265
 266         throw lastError;
 267     }
 268
 269     static ShardIdentifier newShardId(final String memberName) {
 270         return ShardIdentifier.create("entity-ownership", MemberName.forName(memberName),
 271             "operational" + NEXT_SHARD_NUM.getAndIncrement());
 272     }
 273
 274     @SuppressWarnings("checkstyle:IllegalCatch")
 275     void verifyEntityCandidateRemoved(final TestActorRef<EntityOwnershipShard> shard, final String entityType,
 276             final YangInstanceIdentifier entityId, final String candidateName) {
 277         verifyNodeRemoved(candidatePath(entityType, entityId, candidateName), path -> {
 278             try {
 279                 return AbstractShardTest.readStore(shard, path);
 280             } catch (Exception e) {
 281                 throw new AssertionError("Failed to read " + path, e);
 282             }
 283         });
 284     }
 285
 286     @SuppressWarnings("checkstyle:IllegalCatch")
 287     void verifyCommittedEntityCandidate(final TestActorRef<? extends EntityOwnershipShard> shard,
 288             final String entityType, final YangInstanceIdentifier entityId, final String candidateName) {
 289         verifyEntityCandidate(entityType, entityId, candidateName, path -> {
 290             try {
 291                 return AbstractShardTest.readStore(shard, path);
 292             } catch (Exception e) {
 293                 throw new AssertionError("Failed to read " + path, e);
 294             }
 295         });
 296     }
 297
 298     @SuppressWarnings("checkstyle:IllegalCatch")
 299     void verifyNoEntityCandidate(final TestActorRef<? extends EntityOwnershipShard> shard, final String entityType,
 300             final YangInstanceIdentifier entityId, final String candidateName) {
 301         verifyEntityCandidate(entityType, entityId, candidateName, path -> {
 302             try {
 303                 return AbstractShardTest.readStore(shard, path);
 304             } catch (Exception e) {
 305                 throw new AssertionError("Failed to read " + path, e);
 306             }
 307         }, false);
 308     }
 309 }