Fix unique statement argument propagation
[yangtools.git] / parser / yang-parser-rfc7950 / src / main / java / org / opendaylight / yangtools / yang / parser / rfc7950 / stmt / meta / UniqueStatementSupport.java
index 2b80ecc48dc29f7003d926d10d717ea535a4f004..ad3900c2e23f6e7a16f9dfa5e3192796117a9975 100644 (file)
@@ -7,18 +7,30 @@
  */
 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.meta;
 
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.base.CharMatcher;
 import com.google.common.base.Splitter;
+import com.google.common.collect.ImmutableBiMap;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableSet;
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
+import java.util.Collection;
 import java.util.HashSet;
+import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
 import java.util.regex.Pattern;
+import java.util.stream.Stream;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
+import org.opendaylight.yangtools.yang.model.api.stmt.LeafEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
 import org.opendaylight.yangtools.yang.model.api.stmt.UniqueEffectiveStatement;
@@ -28,10 +40,17 @@ import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
 import org.opendaylight.yangtools.yang.model.ri.stmt.EffectiveStatements;
 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
+import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
 import org.opendaylight.yangtools.yang.parser.spi.meta.BoundStmtCtx;
 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
+import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
+import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
 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.SubstatementValidator;
 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
 
@@ -49,20 +68,57 @@ public final class UniqueStatementSupport
         SubstatementValidator.builder(YangStmtMapping.UNIQUE).build();
 
     public UniqueStatementSupport(final YangParserConfiguration config) {
-        // FIXME: This reflects what the current implementation does. We really want to define an adaptArgumentValue(),
-        //        but how that plays with the argument and expectations needs to be investigated.
-        super(YangStmtMapping.UNIQUE, StatementPolicy.contextIndependent(), config, SUBSTATEMENT_VALIDATOR);
+        super(YangStmtMapping.UNIQUE,
+            StatementPolicy.copyDeclared(
+                (copy, current, substatements) -> copy.getArgument().equals(current.getArgument())),
+            config, SUBSTATEMENT_VALIDATOR);
+    }
+
+    @Override
+    public Set<Descendant> adaptArgumentValue(
+            final StmtContext<Set<Descendant>, UniqueStatement, UniqueEffectiveStatement> ctx,
+            final QNameModule targetModule) {
+        // Copy operation to a targetNamespace -- this implies rehosting node-identifiers to target namespace. Check
+        // if that is needed first, though, so as not to copy things unnecessarily.
+        final var origArg = ctx.getArgument();
+        if (allMatch(origArg.stream().flatMap(desc -> desc.getNodeIdentifiers().stream()), targetModule)) {
+            return origArg;
+        }
+
+        return origArg.stream()
+            .map(descendant -> {
+                final var nodeIds = descendant.getNodeIdentifiers();
+                // Only update descendants that need updating
+                return allMatch(nodeIds.stream(), targetModule) ? descendant
+                    : Descendant.of(Lists.transform(nodeIds, nodeId -> nodeId.bindTo(targetModule).intern()));
+            })
+            .collect(ImmutableSet.toImmutableSet());
     }
 
     @Override
     public ImmutableSet<Descendant> parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
-        final ImmutableSet<Descendant> uniqueConstraints = parseUniqueConstraintArgument(ctx, value);
+        final var uniqueConstraints = parseUniqueConstraintArgument(ctx, value);
         SourceException.throwIf(uniqueConstraints.isEmpty(), ctx,
             "Invalid argument value '%s' of unique statement. The value must contains at least one descendant schema "
                 + "node identifier.", value);
         return uniqueConstraints;
     }
 
+    @Override
+    public void onStatementAdded(final Mutable<Set<Descendant>, UniqueStatement, UniqueEffectiveStatement> stmt) {
+        // Check whether this statement is in a list statement and if so ...
+        final var list = stmt.coerceParentContext();
+        if (list.producesEffective(ListEffectiveStatement.class)) {
+            final var listParent = list.coerceParentContext();
+            // ... do not allow parent to complete until we have resolved ...
+            final var action = listParent.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
+            // ... we require the list to be completely resolve ...
+            action.requiresCtx(list, ModelProcessingPhase.EFFECTIVE_MODEL);
+            // ... after which we will continue
+            action.apply(new RequireEffectiveList(stmt, list, listParent));
+        }
+    }
+
     @Override
     protected UniqueStatement createDeclared(final BoundStmtCtx<Set<Descendant>> ctx,
             final ImmutableList<DeclaredStatement<?>> substatements) {
@@ -81,14 +137,18 @@ public final class UniqueStatementSupport
         return EffectiveStatements.createUnique(stmt.declared(), substatements);
     }
 
