yang/yang-parser-impl/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.Assert.assertEquals;
  11 import static org.junit.Assert.assertFalse;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;
  15
  16 import com.google.common.collect.Iterables;
  17 import com.google.common.collect.Range;
  18 import java.net.URI;
  19 import java.util.ArrayList;
  20 import java.util.Collection;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Optional;
  24 import java.util.Set;
  25 import org.junit.Test;
  26 import org.opendaylight.yangtools.yang.common.QName;
  27 import org.opendaylight.yangtools.yang.common.Revision;
  28 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.DeviateKind;
  33 import org.opendaylight.yangtools.yang.model.api.Deviation;
  34 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  35 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.Module;
  39 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  41 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  43 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  44 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  45 import org.opendaylight.yangtools.yang.model.api.type.Uint16TypeDefinition;
  46 import org.opendaylight.yangtools.yang.model.api.type.Uint8TypeDefinition;
  47 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
  48 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  49 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.YangInferencePipeline;
  50
  51 public class YangParserWithContextTest {
  52     private static final URI T1_NS = URI.create("urn:simple.demo.test1");
  53     private static final URI T2_NS = URI.create("urn:simple.demo.test2");
  54     private static final URI T3_NS = URI.create("urn:simple.demo.test3");
  55     private static final Revision REV = Revision.of("2013-06-18");
  56
  57     private static final StatementStreamSource BAR = sourceForResource("/model/bar.yang");
  58     private static final StatementStreamSource BAZ = sourceForResource("/model/baz.yang");
  59     private static final StatementStreamSource FOO = sourceForResource("/model/foo.yang");
  60     private static final StatementStreamSource SUBFOO = sourceForResource("/model/subfoo.yang");
  61
  62     private static final StatementStreamSource[] IETF = new StatementStreamSource[] {
  63             sourceForResource("/ietf/iana-afn-safi@2012-06-04.yang"),
  64             sourceForResource("/ietf/iana-if-type@2012-06-05.yang"),
  65             sourceForResource("/ietf/iana-timezones@2012-07-09.yang"),
  66             sourceForResource("/ietf/ietf-inet-types@2010-09-24.yang"),
  67             sourceForResource("/ietf/ietf-yang-types@2010-09-24.yang"),
  68             sourceForResource("/ietf/network-topology@2013-07-12.yang"),
  69             sourceForResource("/ietf/network-topology@2013-10-21.yang") };
  70
  71     @Test
  72     public void testTypeFromContext() throws Exception {
  73
  74         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
  75
  76         final StatementStreamSource types = sourceForResource("/types/custom-types-test@2012-04-04.yang");
  77         final StatementStreamSource test1 = sourceForResource("/context-test/test1.yang");
  78
  79         reactor.addSources(IETF);
  80         reactor.addSources(types, test1);
  81
  82         final SchemaContext context = reactor.buildEffective();
  83
  84         final Module module = context.findModule("test1", Revision.of("2013-06-18")).get();
  85         final LeafSchemaNode leaf = (LeafSchemaNode) module.getDataChildByName(QName.create(module.getQNameModule(),
  86                 "id"));
  87
  88         assertTrue(leaf.getType() instanceof Uint16TypeDefinition);
  89         final Uint16TypeDefinition leafType = (Uint16TypeDefinition) leaf.getType();
  90         QName qname = leafType.getQName();
  91         assertEquals(URI.create("urn:simple.demo.test1"), qname.getNamespace());
  92         assertEquals(Revision.ofNullable("2013-06-18"), qname.getRevision());
  93         assertEquals("port-number", qname.getLocalName());
  94
  95         final Uint16TypeDefinition leafBaseType = leafType.getBaseType();
  96         qname = leafBaseType.getQName();
  97         assertEquals(URI.create("urn:ietf:params:xml:ns:yang:ietf-inet-types"), qname.getNamespace());
  98         assertEquals(Revision.ofNullable("2010-09-24"), qname.getRevision());
  99         assertEquals("port-number", qname.getLocalName());
 100
 101         final Uint8TypeDefinition dscpExt = (Uint8TypeDefinition) TestUtils.findTypedef(module.getTypeDefinitions(),
 102             "dscp-ext");
 103         final Set<? extends Range<?>> ranges = dscpExt.getRangeConstraint().get().getAllowedRanges().asRanges();
 104         assertEquals(1, ranges.size());
 105         final Range<?> range = ranges.iterator().next();
 106         assertEquals((short)0, range.lowerEndpoint());
 107         assertEquals((short)63, range.upperEndpoint());
 108     }
 109
 110     @Test
 111     public void testUsesFromContext() throws Exception {
 112         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
 113
 114         final StatementStreamSource test2 = sourceForResource("/context-test/test2.yang");
 115         reactor.addSources(BAZ, FOO, BAR, SUBFOO, test2);
 116         final SchemaContext context = reactor.buildEffective();
 117
 118         final Module testModule = context.findModule("test2", Revision.of("2013-06-18")).get();
 119         final Module contextModule = context.findModules(URI.create("urn:opendaylight.baz")).iterator().next();
 120         assertNotNull(contextModule);
 121         final Set<GroupingDefinition> groupings = contextModule.getGroupings();
 122         assertEquals(1, groupings.size());
 123         final GroupingDefinition grouping = groupings.iterator().next();
 124
 125         // get node containing uses
 126         final ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName(QName.create(
 127                 testModule.getQNameModule(), "peer"));
 128         final ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName(QName.create(
 129                 testModule.getQNameModule(), "destination"));
 130
 131         // check uses
 132         final Set<UsesNode> uses = destination.getUses();
 133         assertEquals(1, uses.size());
 134
 135         // check uses process
 136         final AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName(QName.create(
 137                 testModule.getQNameModule(), "data"));
 138         assertNotNull(data_u);
 139         assertTrue(data_u.isAddedByUses());
 140
 141         final AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName(QName.create(
 142                 contextModule.getQNameModule(), "data"));
 143         assertNotNull(data_g);
 144         assertFalse(data_g.isAddedByUses());
 145         assertFalse(data_u.equals(data_g));
 146
 147         final ChoiceSchemaNode how_u = (ChoiceSchemaNode) destination.getDataChildByName(QName.create(
 148                 testModule.getQNameModule(), "how"));
 149         assertNotNull(how_u);
 150         assertTrue(how_u.isAddedByUses());
 151
 152         final ChoiceSchemaNode how_g = (ChoiceSchemaNode) grouping.getDataChildByName(QName.create(
 153                 contextModule.getQNameModule(), "how"));
 154         assertNotNull(how_g);
 155         assertFalse(how_g.isAddedByUses());
 156         assertFalse(how_u.equals(how_g));
 157
 158         final LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName(QName.create(
 159                 testModule.getQNameModule(), "address"));
 160         assertNotNull(address_u);
 161         assertTrue(address_u.isAddedByUses());
 162
 163         final LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName(QName.create(
 164                 contextModule.getQNameModule(), "address"));
 165         assertNotNull(address_g);
 166         assertFalse(address_g.isAddedByUses());
 167         assertFalse(address_u.equals(address_g));
 168
 169         final ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName(QName.create(
 170                 testModule.getQNameModule(), "port"));
 171         assertNotNull(port_u);
 172         assertTrue(port_u.isAddedByUses());
 173
 174         final ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName(QName.create(
 175                 contextModule.getQNameModule(), "port"));
 176         assertNotNull(port_g);
 177         assertFalse(port_g.isAddedByUses());
 178         assertFalse(port_u.equals(port_g));
 179
 180         final ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName(QName.create(
 181                 testModule.getQNameModule(), "addresses"));
 182         assertNotNull(addresses_u);
 183         assertTrue(addresses_u.isAddedByUses());
 184
 185         final ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName(QName.create(
 186                 contextModule.getQNameModule(), "addresses"));
 187         assertNotNull(addresses_g);
 188         assertFalse(addresses_g.isAddedByUses());
 189         assertFalse(addresses_u.equals(addresses_g));
 190
 191         // grouping defined by 'uses'
 192         final Set<GroupingDefinition> groupings_u = destination.getGroupings();
 193         assertEquals(1, groupings_u.size());
 194         final GroupingDefinition grouping_u = groupings_u.iterator().next();
 195         assertTrue(grouping_u.isAddedByUses());
 196
 197         // grouping defined in 'grouping' node
 198         final Set<GroupingDefinition> groupings_g = grouping.getGroupings();
 199         assertEquals(1, groupings_g.size());
 200         final GroupingDefinition grouping_g = groupings_g.iterator().next();
 201         assertFalse(grouping_g.isAddedByUses());
 202         assertFalse(grouping_u.equals(grouping_g));
 203
 204         final List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
 205         assertEquals(1, nodes_u.size());
 206         final UnknownSchemaNode node_u = nodes_u.get(0);
 207         assertTrue(node_u.isAddedByUses());
 208
 209         final List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
 210         assertEquals(1, nodes_g.size());
 211         final UnknownSchemaNode node_g = nodes_g.get(0);
 212         assertFalse(node_g.isAddedByUses());
 213         assertFalse(node_u.equals(node_g));
 214     }
 215
 216     @Test
 217     public void testUsesRefineFromContext() throws Exception {
 218
 219         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
 220
 221         final StatementStreamSource test2 = sourceForResource("/context-test/test2.yang");
 222         reactor.addSources(BAZ, FOO, BAR, SUBFOO, test2);
 223         final SchemaContext context = reactor.buildEffective();
 224
 225         final Module module = context.findModule("test2", Revision.of("2013-06-18")).get();
 226         final ContainerSchemaNode peer = (ContainerSchemaNode) module.getDataChildByName(QName.create(
 227                 module.getQNameModule(), "peer"));
 228         final ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName(QName.create(
 229                 module.getQNameModule(), "destination"));
 230         final Set<UsesNode> usesNodes = destination.getUses();
 231         assertEquals(1, usesNodes.size());
 232         final UsesNode usesNode = usesNodes.iterator().next();
 233
 234         // test grouping path
 235         final List<QName> path = new ArrayList<>();
 236         final QName qname = QName.create(URI.create("urn:opendaylight.baz"), Revision.of("2013-02-27"), "target");
 237         path.add(qname);
 238         final SchemaPath expectedPath = SchemaPath.create(path, true);
 239         assertEquals(expectedPath, usesNode.getGroupingPath());
 240
 241         // test refine
 242         final Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
 243         assertEquals(3, refines.size());
 244
 245         LeafSchemaNode refineLeaf = null;
 246         ContainerSchemaNode refineContainer = null;
 247         ListSchemaNode refineList = null;
 248         for (final Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
 249             final SchemaNode value = entry.getValue();
 250             if (value instanceof LeafSchemaNode) {
 251                 refineLeaf = (LeafSchemaNode) value;
 252             } else if (value instanceof ContainerSchemaNode) {
 253                 refineContainer = (ContainerSchemaNode) value;
 254             } else if (value instanceof ListSchemaNode) {
 255                 refineList = (ListSchemaNode) value;
 256             }
 257         }
 258
 259         // leaf address
 260         assertNotNull(refineLeaf);
 261         assertEquals("address", refineLeaf.getQName().getLocalName());
 262         assertEquals(Optional.of("description of address defined by refine"), refineLeaf.getDescription());
 263         assertEquals(Optional.of("address reference added by refine"), refineLeaf.getReference());
 264         assertFalse(refineLeaf.isConfiguration());
 265         assertTrue(refineLeaf.getConstraints().isMandatory());
 266         final Collection<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
 267         assertEquals(1, leafMustConstraints.size());
 268         final MustDefinition leafMust = leafMustConstraints.iterator().next();
 269         assertEquals("ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)", leafMust.toString());
 270
 271         // container port
 272         assertNotNull(refineContainer);
 273         final Collection<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
 274         assertTrue(mustConstraints.isEmpty());
 275         assertEquals(Optional.of("description of port defined by refine"), refineContainer.getDescription());
 276         assertEquals(Optional.of("port reference added by refine"), refineContainer.getReference());
 277         assertFalse(refineContainer.isConfiguration());
 278         assertTrue(refineContainer.isPresenceContainer());
 279
 280         // list addresses
 281         assertNotNull(refineList);
 282         assertEquals(Optional.of("description of addresses defined by refine"), refineList.getDescription());
 283         assertEquals(Optional.of("addresses reference added by refine"), refineList.getReference());
 284         assertFalse(refineList.isConfiguration());
 285         assertEquals(2, (int) refineList.getConstraints().getMinElements());
 286         assertEquals(12, (int) refineList.getConstraints().getMaxElements());
 287     }
 288
 289     @Test
 290     public void testIdentity() throws Exception {
 291
 292         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
 293
 294         final StatementStreamSource types = sourceForResource("/types/custom-types-test@2012-04-04.yang");
 295         final StatementStreamSource test3 = sourceForResource("/context-test/test3.yang");
 296
 297         reactor.addSources(IETF);
 298         reactor.addSources(types, test3);
 299         final SchemaContext context = reactor.buildEffective();
 300
 301         final Module module = context.findModule("test3", Revision.of("2013-06-18")).get();
 302         final Set<IdentitySchemaNode> identities = module.getIdentities();
 303         assertEquals(1, identities.size());
 304
 305         final IdentitySchemaNode identity = identities.iterator().next();
 306         final QName idQName = identity.getQName();
 307         assertEquals(URI.create("urn:simple.demo.test3"), idQName.getNamespace());
 308         assertEquals(Revision.ofNullable("2013-06-18"), idQName.getRevision());
 309         assertEquals("pt", idQName.getLocalName());
 310
 311         final IdentitySchemaNode baseIdentity = Iterables.getOnlyElement(identity.getBaseIdentities());
 312         final QName idBaseQName = baseIdentity.getQName();
 313         assertEquals(URI.create("urn:custom.types.demo"), idBaseQName.getNamespace());
 314         assertEquals(Revision.ofNullable("2012-04-16"), idBaseQName.getRevision());
 315         assertEquals("service-type", idBaseQName.getLocalName());
 316     }
 317
 318     @Test
 319     public void testUnknownNodes() throws Exception {
 320
 321         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
 322
 323         final StatementStreamSource types = sourceForResource("/types/custom-types-test@2012-04-04.yang");
 324         final StatementStreamSource test3 = sourceForResource("/context-test/test3.yang");
 325
 326         reactor.addSources(IETF);
 327         reactor.addSources(types, test3);
 328
 329         final SchemaContext context = reactor.buildEffective();
 330
 331         final Module module = context.findModule("test3", Revision.of("2013-06-18")).get();
 332         final ContainerSchemaNode network = (ContainerSchemaNode) module.getDataChildByName(QName.create(
 333                 module.getQNameModule(), "network"));
 334         final List<UnknownSchemaNode> unknownNodes = network.getUnknownSchemaNodes();
 335         assertEquals(1, unknownNodes.size());
 336
 337         final UnknownSchemaNode un = unknownNodes.get(0);
 338         final QName unType = un.getNodeType();
 339         assertEquals(URI.create("urn:custom.types.demo"), unType.getNamespace());
 340         assertEquals(Revision.ofNullable("2012-04-16"), unType.getRevision());
 341         assertEquals("mountpoint", unType.getLocalName());
 342         assertEquals("point", un.getNodeParameter());
 343         assertNotNull(un.getExtensionDefinition());
 344     }
 345
 346     @Test
 347     public void testAugment() throws Exception {
 348         final StatementStreamSource resource = sourceForResource("/context-augment-test/test4.yang");
 349         final StatementStreamSource test1 = sourceForResource("/context-augment-test/test1.yang");
 350         final StatementStreamSource test2 = sourceForResource("/context-augment-test/test2.yang");
 351         final StatementStreamSource test3 = sourceForResource("/context-augment-test/test3.yang");
 352
 353         final SchemaContext context = TestUtils.parseYangSources(resource, test1, test2, test3);
 354         final Module t4 = TestUtils.findModule(context, "test4").get();
 355         final ContainerSchemaNode interfaces = (ContainerSchemaNode) t4.getDataChildByName(QName.create(
 356                 t4.getQNameModule(), "interfaces"));
 357         final ListSchemaNode ifEntry = (ListSchemaNode) interfaces.getDataChildByName(QName.create(t4.getQNameModule(),
 358                 "ifEntry"));
 359
 360         // test augmentation process
 361         final ContainerSchemaNode augmentHolder = (ContainerSchemaNode) ifEntry.getDataChildByName(QName.create(T3_NS,
 362                 REV, "augment-holder"));
 363         assertNotNull(augmentHolder);
 364         final DataSchemaNode ds0 = augmentHolder.getDataChildByName(QName.create(T2_NS, REV, "ds0ChannelNumber"));
 365         assertNotNull(ds0);
 366         final DataSchemaNode interfaceId = augmentHolder.getDataChildByName(QName.create(T2_NS, REV, "interface-id"));
 367         assertNotNull(interfaceId);
 368         final DataSchemaNode higherLayerIf = augmentHolder.getDataChildByName(QName.create(T2_NS, REV,
 369                 "higher-layer-if"));
 370         assertNotNull(higherLayerIf);
 371         final ContainerSchemaNode schemas = (ContainerSchemaNode) augmentHolder.getDataChildByName(QName.create(T2_NS,
 372                 REV, "schemas"));
 373         assertNotNull(schemas);
 374         assertNotNull(schemas.getDataChildByName(QName.create(T1_NS, REV, "id")));
 375
 376         // test augment target after augmentation: check if it is same instance
 377         final ListSchemaNode ifEntryAfterAugment = (ListSchemaNode) interfaces.getDataChildByName(QName.create(
 378                 t4.getQNameModule(), "ifEntry"));
 379         assertTrue(ifEntry == ifEntryAfterAugment);
 380     }
 381
 382     @Test
 383     public void testDeviation() throws Exception {
 384
 385         final CrossSourceStatementReactor.BuildAction reactor = YangInferencePipeline.RFC6020_REACTOR.newBuild();
 386
 387         final StatementStreamSource bar = sourceForResource("/model/bar.yang");
 388         final StatementStreamSource deviationTest = sourceForResource("/context-test/deviation-test.yang");
 389
 390         reactor.addSources(bar, deviationTest);
 391         final SchemaContext context = reactor.buildEffective();
 392
 393         final Module testModule = context.findModule("deviation-test", Revision.of("2013-02-27")).get();
 394         final Set<Deviation> deviations = testModule.getDeviations();
 395         assertEquals(1, deviations.size());
 396         final Deviation dev = deviations.iterator().next();
 397
 398         assertEquals(Optional.of("system/user ref"), dev.getReference());
 399
 400         final URI expectedNS = URI.create("urn:opendaylight.bar");
 401         final Revision expectedRev = Revision.of("2013-07-03");
 402         final List<QName> path = new ArrayList<>();
 403         path.add(QName.create(expectedNS, expectedRev, "interfaces"));
 404         path.add(QName.create(expectedNS, expectedRev, "ifEntry"));
 405         final SchemaPath expectedPath = SchemaPath.create(path, true);
 406
 407         assertEquals(expectedPath, dev.getTargetPath());
 408         assertEquals(DeviateKind.ADD, dev.getDeviates().iterator().next().getDeviateType());
 409     }
 410
 411 }