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
  17 import com.google.common.collect.ImmutableSet;
  18 import java.util.Collection;
  19 import java.util.Optional;
  20 import org.junit.Test;
  21 import org.opendaylight.yangtools.rfc8040.model.api.YangDataSchemaNode;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.common.QNameModule;
  24 import org.opendaylight.yangtools.yang.common.Revision;
  25 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  26 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ExtensionDefinition;
  29 import org.opendaylight.yangtools.yang.model.api.Module;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  31 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.InvalidSubstatementException;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.MissingSubstatementException;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  35 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  36 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.BuildAction;
  37
  38 public class YangDataExtensionTest extends AbstractYangDataTest {
  39
  40     private static final StatementStreamSource FOO_MODULE = sourceForResource(
  41             "/yang-data-extension-test/foo.yang");
  42     private static final StatementStreamSource FOO_INVALID_1_MODULE = sourceForResource(
  43             "/yang-data-extension-test/foo-invalid-1.yang");
  44     private static final StatementStreamSource FOO_INVALID_2_MODULE = sourceForResource(
  45             "/yang-data-extension-test/foo-invalid-2.yang");
  46     private static final StatementStreamSource FOO_INVALID_3_MODULE = sourceForResource(
  47             "/yang-data-extension-test/foo-invalid-3.yang");
  48     private static final StatementStreamSource BAR_MODULE = sourceForResource(
  49             "/yang-data-extension-test/bar.yang");
  50     private static final StatementStreamSource BAZ_MODULE = sourceForResource(
  51             "/yang-data-extension-test/baz.yang");
  52     private static final StatementStreamSource FOOBAR_MODULE = sourceForResource(
  53             "/yang-data-extension-test/foobar.yang");
  54
  55     private static final Revision REVISION = Revision.of("2017-06-01");
  56     private static final QNameModule FOO_QNAMEMODULE = QNameModule.create(XMLNamespace.of("foo"), REVISION);
  57
  58     @Test
  59     public void testYangData() throws Exception {
  60         final SchemaContext schemaContext = REACTOR.newBuild().addSources(FOO_MODULE, IETF_RESTCONF_MODULE)
  61                 .buildEffective();
  62         assertNotNull(schemaContext);
  63
  64         final Collection<? extends ExtensionDefinition> extensions = schemaContext.getExtensions();
  65         assertEquals(1, extensions.size());
  66
  67         final Module foo = schemaContext.findModule(FOO_QNAMEMODULE).get();
  68         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = foo.getUnknownSchemaNodes();
  69         assertEquals(2, unknownSchemaNodes.size());
  70
  71         YangDataSchemaNode myYangDataANode = null;
  72         YangDataSchemaNode myYangDataBNode = null;
  73         for (final UnknownSchemaNode unknownSchemaNode : unknownSchemaNodes) {
  74             assertThat(unknownSchemaNode, instanceOf(YangDataSchemaNode.class));
  75             final YangDataSchemaNode yangDataSchemaNode = (YangDataSchemaNode) unknownSchemaNode;
  76             if ("my-yang-data-a".equals(yangDataSchemaNode.getNodeParameter())) {
  77                 myYangDataANode = yangDataSchemaNode;
  78             } else if ("my-yang-data-b".equals(yangDataSchemaNode.getNodeParameter())) {
  79                 myYangDataBNode = yangDataSchemaNode;
  80             }
  81         }
  82
  83         assertNotNull(myYangDataANode);
  84         assertNotNull(myYangDataBNode);
  85     }
  86
  87     @Test
  88     public void testConfigStatementBeingIgnoredInYangDataBody() throws Exception {
  89         final SchemaContext schemaContext = REACTOR.newBuild().addSources(BAZ_MODULE, IETF_RESTCONF_MODULE)
  90                 .buildEffective();
  91         assertNotNull(schemaContext);
  92
  93         final Module baz = schemaContext.findModule("baz", REVISION).get();
  94         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = baz.getUnknownSchemaNodes();
  95         assertEquals(1, unknownSchemaNodes.size());
  96
  97         final UnknownSchemaNode unknownSchemaNode = unknownSchemaNodes.iterator().next();
  98         assertThat(unknownSchemaNode, instanceOf(YangDataSchemaNode.class));
  99         final YangDataSchemaNode myYangDataNode = (YangDataSchemaNode) unknownSchemaNode;
 100         assertNotNull(myYangDataNode);
 101
 102         final Collection<? extends DataSchemaNode> yangDataChildren = myYangDataNode.getChildNodes();
 103         assertEquals(1, yangDataChildren.size());
 104
 105         final DataSchemaNode childInYangData = yangDataChildren.iterator().next();
 106         assertThat(childInYangData, instanceOf(ContainerSchemaNode.class));
 107         final ContainerSchemaNode contInYangData = (ContainerSchemaNode) childInYangData;
 108         assertEquals(Optional.empty(), contInYangData.effectiveConfig());
 109         final ContainerSchemaNode innerCont = (ContainerSchemaNode) contInYangData.getDataChildByName(
 110                 QName.create(baz.getQNameModule(), "inner-cont"));
 111         assertNotNull(innerCont);
 112         assertEquals(Optional.empty(), innerCont.effectiveConfig());
 113         final ContainerSchemaNode grpCont = (ContainerSchemaNode) contInYangData.getDataChildByName(
 114                 QName.create(baz.getQNameModule(), "grp-cont"));
 115         assertNotNull(grpCont);
 116         assertEquals(Optional.empty(), grpCont.effectiveConfig());
 117     }
 118
 119     @Test
 120     public void testIfFeatureStatementBeingIgnoredInYangDataBody() throws Exception {
 121         final SchemaContext schemaContext = REACTOR.newBuild().setSupportedFeatures(ImmutableSet.of())
 122                 .addSources(FOOBAR_MODULE, IETF_RESTCONF_MODULE).buildEffective();
 123         assertNotNull(schemaContext);
 124
 125         final Module foobar = schemaContext.findModule("foobar", REVISION).get();
 126         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = foobar.getUnknownSchemaNodes();
 127         assertEquals(1, unknownSchemaNodes.size());
 128
 129         final UnknownSchemaNode unknownSchemaNode = unknownSchemaNodes.iterator().next();
 130         assertThat(unknownSchemaNode, instanceOf(YangDataSchemaNode.class));
 131         final YangDataSchemaNode myYangDataNode = (YangDataSchemaNode) unknownSchemaNode;
 132         assertNotNull(myYangDataNode);
 133
 134         final Collection<? extends DataSchemaNode> yangDataChildren = myYangDataNode.getChildNodes();
 135         assertEquals(1, yangDataChildren.size());
 136
 137         final DataSchemaNode childInYangData = yangDataChildren.iterator().next();
 138         assertThat(childInYangData, instanceOf(ContainerSchemaNode.class));
 139         final ContainerSchemaNode contInYangData = (ContainerSchemaNode) childInYangData;
 140         final ContainerSchemaNode innerCont = (ContainerSchemaNode) contInYangData.getDataChildByName(
 141                 QName.create(foobar.getQNameModule(), "inner-cont"));
 142         assertNotNull(innerCont);
 143         final ContainerSchemaNode grpCont = (ContainerSchemaNode) contInYangData.getDataChildByName(
 144                 QName.create(foobar.getQNameModule(), "grp-cont"));
 145         assertNotNull(grpCont);
 146     }
 147
 148     @Test
 149     public void testYangDataBeingIgnored() throws Exception {
 150         // yang-data statement is ignored if it does not appear as a top-level statement
 151         // i.e., it will not appear in the final SchemaContext
 152         final SchemaContext schemaContext = REACTOR.newBuild().addSources(BAR_MODULE, IETF_RESTCONF_MODULE)
 153                 .buildEffective();
 154         assertNotNull(schemaContext);
 155
 156         final Module bar = schemaContext.findModule("bar", REVISION).get();
 157         final ContainerSchemaNode cont = (ContainerSchemaNode) bar.getDataChildByName(
 158                 QName.create(bar.getQNameModule(), "cont"));
 159         assertNotNull(cont);
 160
 161         final Collection<? extends ExtensionDefinition> extensions = schemaContext.getExtensions();
 162         assertEquals(1, extensions.size());
 163
 164         final Collection<? extends UnknownSchemaNode> unknownSchemaNodes = cont.getUnknownSchemaNodes();
 165         assertEquals(0, unknownSchemaNodes.size());
 166     }
 167
 168     @Test
 169     public void testYangDataWithMissingTopLevelContainer() {
 170         final BuildAction build = REACTOR.newBuild().addSources(FOO_INVALID_1_MODULE, IETF_RESTCONF_MODULE);
 171         final ReactorException ex = assertThrows(ReactorException.class, () -> build.buildEffective());
 172         final Throwable cause = ex.getCause();
 173         assertThat(cause, instanceOf(MissingSubstatementException.class));
 174         assertThat(cause.getMessage(), startsWith("yang-data requires at least one substatement [at "));
 175     }
 176
 177     @Test
 178     public void testYangDataWithTwoTopLevelContainers() {
 179         final BuildAction build = REACTOR.newBuild().addSources(FOO_INVALID_2_MODULE, IETF_RESTCONF_MODULE);
 180         final ReactorException ex = assertThrows(ReactorException.class, () -> build.buildEffective());
 181         final Throwable cause = ex.getCause();
 182         assertThat(cause, instanceOf(InvalidSubstatementException.class));
 183         assertThat(cause.getMessage(),
 184             startsWith("yang-data requires exactly one container data node definition, found ["));
 185     }
 186 }