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