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