yang/rfc8040-parser-support/src/test/java/org/opendaylight/yangtools/rfc8040/parser/YangDataExtensionTest.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies s.r.o. and others. All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.rfc8040.parser;
   9
  10 import static org.hamcrest.CoreMatchers.instanceOf;
  11 import static org.hamcrest.CoreMatchers.startsWith;
  12 import static org.hamcrest.MatcherAssert.assertThat;
  13 import static org.junit.Assert.assertEquals;
  14 import static org.junit.Assert.assertNotNull;
  15 import static org.junit.Assert.assertThrows;
  16 import static org.junit.Assert.assertTrue;
  17
  18 import com.google.common.collect.ImmutableSet;
  19 import java.io.IOException;
  20 import java.net.URI;
  21 import java.util.Collection;
  22 import org.junit.AfterClass;
  23 import org.junit.BeforeClass;
  24 import org.junit.Test;
  25 import org.opendaylight.yangtools.rfc8040.model.api.YangDataSchemaNode;
  26 import org.opendaylight.yangtools.yang.common.QName;
  27 import org.opendaylight.yangtools.yang.common.QNameModule;
  28 import org.opendaylight.yangtools.yang.common.Revision;
  29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.Module;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
  35 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  36 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  37 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.YangStatementStreamSource;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.InvalidSubstatementException;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.MissingSubstatementException;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  42 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  43 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  44 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.BuildAction;
  45
  46 public class YangDataExtensionTest {
  47
  48     private static final StatementStreamSource FOO_MODULE = sourceForResource(
  49             "/yang-data-extension-test/foo.yang");
  50     private static final StatementStreamSource FOO_INVALID_1_MODULE = sourceForResource(
  51             "/yang-data-extension-test/foo-invalid-1.yang");
  52     private static final StatementStreamSource FOO_INVALID_2_MODULE = sourceForResource(
  53             "/yang-data-extension-test/foo-invalid-2.yang");
  54     private static final StatementStreamSource FOO_INVALID_3_MODULE = sourceForResource(
  55             "/yang-data-extension-test/foo-invalid-3.yang");
  56     private static final StatementStreamSource BAR_MODULE = sourceForResource(
  57             "/yang-data-extension-test/bar.yang");
  58     private static final StatementStreamSource BAZ_MODULE = sourceForResource(
  59             "/yang-data-extension-test/baz.yang");
  60     private static final StatementStreamSource FOOBAR_MODULE = sourceForResource(
  61             "/yang-data-extension-test/foobar.yang");
  62     private static final StatementStreamSource IETF_RESTCONF_MODULE = sourceForResource(
  63             "/yang-data-extension-test/ietf-restconf.yang");
  64
  65     private static final Revision REVISION = Revision.of("2017-06-01");
  66     private static final QNameModule FOO_QNAMEMODULE = QNameModule.create(URI.create("foo"), REVISION);
  67     private static final QName MY_YANG_DATA_A = QName.create(FOO_QNAMEMODULE, "my-yang-data-a");
  68     private static final QName MY_YANG_DATA_B = QName.create(FOO_QNAMEMODULE, "my-yang-data-b");
  69
  70     private static CrossSourceStatementReactor reactor;
  71
  72     @BeforeClass
  73     public static void createReactor() {
  74         reactor = RFC7950Reactors.vanillaReactorBuilder()
  75                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance())
  76                 .build();
  77     }
  78
  79     @AfterClass
  80     public static void freeReactor() {
  81         reactor = null;
  82     }
  83
  84     @Test
  85     public void testYangData() throws Exception {
  86         final SchemaContext schemaContext = reactor.newBuild().addSources(FOO_MODULE, IETF_RESTCONF_MODULE)
  87                 .buildEffective();
  88         assertNotNull(schemaContext);
  89
  90         final Collection<? extends ExtensionDefinition> extensions = schemaContext.getExtensions();
  91         assertEquals(1, extensions.size());
  92
  93         final Module foo = schemaContext.findModule(FOO_QNAMEMODULE).get();
  94         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = foo.getUnknownSchemaNodes();
  95         assertEquals(2, unknownSchemaNodes.size());
  96
  97         YangDataSchemaNode myYangDataANode = null;
  98         YangDataSchemaNode myYangDataBNode = null;
  99         for (final UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
 100             assertTrue(unknownSchemaNode instanceof YangDataSchemaNode);
 101             final YangDataSchemaNode yangDataSchemaNode = (YangDataSchemaNode) unknownSchemaNode;
 102             if (MY_YANG_DATA_A.equals(yangDataSchemaNode.getQName())) {
 103                 myYangDataANode = yangDataSchemaNode;
 104             } else if (MY_YANG_DATA_B.equals(yangDataSchemaNode.getQName())) {
 105                 myYangDataBNode = yangDataSchemaNode;
 106             }
 107         }
 108
 109         assertNotNull(myYangDataANode);
 110         assertNotNull(myYangDataBNode);
 111
 112         assertNotNull(myYangDataANode.getContainerSchemaNode());
 113         assertNotNull(myYangDataBNode.getContainerSchemaNode());
 114     }
 115
 116     @Test
 117     public void testConfigStatementBeingIgnoredInYangDataBody() throws Exception {
 118         final SchemaContext schemaContext = reactor.newBuild().addSources(BAZ_MODULE, IETF_RESTCONF_MODULE)
 119                 .buildEffective();
 120         assertNotNull(schemaContext);
 121
 122         final Module baz = schemaContext.findModule("baz", REVISION).get();
 123         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = baz.getUnknownSchemaNodes();
 124         assertEquals(1, unknownSchemaNodes.size());
 125
 126         final UnknownSchemaNode unknownSchemaNode = unknownSchemaNodes.iterator().next();
 127         assertTrue(unknownSchemaNode instanceof YangDataSchemaNode);
 128         final YangDataSchemaNode myYangDataNode = (YangDataSchemaNode) unknownSchemaNode;
 129         assertNotNull(myYangDataNode);
 130
 131         final ContainerSchemaNode contInYangData = myYangDataNode.getContainerSchemaNode();
 132         assertNotNull(contInYangData);
 133         assertTrue(contInYangData.isConfiguration());
 134         final ContainerSchemaNode innerCont = (ContainerSchemaNode) contInYangData.findDataChildByName(
 135                 QName.create(baz.getQNameModule(), "inner-cont")).get();
 136         assertNotNull(innerCont);
 137         assertTrue(innerCont.isConfiguration());
 138         final ContainerSchemaNode grpCont = (ContainerSchemaNode) contInYangData.findDataChildByName(
 139                 QName.create(baz.getQNameModule(), "grp-cont")).get();
 140         assertNotNull(grpCont);
 141         assertTrue(grpCont.isConfiguration());
 142     }
 143
 144     @Test
 145     public void testIfFeatureStatementBeingIgnoredInYangDataBody() throws Exception {
 146         final SchemaContext schemaContext = reactor.newBuild().setSupportedFeatures(ImmutableSet.of())
 147                 .addSources(FOOBAR_MODULE, IETF_RESTCONF_MODULE).buildEffective();
 148         assertNotNull(schemaContext);
 149
 150         final Module foobar = schemaContext.findModule("foobar", REVISION).get();
 151         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = foobar.getUnknownSchemaNodes();
 152         assertEquals(1, unknownSchemaNodes.size());
 153
 154         final UnknownSchemaNode unknownSchemaNode = unknownSchemaNodes.iterator().next();
 155         assertTrue(unknownSchemaNode instanceof YangDataSchemaNode);
 156         final YangDataSchemaNode myYangDataNode = (YangDataSchemaNode) unknownSchemaNode;
 157         assertNotNull(myYangDataNode);
 158
 159         final ContainerSchemaNode contInYangData = myYangDataNode.getContainerSchemaNode();
 160         assertNotNull(contInYangData);
 161         final ContainerSchemaNode innerCont = (ContainerSchemaNode) contInYangData.findDataChildByName(
 162                 QName.create(foobar.getQNameModule(), "inner-cont")).get();
 163         assertNotNull(innerCont);
 164         final ContainerSchemaNode grpCont = (ContainerSchemaNode) contInYangData.findDataChildByName(
 165                 QName.create(foobar.getQNameModule(), "grp-cont")).get();
 166         assertNotNull(grpCont);
 167     }
 168
 169     @Test
 170     public void testYangDataBeingIgnored() throws Exception {
 171         // yang-data statement is ignored if it does not appear as a top-level statement
 172         // i.e., it will not appear in the final SchemaContext
 173         final SchemaContext schemaContext = reactor.newBuild().addSources(BAR_MODULE, IETF_RESTCONF_MODULE)
 174                 .buildEffective();
 175         assertNotNull(schemaContext);
 176
 177         final Module bar = schemaContext.findModule("bar", REVISION).get();
 178         final ContainerSchemaNode cont = (ContainerSchemaNode) bar.findDataChildByName(
 179                 QName.create(bar.getQNameModule(), "cont")).get();
 180         assertNotNull(cont);
 181
 182         final Collection<? extends ExtensionDefinition> extensions = schemaContext.getExtensions();
 183         assertEquals(1, extensions.size());
 184
 185         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = cont.getUnknownSchemaNodes();
 186         assertEquals(0, unknownSchemaNodes.size());
 187     }
 188
 189     @Test
 190     public void testYangDataWithMissingTopLevelContainer() {
 191         final BuildAction build = reactor.newBuild().addSources(FOO_INVALID_1_MODULE, IETF_RESTCONF_MODULE);
 192         final ReactorException ex = assertThrows(ReactorException.class, () -> build.buildEffective());
 193         final Throwable cause = ex.getCause();
 194         assertThat(cause, instanceOf(MissingSubstatementException.class));
 195         assertThat(cause.getMessage(), startsWith("YANG_DATA is missing CONTAINER. Minimal count is 1."));
 196     }
 197
 198     @Test
 199     public void testYangDataWithTwoTopLevelContainers() {
 200         final BuildAction build = reactor.newBuild().addSources(FOO_INVALID_2_MODULE, IETF_RESTCONF_MODULE);
 201         final ReactorException ex = assertThrows(ReactorException.class, () -> build.buildEffective());
 202         final Throwable cause = ex.getCause();
 203         assertThat(cause, instanceOf(InvalidSubstatementException.class));
 204         assertTrue(cause.getMessage().startsWith("Maximal count of CONTAINER for YANG_DATA is 1, detected 2."));
 205     }
 206
 207     @Test
 208     public void testYangDataWithInvalidToplevelNode() {
 209         final BuildAction build = reactor.newBuild().addSources(FOO_INVALID_3_MODULE, IETF_RESTCONF_MODULE);
 210         final ReactorException ex = assertThrows(ReactorException.class, () -> build.buildEffective());
 211         final Throwable cause = ex.getCause();
 212         assertThat(cause, instanceOf(InvalidSubstatementException.class));
 213         assertThat(cause.getMessage(), startsWith("LEAF is not valid for YANG_DATA."));
 214     }
 215
 216     private static StatementStreamSource sourceForResource(final String resourceName) {
 217         try {
 218             return YangStatementStreamSource.create(YangTextSchemaSource.forResource(resourceName));
 219         } catch (IOException | YangSyntaxErrorException e) {
 220             throw new IllegalArgumentException("Failed to create source", e);
 221         }
 222     }
 223 }