Fix warnings when we are augmenting-in a list 29/92529/1
authorRobert Varga <robert.varga@pantheon.tech>
Mon, 21 Sep 2020 10:48:07 +0000 (12:48 +0200)
committerRobert Varga <nite@hq.sk>
Mon, 21 Sep 2020 15:20:06 +0000 (15:20 +0000)
When we are targetting a non-configuration list we end up issuing
a warning because the augment content contains the list as well --
and is not suppressed. Add logic to suppress it.

JIRA: YANGTOOLS-1133
Change-Id: I55e43d39949db756634e86e4e570df6bbbce6c1f
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
(cherry picked from commit c6510cf99fff6bd27c1abcc66e78558c9f8df713)

yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/list/AbstractListStatementSupport.java
yang/yang-parser-rfc7950/src/test/java/org/opendaylight/yangtools/yang/stmt/YT1133Test.java [new file with mode: 0644]
yang/yang-parser-rfc7950/src/test/resources/bugs/YT1133/bar.yang [new file with mode: 0644]
yang/yang-parser-rfc7950/src/test/resources/bugs/YT1133/foo.yang [new file with mode: 0644]

index 8d3d913f7efaeb4ed67cd0a28db43e554bf8d0c5..e171463cdd80159bf6cfaf1a4d959018a5766f9d 100644 (file)
@@ -26,6 +26,7 @@ import org.opendaylight.yangtools.yang.model.api.Status;
 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
 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.meta.StatementDefinition;
 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
@@ -139,10 +140,24 @@ abstract class AbstractListStatementSupport extends BaseQNameStatementSupport<Li
     }
 
     private static boolean isInstantied(final StmtContext<?, ?, ?> ctx) {
-        for (StmtContext<?, ?, ?> parent = ctx.getParentContext(); parent != null; parent = parent.getParentContext()) {
-            if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parent.getPublicDefinition())) {
+        StmtContext<?, ?, ?> parent = ctx.getParentContext();
+        while (parent != null) {
+            final StatementDefinition parentDef = parent.getPublicDefinition();
+            if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parentDef)) {
                 return false;
             }
+
+            final StmtContext<?, ?, ?> grandParent = parent.getParentContext();
+            if (YangStmtMapping.AUGMENT == parentDef && grandParent != null) {
+                // If this is an augment statement and its parent is either a 'module' or 'submodule' statement, we are
+                // dealing with an uninstantiated context.
+                final StatementDefinition grandParentDef = grandParent.getPublicDefinition();
+                if (YangStmtMapping.MODULE == grandParentDef || YangStmtMapping.SUBMODULE == grandParentDef) {
+                    return false;
+                }
+            }
+
+            parent = grandParent;
         }
         return true;
     }
diff --git a/yang/yang-parser-rfc7950/src/test/java/org/opendaylight/yangtools/yang/stmt/YT1133Test.java b/yang/yang-parser-rfc7950/src/test/java/org/opendaylight/yangtools/yang/stmt/YT1133Test.java
new file mode 100644 (file)
index 0000000..fcb664a
--- /dev/null
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.stmt;
+
+import static org.hamcrest.CoreMatchers.containsString;
+import static org.hamcrest.CoreMatchers.not;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertEquals;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+import org.junit.Test;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
+
+public class YT1133Test {
+    @Test
+    @SuppressWarnings("checkstyle:regexpSinglelineJava")
+    public void testAugmentKeys() throws Exception {
+        final PrintStream stdout = System.out;
+        final ByteArrayOutputStream output = new ByteArrayOutputStream();
+        final EffectiveModelContext ctx;
+
+        try (PrintStream out = new PrintStream(output, true, StandardCharsets.UTF_8)) {
+            System.setOut(out);
+            ctx = StmtTestUtils.parseYangSources("/bugs/YT1133");
+        } finally {
+            System.setOut(stdout);
+        }
+
+        assertEquals(2, ctx.getModules().size());
+        final String log = output.toString();
+        assertThat(log, not(containsString("Configuration list (bar)values")));
+    }
+}
diff --git a/yang/yang-parser-rfc7950/src/test/resources/bugs/YT1133/bar.yang b/yang/yang-parser-rfc7950/src/test/resources/bugs/YT1133/bar.yang
new file mode 100644 (file)
index 0000000..dbe15ae
--- /dev/null
@@ -0,0 +1,18 @@
+module bar {
+  yang-version 1;
+  namespace "bar";
+  prefix bar;
+
+  import foo {
+    prefix foo;
+  }
+
+  augment "/foo:status" {
+    list values {
+      leaf somevalue {
+        type string;
+      }
+    }
+  }
+}
+
diff --git a/yang/yang-parser-rfc7950/src/test/resources/bugs/YT1133/foo.yang b/yang/yang-parser-rfc7950/src/test/resources/bugs/YT1133/foo.yang
new file mode 100644 (file)
index 0000000..4021ab9
--- /dev/null
@@ -0,0 +1,10 @@
+module foo {
+  yang-version 1;
+  namespace "foo";
+  prefix foo;
+
+  container status {
+    config false;
+  }
+}
+