opendaylight/sal/yang-prototype/code-generator/yang-model-parser-impl/src/test/java/org/opendaylight/controller/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.controller.yang.parser.impl;
   9
  10 import static org.junit.Assert.*;
  11
  12 import java.io.FileNotFoundException;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.Set;
  16
  17 import org.junit.Before;
  18 import org.junit.Test;
  19 import org.opendaylight.controller.yang.model.api.AnyXmlSchemaNode;
  20 import org.opendaylight.controller.yang.model.api.ChoiceNode;
  21 import org.opendaylight.controller.yang.model.api.ContainerSchemaNode;
  22 import org.opendaylight.controller.yang.model.api.DataSchemaNode;
  23 import org.opendaylight.controller.yang.model.api.GroupingDefinition;
  24 import org.opendaylight.controller.yang.model.api.LeafSchemaNode;
  25 import org.opendaylight.controller.yang.model.api.ListSchemaNode;
  26 import org.opendaylight.controller.yang.model.api.Module;
  27 import org.opendaylight.controller.yang.model.api.MustDefinition;
  28 import org.opendaylight.controller.yang.model.api.SchemaNode;
  29 import org.opendaylight.controller.yang.model.api.SchemaPath;
  30 import org.opendaylight.controller.yang.model.api.TypeDefinition;
  31 import org.opendaylight.controller.yang.model.api.UnknownSchemaNode;
  32 import org.opendaylight.controller.yang.model.api.UsesNode;
  33 import org.opendaylight.controller.yang.model.util.ExtendedType;
  34
  35 public class GroupingTest {
  36     private Set<Module> modules;
  37
  38     @Before
  39     public void init() throws FileNotFoundException {
  40         modules = TestUtils.loadModules(getClass().getResource("/model").getPath());
  41         assertEquals(3, modules.size());
  42     }
  43
  44     @Test
  45     public void testRefine() {
  46         Module testModule = TestUtils.findModule(modules, "nodes");
  47
  48         ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
  49         ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
  50         Set<UsesNode> usesNodes = destination.getUses();
  51         assertEquals(1, usesNodes.size());
  52         UsesNode usesNode = usesNodes.iterator().next();
  53         Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
  54         assertEquals(5, refines.size());
  55
  56         LeafSchemaNode refineLeaf = null;
  57         ContainerSchemaNode refineContainer = null;
  58         ListSchemaNode refineList = null;
  59         GroupingDefinition refineGrouping = null;
  60         TypeDefinition<?> typedef = 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             } else if (value instanceof GroupingDefinition) {
  70                 refineGrouping = (GroupingDefinition) value;
  71             } else if (value instanceof TypeDefinition<?>) {
  72                 typedef = (TypeDefinition<?>) value;
  73             }
  74         }
  75
  76         // leaf address
  77         assertNotNull(refineLeaf);
  78         assertEquals("address", refineLeaf.getQName().getLocalName());
  79         assertEquals("IP address of target node", refineLeaf.getDescription());
  80         assertEquals("address reference added by refine", refineLeaf.getReference());
  81         assertFalse(refineLeaf.isConfiguration());
  82         assertTrue(refineLeaf.getConstraints().isMandatory());
  83         Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
  84         assertEquals(1, leafMustConstraints.size());
  85         MustDefinition leafMust = leafMustConstraints.iterator().next();
  86         assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
  87
  88         // container port
  89         assertNotNull(refineContainer);
  90         Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
  91         assertTrue(mustConstraints.isEmpty());
  92         assertEquals("description of port defined by refine", refineContainer.getDescription());
  93         assertEquals("port reference added by refine", refineContainer.getReference());
  94         assertFalse(refineContainer.isConfiguration());
  95         assertTrue(refineContainer.isPresenceContainer());
  96
  97         // list addresses
  98         assertNotNull(refineList);
  99         assertEquals("description of addresses defined by refine", refineList.getDescription());
 100         assertEquals("addresses reference added by refine", refineList.getReference());
 101         assertFalse(refineList.isConfiguration());
 102         assertEquals(2, (int) refineList.getConstraints().getMinElements());
 103         assertEquals(12, (int) refineList.getConstraints().getMaxElements());
 104
 105         // grouping target-inner
 106         assertNotNull(refineGrouping);
 107         Set<DataSchemaNode> refineGroupingChildren = refineGrouping.getChildNodes();
 108         assertEquals(1, refineGroupingChildren.size());
 109         LeafSchemaNode refineGroupingLeaf = (LeafSchemaNode) refineGroupingChildren.iterator().next();
 110         assertEquals("inner-grouping-id", refineGroupingLeaf.getQName().getLocalName());
 111         assertEquals("new target-inner grouping description", refineGrouping.getDescription());
 112
 113         // typedef group-type
 114         assertNotNull(typedef);
 115         assertEquals("new group-type description", typedef.getDescription());
 116         assertEquals("new group-type reference", typedef.getReference());
 117         assertTrue(typedef.getBaseType() instanceof ExtendedType);
 118     }
 119
 120     @Test
 121     public void testGrouping() {
 122         Module testModule = TestUtils.findModule(modules, "custom");
 123         Set<GroupingDefinition> groupings = testModule.getGroupings();
 124         assertEquals(1, groupings.size());
 125         GroupingDefinition grouping = groupings.iterator().next();
 126         Set<DataSchemaNode> children = grouping.getChildNodes();
 127         assertEquals(5, children.size());
 128     }
 129
 130     @Test
 131     public void testUses() {
 132         // suffix _u = added by uses
 133         // suffix _g = defined in grouping
 134
 135         Module testModule = TestUtils.findModule(modules, "custom");
 136
 137         // get grouping
 138         Set<GroupingDefinition> groupings = testModule.getGroupings();
 139         assertEquals(1, groupings.size());
 140         GroupingDefinition grouping = groupings.iterator().next();
 141
 142         testModule = TestUtils.findModule(modules, "nodes");
 143
 144         // get node containing uses
 145         ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
 146         ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
 147
 148         // check uses
 149         Set<UsesNode> uses = destination.getUses();
 150         assertEquals(1, uses.size());
 151
 152         // check uses process
 153         AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
 154         assertNotNull(data_u);
 155         assertTrue(data_u.isAddedByUses());
 156
 157         AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
 158         assertNotNull(data_g);
 159         assertFalse(data_g.isAddedByUses());
 160         assertFalse(data_u.equals(data_g));
 161
 162         ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
 163         assertNotNull(how_u);
 164         assertTrue(how_u.isAddedByUses());
 165
 166         ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
 167         assertNotNull(how_g);
 168         assertFalse(how_g.isAddedByUses());
 169         assertFalse(how_u.equals(how_g));
 170
 171         LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
 172         assertNotNull(address_u);
 173         assertEquals("1.2.3.4", address_u.getDefault());
 174         assertEquals("IP address of target node", address_u.getDescription());
 175         assertEquals("address reference added by refine", address_u.getReference());
 176         assertFalse(address_u.isConfiguration());
 177         assertTrue(address_u.isAddedByUses());
 178
 179         LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
 180         assertNotNull(address_g);
 181         assertFalse(address_g.isAddedByUses());
 182         assertNull(address_g.getDefault());
 183         assertEquals("Target IP address", address_g.getDescription());
 184         assertNull(address_g.getReference());
 185         assertTrue(address_g.isConfiguration());
 186         assertFalse(address_u.equals(address_g));
 187
 188         ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
 189         assertNotNull(port_u);
 190         assertTrue(port_u.isAddedByUses());
 191
 192         ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
 193         assertNotNull(port_g);
 194         assertFalse(port_g.isAddedByUses());
 195         assertFalse(port_u.equals(port_g));
 196
 197         ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
 198         assertNotNull(addresses_u);
 199         assertTrue(addresses_u.isAddedByUses());
 200
 201         ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
 202         assertNotNull(addresses_g);
 203         assertFalse(addresses_g.isAddedByUses());
 204         assertFalse(addresses_u.equals(addresses_g));
 205
 206         // grouping defined by 'uses'
 207         Set<GroupingDefinition> groupings_u = destination.getGroupings();
 208         assertEquals(1, groupings_u.size());
 209         GroupingDefinition grouping_u = groupings_u.iterator().next();
 210         assertTrue(grouping_u.isAddedByUses());
 211
 212         // grouping defined in 'grouping' node
 213         Set<GroupingDefinition> groupings_g = grouping.getGroupings();
 214         assertEquals(1, groupings_g.size());
 215         GroupingDefinition grouping_g = groupings_g.iterator().next();
 216         assertFalse(grouping_g.isAddedByUses());
 217         assertFalse(grouping_u.equals(grouping_g));
 218
 219         List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
 220         assertEquals(1, nodes_u.size());
 221         UnknownSchemaNode node_u = nodes_u.get(0);
 222         assertTrue(node_u.isAddedByUses());
 223
 224         List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
 225         assertEquals(1, nodes_g.size());
 226         UnknownSchemaNode node_g = nodes_g.get(0);
 227         assertFalse(node_g.isAddedByUses());
 228         assertFalse(node_u.equals(node_g));
 229     }
 230
 231 }