2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.impl;
10 import static org.junit.Assert.*;
13 import java.io.FileNotFoundException;
15 import java.text.ParseException;
16 import java.util.Collections;
17 import java.util.Date;
18 import java.util.List;
22 import org.junit.Before;
23 import org.junit.Test;
24 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
25 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
26 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
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.GroupingDefinition;
31 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.Module;
34 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
35 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
37 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.UsesNode;
39 import org.opendaylight.yangtools.yang.model.parser.api.YangModelParser;
41 public class GroupingTest {
42 private Set<Module> modules;
45 public void init() throws FileNotFoundException {
46 modules = TestUtils.loadModules(getClass().getResource("/model").getPath());
47 assertEquals(3, modules.size());
51 public void testRefine() {
52 Module testModule = TestUtils.findModule(modules, "foo");
53 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
54 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
56 Set<UsesNode> usesNodes = destination.getUses();
57 assertEquals(1, usesNodes.size());
58 UsesNode usesNode = usesNodes.iterator().next();
59 Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
60 assertEquals(4, refines.size());
62 LeafSchemaNode refineLeaf = null;
63 ContainerSchemaNode refineContainer = null;
64 ListSchemaNode refineList = null;
65 LeafSchemaNode refineInnerLeaf = null;
66 for (Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
67 SchemaNode value = entry.getValue();
68 if ("address".equals(value.getQName().getLocalName())) {
69 refineLeaf = (LeafSchemaNode) value;
70 } else if ("port".equals(value.getQName().getLocalName())) {
71 refineContainer = (ContainerSchemaNode) value;
72 } else if ("addresses".equals(value.getQName().getLocalName())) {
73 refineList = (ListSchemaNode) value;
74 } else if ("id".equals(value.getQName().getLocalName())) {
75 refineInnerLeaf = (LeafSchemaNode) value;
80 assertNotNull(refineLeaf);
81 assertEquals("IP address of target node", refineLeaf.getDescription());
82 assertEquals("address reference added by refine", refineLeaf.getReference());
83 assertFalse(refineLeaf.isConfiguration());
84 assertFalse(refineLeaf.getConstraints().isMandatory());
85 Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
86 assertEquals(1, leafMustConstraints.size());
87 MustDefinition leafMust = leafMustConstraints.iterator().next();
88 assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
89 assertEquals(1, refineLeaf.getUnknownSchemaNodes().size());
92 assertNotNull(refineContainer);
93 Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
94 assertTrue(mustConstraints.isEmpty());
95 assertEquals("description of port defined by refine", refineContainer.getDescription());
96 assertEquals("port reference added by refine", refineContainer.getReference());
97 assertFalse(refineContainer.isConfiguration());
98 assertTrue(refineContainer.isPresenceContainer());
101 assertNotNull(refineList);
102 assertEquals("description of addresses defined by refine", refineList.getDescription());
103 assertEquals("addresses reference added by refine", refineList.getReference());
104 assertFalse(refineList.isConfiguration());
105 assertEquals(2, (int) refineList.getConstraints().getMinElements());
106 assertEquals(12, (int) refineList.getConstraints().getMaxElements());
109 assertNotNull(refineInnerLeaf);
110 assertEquals("id of address", refineInnerLeaf.getDescription());
114 public void testGrouping() {
115 Module testModule = TestUtils.findModule(modules, "baz");
116 Set<GroupingDefinition> groupings = testModule.getGroupings();
117 assertEquals(1, groupings.size());
118 GroupingDefinition grouping = groupings.iterator().next();
119 Set<DataSchemaNode> children = grouping.getChildNodes();
120 assertEquals(5, children.size());
124 public void testUses() {
125 // suffix _u = added by uses
126 // suffix _g = defined in grouping
128 Module testModule = TestUtils.findModule(modules, "baz");
131 Set<GroupingDefinition> groupings = testModule.getGroupings();
132 assertEquals(1, groupings.size());
133 GroupingDefinition grouping = groupings.iterator().next();
135 testModule = TestUtils.findModule(modules, "foo");
137 // get node containing uses
138 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
139 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
142 Set<UsesNode> uses = destination.getUses();
143 assertEquals(1, uses.size());
145 // check uses process
146 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
147 assertNotNull(data_u);
148 assertTrue(data_u.isAddedByUses());
150 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
151 assertNotNull(data_g);
152 assertFalse(data_g.isAddedByUses());
153 assertFalse(data_u.equals(data_g));
155 ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
156 assertNotNull(how_u);
157 TestUtils.checkIsAddedByUses(how_u, true);
158 assertEquals(2, how_u.getCases().size());
160 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
161 assertNotNull(how_g);
162 TestUtils.checkIsAddedByUses(how_g, false);
163 assertEquals(2, how_g.getCases().size());
164 assertFalse(how_u.equals(how_g));
166 LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
167 assertNotNull(address_u);
168 assertEquals("1.2.3.4", address_u.getDefault());
169 assertEquals("IP address of target node", address_u.getDescription());
170 assertEquals("address reference added by refine", address_u.getReference());
171 assertFalse(address_u.isConfiguration());
172 assertTrue(address_u.isAddedByUses());
173 assertFalse(address_u.getConstraints().isMandatory());
175 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
176 assertNotNull(address_g);
177 assertFalse(address_g.isAddedByUses());
178 assertNull(address_g.getDefault());
179 assertEquals("Target IP address", address_g.getDescription());
180 assertNull(address_g.getReference());
181 assertTrue(address_g.isConfiguration());
182 assertFalse(address_u.equals(address_g));
183 assertTrue(address_g.getConstraints().isMandatory());
185 ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
186 assertNotNull(port_u);
187 TestUtils.checkIsAddedByUses(port_u, true);
189 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
190 assertNotNull(port_g);
191 TestUtils.checkIsAddedByUses(port_g, false);
192 assertFalse(port_u.equals(port_g));
194 ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
195 assertNotNull(addresses_u);
196 TestUtils.checkIsAddedByUses(addresses_u, true);
198 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
199 assertNotNull(addresses_g);
200 TestUtils.checkIsAddedByUses(addresses_g, false);
201 assertFalse(addresses_u.equals(addresses_g));
203 // grouping defined by 'uses'
204 Set<GroupingDefinition> groupings_u = destination.getGroupings();
205 assertEquals(1, groupings_u.size());
206 GroupingDefinition grouping_u = groupings_u.iterator().next();
207 TestUtils.checkIsAddedByUses(grouping_u, true);
209 // grouping defined in 'grouping' node
210 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
211 assertEquals(1, groupings_g.size());
212 GroupingDefinition grouping_g = groupings_g.iterator().next();
213 TestUtils.checkIsAddedByUses(grouping_g, false);
214 assertFalse(grouping_u.equals(grouping_g));
216 List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
217 assertEquals(1, nodes_u.size());
218 UnknownSchemaNode node_u = nodes_u.get(0);
219 assertTrue(node_u.isAddedByUses());
221 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
222 assertEquals(1, nodes_g.size());
223 UnknownSchemaNode node_g = nodes_g.get(0);
224 assertFalse(node_g.isAddedByUses());
225 assertFalse(node_u.equals(node_g));
229 public void testUsesUnderModule() {
230 // suffix _u = added by uses
231 // suffix _g = defined in grouping
233 Module testModule = TestUtils.findModule(modules, "baz");
236 Set<GroupingDefinition> groupings = testModule.getGroupings();
237 assertEquals(1, groupings.size());
238 GroupingDefinition grouping = groupings.iterator().next();
240 // get node containing uses
241 Module foo = TestUtils.findModule(modules, "foo");
244 Set<UsesNode> uses = foo.getUses();
245 assertEquals(1, uses.size());
247 // check uses process
248 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) foo.getDataChildByName("data");
249 assertNotNull(data_u);
250 assertTrue(data_u.isAddedByUses());
252 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
253 assertNotNull(data_g);
254 assertFalse(data_g.isAddedByUses());
255 assertFalse(data_u.equals(data_g));
257 ChoiceNode how_u = (ChoiceNode) foo.getDataChildByName("how");
258 assertNotNull(how_u);
259 TestUtils.checkIsAddedByUses(how_u, true);
260 assertFalse(how_u.isAugmenting());
261 Set<ChoiceCaseNode> cases_u = how_u.getCases();
262 assertEquals(2, cases_u.size());
263 ChoiceCaseNode interval = how_u.getCaseNodeByName("interval");
264 assertFalse(interval.isAugmenting());
265 LeafSchemaNode name = (LeafSchemaNode) interval.getDataChildByName("name");
266 assertTrue(name.isAugmenting());
267 LeafSchemaNode intervalLeaf = (LeafSchemaNode) interval.getDataChildByName("interval");
268 assertFalse(intervalLeaf.isAugmenting());
270 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
271 assertNotNull(how_g);
272 TestUtils.checkIsAddedByUses(how_g, false);
273 assertFalse(how_u.equals(how_g));
275 LeafSchemaNode address_u = (LeafSchemaNode) foo.getDataChildByName("address");
276 assertNotNull(address_u);
277 assertNull(address_u.getDefault());
278 assertEquals("Target IP address", address_u.getDescription());
279 assertNull(address_u.getReference());
280 assertTrue(address_u.isConfiguration());
281 assertTrue(address_u.isAddedByUses());
283 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
284 assertNotNull(address_g);
285 assertFalse(address_g.isAddedByUses());
286 assertNull(address_g.getDefault());
287 assertEquals("Target IP address", address_g.getDescription());
288 assertNull(address_g.getReference());
289 assertTrue(address_g.isConfiguration());
290 assertFalse(address_u.equals(address_g));
292 ContainerSchemaNode port_u = (ContainerSchemaNode) foo.getDataChildByName("port");
293 assertNotNull(port_u);
294 TestUtils.checkIsAddedByUses(port_u, true);
296 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
297 assertNotNull(port_g);
298 TestUtils.checkIsAddedByUses(port_g, false);
299 assertFalse(port_u.equals(port_g));
301 ListSchemaNode addresses_u = (ListSchemaNode) foo.getDataChildByName("addresses");
302 assertNotNull(addresses_u);
303 TestUtils.checkIsAddedByUses(addresses_u, true);
305 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
306 assertNotNull(addresses_g);
307 TestUtils.checkIsAddedByUses(addresses_g, false);
308 assertFalse(addresses_u.equals(addresses_g));
310 // grouping defined by 'uses'
311 Set<GroupingDefinition> groupings_u = foo.getGroupings();
312 assertEquals(1, groupings_u.size());
313 GroupingDefinition grouping_u = groupings_u.iterator().next();
314 TestUtils.checkIsAddedByUses(grouping_u, true);
316 // grouping defined in 'grouping' node
317 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
318 assertEquals(1, groupings_g.size());
319 GroupingDefinition grouping_g = groupings_g.iterator().next();
320 TestUtils.checkIsAddedByUses(grouping_g, false);
321 assertFalse(grouping_u.equals(grouping_g));
323 List<UnknownSchemaNode> nodes_u = foo.getUnknownSchemaNodes();
324 assertEquals(1, nodes_u.size());
325 UnknownSchemaNode node_u = nodes_u.get(0);
326 assertTrue(node_u.isAddedByUses());
328 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
329 assertEquals(1, nodes_g.size());
330 UnknownSchemaNode node_g = nodes_g.get(0);
331 assertFalse(node_g.isAddedByUses());
332 assertFalse(node_u.equals(node_g));
334 UsesNode un = uses.iterator().next();
335 Set<AugmentationSchema> usesAugments = un.getAugmentations();
336 assertEquals(1, usesAugments.size());
337 AugmentationSchema augment = usesAugments.iterator().next();
338 assertEquals("inner augment", augment.getDescription());
339 Set<DataSchemaNode> children = augment.getChildNodes();
340 assertEquals(1, children.size());
341 DataSchemaNode leaf = children.iterator().next();
342 assertTrue(leaf instanceof LeafSchemaNode);
343 assertEquals("name", leaf.getQName().getLocalName());
347 public void testCascadeUses() throws FileNotFoundException, ParseException {
348 File yangFile = new File(getClass().getResource("/grouping-test/cascade-uses.yang").getPath());
349 YangModelParser parser = new YangParserImpl();
350 modules = parser.parseYangModels(Collections.singletonList(yangFile));
351 assertEquals(1, modules.size());
353 Module testModule = TestUtils.findModule(modules, "cascade-uses");
354 Set<GroupingDefinition> groupings = testModule.getGroupings();
356 GroupingDefinition gu = null;
357 GroupingDefinition gv = null;
358 GroupingDefinition gx = null;
359 GroupingDefinition gy = null;
360 GroupingDefinition gz = null;
361 GroupingDefinition gzz = null;
362 for (GroupingDefinition gd : groupings) {
363 String name = gd.getQName().getLocalName();
392 URI expectedNS = URI.create("urn:grouping:cascade-uses");
393 Date expectedRev = TestUtils.simpleDateFormat.parse("2013-07-18");
394 String expectedPref = "cu";
395 SchemaPath expectedPath;
398 Set<DataSchemaNode> childNodes = gu.getChildNodes();
399 assertEquals(7, childNodes.size());
400 LeafSchemaNode leafGroupingU = null;
401 for (DataSchemaNode childNode : childNodes) {
402 if ("leaf-grouping-U".equals(childNode.getQName().getLocalName())) {
403 leafGroupingU = (LeafSchemaNode) childNode;
405 TestUtils.checkIsAddedByUses(childNode, true);
408 assertNotNull(leafGroupingU);
409 assertFalse(leafGroupingU.isAddedByUses());
412 childNodes = gv.getChildNodes();
413 assertEquals(4, childNodes.size());
414 LeafSchemaNode leafGroupingV = null;
415 ContainerSchemaNode containerGroupingV = null;
416 for (DataSchemaNode childNode : childNodes) {
417 if ("leaf-grouping-V".equals(childNode.getQName().getLocalName())) {
418 leafGroupingV = (LeafSchemaNode) childNode;
419 } else if ("container-grouping-V".equals(childNode.getQName().getLocalName())) {
420 containerGroupingV = (ContainerSchemaNode) childNode;
422 TestUtils.checkIsAddedByUses(childNode, true);
425 assertNotNull(leafGroupingV);
426 assertFalse(leafGroupingV.isAddedByUses());
428 // grouping-V/container-grouping-V
429 assertNotNull(containerGroupingV);
430 assertFalse(containerGroupingV.isAddedByUses());
431 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
432 "container-grouping-V");
433 assertEquals(expectedPath, containerGroupingV.getPath());
434 childNodes = containerGroupingV.getChildNodes();
435 assertEquals(2, childNodes.size());
436 for (DataSchemaNode childNode : childNodes) {
437 TestUtils.checkIsAddedByUses(childNode, true);
440 // grouping-V/container-grouping-V/leaf-grouping-X
441 LeafSchemaNode leafXinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-X");
442 assertNotNull(leafXinContainerV);
443 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
444 "container-grouping-V", "leaf-grouping-X");
445 assertEquals(expectedPath, leafXinContainerV.getPath());
446 // grouping-V/container-grouping-V/leaf-grouping-Y
447 LeafSchemaNode leafYinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-Y");
448 assertNotNull(leafYinContainerV);
449 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
450 "container-grouping-V", "leaf-grouping-Y");
451 assertEquals(expectedPath, leafYinContainerV.getPath());
454 childNodes = gx.getChildNodes();
455 assertEquals(2, childNodes.size());
457 // grouping-X/leaf-grouping-X
458 LeafSchemaNode leafXinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-X");
459 assertNotNull(leafXinGX);
460 assertFalse(leafXinGX.isAddedByUses());
461 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
463 assertEquals(expectedPath, leafXinGX.getPath());
465 // grouping-X/leaf-grouping-Y
466 LeafSchemaNode leafYinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-Y");
467 assertNotNull(leafYinGX);
468 assertTrue(leafYinGX.isAddedByUses());
469 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
471 assertEquals(expectedPath, leafYinGX.getPath());
474 childNodes = gy.getChildNodes();
475 assertEquals(1, childNodes.size());
477 // grouping-Y/leaf-grouping-Y
478 LeafSchemaNode leafYinGY = (LeafSchemaNode) gy.getDataChildByName("leaf-grouping-Y");
479 assertNotNull(leafYinGY);
480 assertFalse(leafYinGY.isAddedByUses());
481 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Y",
483 assertEquals(expectedPath, leafYinGY.getPath());
486 childNodes = gz.getChildNodes();
487 assertEquals(1, childNodes.size());
489 // grouping-Z/leaf-grouping-Z
490 LeafSchemaNode leafZinGZ = (LeafSchemaNode) gz.getDataChildByName("leaf-grouping-Z");
491 assertNotNull(leafZinGZ);
492 assertFalse(leafZinGZ.isAddedByUses());
493 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Z",
495 assertEquals(expectedPath, leafZinGZ.getPath());
498 childNodes = gzz.getChildNodes();
499 assertEquals(1, childNodes.size());
501 // grouping-ZZ/leaf-grouping-ZZ
502 LeafSchemaNode leafZZinGZZ = (LeafSchemaNode) gzz.getDataChildByName("leaf-grouping-ZZ");
503 assertNotNull(leafZZinGZZ);
504 assertFalse(leafZZinGZZ.isAddedByUses());
505 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-ZZ",
507 assertEquals(expectedPath, leafZZinGZZ.getPath());