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

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