parser/yang-parser-rfc7950/src/test/java/org/opendaylight/yangtools/yang/stmt/YangParserWithContextTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. 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.yang.stmt;
   9
  10 import static org.junit.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertFalse;
  12 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
  13 import static org.junit.jupiter.api.Assertions.assertNotEquals;
  14 import static org.junit.jupiter.api.Assertions.assertNotNull;
  15 import static org.junit.jupiter.api.Assertions.assertSame;
  16 import static org.junit.jupiter.api.Assertions.assertTrue;
  17 import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;
  18
  19 import com.google.common.collect.Iterables;
  20 import java.util.List;
  21 import java.util.Optional;
  22 import org.junit.jupiter.api.Test;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.Revision;
  25 import org.opendaylight.yangtools.yang.common.Uint8;
  26 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  27 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.DeviateKind;
  31 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Descendant;
  37 import org.opendaylight.yangtools.yang.model.api.stmt.UnrecognizedStatement;
  38 import org.opendaylight.yangtools.yang.model.api.type.Uint16TypeDefinition;
  39 import org.opendaylight.yangtools.yang.model.api.type.Uint8TypeDefinition;
  40 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  41 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  42
  43 class YangParserWithContextTest {
  44     private static final XMLNamespace T1_NS = XMLNamespace.of("urn:simple.demo.test1");
  45     private static final XMLNamespace T2_NS = XMLNamespace.of("urn:simple.demo.test2");
  46     private static final XMLNamespace T3_NS = XMLNamespace.of("urn:simple.demo.test3");
  47     private static final Revision REV = Revision.of("2013-06-18");
  48
  49     private static final StatementStreamSource BAR = sourceForResource("/model/bar.yang");
  50     private static final StatementStreamSource BAZ = sourceForResource("/model/baz.yang");
  51     private static final StatementStreamSource FOO = sourceForResource("/model/foo.yang");
  52     private static final StatementStreamSource SUBFOO = sourceForResource("/model/subfoo.yang");
  53
  54     private static final StatementStreamSource[] IETF = new StatementStreamSource[]{
  55         sourceForResource("/ietf/iana-afn-safi@2012-06-04.yang"),
  56         sourceForResource("/ietf/iana-if-type@2012-06-05.yang"),
  57         sourceForResource("/ietf/iana-timezones@2012-07-09.yang"),
  58         sourceForResource("/ietf/ietf-inet-types@2010-09-24.yang"),
  59         sourceForResource("/ietf/ietf-yang-types@2010-09-24.yang"),
  60         sourceForResource("/ietf/network-topology@2013-07-12.yang"),
  61         sourceForResource("/ietf/network-topology@2013-10-21.yang")};
  62
  63     @Test
  64     void testTypeFromContext() throws Exception {
  65         final var context = RFC7950Reactors.defaultReactor().newBuild()
  66             .addSources(IETF)
  67             .addSource(sourceForResource("/types/custom-types-test@2012-04-04.yang"))
  68             .addSource(sourceForResource("/context-test/test1.yang"))
  69             .buildEffective();
  70
  71         final var module = context.findModule("test1", Revision.of("2013-06-18")).orElseThrow();
  72         final var leaf = assertInstanceOf(LeafSchemaNode.class,
  73             module.getDataChildByName(QName.create(module.getQNameModule(), "id")));
  74
  75         final var leafType = assertInstanceOf(Uint16TypeDefinition.class, leaf.getType());
  76         QName qname = leafType.getQName();
  77         assertEquals(XMLNamespace.of("urn:simple.demo.test1"), qname.getNamespace());
  78         assertEquals(Revision.ofNullable("2013-06-18"), qname.getRevision());
  79         assertEquals("port-number", qname.getLocalName());
  80
  81         final var leafBaseType = leafType.getBaseType();
  82         qname = leafBaseType.getQName();
  83         assertEquals(XMLNamespace.of("urn:ietf:params:xml:ns:yang:ietf-inet-types"), qname.getNamespace());
  84         assertEquals(Revision.ofNullable("2010-09-24"), qname.getRevision());
  85         assertEquals("port-number", qname.getLocalName());
  86
  87         final var dscpExt = assertInstanceOf(Uint8TypeDefinition.class,
  88             TestUtils.findTypedef(module.getTypeDefinitions(), "dscp-ext"));
  89         final var ranges = dscpExt.getRangeConstraint().orElseThrow().getAllowedRanges().asRanges();
  90         assertEquals(1, ranges.size());
  91         final var range = ranges.iterator().next();
  92         assertEquals(Uint8.ZERO, range.lowerEndpoint());
  93         assertEquals(Uint8.valueOf(63), range.upperEndpoint());
  94     }
  95
  96     @Test
  97     void testUsesFromContext() throws Exception {
  98         final var context = RFC7950Reactors.defaultReactor().newBuild()
  99             .addSources(BAZ, FOO, BAR, SUBFOO, sourceForResource("/context-test/test2.yang"))
 100             .buildEffective();
 101
 102         final var testModule = context.findModule("test2", Revision.of("2013-06-18")).orElseThrow();
 103         final var contextModule = context.findModules(XMLNamespace.of("urn:opendaylight.baz")).iterator().next();
 104         assertNotNull(contextModule);
 105         final var groupings = contextModule.getGroupings();
 106         assertEquals(1, groupings.size());
 107         final var grouping = groupings.iterator().next();
 108
 109         // get node containing uses
 110         final var peer = assertInstanceOf(ContainerSchemaNode.class,
 111             testModule.dataChildByName(QName.create(testModule.getQNameModule(), "peer")));
 112         final var destination = assertInstanceOf(ContainerSchemaNode.class,
 113             peer.dataChildByName(QName.create(testModule.getQNameModule(), "destination")));
 114
 115         // check uses
 116         final var uses = destination.getUses();
 117         assertEquals(1, uses.size());
 118
 119         // check uses process
 120         final var data_u = assertInstanceOf(AnyxmlSchemaNode.class,
 121             destination.dataChildByName(QName.create(testModule.getQNameModule(), "data")));
 122         assertTrue(data_u.isAddedByUses());
 123
 124         final var data_g = assertInstanceOf(AnyxmlSchemaNode.class,
 125             grouping.dataChildByName(QName.create(contextModule.getQNameModule(), "data")));
 126         assertFalse(data_g.isAddedByUses());
 127         assertNotEquals(data_u, data_g);
 128
 129         final var how_u = assertInstanceOf(ChoiceSchemaNode.class,
 130             destination.dataChildByName(QName.create(testModule.getQNameModule(), "how")));
 131         assertTrue(how_u.isAddedByUses());
 132
 133         final var how_g = assertInstanceOf(ChoiceSchemaNode.class,
 134             grouping.dataChildByName(QName.create(contextModule.getQNameModule(), "how")));
 135         assertFalse(how_g.isAddedByUses());
 136         assertNotEquals(how_u, how_g);
 137
 138         final var address_u = assertInstanceOf(LeafSchemaNode.class,
 139             destination.dataChildByName(QName.create(testModule.getQNameModule(), "address")));
 140         assertTrue(address_u.isAddedByUses());
 141
 142         final var address_g = assertInstanceOf(LeafSchemaNode.class,
 143             grouping.dataChildByName(QName.create(contextModule.getQNameModule(), "address")));
 144         assertFalse(address_g.isAddedByUses());
 145         assertNotEquals(address_u, address_g);
 146
 147         final var port_u = assertInstanceOf(ContainerSchemaNode.class,
 148             destination.dataChildByName(QName.create(testModule.getQNameModule(), "port")));
 149         assertTrue(port_u.isAddedByUses());
 150
 151         final var port_g = assertInstanceOf(ContainerSchemaNode.class,
 152             grouping.dataChildByName(QName.create(contextModule.getQNameModule(), "port")));
 153         assertNotNull(port_g);
 154         assertFalse(port_g.isAddedByUses());
 155         assertNotEquals(port_u, port_g);
 156
 157         final var addresses_u = assertInstanceOf(ListSchemaNode.class,
 158             destination.dataChildByName(QName.create(testModule.getQNameModule(), "addresses")));
 159         assertNotNull(addresses_u);
 160         assertTrue(addresses_u.isAddedByUses());
 161
 162         final var addresses_g = assertInstanceOf(ListSchemaNode.class,
 163             grouping.dataChildByName(QName.create(contextModule.getQNameModule(), "addresses")));
 164         assertNotNull(addresses_g);
 165         assertFalse(addresses_g.isAddedByUses());
 166         assertNotEquals(addresses_u, addresses_g);
 167
 168         // grouping defined by 'uses'
 169         final var groupings_u = destination.getGroupings();
 170         assertEquals(0, groupings_u.size());
 171
 172         // grouping defined in 'grouping' node
 173         final var groupings_g = grouping.getGroupings();
 174         assertEquals(1, groupings_g.size());
 175         final var grouping_g = groupings_g.iterator().next();
 176         assertFalse(grouping_g.isAddedByUses());
 177     }
 178
 179     @Test
 180     void testUsesRefineFromContext() throws Exception {
 181         final var context = RFC7950Reactors.defaultReactor().newBuild()
 182             .addSources(BAZ, FOO, BAR, SUBFOO, sourceForResource("/context-test/test2.yang"))
 183             .buildEffective();
 184
 185         final var module = context.findModule("test2", Revision.of("2013-06-18")).orElseThrow();
 186         final var peer = assertInstanceOf(ContainerSchemaNode.class,
 187             module.dataChildByName(QName.create(module.getQNameModule(), "peer")));
 188         final var destination = assertInstanceOf(ContainerSchemaNode.class,
 189             peer.dataChildByName(QName.create(module.getQNameModule(), "destination")));
 190         final var usesNodes = destination.getUses();
 191         assertEquals(1, usesNodes.size());
 192         final UsesNode usesNode = usesNodes.iterator().next();
 193
 194         // test grouping path
 195         assertEquals(QName.create(XMLNamespace.of("urn:opendaylight.baz"), Revision.of("2013-02-27"), "target"),
 196             usesNode.getSourceGrouping().getQName());
 197
 198         // test refine
 199         final var refines = usesNode.getRefines();
 200         assertEquals(List.of(
 201             Descendant.of(QName.create(T2_NS, REV, "address")),
 202             Descendant.of(QName.create(T2_NS, REV, "port")),
 203             Descendant.of(QName.create(T2_NS, REV, "addresses"))),
 204             List.copyOf(refines));
 205
 206         // leaf address
 207         final var refineLeaf = assertInstanceOf(LeafSchemaNode.class,
 208             destination.dataChildByName(QName.create(T2_NS, REV, "address")));
 209         assertEquals(Optional.of("description of address defined by refine"), refineLeaf.getDescription());
 210         assertEquals(Optional.of("address reference added by refine"), refineLeaf.getReference());
 211         assertEquals(Optional.of(Boolean.FALSE), refineLeaf.effectiveConfig());
 212         assertTrue(refineLeaf.isMandatory());
 213         final var leafMustConstraints = refineLeaf.getMustConstraints();
 214         assertEquals(1, leafMustConstraints.size());
 215         final var leafMust = leafMustConstraints.iterator().next();
 216         assertEquals("ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)", leafMust.getXpath().toString());
 217
 218         // container port
 219         final var refineContainer = assertInstanceOf(ContainerSchemaNode.class,
 220             destination.dataChildByName(QName.create(T2_NS, REV, "port")));
 221         final var mustConstraints = refineContainer.getMustConstraints();
 222         assertTrue(mustConstraints.isEmpty());
 223         assertEquals(Optional.of("description of port defined by refine"), refineContainer.getDescription());
 224         assertEquals(Optional.of("port reference added by refine"), refineContainer.getReference());
 225         assertEquals(Optional.of(Boolean.FALSE), refineContainer.effectiveConfig());
 226         assertTrue(refineContainer.isPresenceContainer());
 227
 228         // list addresses
 229         final var refineList = assertInstanceOf(ListSchemaNode.class,
 230             destination.dataChildByName(QName.create(T2_NS, REV, "addresses")));
 231         assertEquals(Optional.of("description of addresses defined by refine"), refineList.getDescription());
 232         assertEquals(Optional.of("addresses reference added by refine"), refineList.getReference());
 233         assertEquals(Optional.of(Boolean.FALSE), refineList.effectiveConfig());
 234         final var constraint = refineList.getElementCountConstraint().orElseThrow();
 235         assertEquals(2, constraint.getMinElements());
 236         assertEquals(12, constraint.getMaxElements());
 237     }
 238
 239     @Test
 240     void testIdentity() throws Exception {
 241         final var context = RFC7950Reactors.defaultReactor().newBuild()
 242             .addSources(IETF)
 243             .addSource(sourceForResource("/types/custom-types-test@2012-04-04.yang"))
 244             .addSource(sourceForResource("/context-test/test3.yang"))
 245             .buildEffective();
 246
 247         final var module = context.findModule("test3", Revision.of("2013-06-18")).orElseThrow();
 248         final var identities = module.getIdentities();
 249         assertEquals(1, identities.size());
 250
 251         final var identity = identities.iterator().next();
 252         final QName idQName = identity.getQName();
 253         assertEquals(XMLNamespace.of("urn:simple.demo.test3"), idQName.getNamespace());
 254         assertEquals(Revision.ofNullable("2013-06-18"), idQName.getRevision());
 255         assertEquals("pt", idQName.getLocalName());
 256
 257         final var baseIdentity = Iterables.getOnlyElement(identity.getBaseIdentities());
 258         final QName idBaseQName = baseIdentity.getQName();
 259         assertEquals(XMLNamespace.of("urn:custom.types.demo"), idBaseQName.getNamespace());
 260         assertEquals(Revision.ofNullable("2012-04-16"), idBaseQName.getRevision());
 261         assertEquals("service-type", idBaseQName.getLocalName());
 262     }
 263
 264     @Test
 265     void testUnknownNodes() throws Exception {
 266         final var context = RFC7950Reactors.defaultReactor().newBuild()
 267             .addSources(IETF)
 268             .addSource(sourceForResource("/types/custom-types-test@2012-04-04.yang"))
 269             .addSource(sourceForResource("/context-test/test3.yang"))
 270             .buildEffective();
 271
 272         final var module = context.findModule("test3", Revision.of("2013-06-18")).orElseThrow();
 273         final var network = assertInstanceOf(ContainerSchemaNode.class,
 274             module.dataChildByName(QName.create(module.getQNameModule(), "network")))
 275             .asEffectiveStatement().getDeclared();
 276         final var unknownNodes = network.declaredSubstatements(UnrecognizedStatement.class);
 277         assertEquals(1, unknownNodes.size());
 278
 279         final var un = unknownNodes.iterator().next();
 280         final QName unType = un.statementDefinition().getStatementName();
 281         assertEquals(XMLNamespace.of("urn:custom.types.demo"), unType.getNamespace());
 282         assertEquals(Revision.ofNullable("2012-04-16"), unType.getRevision());
 283         assertEquals("mountpoint", unType.getLocalName());
 284         assertEquals("point", un.argument());
 285     }
 286
 287     @Test
 288     void testAugment() throws Exception {
 289         final var t4 = TestUtils.parseYangSource(
 290             "/context-augment-test/test1.yang", "/context-augment-test/test2.yang",
 291             "/context-augment-test/test3.yang", "/context-augment-test/test4.yang")
 292             .findModules("test4").iterator().next();
 293         final var interfaces = assertInstanceOf(ContainerSchemaNode.class,
 294             t4.dataChildByName(QName.create(t4.getQNameModule(), "interfaces")));
 295         final var ifEntry = assertInstanceOf(ListSchemaNode.class,
 296             interfaces.dataChildByName(QName.create(t4.getQNameModule(), "ifEntry")));
 297
 298         // test augmentation process
 299         final var augmentHolder = assertInstanceOf(ContainerSchemaNode.class,
 300             ifEntry.dataChildByName(QName.create(T3_NS, REV, "augment-holder")));
 301         assertInstanceOf(LeafSchemaNode.class,
 302             augmentHolder.dataChildByName(QName.create(T2_NS, REV, "ds0ChannelNumber")));
 303         assertInstanceOf(LeafSchemaNode.class, augmentHolder.dataChildByName(QName.create(T2_NS, REV, "interface-id")));
 304         assertInstanceOf(LeafListSchemaNode.class,
 305             augmentHolder.dataChildByName(QName.create(T2_NS, REV, "higher-layer-if")));
 306         final var schemas = assertInstanceOf(ContainerSchemaNode.class,
 307             augmentHolder.dataChildByName(QName.create(T2_NS, REV, "schemas")));
 308         assertInstanceOf(LeafSchemaNode.class, schemas.dataChildByName(QName.create(T1_NS, REV, "id")));
 309
 310         // test augment target after augmentation: check if it is same instance
 311         final var ifEntryAfterAugment = assertInstanceOf(ListSchemaNode.class,
 312             interfaces.dataChildByName(QName.create(t4.getQNameModule(), "ifEntry")));
 313         assertSame(ifEntry, ifEntryAfterAugment);
 314     }
 315
 316     @Test
 317     void testDeviation() throws Exception {
 318         final var context = RFC7950Reactors.defaultReactor().newBuild()
 319             .addSource(sourceForResource("/model/bar.yang"))
 320             .addSource(sourceForResource("/context-test/deviation-test.yang"))
 321             .buildEffective();
 322
 323         final var testModule = context.findModule("deviation-test", Revision.of("2013-02-27")).orElseThrow();
 324         final var deviations = testModule.getDeviations();
 325         assertEquals(1, deviations.size());
 326         final var dev = deviations.iterator().next();
 327
 328         assertEquals(Optional.of("system/user ref"), dev.getReference());
 329
 330         final var expectedNS = XMLNamespace.of("urn:opendaylight.bar");
 331         final var expectedRev = Revision.of("2013-07-03");
 332
 333         assertEquals(
 334             Absolute.of(
 335                 QName.create(expectedNS, expectedRev, "interfaces"),
 336                 QName.create(expectedNS, expectedRev, "ifEntry")),
 337             dev.getTargetPath());
 338         assertEquals(DeviateKind.ADD, dev.getDeviates().iterator().next().getDeviateType());
 339     }
 340 }