X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=yang%2Fyang-parser-impl%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Fyang%2Fparser%2Fstmt%2Frfc6020%2FAugmentUtils.java;h=9bcedcb22ba870bcc39e483e09da1346247017fb;hb=78cbd44f2617ed955064036b94f88603bc3de826;hp=46c2954b9d000006d3d7350a732d41c5f1233865;hpb=30c67c4d780e897d972d60bb79d546b512516f90;p=yangtools.git diff --git a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/AugmentUtils.java b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/AugmentUtils.java index 46c2954b9d..9bcedcb22b 100644 --- a/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/AugmentUtils.java +++ b/yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/AugmentUtils.java @@ -1,100 +1,57 @@ /** * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved. - *

+ * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.yangtools.yang.parser.stmt.rfc6020; -import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName; - -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; +import com.google.common.base.Verify; import com.google.common.collect.ImmutableList.Builder; +import com.google.common.collect.ImmutableSet; import java.util.Collection; -import java.util.HashSet; -import java.util.Iterator; -import java.util.LinkedList; import java.util.List; -import java.util.Map; import java.util.Objects; import java.util.Set; -import javax.annotation.Nullable; import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.common.QNameModule; import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping; -import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; -import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition; -import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement; import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement; import org.opendaylight.yangtools.yang.model.api.stmt.MandatoryStatement; -import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier; import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement; import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement; -import org.opendaylight.yangtools.yang.parser.spi.NamespaceToModule; +import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext; -import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable; import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.TypeOfCopy; -import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils; import org.opendaylight.yangtools.yang.parser.spi.source.SourceException; import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace; import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType; +import org.opendaylight.yangtools.yang.parser.stmt.reactor.RootStatementContext; import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase; +// FIXME: Move this to the AugmentStatementDefinition#ApplyAction public final class AugmentUtils { - - private static final Logger LOG = LoggerFactory.getLogger(AugmentUtils.class); - - private static final String REGEX_PATH_REL1 = "\\.\\.?\\s*/(.+)"; - private static final String REGEX_PATH_REL2 = "//.*"; - private AugmentUtils() { } - public static Iterable parseAugmentPath(StmtContext ctx, - String path) { - - if (path.matches(REGEX_PATH_REL1) || path.matches(REGEX_PATH_REL2)) { - throw new IllegalArgumentException( - "An argument for augment can be only absolute path; or descendant if used in uses"); - } - - return Utils.parseXPath(ctx, path); - } - - public static void copyFromSourceToTarget( - StatementContextBase sourceCtx, - StatementContextBase targetCtx) throws SourceException { - + public static void copyFromSourceToTarget(final StatementContextBase sourceCtx, + final StatementContextBase targetCtx) throws SourceException { copyDeclaredStmts(sourceCtx, targetCtx); copyEffectiveStmts(sourceCtx, targetCtx); } - public static void copyDeclaredStmts( - StatementContextBase sourceCtx, - StatementContextBase targetCtx) throws SourceException { + // FIXME: Declared statements should not be copied. + private static void copyDeclaredStmts(final StatementContextBase sourceCtx, + final StatementContextBase targetCtx) throws SourceException { - Collection> declaredSubStatements = sourceCtx - .declaredSubstatements(); - final List subStatements = new Builder() - .addAll(targetCtx.declaredSubstatements()) - .addAll(targetCtx.effectiveSubstatements()).build(); - boolean sourceAndTargetInSameModule = Utils.getRootModuleQName( - sourceCtx).equals(Utils.getRootModuleQName(targetCtx)); + TypeOfCopy typeOfCopy = sourceCtx.getParentContext().getPublicDefinition().getDeclaredRepresentationClass() + .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION : TypeOfCopy.ADDED_BY_AUGMENTATION; - TypeOfCopy typeOfCopy = sourceCtx.getParentContext() - .getPublicDefinition().getDeclaredRepresentationClass() - .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION - : TypeOfCopy.ADDED_BY_AUGMENTATION; - - for (StatementContextBase originalStmtCtx : declaredSubStatements) { + for (StatementContextBase originalStmtCtx : sourceCtx.declaredSubstatements()) { if (needToCopyByAugment(originalStmtCtx)) { - validateNodeCanBeCopiedByAugment(originalStmtCtx, - subStatements, sourceAndTargetInSameModule); + validateNodeCanBeCopiedByAugment(originalStmtCtx, targetCtx); - StatementContextBase copy = originalStmtCtx - .createCopy(targetCtx, typeOfCopy); + StatementContextBase copy = originalStmtCtx.createCopy(targetCtx, typeOfCopy); targetCtx.addEffectiveSubstatement(copy); } else if (isReusedByAugment(originalStmtCtx)) { targetCtx.addEffectiveSubstatement(originalStmtCtx); @@ -102,30 +59,16 @@ public final class AugmentUtils { } } - public static void copyEffectiveStmts( - StatementContextBase sourceCtx, - StatementContextBase targetCtx) throws SourceException { - - Collection> effectiveSubstatements = sourceCtx - .effectiveSubstatements(); - final List subStatements = new Builder() - .addAll(targetCtx.declaredSubstatements()) - .addAll(targetCtx.effectiveSubstatements()).build(); - boolean sourceAndTargetInSameModule = Utils.getRootModuleQName( - sourceCtx).equals(Utils.getRootModuleQName(targetCtx)); + private static void copyEffectiveStmts(final StatementContextBase sourceCtx, + final StatementContextBase targetCtx) throws SourceException { + TypeOfCopy typeOfCopy = sourceCtx.getParentContext().getPublicDefinition().getDeclaredRepresentationClass() + .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION : TypeOfCopy.ADDED_BY_AUGMENTATION; - TypeOfCopy typeOfCopy = sourceCtx.getParentContext() - .getPublicDefinition().getDeclaredRepresentationClass() - .equals(UsesStatement.class) ? TypeOfCopy.ADDED_BY_USES_AUGMENTATION - : TypeOfCopy.ADDED_BY_AUGMENTATION; - - for (StatementContextBase originalStmtCtx : effectiveSubstatements) { + for (StatementContextBase originalStmtCtx : sourceCtx.effectiveSubstatements()) { if (needToCopyByAugment(originalStmtCtx)) { - validateNodeCanBeCopiedByAugment(originalStmtCtx, - subStatements, sourceAndTargetInSameModule); + validateNodeCanBeCopiedByAugment(originalStmtCtx, targetCtx); - StatementContextBase copy = originalStmtCtx - .createCopy(targetCtx, typeOfCopy); + StatementContextBase copy = originalStmtCtx.createCopy(targetCtx, typeOfCopy); targetCtx.addEffectiveSubstatement(copy); } else if (isReusedByAugment(originalStmtCtx)) { targetCtx.addEffectiveSubstatement(originalStmtCtx); @@ -133,235 +76,112 @@ public final class AugmentUtils { } } - private static void validateNodeCanBeCopiedByAugment( - final StatementContextBase sourceCtx, - final List targetSubStatements, - boolean sourceAndTargetInSameModule) { + private static void validateNodeCanBeCopiedByAugment(final StatementContextBase sourceCtx, + final StatementContextBase targetCtx) { - if (sourceCtx.getPublicDefinition().getDeclaredRepresentationClass() - .equals(WhenStatement.class)) { + if (sourceCtx.getPublicDefinition().getDeclaredRepresentationClass().equals(WhenStatement.class)) { return; } - if (!sourceAndTargetInSameModule) { - final List sourceSubStatements = new Builder() - .addAll(sourceCtx.declaredSubstatements()) - .addAll(sourceCtx.effectiveSubstatements()).build(); - - for (final StatementContextBase sourceSubStatement : sourceSubStatements) { - if (sourceSubStatement.getPublicDefinition() - .getDeclaredRepresentationClass() - .equals(MandatoryStatement.class)) { - throw new IllegalArgumentException( - String.format( - "An augment cannot add node '%s' because it is mandatory and in module different from target", - sourceCtx.rawStatementArgument())); - } - } - } - - for (final StatementContextBase subStatement : targetSubStatements) { + if (reguiredCheckOfMandatoryNodes(sourceCtx, targetCtx)) { + final List> sourceSubStatements = new Builder>() + .addAll(sourceCtx.declaredSubstatements()).addAll(sourceCtx.effectiveSubstatements()).build(); - final boolean sourceIsDataNode = DataDefinitionStatement.class - .isAssignableFrom(sourceCtx.getPublicDefinition() - .getDeclaredRepresentationClass()); - final boolean targetIsDataNode = DataDefinitionStatement.class - .isAssignableFrom(subStatement.getPublicDefinition() - .getDeclaredRepresentationClass()); - boolean qNamesEqual = sourceIsDataNode - && targetIsDataNode - && Objects.equals(sourceCtx.getStatementArgument(), - subStatement.getStatementArgument()); - - if (qNamesEqual) { - throw new IllegalStateException( - String.format( - "An augment cannot add node named '%s' because this name is already used in target", - sourceCtx.rawStatementArgument())); + for (final StatementContextBase sourceSubStatement : sourceSubStatements) { + InferenceException.throwIf(MandatoryStatement.class.equals( + sourceSubStatement.getPublicDefinition().getDeclaredRepresentationClass()), + sourceCtx.getStatementSourceReference(), + "An augment cannot add node '%s' because it is mandatory and in module different from target", + sourceCtx.rawStatementArgument()); } } - } - public static QNameModule getNewQNameModule( - StatementContextBase targetCtx, - StatementContextBase sourceCtx) { - Object targetStmtArgument = targetCtx.getStatementArgument(); + final List> targetSubStatements = new Builder>() + .addAll(targetCtx.declaredSubstatements()).addAll(targetCtx.effectiveSubstatements()).build(); - final StatementContextBase root = sourceCtx.getRoot(); - final QNameModule sourceQNameModule = root.getFromNamespace( - ModuleCtxToModuleQName.class, root); + for (final StatementContextBase subStatement : targetSubStatements) { - if (targetStmtArgument instanceof QName) { - QName targetQName = (QName) targetStmtArgument; - QNameModule targetQNameModule = targetQName.getModule(); + final boolean sourceIsDataNode = DataDefinitionStatement.class.isAssignableFrom(sourceCtx + .getPublicDefinition().getDeclaredRepresentationClass()); + final boolean targetIsDataNode = DataDefinitionStatement.class.isAssignableFrom(subStatement + .getPublicDefinition().getDeclaredRepresentationClass()); + boolean qNamesEqual = sourceIsDataNode && targetIsDataNode + && Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument()); - if (targetQNameModule.equals(sourceQNameModule)) { - return null; - } else { - return targetQNameModule; - } - } else { - return null; + InferenceException.throwIf(qNamesEqual, sourceCtx.getStatementSourceReference(), + "An augment cannot add node named '%s' because this name is already used in target", + sourceCtx.rawStatementArgument()); } } - public static boolean needToCopyByAugment(StmtContext stmtContext) { - - Set noCopyDefSet = new HashSet<>(); - noCopyDefSet.add(Rfc6020Mapping.USES); - - StatementDefinition def = stmtContext.getPublicDefinition(); - return !noCopyDefSet.contains(def); - } - - public static boolean isReusedByAugment(StmtContext stmtContext) { - - Set reusedDefSet = new HashSet<>(); - reusedDefSet.add(Rfc6020Mapping.TYPEDEF); - - StatementDefinition def = stmtContext.getPublicDefinition(); - - return reusedDefSet.contains(def); - } - - public static StatementContextBase getAugmentTargetCtx( - final Mutable> augmentNode) { - - final SchemaNodeIdentifier augmentTargetNode = augmentNode - .getStatementArgument(); - if (augmentTargetNode == null) { - throw new IllegalArgumentException( - "Augment argument null, something bad happened in some of previous parsing phases"); + private static boolean reguiredCheckOfMandatoryNodes(StatementContextBase sourceCtx, + StatementContextBase targetCtx) { + /* + * If the statement argument is not QName, it cannot be mandatory statement, + * therefore return false and skip mandatory nodes validation + */ + if(!(sourceCtx.getStatementArgument() instanceof QName)) { + return false; } - - List> rootStatementCtxList = new LinkedList<>(); - if (augmentTargetNode.isAbsolute()) { - - QNameModule module = augmentTargetNode.getPathFromRoot().iterator() - .next().getModule(); - - StatementContextBase rootStatementCtx = (StatementContextBase) augmentNode - .getFromNamespace(NamespaceToModule.class, module); - rootStatementCtxList.add(rootStatementCtx); - - final Map subModules = rootStatementCtx - .getAllFromNamespace(IncludedModuleContext.class); - if (subModules != null) { - rootStatementCtxList - .addAll((Collection>) subModules - .values()); - } - - } else { - StatementContextBase parent = (StatementContextBase) augmentNode - .getParentContext(); - if (StmtContextUtils.producesDeclared(parent, UsesStatement.class)) { - rootStatementCtxList.add(parent.getParentContext()); + QName sourceStmtQName = (QName) sourceCtx.getStatementArgument(); + + RootStatementContext root = targetCtx.getRoot(); + do { + Verify.verify(targetCtx.getStatementArgument() instanceof QName, + "Argument of augment target statement must be QName."); + QName targetStmtQName = (QName) targetCtx.getStatementArgument(); + /* + * If target is from another module, return true and perform + * mandatory nodes validation + */ + if (!Utils.belongsToTheSameModule(targetStmtQName, sourceStmtQName)) { + return true; } else { - // error + /* + * If target or one of its parent is a presence container from + * the same module, return false and skip mandatory nodes + * validation + */ + if (Utils.isPresenceContainer(targetCtx)) { + return false; + } } - } - - StatementContextBase augmentTargetCtx = null; - for (final StatementContextBase rootStatementCtx : rootStatementCtxList) { - augmentTargetCtx = findCtxOfNodeInRoot(rootStatementCtx, - augmentTargetNode); - if (augmentTargetCtx != null) - break; - } + } while ((targetCtx = targetCtx.getParentContext()) != root); - return augmentTargetCtx; + /* + * All target node's parents belong to the same module as source node, + * therefore return false and skip mandatory nodes validation. + */ + return false; } - @Nullable - public static StatementContextBase findCtxOfNodeInSubstatements( - StatementContextBase rootStmtCtx, - final Iterable path) { - - StatementContextBase parent = rootStmtCtx; - - Iterator pathIter = path.iterator(); - while (pathIter.hasNext()) { - QName nextPathQName = pathIter.next(); - StatementContextBase foundSubstatement = getSubstatementByQName( - parent, nextPathQName); + private static final Set NOCOPY_DEF_SET = ImmutableSet.of(Rfc6020Mapping.USES, Rfc6020Mapping.WHEN, + Rfc6020Mapping.DESCRIPTION, Rfc6020Mapping.REFERENCE, Rfc6020Mapping.STATUS); - if (foundSubstatement == null) { - return null; - } - if (!pathIter.hasNext()) { - return foundSubstatement; - } - - parent = foundSubstatement; - } - - return null; + public static boolean needToCopyByAugment(final StmtContext stmtContext) { + return !NOCOPY_DEF_SET.contains(stmtContext.getPublicDefinition()); } - public static StatementContextBase getSubstatementByQName( - StatementContextBase parent, QName nextPathQName) { - - Collection> declaredSubstatement = parent - .declaredSubstatements(); - Collection> effectiveSubstatement = parent - .effectiveSubstatements(); - - Collection> allSubstatements = new LinkedList<>(); - allSubstatements.addAll(declaredSubstatement); - allSubstatements.addAll(effectiveSubstatement); - - for (StatementContextBase substatement : allSubstatements) { - Object substatementArgument = substatement.getStatementArgument(); - QName substatementQName; - if (substatementArgument instanceof QName) { - substatementQName = (QName) substatementArgument; + private static final Set REUSED_DEF_SET = ImmutableSet.of(Rfc6020Mapping.TYPEDEF); - if (isSupportedAugmentTarget(substatement) - && nextPathQName.getLocalName().equals( - substatementQName.getLocalName())) { - return substatement; - } - } // augment to extension - else if (StmtContextUtils.producesDeclared(substatement, - UnknownStatementImpl.class) - && substatementArgument instanceof String) { - if (nextPathQName.getLocalName().equals(substatementArgument)) { - String message = "Module '"+substatement.getRoot().getStatementArgument()+"': augment into extension '"+substatementArgument+"'."; - LOG.warn(message); - return substatement; - } - } - } - - return null; + public static boolean isReusedByAugment(final StmtContext stmtContext) { + return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition()); } - public static boolean isSupportedAugmentTarget( - StatementContextBase substatementCtx) { + static boolean isSupportedAugmentTarget(final StatementContextBase substatementCtx) { /* - * :TODO Substatement must be allowed augment target type e.g. - * Container, etc... and must be not for example grouping, identity etc. - * It is problem in case when more than one substatements have the same - * QName, for example Grouping and Container are siblings and they have - * the same QName. We must find the Container and the Grouping must be - * ignored as disallowed augment target. + * :TODO Substatement must be allowed augment target type e.g. Container, etc... and must not be for example + * grouping, identity etc. It is problem in case when more than one substatements have the same QName, for + * example Grouping and Container are siblings and they have the same QName. We must find the Container and the + * Grouping must be ignored as disallowed augment target. */ - Collection allowedAugmentTargets = substatementCtx.getFromNamespace( - ValidationBundlesNamespace.class, + Collection allowedAugmentTargets = substatementCtx.getFromNamespace(ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS); // if no allowed target is returned we consider all targets allowed return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty() || allowedAugmentTargets.contains(substatementCtx.getPublicDefinition()); } - - @Nullable - public static StatementContextBase findCtxOfNodeInRoot( - StatementContextBase rootStmtCtx, - final SchemaNodeIdentifier node) { - return findCtxOfNodeInSubstatements(rootStmtCtx, node.getPathFromRoot()); - } }