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