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