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.text.SimpleDateFormat;
17 import java.util.Collections;
18 import java.util.Date;
19 import java.util.List;
23 import org.junit.Before;
24 import org.junit.Test;
25 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
27 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
28 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
32 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.Module;
35 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
36 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
38 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.UsesNode;
40 import org.opendaylight.yangtools.yang.model.parser.api.YangModelParser;
42 public class GroupingTest {
43 private Set<Module> modules;
46 public void init() throws FileNotFoundException {
47 modules = TestUtils.loadModules(getClass().getResource("/model").getPath());
48 assertEquals(3, modules.size());
52 public void testRefine() {
53 Module testModule = TestUtils.findModule(modules, "foo");
54 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
55 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
57 Set<UsesNode> usesNodes = destination.getUses();
58 assertEquals(1, usesNodes.size());
59 UsesNode usesNode = usesNodes.iterator().next();
60 Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
61 assertEquals(4, refines.size());
63 LeafSchemaNode refineLeaf = null;
64 ContainerSchemaNode refineContainer = null;
65 ListSchemaNode refineList = null;
66 LeafSchemaNode refineInnerLeaf = null;
67 for (Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
68 SchemaNode value = entry.getValue();
69 if ("address".equals(value.getQName().getLocalName())) {
70 refineLeaf = (LeafSchemaNode) value;
71 } else if ("port".equals(value.getQName().getLocalName())) {
72 refineContainer = (ContainerSchemaNode) value;
73 } else if ("addresses".equals(value.getQName().getLocalName())) {
74 refineList = (ListSchemaNode) value;
75 } else if ("id".equals(value.getQName().getLocalName())) {
76 refineInnerLeaf = (LeafSchemaNode) value;
81 assertNotNull(refineLeaf);
82 assertEquals("IP address of target node", refineLeaf.getDescription());
83 assertEquals("address reference added by refine", refineLeaf.getReference());
84 assertFalse(refineLeaf.isConfiguration());
85 assertFalse(refineLeaf.getConstraints().isMandatory());
86 Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
87 assertEquals(1, leafMustConstraints.size());
88 MustDefinition leafMust = leafMustConstraints.iterator().next();
89 assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
90 assertEquals(1, refineLeaf.getUnknownSchemaNodes().size());
93 assertNotNull(refineContainer);
94 Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
95 assertTrue(mustConstraints.isEmpty());
96 assertEquals("description of port defined by refine", refineContainer.getDescription());
97 assertEquals("port reference added by refine", refineContainer.getReference());
98 assertFalse(refineContainer.isConfiguration());
99 assertTrue(refineContainer.isPresenceContainer());
102 assertNotNull(refineList);
103 assertEquals("description of addresses defined by refine", refineList.getDescription());
104 assertEquals("addresses reference added by refine", refineList.getReference());
105 assertFalse(refineList.isConfiguration());
106 assertEquals(2, (int) refineList.getConstraints().getMinElements());
107 assertEquals(12, (int) refineList.getConstraints().getMaxElements());
110 assertNotNull(refineInnerLeaf);
111 assertEquals("id of address", refineInnerLeaf.getDescription());
115 public void testGrouping() {
116 Module testModule = TestUtils.findModule(modules, "baz");
117 Set<GroupingDefinition> groupings = testModule.getGroupings();
118 assertEquals(1, groupings.size());
119 GroupingDefinition grouping = groupings.iterator().next();
120 Set<DataSchemaNode> children = grouping.getChildNodes();
121 assertEquals(5, children.size());
125 public void testUses() {
126 // suffix _u = added by uses
127 // suffix _g = defined in grouping
129 Module testModule = TestUtils.findModule(modules, "baz");
132 Set<GroupingDefinition> groupings = testModule.getGroupings();
133 assertEquals(1, groupings.size());
134 GroupingDefinition grouping = groupings.iterator().next();
136 testModule = TestUtils.findModule(modules, "foo");
138 // get node containing uses
139 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
140 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
143 Set<UsesNode> uses = destination.getUses();
144 assertEquals(1, uses.size());
146 // check uses process
147 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
148 assertNotNull(data_u);
149 assertTrue(data_u.isAddedByUses());
151 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
152 assertNotNull(data_g);
153 assertFalse(data_g.isAddedByUses());
154 assertFalse(data_u.equals(data_g));
156 ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
157 assertNotNull(how_u);
158 TestUtils.checkIsAddedByUses(how_u, true);
159 assertEquals(2, how_u.getCases().size());
161 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
162 assertNotNull(how_g);
163 TestUtils.checkIsAddedByUses(how_g, false);
164 assertEquals(2, how_g.getCases().size());
165 assertFalse(how_u.equals(how_g));
167 LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
168 assertNotNull(address_u);
169 assertEquals("1.2.3.4", address_u.getDefault());
170 assertEquals("IP address of target node", address_u.getDescription());
171 assertEquals("address reference added by refine", address_u.getReference());
172 assertFalse(address_u.isConfiguration());
173 assertTrue(address_u.isAddedByUses());
174 assertFalse(address_u.getConstraints().isMandatory());
176 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
177 assertNotNull(address_g);
178 assertFalse(address_g.isAddedByUses());
179 assertNull(address_g.getDefault());
180 assertEquals("Target IP address", address_g.getDescription());
181 assertNull(address_g.getReference());
182 assertTrue(address_g.isConfiguration());
183 assertFalse(address_u.equals(address_g));
184 assertTrue(address_g.getConstraints().isMandatory());
186 ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
187 assertNotNull(port_u);
188 TestUtils.checkIsAddedByUses(port_u, true);
190 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
191 assertNotNull(port_g);
192 TestUtils.checkIsAddedByUses(port_g, false);
193 assertFalse(port_u.equals(port_g));
195 ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
196 assertNotNull(addresses_u);
197 TestUtils.checkIsAddedByUses(addresses_u, true);
199 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
200 assertNotNull(addresses_g);
201 TestUtils.checkIsAddedByUses(addresses_g, false);
202 assertFalse(addresses_u.equals(addresses_g));
204 // grouping defined by 'uses'
205 Set<GroupingDefinition> groupings_u = destination.getGroupings();
206 assertEquals(1, groupings_u.size());
207 GroupingDefinition grouping_u = groupings_u.iterator().next();
208 TestUtils.checkIsAddedByUses(grouping_u, true);
210 // grouping defined in 'grouping' node
211 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
212 assertEquals(1, groupings_g.size());
213 GroupingDefinition grouping_g = groupings_g.iterator().next();
214 TestUtils.checkIsAddedByUses(grouping_g, false);
215 assertFalse(grouping_u.equals(grouping_g));
217 List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
218 assertEquals(1, nodes_u.size());
219 UnknownSchemaNode node_u = nodes_u.get(0);
220 assertTrue(node_u.isAddedByUses());
222 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
223 assertEquals(1, nodes_g.size());
224 UnknownSchemaNode node_g = nodes_g.get(0);
225 assertFalse(node_g.isAddedByUses());
226 assertFalse(node_u.equals(node_g));
230 public void testUsesUnderModule() {
231 // suffix _u = added by uses
232 // suffix _g = defined in grouping
234 Module testModule = TestUtils.findModule(modules, "baz");
237 Set<GroupingDefinition> groupings = testModule.getGroupings();
238 assertEquals(1, groupings.size());
239 GroupingDefinition grouping = groupings.iterator().next();
241 // get node containing uses
242 Module foo = TestUtils.findModule(modules, "foo");
245 Set<UsesNode> uses = foo.getUses();
246 assertEquals(1, uses.size());
248 // check uses process
249 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) foo.getDataChildByName("data");
250 assertNotNull(data_u);
251 assertTrue(data_u.isAddedByUses());
253 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
254 assertNotNull(data_g);
255 assertFalse(data_g.isAddedByUses());
256 assertFalse(data_u.equals(data_g));
258 ChoiceNode how_u = (ChoiceNode) foo.getDataChildByName("how");
259 assertNotNull(how_u);
260 TestUtils.checkIsAddedByUses(how_u, true);
261 assertFalse(how_u.isAugmenting());
262 Set<ChoiceCaseNode> cases_u = how_u.getCases();
263 assertEquals(2, cases_u.size());
264 ChoiceCaseNode interval = how_u.getCaseNodeByName("interval");
265 assertFalse(interval.isAugmenting());
266 LeafSchemaNode name = (LeafSchemaNode) interval.getDataChildByName("name");
267 assertTrue(name.isAugmenting());
268 LeafSchemaNode intervalLeaf = (LeafSchemaNode) interval.getDataChildByName("interval");
269 assertFalse(intervalLeaf.isAugmenting());
271 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
272 assertNotNull(how_g);
273 TestUtils.checkIsAddedByUses(how_g, false);
274 assertFalse(how_u.equals(how_g));
276 LeafSchemaNode address_u = (LeafSchemaNode) foo.getDataChildByName("address");
277 assertNotNull(address_u);
278 assertNull(address_u.getDefault());
279 assertEquals("Target IP address", address_u.getDescription());
280 assertNull(address_u.getReference());
281 assertTrue(address_u.isConfiguration());
282 assertTrue(address_u.isAddedByUses());
284 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
285 assertNotNull(address_g);
286 assertFalse(address_g.isAddedByUses());
287 assertNull(address_g.getDefault());
288 assertEquals("Target IP address", address_g.getDescription());
289 assertNull(address_g.getReference());
290 assertTrue(address_g.isConfiguration());
291 assertFalse(address_u.equals(address_g));
293 ContainerSchemaNode port_u = (ContainerSchemaNode) foo.getDataChildByName("port");
294 assertNotNull(port_u);
295 TestUtils.checkIsAddedByUses(port_u, true);
297 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
298 assertNotNull(port_g);
299 TestUtils.checkIsAddedByUses(port_g, false);
300 assertFalse(port_u.equals(port_g));
302 ListSchemaNode addresses_u = (ListSchemaNode) foo.getDataChildByName("addresses");
303 assertNotNull(addresses_u);
304 TestUtils.checkIsAddedByUses(addresses_u, true);
306 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
307 assertNotNull(addresses_g);
308 TestUtils.checkIsAddedByUses(addresses_g, false);
309 assertFalse(addresses_u.equals(addresses_g));
311 // grouping defined by 'uses'
312 Set<GroupingDefinition> groupings_u = foo.getGroupings();
313 assertEquals(1, groupings_u.size());
314 GroupingDefinition grouping_u = groupings_u.iterator().next();
315 TestUtils.checkIsAddedByUses(grouping_u, true);
317 // grouping defined in 'grouping' node
318 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
319 assertEquals(1, groupings_g.size());
320 GroupingDefinition grouping_g = groupings_g.iterator().next();
321 TestUtils.checkIsAddedByUses(grouping_g, false);
322 assertFalse(grouping_u.equals(grouping_g));
324 List<UnknownSchemaNode> nodes_u = foo.getUnknownSchemaNodes();
325 assertEquals(1, nodes_u.size());
326 UnknownSchemaNode node_u = nodes_u.get(0);
327 assertTrue(node_u.isAddedByUses());
329 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
330 assertEquals(1, nodes_g.size());
331 UnknownSchemaNode node_g = nodes_g.get(0);
332 assertFalse(node_g.isAddedByUses());
333 assertFalse(node_u.equals(node_g));
335 UsesNode un = uses.iterator().next();
336 Set<AugmentationSchema> usesAugments = un.getAugmentations();
337 assertEquals(1, usesAugments.size());
338 AugmentationSchema augment = usesAugments.iterator().next();
339 assertEquals("inner augment", augment.getDescription());
340 Set<DataSchemaNode> children = augment.getChildNodes();
341 assertEquals(1, children.size());
342 DataSchemaNode leaf = children.iterator().next();
343 assertTrue(leaf instanceof LeafSchemaNode);
344 assertEquals("name", leaf.getQName().getLocalName());
348 public void testCascadeUses() throws FileNotFoundException, ParseException {
349 File yangFile = new File(getClass().getResource("/grouping-test/cascade-uses.yang").getPath());
350 YangModelParser parser = new YangParserImpl();
351 modules = parser.parseYangModels(Collections.singletonList(yangFile));
352 assertEquals(1, modules.size());
354 Module testModule = TestUtils.findModule(modules, "cascade-uses");
355 Set<GroupingDefinition> groupings = testModule.getGroupings();
357 GroupingDefinition gu = null;
358 GroupingDefinition gv = null;
359 GroupingDefinition gx = null;
360 GroupingDefinition gy = null;
361 GroupingDefinition gz = null;
362 GroupingDefinition gzz = null;
363 for (GroupingDefinition gd : groupings) {
364 String name = gd.getQName().getLocalName();
393 URI expectedNS = URI.create("urn:grouping:cascade-uses");
394 Date expectedRev = new SimpleDateFormat("yyyy-MM-dd").parse("2013-07-18");
395 String expectedPref = "cu";
396 SchemaPath expectedPath;
399 Set<DataSchemaNode> childNodes = gu.getChildNodes();
400 assertEquals(7, childNodes.size());
401 LeafSchemaNode leafGroupingU = null;
402 for (DataSchemaNode childNode : childNodes) {
403 if ("leaf-grouping-U".equals(childNode.getQName().getLocalName())) {
404 leafGroupingU = (LeafSchemaNode) childNode;
406 TestUtils.checkIsAddedByUses(childNode, true);
409 assertNotNull(leafGroupingU);
410 assertFalse(leafGroupingU.isAddedByUses());
413 childNodes = gv.getChildNodes();
414 assertEquals(4, childNodes.size());
415 LeafSchemaNode leafGroupingV = null;
416 ContainerSchemaNode containerGroupingV = null;
417 for (DataSchemaNode childNode : childNodes) {
418 if ("leaf-grouping-V".equals(childNode.getQName().getLocalName())) {
419 leafGroupingV = (LeafSchemaNode) childNode;
420 } else if ("container-grouping-V".equals(childNode.getQName().getLocalName())) {
421 containerGroupingV = (ContainerSchemaNode) childNode;
423 TestUtils.checkIsAddedByUses(childNode, true);
426 assertNotNull(leafGroupingV);
427 assertFalse(leafGroupingV.isAddedByUses());
429 // grouping-V/container-grouping-V
430 assertNotNull(containerGroupingV);
431 assertFalse(containerGroupingV.isAddedByUses());
432 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
433 "container-grouping-V");
434 assertEquals(expectedPath, containerGroupingV.getPath());
435 childNodes = containerGroupingV.getChildNodes();
436 assertEquals(2, childNodes.size());
437 for (DataSchemaNode childNode : childNodes) {
438 TestUtils.checkIsAddedByUses(childNode, true);
441 // grouping-V/container-grouping-V/leaf-grouping-X
442 LeafSchemaNode leafXinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-X");
443 assertNotNull(leafXinContainerV);
444 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
445 "container-grouping-V", "leaf-grouping-X");
446 assertEquals(expectedPath, leafXinContainerV.getPath());
447 // grouping-V/container-grouping-V/leaf-grouping-Y
448 LeafSchemaNode leafYinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-Y");
449 assertNotNull(leafYinContainerV);
450 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
451 "container-grouping-V", "leaf-grouping-Y");
452 assertEquals(expectedPath, leafYinContainerV.getPath());
455 childNodes = gx.getChildNodes();
456 assertEquals(2, childNodes.size());
458 // grouping-X/leaf-grouping-X
459 LeafSchemaNode leafXinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-X");
460 assertNotNull(leafXinGX);
461 assertFalse(leafXinGX.isAddedByUses());
462 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
464 assertEquals(expectedPath, leafXinGX.getPath());
466 // grouping-X/leaf-grouping-Y
467 LeafSchemaNode leafYinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-Y");
468 assertNotNull(leafYinGX);
469 assertTrue(leafYinGX.isAddedByUses());
470 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
472 assertEquals(expectedPath, leafYinGX.getPath());
475 childNodes = gy.getChildNodes();
476 assertEquals(1, childNodes.size());
478 // grouping-Y/leaf-grouping-Y
479 LeafSchemaNode leafYinGY = (LeafSchemaNode) gy.getDataChildByName("leaf-grouping-Y");
480 assertNotNull(leafYinGY);
481 assertFalse(leafYinGY.isAddedByUses());
482 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Y",
484 assertEquals(expectedPath, leafYinGY.getPath());
487 childNodes = gz.getChildNodes();
488 assertEquals(1, childNodes.size());
490 // grouping-Z/leaf-grouping-Z
491 LeafSchemaNode leafZinGZ = (LeafSchemaNode) gz.getDataChildByName("leaf-grouping-Z");
492 assertNotNull(leafZinGZ);
493 assertFalse(leafZinGZ.isAddedByUses());
494 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Z",
496 assertEquals(expectedPath, leafZinGZ.getPath());
499 childNodes = gzz.getChildNodes();
500 assertEquals(1, childNodes.size());
502 // grouping-ZZ/leaf-grouping-ZZ
503 LeafSchemaNode leafZZinGZZ = (LeafSchemaNode) gzz.getDataChildByName("leaf-grouping-ZZ");
504 assertNotNull(leafZZinGZZ);
505 assertFalse(leafZZinGZZ.isAddedByUses());
506 expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-ZZ",
508 assertEquals(expectedPath, leafZZinGZZ.getPath());