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.assertEquals;
11 import static org.junit.Assert.assertFalse;
12 import static org.junit.Assert.assertNotNull;
13 import static org.junit.Assert.assertNull;
14 import static org.junit.Assert.assertTrue;
17 import java.io.FileNotFoundException;
19 import java.net.URISyntaxException;
20 import java.text.SimpleDateFormat;
21 import java.util.Collections;
22 import java.util.Date;
23 import java.util.List;
27 import org.junit.Before;
28 import org.junit.Test;
29 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
31 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
32 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
33 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
36 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.Module;
39 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
40 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
42 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.UsesNode;
44 import org.opendaylight.yangtools.yang.model.parser.api.YangModelParser;
46 public class GroupingTest {
47 private Set<Module> modules;
50 public void init() throws FileNotFoundException, URISyntaxException {
51 modules = TestUtils.loadModules(getClass().getResource("/model").toURI());
52 assertEquals(3, modules.size());
56 public void testRefine() {
57 Module testModule = TestUtils.findModule(modules, "foo");
58 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
59 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
61 Set<UsesNode> usesNodes = destination.getUses();
62 assertEquals(1, usesNodes.size());
63 UsesNode usesNode = usesNodes.iterator().next();
64 Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
65 assertEquals(4, refines.size());
67 LeafSchemaNode refineLeaf = null;
68 ContainerSchemaNode refineContainer = null;
69 ListSchemaNode refineList = null;
70 LeafSchemaNode refineInnerLeaf = null;
71 for (Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
72 SchemaNode value = entry.getValue();
73 if ("address".equals(value.getQName().getLocalName())) {
74 refineLeaf = (LeafSchemaNode) value;
75 } else if ("port".equals(value.getQName().getLocalName())) {
76 refineContainer = (ContainerSchemaNode) value;
77 } else if ("addresses".equals(value.getQName().getLocalName())) {
78 refineList = (ListSchemaNode) value;
79 } else if ("id".equals(value.getQName().getLocalName())) {
80 refineInnerLeaf = (LeafSchemaNode) value;
85 assertNotNull(refineLeaf);
86 assertEquals("IP address of target node", refineLeaf.getDescription());
87 assertEquals("address reference added by refine", refineLeaf.getReference());
88 assertFalse(refineLeaf.isConfiguration());
89 assertFalse(refineLeaf.getConstraints().isMandatory());
90 Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
91 assertEquals(1, leafMustConstraints.size());
92 MustDefinition leafMust = leafMustConstraints.iterator().next();
93 assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
94 assertEquals(1, refineLeaf.getUnknownSchemaNodes().size());
97 assertNotNull(refineContainer);
98 Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
99 assertTrue(mustConstraints.isEmpty());
100 assertEquals("description of port defined by refine", refineContainer.getDescription());
101 assertEquals("port reference added by refine", refineContainer.getReference());
102 assertFalse(refineContainer.isConfiguration());
103 assertTrue(refineContainer.isPresenceContainer());
106 assertNotNull(refineList);
107 assertEquals("description of addresses defined by refine", refineList.getDescription());
108 assertEquals("addresses reference added by refine", refineList.getReference());
109 assertFalse(refineList.isConfiguration());
110 assertEquals(2, (int) refineList.getConstraints().getMinElements());
111 assertEquals(12, (int) refineList.getConstraints().getMaxElements());
114 assertNotNull(refineInnerLeaf);
115 assertEquals("id of address", refineInnerLeaf.getDescription());
119 public void testGrouping() {
120 Module testModule = TestUtils.findModule(modules, "baz");
121 Set<GroupingDefinition> groupings = testModule.getGroupings();
122 assertEquals(1, groupings.size());
123 GroupingDefinition grouping = groupings.iterator().next();
124 Set<DataSchemaNode> children = grouping.getChildNodes();
125 assertEquals(5, children.size());
129 public void testUses() {
130 // suffix _u = added by uses
131 // suffix _g = defined in grouping
133 Module testModule = TestUtils.findModule(modules, "baz");
136 Set<GroupingDefinition> groupings = testModule.getGroupings();
137 assertEquals(1, groupings.size());
138 GroupingDefinition grouping = groupings.iterator().next();
140 testModule = TestUtils.findModule(modules, "foo");
142 // get node containing uses
143 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
144 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
147 Set<UsesNode> uses = destination.getUses();
148 assertEquals(1, uses.size());
150 // check uses process
151 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
152 assertNotNull(data_u);
153 assertTrue(data_u.isAddedByUses());
155 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
156 assertNotNull(data_g);
157 assertFalse(data_g.isAddedByUses());
158 assertFalse(data_u.equals(data_g));
160 ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
161 assertNotNull(how_u);
162 TestUtils.checkIsAddedByUses(how_u, true);
163 assertEquals(2, how_u.getCases().size());
165 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
166 assertNotNull(how_g);
167 TestUtils.checkIsAddedByUses(how_g, false);
168 assertEquals(2, how_g.getCases().size());
169 assertFalse(how_u.equals(how_g));
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 assertFalse(address_u.getConstraints().isMandatory());
180 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
181 assertNotNull(address_g);
182 assertFalse(address_g.isAddedByUses());
183 assertNull(address_g.getDefault());
184 assertEquals("Target IP address", address_g.getDescription());
185 assertNull(address_g.getReference());
186 assertTrue(address_g.isConfiguration());
187 assertFalse(address_u.equals(address_g));
188 assertTrue(address_g.getConstraints().isMandatory());
190 ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
191 assertNotNull(port_u);
192 TestUtils.checkIsAddedByUses(port_u, true);
194 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
195 assertNotNull(port_g);
196 TestUtils.checkIsAddedByUses(port_g, false);
197 assertFalse(port_u.equals(port_g));
199 ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
200 assertNotNull(addresses_u);
201 TestUtils.checkIsAddedByUses(addresses_u, true);
203 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
204 assertNotNull(addresses_g);
205 TestUtils.checkIsAddedByUses(addresses_g, false);
206 assertFalse(addresses_u.equals(addresses_g));
208 // grouping defined by 'uses'
209 Set<GroupingDefinition> groupings_u = destination.getGroupings();
210 assertEquals(1, groupings_u.size());
211 GroupingDefinition grouping_u = groupings_u.iterator().next();
212 TestUtils.checkIsAddedByUses(grouping_u, true);
214 // grouping defined in 'grouping' node
215 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
216 assertEquals(1, groupings_g.size());
217 GroupingDefinition grouping_g = groupings_g.iterator().next();
218 TestUtils.checkIsAddedByUses(grouping_g, false);
219 assertFalse(grouping_u.equals(grouping_g));
221 List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
222 assertEquals(1, nodes_u.size());
223 UnknownSchemaNode node_u = nodes_u.get(0);
224 assertTrue(node_u.isAddedByUses());
226 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
227 assertEquals(1, nodes_g.size());
228 UnknownSchemaNode node_g = nodes_g.get(0);
229 assertFalse(node_g.isAddedByUses());
230 assertFalse(node_u.equals(node_g));
234 public void testUsesUnderModule() {
235 // suffix _u = added by uses
236 // suffix _g = defined in grouping
238 Module testModule = TestUtils.findModule(modules, "baz");
241 Set<GroupingDefinition> groupings = testModule.getGroupings();
242 assertEquals(1, groupings.size());
243 GroupingDefinition grouping = groupings.iterator().next();
245 // get node containing uses
246 Module foo = TestUtils.findModule(modules, "foo");
249 Set<UsesNode> uses = foo.getUses();
250 assertEquals(1, uses.size());
252 // check uses process
253 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) foo.getDataChildByName("data");
254 assertNotNull(data_u);
255 assertTrue(data_u.isAddedByUses());
257 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
258 assertNotNull(data_g);
259 assertFalse(data_g.isAddedByUses());
260 assertFalse(data_u.equals(data_g));
262 ChoiceNode how_u = (ChoiceNode) foo.getDataChildByName("how");
263 assertNotNull(how_u);
264 TestUtils.checkIsAddedByUses(how_u, true);
265 assertFalse(how_u.isAugmenting());
266 Set<ChoiceCaseNode> cases_u = how_u.getCases();
267 assertEquals(2, cases_u.size());
268 ChoiceCaseNode interval = how_u.getCaseNodeByName("interval");
269 assertFalse(interval.isAugmenting());
270 LeafSchemaNode name = (LeafSchemaNode) interval.getDataChildByName("name");
271 assertTrue(name.isAugmenting());
272 LeafSchemaNode intervalLeaf = (LeafSchemaNode) interval.getDataChildByName("interval");
273 assertFalse(intervalLeaf.isAugmenting());
275 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
276 assertNotNull(how_g);
277 TestUtils.checkIsAddedByUses(how_g, false);
278 assertFalse(how_u.equals(how_g));
280 LeafSchemaNode address_u = (LeafSchemaNode) foo.getDataChildByName("address");
281 assertNotNull(address_u);
282 assertNull(address_u.getDefault());
283 assertEquals("Target IP address", address_u.getDescription());
284 assertNull(address_u.getReference());
285 assertTrue(address_u.isConfiguration());
286 assertTrue(address_u.isAddedByUses());
288 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
289 assertNotNull(address_g);
290 assertFalse(address_g.isAddedByUses());
291 assertNull(address_g.getDefault());
292 assertEquals("Target IP address", address_g.getDescription());
293 assertNull(address_g.getReference());
294 assertTrue(address_g.isConfiguration());
295 assertFalse(address_u.equals(address_g));
297 ContainerSchemaNode port_u = (ContainerSchemaNode) foo.getDataChildByName("port");
298 assertNotNull(port_u);
299 TestUtils.checkIsAddedByUses(port_u, true);
301 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
302 assertNotNull(port_g);
303 TestUtils.checkIsAddedByUses(port_g, false);
304 assertFalse(port_u.equals(port_g));
306 ListSchemaNode addresses_u = (ListSchemaNode) foo.getDataChildByName("addresses");
307 assertNotNull(addresses_u);
308 TestUtils.checkIsAddedByUses(addresses_u, true);
310 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
311 assertNotNull(addresses_g);
312 TestUtils.checkIsAddedByUses(addresses_g, false);
313 assertFalse(addresses_u.equals(addresses_g));
315 // grouping defined by 'uses'
316 Set<GroupingDefinition> groupings_u = foo.getGroupings();
317 assertEquals(1, groupings_u.size());
318 GroupingDefinition grouping_u = groupings_u.iterator().next();
319 TestUtils.checkIsAddedByUses(grouping_u, true);
321 // grouping defined in 'grouping' node
322 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
323 assertEquals(1, groupings_g.size());
324 GroupingDefinition grouping_g = groupings_g.iterator().next();
325 TestUtils.checkIsAddedByUses(grouping_g, false);
326 assertFalse(grouping_u.equals(grouping_g));
328 List<UnknownSchemaNode> nodes_u = foo.getUnknownSchemaNodes();
329 assertEquals(1, nodes_u.size());
330 UnknownSchemaNode node_u = nodes_u.get(0);
331 assertTrue(node_u.isAddedByUses());
333 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
334 assertEquals(1, nodes_g.size());
335 UnknownSchemaNode node_g = nodes_g.get(0);
336 assertFalse(node_g.isAddedByUses());
337 assertFalse(node_u.equals(node_g));
339 UsesNode un = uses.iterator().next();
340 Set<AugmentationSchema> usesAugments = un.getAugmentations();
341 assertEquals(1, usesAugments.size());
342 AugmentationSchema augment = usesAugments.iterator().next();
343 assertEquals("inner augment", augment.getDescription());
344 Set<DataSchemaNode> children = augment.getChildNodes();
345 assertEquals(1, children.size());
346 DataSchemaNode leaf = children.iterator().next();
347 assertTrue(leaf instanceof LeafSchemaNode);
348 assertEquals("name", leaf.getQName().getLocalName());
352 public void testCascadeUses() throws Exception {
353 File yangFile = new File(getClass().getResource("/grouping-test/cascade-uses.yang").toURI());
354 YangModelParser parser = new YangParserImpl();
355 modules = parser.parseYangModels(Collections.singletonList(yangFile));
356 assertEquals(1, modules.size());
358 Module testModule = TestUtils.findModule(modules, "cascade-uses");
359 Set<GroupingDefinition> groupings = testModule.getGroupings();
361 GroupingDefinition gu = null;
362 GroupingDefinition gv = null;
363 GroupingDefinition gx = null;
364 GroupingDefinition gy = null;
365 GroupingDefinition gz = null;
366 GroupingDefinition gzz = null;
367 for (GroupingDefinition gd : groupings) {
368 String name = gd.getQName().getLocalName();
397 URI expectedNS = URI.create("urn:grouping:cascade-uses");
398 Date expectedRev = new SimpleDateFormat("yyyy-MM-dd").parse("2013-07-18");
399 String expectedPref = "cu";
400 SchemaPath expectedPath;
403 Set<DataSchemaNode> childNodes = gu.getChildNodes();
404 assertEquals(7, childNodes.size());
405 LeafSchemaNode leafGroupingU = null;
406 for (DataSchemaNode childNode : childNodes) {
407 if ("leaf-grouping-U".equals(childNode.getQName().getLocalName())) {
408 leafGroupingU = (LeafSchemaNode) childNode;
410 TestUtils.checkIsAddedByUses(childNode, true);
413 assertNotNull(leafGroupingU);
414 assertFalse(leafGroupingU.isAddedByUses());
417 childNodes = gv.getChildNodes();
418 assertEquals(4, childNodes.size());
419 LeafSchemaNode leafGroupingV = null;
420 ContainerSchemaNode containerGroupingV = null;
421 for (DataSchemaNode childNode : childNodes) {
422 if ("leaf-grouping-V".equals(childNode.getQName().getLocalName())) {
423 leafGroupingV = (LeafSchemaNode) childNode;
424 } else if ("container-grouping-V".equals(childNode.getQName().getLocalName())) {
425 containerGroupingV = (ContainerSchemaNode) childNode;
427 TestUtils.checkIsAddedByUses(childNode, true);
430 assertNotNull(leafGroupingV);
431 assertFalse(leafGroupingV.isAddedByUses());
433 // grouping-V/container-grouping-V
434 assertNotNull(containerGroupingV);
435 assertFalse(containerGroupingV.isAddedByUses());
436 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
437 "container-grouping-V");
438 assertEquals(expectedPath, containerGroupingV.getPath());
439 childNodes = containerGroupingV.getChildNodes();
440 assertEquals(2, childNodes.size());
441 for (DataSchemaNode childNode : childNodes) {
442 TestUtils.checkIsAddedByUses(childNode, true);
445 // grouping-V/container-grouping-V/leaf-grouping-X
446 LeafSchemaNode leafXinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-X");
447 assertNotNull(leafXinContainerV);
448 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
449 "container-grouping-V", "leaf-grouping-X");
450 assertEquals(expectedPath, leafXinContainerV.getPath());
451 // grouping-V/container-grouping-V/leaf-grouping-Y
452 LeafSchemaNode leafYinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-Y");
453 assertNotNull(leafYinContainerV);
454 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
455 "container-grouping-V", "leaf-grouping-Y");
456 assertEquals(expectedPath, leafYinContainerV.getPath());
459 childNodes = gx.getChildNodes();
460 assertEquals(2, childNodes.size());
462 // grouping-X/leaf-grouping-X
463 LeafSchemaNode leafXinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-X");
464 assertNotNull(leafXinGX);
465 assertFalse(leafXinGX.isAddedByUses());
466 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
468 assertEquals(expectedPath, leafXinGX.getPath());
470 // grouping-X/leaf-grouping-Y
471 LeafSchemaNode leafYinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-Y");
472 assertNotNull(leafYinGX);
473 assertTrue(leafYinGX.isAddedByUses());
474 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
476 assertEquals(expectedPath, leafYinGX.getPath());
479 childNodes = gy.getChildNodes();
480 assertEquals(1, childNodes.size());
482 // grouping-Y/leaf-grouping-Y
483 LeafSchemaNode leafYinGY = (LeafSchemaNode) gy.getDataChildByName("leaf-grouping-Y");
484 assertNotNull(leafYinGY);
485 assertFalse(leafYinGY.isAddedByUses());
486 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Y",
488 assertEquals(expectedPath, leafYinGY.getPath());
491 childNodes = gz.getChildNodes();
492 assertEquals(1, childNodes.size());
494 // grouping-Z/leaf-grouping-Z
495 LeafSchemaNode leafZinGZ = (LeafSchemaNode) gz.getDataChildByName("leaf-grouping-Z");
496 assertNotNull(leafZinGZ);
497 assertFalse(leafZinGZ.isAddedByUses());
498 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Z",
500 assertEquals(expectedPath, leafZinGZ.getPath());
503 childNodes = gzz.getChildNodes();
504 assertEquals(1, childNodes.size());
506 // grouping-ZZ/leaf-grouping-ZZ
507 LeafSchemaNode leafZZinGZZ = (LeafSchemaNode) gzz.getDataChildByName("leaf-grouping-ZZ");
508 assertNotNull(leafZZinGZZ);
509 assertFalse(leafZZinGZZ.isAddedByUses());
510 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-ZZ",
512 assertEquals(expectedPath, leafZZinGZZ.getPath());