2 * Copyright (c) 2015 Cisco 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.yangtools.yang.data.impl.leafref;
10 import com.google.common.collect.Iterables;
11 import java.util.ArrayList;
12 import java.util.Collection;
13 import java.util.HashMap;
14 import java.util.HashSet;
15 import java.util.Iterator;
16 import java.util.List;
18 import java.util.Map.Entry;
19 import java.util.Optional;
21 import org.opendaylight.yangtools.yang.common.QName;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
25 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
28 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
35 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
38 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.tree.ModificationType;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
43 public final class LeafRefValidatation {
45 private static final Logger LOG = LoggerFactory.getLogger(LeafRefValidatation.class);
46 private static final String FAILED = " -> FAILED";
47 private static final String SUCCESS = " -> OK";
49 private final Set<LeafRefContext> validatedLeafRefCtx = new HashSet<>();
50 private final List<String> errorsMessages = new ArrayList<>();
51 private final DataTreeCandidate tree;
53 private LeafRefValidatation(final DataTreeCandidate tree) {
57 public static void validate(final DataTreeCandidate tree, final LeafRefContext rootLeafRefCtx)
58 throws LeafRefDataValidationFailedException {
59 new LeafRefValidatation(tree).validate0(rootLeafRefCtx);
62 private void validate0(final LeafRefContext rootLeafRefCtx) throws LeafRefDataValidationFailedException {
63 for (final DataTreeCandidateNode dataTreeCandidateNode : tree.getRootNode().getChildNodes()) {
64 if (dataTreeCandidateNode.getModificationType() != ModificationType.UNMODIFIED) {
65 final PathArgument identifier = dataTreeCandidateNode.getIdentifier();
66 final QName childQName = identifier.getNodeType();
68 final LeafRefContext referencedByCtx = rootLeafRefCtx.getReferencedChildByName(childQName);
69 final LeafRefContext referencingCtx = rootLeafRefCtx.getReferencingChildByName(childQName);
70 if (referencedByCtx != null || referencingCtx != null) {
71 final YangInstanceIdentifier yangInstanceIdentifier = YangInstanceIdentifier
72 .create(dataTreeCandidateNode.getIdentifier());
73 validateNode(dataTreeCandidateNode, referencedByCtx, referencingCtx, yangInstanceIdentifier);
78 if (!errorsMessages.isEmpty()) {
79 final StringBuilder message = new StringBuilder();
81 for (final String errorMessage : errorsMessages) {
82 message.append(errorMessage);
85 throw new LeafRefDataValidationFailedException(message.toString(), errCount);
89 private void validateNode(final DataTreeCandidateNode node, final LeafRefContext referencedByCtx,
90 final LeafRefContext referencingCtx, final YangInstanceIdentifier current) {
92 if (node.getModificationType() == ModificationType.WRITE && node.getDataAfter().isPresent()) {
93 final Optional<NormalizedNode<?, ?>> dataAfter = node.getDataAfter();
94 final NormalizedNode<?, ?> normalizedNode = dataAfter.get();
95 validateNodeData(normalizedNode, referencedByCtx, referencingCtx,
96 node.getModificationType(), current);
100 if (node.getModificationType() == ModificationType.DELETE && referencedByCtx != null) {
101 final Optional<NormalizedNode<?, ?>> dataBefor = node.getDataBefore();
102 final NormalizedNode<?, ?> normalizedNode = dataBefor.get();
103 validateNodeData(normalizedNode, referencedByCtx, null,
104 node.getModificationType(), current);
108 final Collection<DataTreeCandidateNode> childNodes = node.getChildNodes();
109 for (final DataTreeCandidateNode childNode : childNodes) {
110 if (childNode.getModificationType() != ModificationType.UNMODIFIED) {
111 final LeafRefContext childReferencedByCtx = getReferencedByCtxChild(referencedByCtx, childNode);
112 final LeafRefContext childReferencingCtx = getReferencingCtxChild(referencingCtx, childNode);
114 if (childReferencedByCtx != null || childReferencingCtx != null) {
115 final YangInstanceIdentifier childYangInstanceIdentifier = current.node(childNode.getIdentifier());
116 validateNode(childNode, childReferencedByCtx,childReferencingCtx, childYangInstanceIdentifier);
122 private static LeafRefContext getReferencingCtxChild(final LeafRefContext referencingCtx,
123 final DataTreeCandidateNode childNode) {
124 if (referencingCtx == null) {
128 final QName childQName = childNode.getIdentifier().getNodeType();
129 LeafRefContext childReferencingCtx = referencingCtx.getReferencingChildByName(childQName);
130 if (childReferencingCtx == null) {
131 final NormalizedNode<?, ?> data = childNode.getDataAfter().get();
132 if (data instanceof MapEntryNode || data instanceof UnkeyedListEntryNode) {
133 childReferencingCtx = referencingCtx;
137 return childReferencingCtx;
140 private static LeafRefContext getReferencedByCtxChild(final LeafRefContext referencedByCtx,
141 final DataTreeCandidateNode childNode) {
142 if (referencedByCtx == null) {
146 final QName childQName = childNode.getIdentifier().getNodeType();
147 LeafRefContext childReferencedByCtx = referencedByCtx.getReferencedChildByName(childQName);
148 if (childReferencedByCtx == null) {
149 final NormalizedNode<?, ?> data = childNode.getDataAfter().get();
150 if (data instanceof MapEntryNode || data instanceof UnkeyedListEntryNode) {
151 childReferencedByCtx = referencedByCtx;
155 return childReferencedByCtx;
158 private void validateNodeData(final NormalizedNode<?, ?> node, final LeafRefContext referencedByCtx,
159 final LeafRefContext referencingCtx, final ModificationType modificationType,
160 final YangInstanceIdentifier current) {
162 if (node instanceof LeafNode) {
163 final LeafNode<?> leaf = (LeafNode<?>) node;
165 if (referencedByCtx != null && referencedByCtx.isReferenced()) {
166 validateLeafRefTargetNodeData(leaf, referencedByCtx, modificationType);
168 if (referencingCtx != null && referencingCtx.isReferencing()) {
169 validateLeafRefNodeData(leaf, referencingCtx, modificationType, current);
175 if (node instanceof LeafSetNode) {
176 if (referencedByCtx == null && referencingCtx == null) {
180 final LeafSetNode<?> leafSet = (LeafSetNode<?>) node;
181 for (final NormalizedNode<?, ?> leafSetEntry : leafSet.getValue()) {
182 if (referencedByCtx != null && referencedByCtx.isReferenced()) {
183 validateLeafRefTargetNodeData(leafSetEntry, referencedByCtx, modificationType);
185 if (referencingCtx != null && referencingCtx.isReferencing()) {
186 validateLeafRefNodeData(leafSetEntry, referencingCtx, modificationType, current);
193 if (node instanceof ChoiceNode) {
194 final ChoiceNode choice = (ChoiceNode) node;
195 for (final DataContainerChild<? extends PathArgument, ?> dataContainerChild : choice.getValue()) {
196 final QName qname = dataContainerChild.getNodeType();
198 final LeafRefContext childReferencedByCtx;
199 if (referencedByCtx != null) {
200 childReferencedByCtx = findReferencedByCtxUnderChoice(referencedByCtx, qname);
202 childReferencedByCtx = null;
205 final LeafRefContext childReferencingCtx;
206 if (referencingCtx != null) {
207 childReferencingCtx = findReferencingCtxUnderChoice(referencingCtx, qname);
209 childReferencingCtx = null;
212 if (childReferencedByCtx != null || childReferencingCtx != null) {
213 final YangInstanceIdentifier childYangInstanceIdentifier = current
214 .node(dataContainerChild.getIdentifier());
215 validateNodeData(dataContainerChild, childReferencedByCtx,
216 childReferencingCtx, modificationType, childYangInstanceIdentifier);
219 } else if (node instanceof DataContainerNode) {
220 final DataContainerNode<?> dataContainerNode = (DataContainerNode<?>) node;
222 for (final DataContainerChild<? extends PathArgument, ?> child : dataContainerNode.getValue()) {
223 if (child instanceof AugmentationNode) {
224 validateNodeData(child, referencedByCtx, referencingCtx, modificationType, current
225 .node(child.getIdentifier()));
229 final QName qname = child.getNodeType();
230 final LeafRefContext childReferencedByCtx;
231 if (referencedByCtx != null) {
232 childReferencedByCtx = referencedByCtx.getReferencedChildByName(qname);
234 childReferencedByCtx = null;
237 final LeafRefContext childReferencingCtx;
238 if (referencingCtx != null) {
239 childReferencingCtx = referencingCtx.getReferencingChildByName(qname);
241 childReferencingCtx = null;
244 if (childReferencedByCtx != null || childReferencingCtx != null) {
245 final YangInstanceIdentifier childYangInstanceIdentifier = current
246 .node(child.getIdentifier());
247 validateNodeData(child, childReferencedByCtx,
248 childReferencingCtx, modificationType, childYangInstanceIdentifier);
251 } else if (node instanceof MapNode) {
252 final MapNode map = (MapNode) node;
254 for (final MapEntryNode mapEntry : map.getValue()) {
255 final YangInstanceIdentifier mapEntryYangInstanceIdentifier = current.node(mapEntry.getIdentifier());
256 for (final DataContainerChild<? extends PathArgument, ?> mapEntryNode : mapEntry.getValue()) {
257 if (mapEntryNode instanceof AugmentationNode) {
258 validateNodeData(mapEntryNode, referencedByCtx, referencingCtx, modificationType, current
259 .node(mapEntryNode.getIdentifier()));
263 final QName qname = mapEntryNode.getNodeType();
264 final LeafRefContext childReferencedByCtx;
265 if (referencedByCtx != null) {
266 childReferencedByCtx = referencedByCtx.getReferencedChildByName(qname);
268 childReferencedByCtx = null;
271 final LeafRefContext childReferencingCtx;
272 if (referencingCtx != null) {
273 childReferencingCtx = referencingCtx.getReferencingChildByName(qname);
275 childReferencingCtx = null;
278 if (childReferencedByCtx != null || childReferencingCtx != null) {
279 validateNodeData(mapEntryNode, childReferencedByCtx, childReferencingCtx, modificationType,
280 mapEntryYangInstanceIdentifier.node(mapEntryNode.getIdentifier()));
285 // FIXME: check UnkeyedListNode case
288 private static LeafRefContext findReferencingCtxUnderChoice(
289 final LeafRefContext referencingCtx, final QName qname) {
291 for (final LeafRefContext child : referencingCtx.getReferencingChilds().values()) {
292 final LeafRefContext referencingChildByName = child.getReferencingChildByName(qname);
293 if (referencingChildByName != null) {
294 return referencingChildByName;
301 private static LeafRefContext findReferencedByCtxUnderChoice(
302 final LeafRefContext referencedByCtx, final QName qname) {
304 for (final LeafRefContext child : referencedByCtx.getReferencedByChilds().values()) {
305 final LeafRefContext referencedByChildByName = child.getReferencedChildByName(qname);
306 if (referencedByChildByName != null) {
307 return referencedByChildByName;
314 private void validateLeafRefTargetNodeData(final NormalizedNode<?, ?> leaf, final LeafRefContext
315 referencedByCtx, final ModificationType modificationType) {
316 if (validatedLeafRefCtx.contains(referencedByCtx)) {
317 LOG.trace("Operation [{}] validate data of leafref TARGET node: name[{}] = value[{}] -> SKIP: Already "
318 + "validated", modificationType, referencedByCtx.getNodeName(), leaf.getValue());
322 final Map<LeafRefContext, Set<?>> leafRefsValues = new HashMap<>();
323 for (final LeafRefContext leafRefContext : referencedByCtx.getAllReferencedByLeafRefCtxs().values()) {
324 if (leafRefContext.isReferencing()) {
325 leafRefsValues.put(leafRefContext, extractRootValues(leafRefContext));
329 if (!leafRefsValues.isEmpty()) {
330 final Set<Object> values = extractRootValues(referencedByCtx);
331 leafRefTargetNodeDataLog(leaf, referencedByCtx, modificationType, leafRefsValues, values);
333 validatedLeafRefCtx.add(referencedByCtx);
336 private Set<Object> extractRootValues(final LeafRefContext context) {
337 final Set<Object> values = new HashSet<>();
338 addValues(values, tree.getRootNode().getDataAfter(), context.getLeafRefNodePath().getPathFromRoot(), null,
339 QNameWithPredicate.ROOT);
343 private void leafRefTargetNodeDataLog(final NormalizedNode<?, ?> leaf, final LeafRefContext referencedByCtx,
344 final ModificationType modificationType, final Map<LeafRefContext, Set<?>> leafRefsValues,
345 final Set<Object> leafRefTargetNodeValues) {
347 LOG.debug("Operation [{}] validate data of leafref TARGET node: name[{}] = value[{}]", modificationType,
348 referencedByCtx.getNodeName(), leaf.getValue());
349 for (final Entry<LeafRefContext, Set<?>> entry : leafRefsValues.entrySet()) {
350 for (final Object leafRefsValue : entry.getValue()) {
351 if (!leafRefTargetNodeValues.contains(leafRefsValue)) {
352 final LeafRefContext leafRefContext = entry.getKey();
353 LOG.debug("Invalid leafref value [{}] allowed values {} by validation of leafref TARGET node: "
354 + "{} path of invalid LEAFREF node: {} leafRef target path: {} {}", leafRefsValue,
355 leafRefTargetNodeValues, leaf.getNodeType(), leafRefContext.getCurrentNodePath(),
356 leafRefContext.getAbsoluteLeafRefTargetPath(), FAILED);
357 errorsMessages.add(String.format("Invalid leafref value [%s] allowed values %s by validation of "
358 + "leafref TARGET node: %s path of invalid LEAFREF node: %s leafRef target path: %s %s",
359 leafRefsValue, leafRefTargetNodeValues, leaf.getNodeType(),
360 leafRefContext.getCurrentNodePath(), leafRefContext.getAbsoluteLeafRefTargetPath(),
363 LOG.trace("Valid leafref value [{}] {}", leafRefsValue, SUCCESS);
369 private void validateLeafRefNodeData(final NormalizedNode<?, ?> leaf, final LeafRefContext referencingCtx,
370 final ModificationType modificationType, final YangInstanceIdentifier current) {
371 final HashSet<Object> values = new HashSet<>();
372 final LeafRefPath targetPath = referencingCtx.getAbsoluteLeafRefTargetPath();
373 final Iterable<QNameWithPredicate> pathFromRoot = targetPath.getPathFromRoot();
375 addValues(values, tree.getRootNode().getDataAfter(), pathFromRoot, current, QNameWithPredicate.ROOT);
377 if (values.contains(leaf.getValue())) {
378 LOG.debug("Operation [{}] validate data of LEAFREF node: name[{}] = value[{}] {}", modificationType,
379 referencingCtx.getNodeName(), leaf.getValue(), SUCCESS);
383 LOG.debug("Operation [{}] validate data of LEAFREF node: name[{}] = value[{}] {}", modificationType,
384 referencingCtx.getNodeName(), leaf.getValue(), FAILED);
385 LOG.debug("Invalid leafref value [{}] allowed values {} of LEAFREF node: {} leafRef target path: {}",
386 leaf.getValue(), values, leaf.getNodeType(), referencingCtx.getAbsoluteLeafRefTargetPath());
387 errorsMessages.add(String.format("Invalid leafref value [%s] allowed values %s of LEAFREF node: %s leafRef "
388 + "target path: %s", leaf.getValue(), values, leaf.getNodeType(),
389 referencingCtx.getAbsoluteLeafRefTargetPath()));
392 private void addValues(final Set<Object> values, final Optional<? extends NormalizedNode<?, ?>> optDataNode,
393 final Iterable<QNameWithPredicate> path, final YangInstanceIdentifier current,
394 final QNameWithPredicate previousQName) {
396 if (!optDataNode.isPresent()) {
399 final NormalizedNode<?, ?> node = optDataNode.get();
400 if (node instanceof ValueNode) {
401 values.add(node.getValue());
404 if (node instanceof LeafSetNode<?>) {
405 for (final NormalizedNode<?, ?> entry : ((LeafSetNode<?>) node).getValue()) {
406 values.add(entry.getValue());
411 final Iterator<QNameWithPredicate> iterator = path.iterator();
412 if (!iterator.hasNext()) {
415 final QNameWithPredicate qnameWithPredicate = iterator.next();
416 final QName qName = qnameWithPredicate.getQName();
417 final PathArgument pathArgument = new NodeIdentifier(qName);
419 if (node instanceof DataContainerNode) {
420 final DataContainerNode<?> dataContainerNode = (DataContainerNode<?>) node;
421 final Optional<DataContainerChild<? extends PathArgument, ?>> child = dataContainerNode
422 .getChild(pathArgument);
424 if (child.isPresent()) {
425 addValues(values, child, nextLevel(path), current, qnameWithPredicate);
427 for (final ChoiceNode choiceNode : getChoiceNodes(dataContainerNode)) {
428 addValues(values, Optional.of(choiceNode), path, current,
433 } else if (node instanceof MapNode) {
434 final MapNode map = (MapNode) node;
435 final List<QNamePredicate> qNamePredicates = previousQName.getQNamePredicates();
436 if (qNamePredicates.isEmpty() || current == null) {
437 final Iterable<MapEntryNode> value = map.getValue();
438 for (final MapEntryNode mapEntryNode : value) {
439 final Optional<DataContainerChild<? extends PathArgument, ?>> child = mapEntryNode
440 .getChild(pathArgument);
442 if (child.isPresent()) {
443 addValues(values, child, nextLevel(path), current, qnameWithPredicate);
445 for (final ChoiceNode choiceNode : getChoiceNodes(mapEntryNode)) {
446 addValues(values, Optional.of(choiceNode), path, current, qnameWithPredicate);
451 final Map<QName, Set<?>> keyValues = new HashMap<>();
453 final Iterator<QNamePredicate> predicates = qNamePredicates.iterator();
454 while (predicates.hasNext()) {
455 final QNamePredicate predicate = predicates.next();
456 final QName identifier = predicate.getIdentifier();
457 final LeafRefPath predicatePathKeyExpression = predicate
458 .getPathKeyExpression();
460 final Set<?> pathKeyExprValues = getPathKeyExpressionValues(
461 predicatePathKeyExpression, current);
463 keyValues.put(identifier, pathKeyExprValues);
466 for (final MapEntryNode mapEntryNode : map.getValue()) {
467 if (isMatchingPredicate(mapEntryNode, keyValues)) {
468 final Optional<DataContainerChild<? extends PathArgument, ?>> child = mapEntryNode
469 .getChild(pathArgument);
471 if (child.isPresent()) {
472 addValues(values, child, nextLevel(path), current, qnameWithPredicate);
474 for (final ChoiceNode choiceNode : getChoiceNodes(mapEntryNode)) {
475 addValues(values, Optional.of(choiceNode), path, current, qnameWithPredicate);
484 private static Iterable<ChoiceNode> getChoiceNodes(final DataContainerNode<?> dataContainerNode) {
485 final List<ChoiceNode> choiceNodes = new ArrayList<>();
486 for (final DataContainerChild<? extends PathArgument, ?> child : dataContainerNode.getValue()) {
487 if (child instanceof ChoiceNode) {
488 choiceNodes.add((ChoiceNode) child);
494 private static boolean isMatchingPredicate(final MapEntryNode mapEntryNode,
495 final Map<QName, Set<?>> allowedKeyValues) {
496 for (final Entry<QName, Object> entryKeyValue : mapEntryNode.getIdentifier().getKeyValues().entrySet()) {
497 final Set<?> allowedValues = allowedKeyValues.get(entryKeyValue.getKey());
498 if (allowedValues != null && !allowedValues.contains(entryKeyValue.getValue())) {
506 private Set<?> getPathKeyExpressionValues(final LeafRefPath predicatePathKeyExpression,
507 final YangInstanceIdentifier current) {
509 final Optional<NormalizedNode<?, ?>> parent = findParentNode(tree.getRootNode().getDataAfter(), current);
510 final Iterable<QNameWithPredicate> predicatePathExpr = predicatePathKeyExpression.getPathFromRoot();
511 final Iterable<QNameWithPredicate> predicatePath = nextLevel(predicatePathExpr);
513 final Set<Object> values = new HashSet<>();
514 // FIXME: this null check does not look right
515 if (parent != null) {
516 addValues(values, parent, predicatePath, null, QNameWithPredicate.ROOT);
522 private static Optional<NormalizedNode<?, ?>> findParentNode(
523 final Optional<NormalizedNode<?, ?>> root, final YangInstanceIdentifier path) {
524 Optional<NormalizedNode<?, ?>> currentNode = root;
525 final Iterator<PathArgument> pathIterator = path.getPathArguments().iterator();
526 while (pathIterator.hasNext()) {
527 final PathArgument childPathArgument = pathIterator.next();
528 if (pathIterator.hasNext() && currentNode.isPresent()) {
529 currentNode = NormalizedNodes.getDirectChild(currentNode.get(), childPathArgument);
534 return Optional.empty();
537 private static Iterable<QNameWithPredicate> nextLevel(final Iterable<QNameWithPredicate> path) {
538 return Iterables.skip(path, 1);