yang/yang-parser-impl/src/test/java/org/opendaylight/yangtools/yang/parser/impl/GroupingTest.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.FileNotFoundException;
  13 import java.net.URI;
  14 import java.text.ParseException;
  15 import java.util.Date;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.Set;
  19
  20 import org.junit.Before;
  21 import org.junit.Test;
  22 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  24 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
  25 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  28 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.Module;
  31 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  34 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.UsesNode;
  36
  37 public class GroupingTest {
  38     private Set<Module> modules;
  39
  40     @Before
  41     public void init() throws FileNotFoundException {
  42         modules = TestUtils.loadModules(getClass().getResource("/model").getPath());
  43         assertEquals(3, modules.size());
  44     }
  45
  46     @Test
  47     public void testRefine() {
  48         Module testModule = TestUtils.findModule(modules, "nodes");
  49
  50         ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
  51         ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
  52         Set<UsesNode> usesNodes = destination.getUses();
  53         assertEquals(1, usesNodes.size());
  54         UsesNode usesNode = usesNodes.iterator().next();
  55         Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
  56         assertEquals(3, refines.size());
  57
  58         LeafSchemaNode refineLeaf = null;
  59         ContainerSchemaNode refineContainer = null;
  60         ListSchemaNode refineList = null;
  61         for (Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
  62             SchemaNode value = entry.getValue();
  63             if (value instanceof LeafSchemaNode) {
  64                 refineLeaf = (LeafSchemaNode) value;
  65             } else if (value instanceof ContainerSchemaNode) {
  66                 refineContainer = (ContainerSchemaNode) value;
  67             } else if (value instanceof ListSchemaNode) {
  68                 refineList = (ListSchemaNode) value;
  69             }
  70         }
  71
  72         // leaf address
  73         assertNotNull(refineLeaf);
  74         assertEquals("address", refineLeaf.getQName().getLocalName());
  75         assertEquals("IP address of target node", refineLeaf.getDescription());
  76         assertEquals("address reference added by refine", refineLeaf.getReference());
  77         assertFalse(refineLeaf.isConfiguration());
  78         assertFalse(refineLeaf.getConstraints().isMandatory());
  79         Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
  80         assertEquals(1, leafMustConstraints.size());
  81         MustDefinition leafMust = leafMustConstraints.iterator().next();
  82         assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
  83
  84         // container port
  85         assertNotNull(refineContainer);
  86         Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
  87         assertTrue(mustConstraints.isEmpty());
  88         assertEquals("description of port defined by refine", refineContainer.getDescription());
  89         assertEquals("port reference added by refine", refineContainer.getReference());
  90         assertFalse(refineContainer.isConfiguration());
  91         assertTrue(refineContainer.isPresenceContainer());
  92
  93         // list addresses
  94         assertNotNull(refineList);
  95         assertEquals("description of addresses defined by refine", refineList.getDescription());
  96         assertEquals("addresses reference added by refine", refineList.getReference());
  97         assertFalse(refineList.isConfiguration());
  98         assertEquals(2, (int) refineList.getConstraints().getMinElements());
  99         assertEquals(12, (int) refineList.getConstraints().getMaxElements());
 100     }
 101
 102     @Test
 103     public void testGrouping() {
 104         Module testModule = TestUtils.findModule(modules, "custom");
 105         Set<GroupingDefinition> groupings = testModule.getGroupings();
 106         assertEquals(1, groupings.size());
 107         GroupingDefinition grouping = groupings.iterator().next();
 108         Set<DataSchemaNode> children = grouping.getChildNodes();
 109         assertEquals(5, children.size());
 110     }
 111
 112     @Test
 113     public void testUses() {
 114         // suffix _u = added by uses
 115         // suffix _g = defined in grouping
 116
 117         Module testModule = TestUtils.findModule(modules, "custom");
 118
 119         // get grouping
 120         Set<GroupingDefinition> groupings = testModule.getGroupings();
 121         assertEquals(1, groupings.size());
 122         GroupingDefinition grouping = groupings.iterator().next();
 123
 124         testModule = TestUtils.findModule(modules, "nodes");
 125
 126         // get node containing uses
 127         ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
 128         ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
 129
 130         // check uses
 131         Set<UsesNode> uses = destination.getUses();
 132         assertEquals(1, uses.size());
 133
 134         // check uses process
 135         AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
 136         assertNotNull(data_u);
 137         assertTrue(data_u.isAddedByUses());
 138
 139         AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
 140         assertNotNull(data_g);
 141         assertFalse(data_g.isAddedByUses());
 142         assertFalse(data_u.equals(data_g));
 143
 144         ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
 145         assertNotNull(how_u);
 146         assertTrue(how_u.isAddedByUses());
 147
 148         ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
 149         assertNotNull(how_g);
 150         assertFalse(how_g.isAddedByUses());
 151         assertFalse(how_u.equals(how_g));
 152
 153         LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
 154         assertNotNull(address_u);
 155         assertEquals("1.2.3.4", address_u.getDefault());
 156         assertEquals("IP address of target node", address_u.getDescription());
 157         assertEquals("address reference added by refine", address_u.getReference());
 158         assertFalse(address_u.isConfiguration());
 159         assertTrue(address_u.isAddedByUses());
 160         assertFalse(address_u.getConstraints().isMandatory());
 161
 162         LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
 163         assertNotNull(address_g);
 164         assertFalse(address_g.isAddedByUses());
 165         assertNull(address_g.getDefault());
 166         assertEquals("Target IP address", address_g.getDescription());
 167         assertNull(address_g.getReference());
 168         assertTrue(address_g.isConfiguration());
 169         assertFalse(address_u.equals(address_g));
 170         assertTrue(address_g.getConstraints().isMandatory());
 171
 172         ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
 173         assertNotNull(port_u);
 174         assertTrue(port_u.isAddedByUses());
 175
 176         ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
 177         assertNotNull(port_g);
 178         assertFalse(port_g.isAddedByUses());
 179         assertFalse(port_u.equals(port_g));
 180
 181         ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
 182         assertNotNull(addresses_u);
 183         assertTrue(addresses_u.isAddedByUses());
 184
 185         ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
 186         assertNotNull(addresses_g);
 187         assertFalse(addresses_g.isAddedByUses());
 188         assertFalse(addresses_u.equals(addresses_g));
 189
 190         // grouping defined by 'uses'
 191         Set<GroupingDefinition> groupings_u = destination.getGroupings();
 192         assertEquals(1, groupings_u.size());
 193         GroupingDefinition grouping_u = groupings_u.iterator().next();
 194         assertTrue(grouping_u.isAddedByUses());
 195
 196         // grouping defined in 'grouping' node
 197         Set<GroupingDefinition> groupings_g = grouping.getGroupings();
 198         assertEquals(1, groupings_g.size());
 199         GroupingDefinition grouping_g = groupings_g.iterator().next();
 200         assertFalse(grouping_g.isAddedByUses());
 201         assertFalse(grouping_u.equals(grouping_g));
 202
 203         List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
 204         assertEquals(1, nodes_u.size());
 205         UnknownSchemaNode node_u = nodes_u.get(0);
 206         assertTrue(node_u.isAddedByUses());
 207
 208         List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
 209         assertEquals(1, nodes_g.size());
 210         UnknownSchemaNode node_g = nodes_g.get(0);
 211         assertFalse(node_g.isAddedByUses());
 212         assertFalse(node_u.equals(node_g));
 213     }
 214
 215     @Test
 216     public void testUsesUnderModule() {
 217         // suffix _u = added by uses
 218         // suffix _g = defined in grouping
 219
 220         Module testModule = TestUtils.findModule(modules, "custom");
 221
 222         // get grouping
 223         Set<GroupingDefinition> groupings = testModule.getGroupings();
 224         assertEquals(1, groupings.size());
 225         GroupingDefinition grouping = groupings.iterator().next();
 226
 227         // get node containing uses
 228         Module destination = TestUtils.findModule(modules, "nodes");
 229
 230         // check uses
 231         Set<UsesNode> uses = destination.getUses();
 232         assertEquals(1, uses.size());
 233
 234         // check uses process
 235         AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
 236         assertNotNull(data_u);
 237         assertTrue(data_u.isAddedByUses());
 238
 239         AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
 240         assertNotNull(data_g);
 241         assertFalse(data_g.isAddedByUses());
 242         assertFalse(data_u.equals(data_g));
 243
 244         ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
 245         assertNotNull(how_u);
 246         assertTrue(how_u.isAddedByUses());
 247
 248         ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
 249         assertNotNull(how_g);
 250         assertFalse(how_g.isAddedByUses());
 251         assertFalse(how_u.equals(how_g));
 252
 253         LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
 254         assertNotNull(address_u);
 255         assertNull(address_u.getDefault());
 256         assertEquals("Target IP address", address_u.getDescription());
 257         assertNull(address_u.getReference());
 258         assertTrue(address_u.isConfiguration());
 259         assertTrue(address_u.isAddedByUses());
 260
 261         LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
 262         assertNotNull(address_g);
 263         assertFalse(address_g.isAddedByUses());
 264         assertNull(address_g.getDefault());
 265         assertEquals("Target IP address", address_g.getDescription());
 266         assertNull(address_g.getReference());
 267         assertTrue(address_g.isConfiguration());
 268         assertFalse(address_u.equals(address_g));
 269
 270         ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
 271         assertNotNull(port_u);
 272         assertTrue(port_u.isAddedByUses());
 273
 274         ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
 275         assertNotNull(port_g);
 276         assertFalse(port_g.isAddedByUses());
 277         assertFalse(port_u.equals(port_g));
 278
 279         ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
 280         assertNotNull(addresses_u);
 281         assertTrue(addresses_u.isAddedByUses());
 282
 283         ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
 284         assertNotNull(addresses_g);
 285         assertFalse(addresses_g.isAddedByUses());
 286         assertFalse(addresses_u.equals(addresses_g));
 287
 288         // grouping defined by 'uses'
 289         Set<GroupingDefinition> groupings_u = destination.getGroupings();
 290         assertEquals(1, groupings_u.size());
 291         GroupingDefinition grouping_u = groupings_u.iterator().next();
 292         assertTrue(grouping_u.isAddedByUses());
 293
 294         // grouping defined in 'grouping' node
 295         Set<GroupingDefinition> groupings_g = grouping.getGroupings();
 296         assertEquals(1, groupings_g.size());
 297         GroupingDefinition grouping_g = groupings_g.iterator().next();
 298         assertFalse(grouping_g.isAddedByUses());
 299         assertFalse(grouping_u.equals(grouping_g));
 300
 301         List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
 302         assertEquals(1, nodes_u.size());
 303         UnknownSchemaNode node_u = nodes_u.get(0);
 304         assertTrue(node_u.isAddedByUses());
 305
 306         List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
 307         assertEquals(1, nodes_g.size());
 308         UnknownSchemaNode node_g = nodes_g.get(0);
 309         assertFalse(node_g.isAddedByUses());
 310         assertFalse(node_u.equals(node_g));
 311
 312         UsesNode un = uses.iterator().next();
 313         Set<AugmentationSchema> usesAugments = un.getAugmentations();
 314         assertEquals(1, usesAugments.size());
 315         AugmentationSchema augment = usesAugments.iterator().next();
 316         assertEquals("inner augment", augment.getDescription());
 317         Set<DataSchemaNode> children = augment.getChildNodes();
 318         assertEquals(1, children.size());
 319         DataSchemaNode leaf = children.iterator().next();
 320         assertTrue(leaf instanceof LeafSchemaNode);
 321         assertEquals("name", leaf.getQName().getLocalName());
 322     }
 323
 324     @Test
 325     public void testCascadeUses() throws FileNotFoundException, ParseException {
 326         modules = TestUtils.loadModules(getClass().getResource("/simple-test").getPath());
 327         Module testModule = TestUtils.findModule(modules, "cascade-uses");
 328         Set<GroupingDefinition> groupings = testModule.getGroupings();
 329
 330         GroupingDefinition gu = null;
 331         GroupingDefinition gv = null;
 332         GroupingDefinition gx = null;
 333         GroupingDefinition gy = null;
 334         GroupingDefinition gz = null;
 335         GroupingDefinition gzz = null;
 336         for (GroupingDefinition gd : groupings) {
 337             if ("grouping-U".equals(gd.getQName().getLocalName()))
 338                 gu = gd;
 339             if ("grouping-V".equals(gd.getQName().getLocalName()))
 340                 gv = gd;
 341             if ("grouping-X".equals(gd.getQName().getLocalName()))
 342                 gx = gd;
 343             if ("grouping-Y".equals(gd.getQName().getLocalName()))
 344                 gy = gd;
 345             if ("grouping-Z".equals(gd.getQName().getLocalName()))
 346                 gz = gd;
 347             if ("grouping-ZZ".equals(gd.getQName().getLocalName()))
 348                 gzz = gd;
 349         }
 350         assertNotNull(gu);
 351         assertNotNull(gv);
 352         assertNotNull(gx);
 353         assertNotNull(gy);
 354         assertNotNull(gz);
 355         assertNotNull(gzz);
 356
 357         assertEquals(7, gu.getChildNodes().size());
 358         assertEquals(4, gv.getChildNodes().size());
 359         assertEquals(2, gx.getChildNodes().size());
 360         assertEquals(1, gy.getChildNodes().size());
 361         assertEquals(1, gz.getChildNodes().size());
 362         assertEquals(1, gzz.getChildNodes().size());
 363
 364         URI expectedNS = URI.create("urn:grouping:cascade-uses");
 365         Date expectedRev = TestUtils.simpleDateFormat.parse("2013-07-18");
 366         String expectedPref = "cu";
 367         SchemaPath expectedPath;
 368
 369         // grouping-V/container-grouping-V
 370         ContainerSchemaNode containerV = (ContainerSchemaNode)gv.getDataChildByName("container-grouping-V");
 371         assertNotNull(containerV);
 372         assertEquals(2, containerV.getChildNodes().size());
 373         // grouping-V/container-grouping-V/leaf-grouping-X
 374         LeafSchemaNode leafXinContainerV = (LeafSchemaNode)containerV.getDataChildByName("leaf-grouping-X");
 375         assertNotNull(leafXinContainerV);
 376         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V", "container-grouping-V", "leaf-grouping-X");
 377         assertEquals(expectedPath, leafXinContainerV.getPath());
 378         // grouping-V/container-grouping-V/leaf-grouping-Y
 379         LeafSchemaNode leafYinContainerV = (LeafSchemaNode)containerV.getDataChildByName("leaf-grouping-Y");
 380         assertNotNull(leafYinContainerV);
 381         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V", "container-grouping-V", "leaf-grouping-Y");
 382         assertEquals(expectedPath, leafYinContainerV.getPath());
 383
 384         // grouping-X/leaf-grouping-X
 385         LeafSchemaNode leafXinGX = (LeafSchemaNode)gx.getDataChildByName("leaf-grouping-X");
 386         assertNotNull(leafXinGX);
 387         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X", "leaf-grouping-X");
 388         assertEquals(expectedPath, leafXinGX.getPath());
 389         // grouping-X/leaf-grouping-Y
 390         LeafSchemaNode leafYinGY = (LeafSchemaNode)gx.getDataChildByName("leaf-grouping-Y");
 391         assertNotNull(leafYinGY);
 392         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X", "leaf-grouping-Y");
 393         assertEquals(expectedPath, leafYinGY.getPath());
 394     }
 395
 396 }