Merge "BUG-981: Migrate from deprecated private method to public"
[yangtools.git] / 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.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;
15
16 import java.io.File;
17 import java.io.IOException;
18 import java.net.URI;
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;
24 import java.util.Map;
25 import java.util.Set;
26 import org.junit.Before;
27 import org.junit.Test;
28 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
30 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
31 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
32 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
35 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.Module;
38 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
39 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
41 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.UsesNode;
43 import org.opendaylight.yangtools.yang.model.parser.api.YangContextParser;
44
45 public class GroupingTest {
46     private Set<Module> modules;
47
48     @Before
49     public void init() throws IOException, URISyntaxException {
50         modules = TestUtils.loadModules(getClass().getResource("/model").toURI());
51         assertEquals(3, modules.size());
52     }
53
54     @Test
55     public void testRefine() {
56         Module testModule = TestUtils.findModule(modules, "foo");
57         ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
58         ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
59
60         Set<UsesNode> usesNodes = destination.getUses();
61         assertEquals(1, usesNodes.size());
62         UsesNode usesNode = usesNodes.iterator().next();
63         Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
64         assertEquals(4, refines.size());
65
66         LeafSchemaNode refineLeaf = null;
67         ContainerSchemaNode refineContainer = null;
68         ListSchemaNode refineList = null;
69         LeafSchemaNode refineInnerLeaf = null;
70         for (Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
71             SchemaNode value = entry.getValue();
72             if ("address".equals(value.getQName().getLocalName())) {
73                 refineLeaf = (LeafSchemaNode) value;
74             } else if ("port".equals(value.getQName().getLocalName())) {
75                 refineContainer = (ContainerSchemaNode) value;
76             } else if ("addresses".equals(value.getQName().getLocalName())) {
77                 refineList = (ListSchemaNode) value;
78             } else if ("id".equals(value.getQName().getLocalName())) {
79                 refineInnerLeaf = (LeafSchemaNode) value;
80             }
81         }
82
83         // leaf address
84         assertNotNull(refineLeaf);
85         assertEquals("IP address of target node", refineLeaf.getDescription());
86         assertEquals("address reference added by refine", refineLeaf.getReference());
87         assertFalse(refineLeaf.isConfiguration());
88         assertFalse(refineLeaf.getConstraints().isMandatory());
89         Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
90         assertEquals(1, leafMustConstraints.size());
91         MustDefinition leafMust = leafMustConstraints.iterator().next();
92         assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
93         assertEquals(1, refineLeaf.getUnknownSchemaNodes().size());
94
95         // container port
96         assertNotNull(refineContainer);
97         Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
98         assertTrue(mustConstraints.isEmpty());
99         assertEquals("description of port defined by refine", refineContainer.getDescription());
100         assertEquals("port reference added by refine", refineContainer.getReference());
101         assertFalse(refineContainer.isConfiguration());
102         assertTrue(refineContainer.isPresenceContainer());
103
104         // list addresses
105         assertNotNull(refineList);
106         assertEquals("description of addresses defined by refine", refineList.getDescription());
107         assertEquals("addresses reference added by refine", refineList.getReference());
108         assertFalse(refineList.isConfiguration());
109         assertEquals(2, (int) refineList.getConstraints().getMinElements());
110         assertEquals(12, (int) refineList.getConstraints().getMaxElements());
111
112         // leaf id
113         assertNotNull(refineInnerLeaf);
114         assertEquals("id of address", refineInnerLeaf.getDescription());
115     }
116
117     @Test
118     public void testGrouping() {
119         Module testModule = TestUtils.findModule(modules, "baz");
120         Set<GroupingDefinition> groupings = testModule.getGroupings();
121         assertEquals(1, groupings.size());
122         GroupingDefinition grouping = groupings.iterator().next();
123         Set<DataSchemaNode> children = grouping.getChildNodes();
124         assertEquals(5, children.size());
125     }
126
127     @Test
128     public void testUses() {
129         // suffix _u = added by uses
130         // suffix _g = defined in grouping
131
132         Module testModule = TestUtils.findModule(modules, "baz");
133
134         // get grouping
135         Set<GroupingDefinition> groupings = testModule.getGroupings();
136         assertEquals(1, groupings.size());
137         GroupingDefinition grouping = groupings.iterator().next();
138
139         testModule = TestUtils.findModule(modules, "foo");
140
141         // get node containing uses
142         ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
143         ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
144
145         // check uses
146         Set<UsesNode> uses = destination.getUses();
147         assertEquals(1, uses.size());
148
149         // check uses process
150         AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
151         assertNotNull(data_u);
152         assertTrue(data_u.isAddedByUses());
153
154         AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
155         assertNotNull(data_g);
156         assertFalse(data_g.isAddedByUses());
157         assertFalse(data_u.equals(data_g));
158
159         ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
160         assertNotNull(how_u);
161         TestUtils.checkIsAddedByUses(how_u, true);
162         assertEquals(2, how_u.getCases().size());
163
164         ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
165         assertNotNull(how_g);
166         TestUtils.checkIsAddedByUses(how_g, false);
167         assertEquals(2, how_g.getCases().size());
168         assertFalse(how_u.equals(how_g));
169
170         LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
171         assertNotNull(address_u);
172         assertEquals("1.2.3.4", address_u.getDefault());
173         assertEquals("IP address of target node", address_u.getDescription());
174         assertEquals("address reference added by refine", address_u.getReference());
175         assertFalse(address_u.isConfiguration());
176         assertTrue(address_u.isAddedByUses());
177         assertFalse(address_u.getConstraints().isMandatory());
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         assertTrue(address_g.getConstraints().isMandatory());
188
189         ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
190         assertNotNull(port_u);
191         TestUtils.checkIsAddedByUses(port_u, true);
192
193         ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
194         assertNotNull(port_g);
195         TestUtils.checkIsAddedByUses(port_g, false);
196         assertFalse(port_u.equals(port_g));
197
198         ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
199         assertNotNull(addresses_u);
200         TestUtils.checkIsAddedByUses(addresses_u, true);
201
202         ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
203         assertNotNull(addresses_g);
204         TestUtils.checkIsAddedByUses(addresses_g, false);
205         assertFalse(addresses_u.equals(addresses_g));
206
207         // grouping defined by 'uses'
208         Set<GroupingDefinition> groupings_u = destination.getGroupings();
209         assertEquals(1, groupings_u.size());
210         GroupingDefinition grouping_u = groupings_u.iterator().next();
211         TestUtils.checkIsAddedByUses(grouping_u, true);
212
213         // grouping defined in 'grouping' node
214         Set<GroupingDefinition> groupings_g = grouping.getGroupings();
215         assertEquals(1, groupings_g.size());
216         GroupingDefinition grouping_g = groupings_g.iterator().next();
217         TestUtils.checkIsAddedByUses(grouping_g, false);
218         assertFalse(grouping_u.equals(grouping_g));
219
220         List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
221         assertEquals(1, nodes_u.size());
222         UnknownSchemaNode node_u = nodes_u.get(0);
223         assertTrue(node_u.isAddedByUses());
224
225         List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
226         assertEquals(1, nodes_g.size());
227         UnknownSchemaNode node_g = nodes_g.get(0);
228         assertFalse(node_g.isAddedByUses());
229         assertFalse(node_u.equals(node_g));
230     }
231
232     @Test
233     public void testUsesUnderModule() {
234         // suffix _u = added by uses
235         // suffix _g = defined in grouping
236
237         Module testModule = TestUtils.findModule(modules, "baz");
238
239         // get grouping
240         Set<GroupingDefinition> groupings = testModule.getGroupings();
241         assertEquals(1, groupings.size());
242         GroupingDefinition grouping = groupings.iterator().next();
243
244         // get node containing uses
245         Module foo = TestUtils.findModule(modules, "foo");
246
247         // check uses
248         Set<UsesNode> uses = foo.getUses();
249         assertEquals(1, uses.size());
250
251         // check uses process
252         AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) foo.getDataChildByName("data");
253         assertNotNull(data_u);
254         assertTrue(data_u.isAddedByUses());
255
256         AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
257         assertNotNull(data_g);
258         assertFalse(data_g.isAddedByUses());
259         assertFalse(data_u.equals(data_g));
260
261         ChoiceNode how_u = (ChoiceNode) foo.getDataChildByName("how");
262         assertNotNull(how_u);
263         TestUtils.checkIsAddedByUses(how_u, true);
264         assertFalse(how_u.isAugmenting());
265         Set<ChoiceCaseNode> cases_u = how_u.getCases();
266         assertEquals(2, cases_u.size());
267         ChoiceCaseNode interval = how_u.getCaseNodeByName("interval");
268         assertFalse(interval.isAugmenting());
269         LeafSchemaNode name = (LeafSchemaNode) interval.getDataChildByName("name");
270         assertTrue(name.isAugmenting());
271         LeafSchemaNode intervalLeaf = (LeafSchemaNode) interval.getDataChildByName("interval");
272         assertFalse(intervalLeaf.isAugmenting());
273
274         ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
275         assertNotNull(how_g);
276         TestUtils.checkIsAddedByUses(how_g, false);
277         assertFalse(how_u.equals(how_g));
278
279         LeafSchemaNode address_u = (LeafSchemaNode) foo.getDataChildByName("address");
280         assertNotNull(address_u);
281         assertNull(address_u.getDefault());
282         assertEquals("Target IP address", address_u.getDescription());
283         assertNull(address_u.getReference());
284         assertTrue(address_u.isConfiguration());
285         assertTrue(address_u.isAddedByUses());
286
287         LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
288         assertNotNull(address_g);
289         assertFalse(address_g.isAddedByUses());
290         assertNull(address_g.getDefault());
291         assertEquals("Target IP address", address_g.getDescription());
292         assertNull(address_g.getReference());
293         assertTrue(address_g.isConfiguration());
294         assertFalse(address_u.equals(address_g));
295
296         ContainerSchemaNode port_u = (ContainerSchemaNode) foo.getDataChildByName("port");
297         assertNotNull(port_u);
298         TestUtils.checkIsAddedByUses(port_u, true);
299
300         ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
301         assertNotNull(port_g);
302         TestUtils.checkIsAddedByUses(port_g, false);
303         assertFalse(port_u.equals(port_g));
304
305         ListSchemaNode addresses_u = (ListSchemaNode) foo.getDataChildByName("addresses");
306         assertNotNull(addresses_u);
307         TestUtils.checkIsAddedByUses(addresses_u, true);
308
309         ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
310         assertNotNull(addresses_g);
311         TestUtils.checkIsAddedByUses(addresses_g, false);
312         assertFalse(addresses_u.equals(addresses_g));
313
314         // grouping defined by 'uses'
315         Set<GroupingDefinition> groupings_u = foo.getGroupings();
316         assertEquals(1, groupings_u.size());
317         GroupingDefinition grouping_u = groupings_u.iterator().next();
318         TestUtils.checkIsAddedByUses(grouping_u, true);
319
320         // grouping defined in 'grouping' node
321         Set<GroupingDefinition> groupings_g = grouping.getGroupings();
322         assertEquals(1, groupings_g.size());
323         GroupingDefinition grouping_g = groupings_g.iterator().next();
324         TestUtils.checkIsAddedByUses(grouping_g, false);
325         assertFalse(grouping_u.equals(grouping_g));
326
327         List<UnknownSchemaNode> nodes_u = foo.getUnknownSchemaNodes();
328         assertEquals(1, nodes_u.size());
329         UnknownSchemaNode node_u = nodes_u.get(0);
330         assertTrue(node_u.isAddedByUses());
331
332         List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
333         assertEquals(1, nodes_g.size());
334         UnknownSchemaNode node_g = nodes_g.get(0);
335         assertFalse(node_g.isAddedByUses());
336         assertFalse(node_u.equals(node_g));
337
338         UsesNode un = uses.iterator().next();
339         Set<AugmentationSchema> usesAugments = un.getAugmentations();
340         assertEquals(1, usesAugments.size());
341         AugmentationSchema augment = usesAugments.iterator().next();
342         assertEquals("inner augment", augment.getDescription());
343         Set<DataSchemaNode> children = augment.getChildNodes();
344         assertEquals(1, children.size());
345         DataSchemaNode leaf = children.iterator().next();
346         assertTrue(leaf instanceof LeafSchemaNode);
347         assertEquals("name", leaf.getQName().getLocalName());
348     }
349
350     @Test
351     public void testCascadeUses() throws Exception {
352         File yangFile = new File(getClass().getResource("/grouping-test/cascade-uses.yang").toURI());
353         YangContextParser parser = new YangParserImpl();
354         modules = parser.parseFiles(Collections.singleton(yangFile)).getModules();
355         assertEquals(1, modules.size());
356
357         Module testModule = TestUtils.findModule(modules, "cascade-uses");
358         Set<GroupingDefinition> groupings = testModule.getGroupings();
359
360         GroupingDefinition gu = null;
361         GroupingDefinition gv = null;
362         GroupingDefinition gx = null;
363         GroupingDefinition gy = null;
364         GroupingDefinition gz = null;
365         GroupingDefinition gzz = null;
366         for (GroupingDefinition gd : groupings) {
367             String name = gd.getQName().getLocalName();
368             switch (name) {
369             case "grouping-U":
370                 gu = gd;
371                 break;
372             case "grouping-V":
373                 gv = gd;
374                 break;
375             case "grouping-X":
376                 gx = gd;
377                 break;
378             case "grouping-Y":
379                 gy = gd;
380                 break;
381             case "grouping-Z":
382                 gz = gd;
383                 break;
384             case "grouping-ZZ":
385                 gzz = gd;
386                 break;
387             }
388         }
389         assertNotNull(gu);
390         assertNotNull(gv);
391         assertNotNull(gx);
392         assertNotNull(gy);
393         assertNotNull(gz);
394         assertNotNull(gzz);
395
396         URI expectedNS = URI.create("urn:grouping:cascade-uses");
397         Date expectedRev = new SimpleDateFormat("yyyy-MM-dd").parse("2013-07-18");
398         String expectedPref = "cu";
399         SchemaPath expectedPath;
400
401         // grouping-U
402         Set<DataSchemaNode> childNodes = gu.getChildNodes();
403         assertEquals(7, childNodes.size());
404         LeafSchemaNode leafGroupingU = null;
405         for (DataSchemaNode childNode : childNodes) {
406             if ("leaf-grouping-U".equals(childNode.getQName().getLocalName())) {
407                 leafGroupingU = (LeafSchemaNode) childNode;
408             } else {
409                 TestUtils.checkIsAddedByUses(childNode, true);
410             }
411         }
412         assertNotNull(leafGroupingU);
413         assertFalse(leafGroupingU.isAddedByUses());
414
415         // grouping-V
416         childNodes = gv.getChildNodes();
417         assertEquals(4, childNodes.size());
418         LeafSchemaNode leafGroupingV = null;
419         ContainerSchemaNode containerGroupingV = null;
420         for (DataSchemaNode childNode : childNodes) {
421             if ("leaf-grouping-V".equals(childNode.getQName().getLocalName())) {
422                 leafGroupingV = (LeafSchemaNode) childNode;
423             } else if ("container-grouping-V".equals(childNode.getQName().getLocalName())) {
424                 containerGroupingV = (ContainerSchemaNode) childNode;
425             } else {
426                 TestUtils.checkIsAddedByUses(childNode, true);
427             }
428         }
429         assertNotNull(leafGroupingV);
430         assertFalse(leafGroupingV.isAddedByUses());
431
432         // grouping-V/container-grouping-V
433         assertNotNull(containerGroupingV);
434         assertFalse(containerGroupingV.isAddedByUses());
435         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
436                 "container-grouping-V");
437         assertEquals(expectedPath, containerGroupingV.getPath());
438         childNodes = containerGroupingV.getChildNodes();
439         assertEquals(2, childNodes.size());
440         for (DataSchemaNode childNode : childNodes) {
441             TestUtils.checkIsAddedByUses(childNode, true);
442         }
443
444         // grouping-V/container-grouping-V/leaf-grouping-X
445         LeafSchemaNode leafXinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-X");
446         assertNotNull(leafXinContainerV);
447         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
448                 "container-grouping-V", "leaf-grouping-X");
449         assertEquals(expectedPath, leafXinContainerV.getPath());
450         // grouping-V/container-grouping-V/leaf-grouping-Y
451         LeafSchemaNode leafYinContainerV = (LeafSchemaNode) containerGroupingV.getDataChildByName("leaf-grouping-Y");
452         assertNotNull(leafYinContainerV);
453         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-V",
454                 "container-grouping-V", "leaf-grouping-Y");
455         assertEquals(expectedPath, leafYinContainerV.getPath());
456
457         // grouping-X
458         childNodes = gx.getChildNodes();
459         assertEquals(2, childNodes.size());
460
461         // grouping-X/leaf-grouping-X
462         LeafSchemaNode leafXinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-X");
463         assertNotNull(leafXinGX);
464         assertFalse(leafXinGX.isAddedByUses());
465         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
466                 "leaf-grouping-X");
467         assertEquals(expectedPath, leafXinGX.getPath());
468
469         // grouping-X/leaf-grouping-Y
470         LeafSchemaNode leafYinGX = (LeafSchemaNode) gx.getDataChildByName("leaf-grouping-Y");
471         assertNotNull(leafYinGX);
472         assertTrue(leafYinGX.isAddedByUses());
473         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-X",
474                 "leaf-grouping-Y");
475         assertEquals(expectedPath, leafYinGX.getPath());
476
477         // grouping-Y
478         childNodes = gy.getChildNodes();
479         assertEquals(1, childNodes.size());
480
481         // grouping-Y/leaf-grouping-Y
482         LeafSchemaNode leafYinGY = (LeafSchemaNode) gy.getDataChildByName("leaf-grouping-Y");
483         assertNotNull(leafYinGY);
484         assertFalse(leafYinGY.isAddedByUses());
485         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Y",
486                 "leaf-grouping-Y");
487         assertEquals(expectedPath, leafYinGY.getPath());
488
489         // grouping-Z
490         childNodes = gz.getChildNodes();
491         assertEquals(1, childNodes.size());
492
493         // grouping-Z/leaf-grouping-Z
494         LeafSchemaNode leafZinGZ = (LeafSchemaNode) gz.getDataChildByName("leaf-grouping-Z");
495         assertNotNull(leafZinGZ);
496         assertFalse(leafZinGZ.isAddedByUses());
497         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-Z",
498                 "leaf-grouping-Z");
499         assertEquals(expectedPath, leafZinGZ.getPath());
500
501         // grouping-ZZ
502         childNodes = gzz.getChildNodes();
503         assertEquals(1, childNodes.size());
504
505         // grouping-ZZ/leaf-grouping-ZZ
506         LeafSchemaNode leafZZinGZZ = (LeafSchemaNode) gzz.getDataChildByName("leaf-grouping-ZZ");
507         assertNotNull(leafZZinGZZ);
508         assertFalse(leafZZinGZZ.isAddedByUses());
509         expectedPath = TestUtils.createPath(true, expectedNS, expectedRev, expectedPref, "grouping-ZZ",
510                 "leaf-grouping-ZZ");
511         assertEquals(expectedPath, leafZZinGZZ.getPath());
512     }
513
514 }