2 * Copyright (c) 2015 Brocade Communications Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore.entityownership;
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;
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.Duration;
65 import scala.concurrent.duration.FiniteDuration;
68 * Abstract base class providing utility methods.
70 * @author Thomas Pantelis
72 public class AbstractEntityOwnershipTest extends AbstractActorTest {
73 protected final Logger testLog = LoggerFactory.getLogger(getClass());
75 private static final AtomicInteger NEXT_SHARD_NUM = new AtomicInteger();
77 protected void verifyEntityCandidate(final NormalizedNode<?, ?> node, final String entityType,
78 final YangInstanceIdentifier entityId, final String candidateName, final boolean expectPresent) {
80 assertNotNull("Missing " + EntityOwners.QNAME.toString(), node);
81 assertTrue(node instanceof ContainerNode);
83 ContainerNode entityOwnersNode = (ContainerNode) node;
85 MapEntryNode entityTypeEntry = getMapEntryNodeChild(entityOwnersNode, EntityType.QNAME,
86 ENTITY_TYPE_QNAME, entityType, true);
88 MapEntryNode entityEntry = getMapEntryNodeChild(entityTypeEntry, ENTITY_QNAME, ENTITY_ID_QNAME,
91 getMapEntryNodeChild(entityEntry, Candidate.QNAME, CANDIDATE_NAME_QNAME, candidateName, expectPresent);
92 } catch (AssertionError e) {
93 throw new AssertionError("Verification of entity candidate failed - returned data was: " + node, e);
97 protected void verifyEntityCandidate(final String entityType, final YangInstanceIdentifier entityId,
98 final String candidateName, final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader,
99 final boolean expectPresent) {
100 AssertionError lastError = null;
101 Stopwatch sw = Stopwatch.createStarted();
102 while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
103 NormalizedNode<?, ?> node = reader.apply(ENTITY_OWNERS_PATH);
105 verifyEntityCandidate(node, entityType, entityId, candidateName, expectPresent);
107 } catch (AssertionError e) {
109 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
116 protected void verifyEntityCandidate(final String entityType, final YangInstanceIdentifier entityId,
117 final String candidateName, final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader) {
118 verifyEntityCandidate(entityType, entityId, candidateName, reader, true);
121 protected MapEntryNode getMapEntryNodeChild(final DataContainerNode<? extends PathArgument> parent,
122 final QName childMap, final QName child, final Object key, final boolean expectPresent) {
123 Optional<DataContainerChild<? extends PathArgument, ?>> childNode =
124 parent.getChild(new NodeIdentifier(childMap));
125 // We have to account for empty maps disappearing. If we expect the entry to be non-present, tolerate a missing
127 if (!expectPresent && !childNode.isPresent()) {
131 assertTrue("Missing " + childMap.toString(), childNode.isPresent());
133 MapNode entityTypeMapNode = (MapNode) childNode.get();
134 Optional<MapEntryNode> entityTypeEntry = entityTypeMapNode.getChild(new NodeIdentifierWithPredicates(
135 childMap, child, key));
136 if (expectPresent && !entityTypeEntry.isPresent()) {
137 fail("Missing " + childMap.toString() + " entry for " + key + ". Actual: " + entityTypeMapNode.getValue());
138 } else if (!expectPresent && entityTypeEntry.isPresent()) {
139 fail("Found unexpected " + childMap.toString() + " entry for " + key);
142 return entityTypeEntry.isPresent() ? entityTypeEntry.get() : null;
145 static void verifyOwner(final String expected, final String entityType, final YangInstanceIdentifier entityId,
146 final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader) {
147 AssertionError lastError = null;
148 YangInstanceIdentifier entityPath = entityPath(entityType, entityId).node(ENTITY_OWNER_QNAME);
149 Stopwatch sw = Stopwatch.createStarted();
150 while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
152 NormalizedNode<?, ?> node = reader.apply(entityPath);
153 Assert.assertNotNull("Owner was not set for entityId: " + entityId, node);
154 Assert.assertEquals("Entity owner", expected, node.getValue().toString());
156 } catch (AssertionError e) {
158 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
165 @SuppressWarnings("checkstyle:IllegalCatch")
166 static void verifyOwner(final TestActorRef<? extends EntityOwnershipShard> shard, final String entityType,
167 final YangInstanceIdentifier entityId, final String localMemberName) {
168 verifyOwner(localMemberName, entityType, entityId, path -> {
170 return AbstractShardTest.readStore(shard, path);
171 } catch (Exception e) {
177 protected void verifyNodeRemoved(final YangInstanceIdentifier path,
178 final Function<YangInstanceIdentifier,NormalizedNode<?,?>> reader) {
179 AssertionError lastError = null;
180 Stopwatch sw = Stopwatch.createStarted();
181 while (sw.elapsed(TimeUnit.MILLISECONDS) <= 5000) {
183 NormalizedNode<?, ?> node = reader.apply(path);
184 Assert.assertNull("Node was not removed at path: " + path, node);
186 } catch (AssertionError e) {
188 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
195 static void writeNode(final YangInstanceIdentifier path, final NormalizedNode<?, ?> node,
196 final ShardDataTree shardDataTree) throws DataValidationFailedException {
197 DataTreeModification modification = shardDataTree.newModification();
198 modification.merge(path, node);
199 commit(shardDataTree, modification);
202 static void deleteNode(final YangInstanceIdentifier path, final ShardDataTree shardDataTree)
203 throws DataValidationFailedException {
204 DataTreeModification modification = shardDataTree.newModification();
205 modification.delete(path);
206 commit(shardDataTree, modification);
209 static void commit(final ShardDataTree shardDataTree, final DataTreeModification modification)
210 throws DataValidationFailedException {
211 modification.ready();
212 shardDataTree.getDataTree().validate(modification);
213 final DataTreeCandidate candidate = shardDataTree.getDataTree().prepare(modification);
214 shardDataTree.getDataTree().commit(candidate);
215 shardDataTree.notifyListeners(candidate);
218 static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity, final boolean expWasOwner,
219 final boolean expIsOwner, final boolean expHasOwner) {
220 return ownershipChange(expEntity, expWasOwner, expIsOwner, expHasOwner, false);
223 static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity, final boolean expWasOwner,
224 final boolean expIsOwner, final boolean expHasOwner, final boolean expInJeopardy) {
225 return argThat(change -> expEntity.equals(change.getEntity()) && expWasOwner == change.getState().wasOwner()
226 && expIsOwner == change.getState().isOwner() && expHasOwner == change.getState().hasOwner()
227 && expInJeopardy == change.inJeopardy());
230 static DOMEntityOwnershipChange ownershipChange(final DOMEntity expEntity) {
231 return argThat(change -> expEntity.equals(change.getEntity()));
234 @SuppressWarnings("checkstyle:IllegalCatch")
235 static void verifyNoOwnerSet(final TestActorRef<? extends EntityOwnershipShard> shard, final String entityType,
236 final YangInstanceIdentifier entityId) {
237 YangInstanceIdentifier entityPath = entityPath(entityType, entityId).node(ENTITY_OWNER_QNAME);
239 NormalizedNode<?, ?> node = AbstractShardTest.readStore(shard, entityPath);
241 Assert.fail("Owner " + node.getValue() + " was set for " + entityPath);
244 } catch (Exception e) {
245 throw new AssertionError("read failed", e);
249 static void verifyRaftState(final TestActorRef<? extends EntityOwnershipShard> shard,
250 final Consumer<OnDemandRaftState> verifier)
252 AssertionError lastError = null;
253 Stopwatch sw = Stopwatch.createStarted();
254 while (sw.elapsed(TimeUnit.SECONDS) <= 5) {
255 FiniteDuration operationDuration = Duration.create(5, TimeUnit.SECONDS);
256 Future<Object> future = Patterns.ask(shard, GetOnDemandRaftState.INSTANCE, new Timeout(operationDuration));
257 OnDemandRaftState raftState = (OnDemandRaftState)Await.result(future, operationDuration);
259 verifier.accept(raftState);
261 } catch (AssertionError e) {
263 Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
270 static ShardIdentifier newShardId(final String memberName) {
271 return ShardIdentifier.create("entity-ownership", MemberName.forName(memberName),
272 "operational" + NEXT_SHARD_NUM.getAndIncrement());
275 @SuppressWarnings("checkstyle:IllegalCatch")
276 void verifyEntityCandidateRemoved(final TestActorRef<EntityOwnershipShard> shard, final String entityType,
277 final YangInstanceIdentifier entityId, final String candidateName) {
278 verifyNodeRemoved(candidatePath(entityType, entityId, candidateName), path -> {
280 return AbstractShardTest.readStore(shard, path);
281 } catch (Exception e) {
282 throw new AssertionError("Failed to read " + path, e);
287 @SuppressWarnings("checkstyle:IllegalCatch")
288 void verifyCommittedEntityCandidate(final TestActorRef<? extends EntityOwnershipShard> shard,
289 final String entityType, final YangInstanceIdentifier entityId, final String candidateName) {
290 verifyEntityCandidate(entityType, entityId, candidateName, path -> {
292 return AbstractShardTest.readStore(shard, path);
293 } catch (Exception e) {
294 throw new AssertionError("Failed to read " + path, e);
299 @SuppressWarnings("checkstyle:IllegalCatch")
300 void verifyNoEntityCandidate(final TestActorRef<? extends EntityOwnershipShard> shard, final String entityType,
301 final YangInstanceIdentifier entityId, final String candidateName) {
302 verifyEntityCandidate(entityType, entityId, candidateName, path -> {
304 return AbstractShardTest.readStore(shard, path);
305 } catch (Exception e) {
306 throw new AssertionError("Failed to read " + path, e);