2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.parser.rfc7950.stmt.augment;
10 import static com.google.common.base.Verify.verify;
12 import com.google.common.base.Verify;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableSet;
15 import com.google.common.collect.Lists;
16 import java.util.ArrayList;
17 import java.util.Collection;
18 import java.util.List;
19 import java.util.Objects;
20 import java.util.Optional;
21 import java.util.regex.Pattern;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.common.YangVersion;
24 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.Status;
26 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
27 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
28 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
29 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
30 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
31 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
32 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
33 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
34 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
35 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
36 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStatementSupport;
39 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
40 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
41 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
47 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
48 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
50 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
51 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
52 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
53 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
57 abstract class AbstractAugmentStatementSupport
58 extends BaseStatementSupport<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> {
59 private static final Logger LOG = LoggerFactory.getLogger(AbstractAugmentStatementSupport.class);
60 private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
61 private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
63 AbstractAugmentStatementSupport() {
64 super(YangStmtMapping.AUGMENT);
68 public final SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
69 SourceException.throwIf(PATH_REL_PATTERN1.matcher(value).matches()
70 || PATH_REL_PATTERN2.matcher(value).matches(), ctx.getStatementSourceReference(),
71 "Augment argument \'%s\' is not valid, it can be only absolute path; or descendant if used in uses",
74 return ArgumentUtils.nodeIdentifierFromPath(ctx, value);
78 public final void onFullDefinitionDeclared(
79 final Mutable<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> augmentNode) {
80 if (!augmentNode.isSupportedByFeatures()) {
84 super.onFullDefinitionDeclared(augmentNode);
86 if (StmtContextUtils.isInExtensionBody(augmentNode)) {
90 final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
91 augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
92 final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target = augmentAction.mutatesEffectiveCtxPath(
93 getSearchRoot(augmentNode), ChildSchemaNodeNamespace.class,
94 augmentNode.coerceStatementArgument().getNodeIdentifiers());
96 augmentAction.apply(new InferenceAction() {
98 public void apply(final InferenceContext ctx) {
99 final StatementContextBase<?, ?, ?> augmentTargetCtx =
100 (StatementContextBase<?, ?, ?>) target.resolve(ctx);
101 if (!isSupportedAugmentTarget(augmentTargetCtx)
102 || StmtContextUtils.isInExtensionBody(augmentTargetCtx)) {
103 augmentNode.setIsSupportedToBuildEffective(false);
107 // We are targeting a context which is creating implicit nodes. In order to keep things consistent,
108 // we will need to circle back when creating effective statements.
109 if (augmentTargetCtx.hasImplicitParentSupport()) {
110 augmentNode.addToNs(AugmentImplicitHandlingNamespace.class, augmentNode, augmentTargetCtx);
113 final StatementContextBase<?, ?, ?> augmentSourceCtx = (StatementContextBase<?, ?, ?>) augmentNode;
114 // FIXME: this is a workaround for models which augment a node which is added via an extension
115 // which we do not handle. This needs to be reworked in terms of unknown schema nodes.
117 copyFromSourceToTarget(augmentSourceCtx, augmentTargetCtx);
118 augmentTargetCtx.addEffectiveSubstatement(augmentSourceCtx);
119 } catch (final SourceException e) {
120 LOG.warn("Failed to add augmentation {} defined at {}",
121 augmentTargetCtx.getStatementSourceReference(),
122 augmentSourceCtx.getStatementSourceReference(), e);
127 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
129 * Do not fail, if it is an uses-augment to an unknown node.
131 if (YangStmtMapping.USES == augmentNode.coerceParentContext().getPublicDefinition()) {
132 final SchemaNodeIdentifier augmentArg = augmentNode.coerceStatementArgument();
133 final Optional<StmtContext<?, ?, ?>> targetNode = ChildSchemaNodeNamespace.findNode(
134 getSearchRoot(augmentNode), augmentArg);
135 if (targetNode.isPresent() && StmtContextUtils.isUnknownStatement(targetNode.get())) {
136 augmentNode.setIsSupportedToBuildEffective(false);
137 LOG.warn("Uses-augment to unknown node {}. Augmentation has not been performed. At line: {}",
138 augmentArg, augmentNode.getStatementSourceReference());
143 throw new InferenceException(augmentNode.getStatementSourceReference(),
144 "Augment target '%s' not found", augmentNode.getStatementArgument());
150 protected final AugmentStatement createDeclared(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx,
151 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
152 return new RegularAugmentStatement(ctx, substatements);
156 protected final AugmentStatement createEmptyDeclared(
157 final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx) {
158 return new EmptyAugmentStatement(ctx);
162 protected final List<? extends StmtContext<?, ?, ?>> statementsToBuild(
163 final StmtContext<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> ctx,
164 final List<? extends StmtContext<?, ?, ?>> substatements) {
165 final StatementContextBase<?, ?, ?> implicitDef = ctx.getFromNamespace(AugmentImplicitHandlingNamespace.class,
167 return implicitDef == null ? substatements : Lists.transform(substatements, subCtx -> {
168 verify(subCtx instanceof StatementContextBase);
169 return implicitDef.wrapWithImplicit((StatementContextBase<?, ?, ?>) subCtx);
174 protected final AugmentEffectiveStatement createEffective(
175 final StmtContext<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> ctx,
176 final AugmentStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
177 final int flags = new FlagsBuilder()
178 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
181 return new AugmentEffectiveStatementImpl(declared, ctx.coerceStatementArgument(), flags,
182 StmtContextUtils.getRootModuleQName(ctx), substatements, ctx.getStatementSourceReference(),
183 (AugmentationSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective).orElse(null));
187 protected final AugmentEffectiveStatement createEmptyEffective(
188 final StmtContext<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> ctx,
189 final AugmentStatement declared) {
190 return createEffective(ctx, declared, ImmutableList.of());
193 private static StmtContext<?, ?, ?> getSearchRoot(final StmtContext<?, ?, ?> augmentContext) {
194 // Augment is in uses - we need to augment instantiated nodes in parent.
195 final StmtContext<?, ?, ?> parent = augmentContext.coerceParentContext();
196 if (YangStmtMapping.USES == parent.getPublicDefinition()) {
197 return parent.getParentContext();
202 static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
203 final StatementContextBase<?, ?, ?> targetCtx) {
204 final CopyType typeOfCopy = sourceCtx.coerceParentContext().producesDeclared(UsesStatement.class)
205 ? CopyType.ADDED_BY_USES_AUGMENTATION : CopyType.ADDED_BY_AUGMENTATION;
207 * Since Yang 1.1, if an augmentation is made conditional with a
208 * "when" statement, it is allowed to add mandatory nodes.
210 final boolean skipCheckOfMandatoryNodes = YangVersion.VERSION_1_1.equals(sourceCtx.getRootVersion())
211 && isConditionalAugmentStmt(sourceCtx);
213 final Collection<? extends Mutable<?, ?, ?>> declared = sourceCtx.mutableDeclaredSubstatements();
214 final Collection<? extends Mutable<?, ?, ?>> effective = sourceCtx.mutableEffectiveSubstatements();
215 final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
217 for (final Mutable<?, ?, ?> originalStmtCtx : declared) {
218 if (originalStmtCtx.isSupportedByFeatures()) {
219 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
222 for (final Mutable<?, ?, ?> originalStmtCtx : effective) {
223 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
226 targetCtx.addEffectiveSubstatements(buffer);
230 * Checks whether supplied statement context is conditional augment
234 * statement context to be checked
236 * @return true if supplied statement context is conditional augment
237 * statement, otherwise false
239 private static boolean isConditionalAugmentStmt(final StmtContext<?, ?, ?> ctx) {
240 return ctx.getPublicDefinition() == YangStmtMapping.AUGMENT && hasWhenSubstatement(ctx);
243 private static boolean hasWhenSubstatement(final StmtContext<?, ?, ?> ctx) {
244 return StmtContextUtils.findFirstSubstatement(ctx, WhenStatement.class) != null;
247 private static void copyStatement(final Mutable<?, ?, ?> original, final StatementContextBase<?, ?, ?> target,
248 final CopyType typeOfCopy, final Collection<Mutable<?, ?, ?>> buffer,
249 final boolean skipCheckOfMandatoryNodes) {
250 if (needToCopyByAugment(original)) {
251 validateNodeCanBeCopiedByAugment(original, target, typeOfCopy, skipCheckOfMandatoryNodes);
253 buffer.add(target.childCopyOf(original, typeOfCopy));
254 } else if (isReusedByAugment(original)) {
255 buffer.add(original);
259 private static void validateNodeCanBeCopiedByAugment(final StmtContext<?, ?, ?> sourceCtx,
260 final StatementContextBase<?, ?, ?> targetCtx, final CopyType typeOfCopy,
261 final boolean skipCheckOfMandatoryNodes) {
263 if (sourceCtx.producesDeclared(WhenStatement.class)) {
267 if (!skipCheckOfMandatoryNodes && typeOfCopy == CopyType.ADDED_BY_AUGMENTATION
268 && requireCheckOfMandatoryNodes(sourceCtx, targetCtx)) {
269 checkForMandatoryNodes(sourceCtx);
272 // Data definition statements must not collide on their namespace
273 if (sourceCtx.producesDeclared(DataDefinitionStatement.class)) {
274 for (final StmtContext<?, ?, ?> subStatement : targetCtx.allSubstatements()) {
275 if (subStatement.producesDeclared(DataDefinitionStatement.class)) {
276 InferenceException.throwIf(
277 Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument()),
278 sourceCtx.getStatementSourceReference(),
279 "An augment cannot add node named '%s' because this name is already used in target",
280 sourceCtx.rawStatementArgument());
286 private static void checkForMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx) {
287 if (StmtContextUtils.isNonPresenceContainer(sourceCtx)) {
289 * We need to iterate over both declared and effective sub-statements,
290 * because a mandatory node can be:
291 * a) declared in augment body
292 * b) added to augment body also via uses of a grouping and
293 * such sub-statements are stored in effective sub-statements collection.
295 sourceCtx.allSubstatementsStream().forEach(AbstractAugmentStatementSupport::checkForMandatoryNodes);
298 InferenceException.throwIf(StmtContextUtils.isMandatoryNode(sourceCtx),
299 sourceCtx.getStatementSourceReference(),
300 "An augment cannot add node '%s' because it is mandatory and in module different than target",
301 sourceCtx.rawStatementArgument());
304 private static boolean requireCheckOfMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx,
305 Mutable<?, ?, ?> targetCtx) {
307 * If the statement argument is not QName, it cannot be mandatory
308 * statement, therefore return false and skip mandatory nodes validation
310 final Object arg = sourceCtx.getStatementArgument();
311 if (!(arg instanceof QName)) {
314 final QName sourceStmtQName = (QName) arg;
316 // RootStatementContext, for example
317 final Mutable<?, ?, ?> root = targetCtx.getRoot();
319 final Object targetArg = targetCtx.getStatementArgument();
320 Verify.verify(targetArg instanceof QName, "Argument of augment target statement must be QName, not %s",
322 final QName targetStmtQName = (QName) targetArg;
324 * If target is from another module, return true and perform mandatory nodes validation
326 if (!targetStmtQName.getModule().equals(sourceStmtQName.getModule())) {
331 * If target or one of the target's ancestors from the same namespace
332 * is a presence container
333 * or is non-mandatory choice
334 * or is non-mandatory list
335 * return false and skip mandatory nodes validation, because these nodes
336 * are not mandatory node containers according to RFC 6020 section 3.1.
338 if (StmtContextUtils.isPresenceContainer(targetCtx)
339 || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.CHOICE)
340 || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.LIST)) {
344 // This could be an augmentation stacked on top of a previous augmentation from the same module, which is
345 // conditional -- in which case we do not run further checks
346 if (targetCtx.getCopyHistory().getLastOperation() == CopyType.ADDED_BY_AUGMENTATION) {
347 final Optional<? extends StmtContext<?, ?, ?>> optPrevCopy = targetCtx.getPreviousCopyCtx();
348 if (optPrevCopy.isPresent()) {
349 final StmtContext<?, ?, ?> original = optPrevCopy.get();
350 final Object origArg = original.coerceStatementArgument();
351 Verify.verify(origArg instanceof QName, "Unexpected statement argument %s", origArg);
353 if (sourceStmtQName.getModule().equals(((QName) origArg).getModule())
354 && hasWhenSubstatement(getParentAugmentation(original))) {
359 } while ((targetCtx = targetCtx.getParentContext()) != root);
362 * All target node's parents belong to the same module as source node,
363 * therefore return false and skip mandatory nodes validation.
368 private static StmtContext<?, ?, ?> getParentAugmentation(final StmtContext<?, ?, ?> child) {
369 StmtContext<?, ?, ?> parent = Verify.verifyNotNull(child.getParentContext(), "Child %s has not parent", child);
370 while (parent.getPublicDefinition() != YangStmtMapping.AUGMENT) {
371 parent = Verify.verifyNotNull(parent.getParentContext(), "Failed to find augmentation parent of %s", child);
376 private static final ImmutableSet<YangStmtMapping> NOCOPY_DEF_SET = ImmutableSet.of(YangStmtMapping.USES,
377 YangStmtMapping.WHEN, YangStmtMapping.DESCRIPTION, YangStmtMapping.REFERENCE, YangStmtMapping.STATUS);
379 private static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
380 return !NOCOPY_DEF_SET.contains(stmtContext.getPublicDefinition());
383 private static final ImmutableSet<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(YangStmtMapping.TYPEDEF);
385 private static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
386 return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
389 static boolean isSupportedAugmentTarget(final StmtContext<?, ?, ?> substatementCtx) {
391 * :TODO Substatement must be allowed augment target type e.g.
392 * Container, etc... and must not be for example grouping, identity etc.
393 * It is problem in case when more than one substatements have the same
394 * QName, for example Grouping and Container are siblings and they have
395 * the same QName. We must find the Container and the Grouping must be
396 * ignored as disallowed augment target.
398 final Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
399 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
401 // if no allowed target is returned we consider all targets allowed
402 return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty()
403 || allowedAugmentTargets.contains(substatementCtx.getPublicDefinition());