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