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