+    private static boolean allMatch(final Stream<QName> qnames, final QNameModule module) {
+        return qnames.allMatch(qname -> module.equals(qname.getModule()));
+    }
+
     private static ImmutableSet<Descendant> parseUniqueConstraintArgument(final StmtContext<?, ?, ?> ctx,
             final String argumentValue) {
         // deal with 'line-break' rule, which is either "\n" or "\r\n", but not "\r"
         final String nocrlf = CRLF_PATTERN.matcher(argumentValue).replaceAll("\n");
 
-        final Set<Descendant> uniqueConstraintNodes = new HashSet<>();
-        for (final String uniqueArgToken : SEP_SPLITTER.split(nocrlf)) {
-            final SchemaNodeIdentifier nodeIdentifier = ArgumentUtils.nodeIdentifierFromPath(ctx, uniqueArgToken);
+        final var uniqueConstraintNodes = new HashSet<Descendant>();
+        for (var uniqueArgToken : SEP_SPLITTER.split(nocrlf)) {
+            final var nodeIdentifier = ArgumentUtils.nodeIdentifierFromPath(ctx, uniqueArgToken);
             SourceException.throwIf(nodeIdentifier instanceof Absolute, ctx,
                 "Unique statement argument '%s' contains schema node identifier '%s' which is not in the descendant "
                     + "node identifier form.", argumentValue, uniqueArgToken);
@@ -96,4 +156,74 @@ public final class UniqueStatementSupport
         }
         return ImmutableSet.copyOf(uniqueConstraintNodes);
     }
+
+    /**
+     * Inference action to process parent list reaching effective model, i.e. we can tell it is now complete.
+     */
+    private static final class RequireEffectiveList implements InferenceAction {
+        private final StmtContext<Set<Descendant>, ?, ?> unique;
+        private final StmtContext<?, ?, ?> list;
+        private final Mutable<?, ?, ?> parent;
+
+        RequireEffectiveList(final StmtContext<Set<Descendant>, ?, ?> unique, final StmtContext<?, ?, ?> list,
+                final Mutable<?, ?, ?> parent) {
+            this.unique = requireNonNull(unique);
+            this.list = requireNonNull(list);
+            this.parent = requireNonNull(parent);
+        }
+
+        @Override
+        public void apply(final InferenceContext ctx) {
+            if (isApplicable()) {
+                // So now, we have the effective list, we again block its parent from resolving ...
+                final var action = parent.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
+                // ... and before going further ...
+                action.apply(new RequireLeafDescendants(unique,
+                    // ... require that each schema node identifier resolves against the schema tree
+                    Maps.uniqueIndex(unique.getArgument(), desc -> action.requiresCtxPath(list,
+                        SchemaTreeNamespace.class, desc.getNodeIdentifiers(), ModelProcessingPhase.EFFECTIVE_MODEL))));
+            }
+        }
+
+        @Override
+        public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
+            InferenceException.throwIf(isApplicable(), unique, "Parent list failed to reach effective model");
+        }
+
+        private boolean isApplicable() {
+            return list.isSupportedToBuildEffective() && unique.isSupportedToBuildEffective();
+        }
+    }
+
+    private static final class RequireLeafDescendants implements InferenceAction {
+        private final Map<Prerequisite<StmtContext<?, ?, ?>>, Descendant> prereqs;
+        private final StmtContext<Set<Descendant>, ?, ?> unique;
+
+        RequireLeafDescendants(final StmtContext<Set<Descendant>, ?, ?> unique,
+                final Map<Prerequisite<StmtContext<?, ?, ?>>, Descendant> prereqs) {
+            this.unique = requireNonNull(unique);
+            this.prereqs = requireNonNull(prereqs);
+
+        }
+
+        @Override
+        public void apply(final InferenceContext ctx) {
+            // All prerequisites have resolved, so now check each ...
+            for (var entry : prereqs.entrySet()) {
+                final var stmt = entry.getKey().resolve(ctx);
+                // ... and if it is not a leaf, report an error
+                SourceException.throwIf(!stmt.producesEffective(LeafEffectiveStatement.class),
+                    unique, "Path %s resolved to non-leaf %s", stmt.publicDefinition().getStatementName());
+            }
+        }
+
+        @Override
+        public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
+            // Report failed descandants
+            final var inv = ImmutableBiMap.copyOf(prereqs);
+            throw new SourceException(unique,
+                "Following components of unique statement argument refer to non-existent nodes: %s",
+                failed.stream().map(inv::get).filter(Objects::nonNull).collect(ImmutableSet.toImmutableSet()));
+        }
+    }
 }