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