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