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.controller.yang.parser.impl;
10 import static org.junit.Assert.*;
12 import java.io.FileNotFoundException;
13 import java.util.List;
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.AugmentationSchema;
21 import org.opendaylight.controller.yang.model.api.ChoiceNode;
22 import org.opendaylight.controller.yang.model.api.ContainerSchemaNode;
23 import org.opendaylight.controller.yang.model.api.DataSchemaNode;
24 import org.opendaylight.controller.yang.model.api.GroupingDefinition;
25 import org.opendaylight.controller.yang.model.api.LeafSchemaNode;
26 import org.opendaylight.controller.yang.model.api.ListSchemaNode;
27 import org.opendaylight.controller.yang.model.api.Module;
28 import org.opendaylight.controller.yang.model.api.MustDefinition;
29 import org.opendaylight.controller.yang.model.api.SchemaNode;
30 import org.opendaylight.controller.yang.model.api.SchemaPath;
31 import org.opendaylight.controller.yang.model.api.TypeDefinition;
32 import org.opendaylight.controller.yang.model.api.UnknownSchemaNode;
33 import org.opendaylight.controller.yang.model.api.UsesNode;
34 import org.opendaylight.controller.yang.model.util.ExtendedType;
36 public class GroupingTest {
37 private Set<Module> modules;
40 public void init() throws FileNotFoundException {
41 modules = TestUtils.loadModules(getClass().getResource("/model").getPath());
42 assertEquals(3, modules.size());
46 public void testRefine() {
47 Module testModule = TestUtils.findModule(modules, "nodes");
49 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
50 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
51 Set<UsesNode> usesNodes = destination.getUses();
52 assertEquals(1, usesNodes.size());
53 UsesNode usesNode = usesNodes.iterator().next();
54 Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
55 assertEquals(5, refines.size());
57 LeafSchemaNode refineLeaf = null;
58 ContainerSchemaNode refineContainer = null;
59 ListSchemaNode refineList = null;
60 GroupingDefinition refineGrouping = null;
61 TypeDefinition<?> typedef = null;
62 for (Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
63 SchemaNode value = entry.getValue();
64 if (value instanceof LeafSchemaNode) {
65 refineLeaf = (LeafSchemaNode) value;
66 } else if (value instanceof ContainerSchemaNode) {
67 refineContainer = (ContainerSchemaNode) value;
68 } else if (value instanceof ListSchemaNode) {
69 refineList = (ListSchemaNode) value;
70 } else if (value instanceof GroupingDefinition) {
71 refineGrouping = (GroupingDefinition) value;
72 } else if (value instanceof TypeDefinition<?>) {
73 typedef = (TypeDefinition<?>) value;
78 assertNotNull(refineLeaf);
79 assertEquals("address", refineLeaf.getQName().getLocalName());
80 assertEquals("IP address of target node", refineLeaf.getDescription());
81 assertEquals("address reference added by refine", refineLeaf.getReference());
82 assertFalse(refineLeaf.isConfiguration());
83 assertTrue(refineLeaf.getConstraints().isMandatory());
84 Set<MustDefinition> leafMustConstraints = refineLeaf.getConstraints().getMustConstraints();
85 assertEquals(1, leafMustConstraints.size());
86 MustDefinition leafMust = leafMustConstraints.iterator().next();
87 assertEquals("\"ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)\"", leafMust.toString());
90 assertNotNull(refineContainer);
91 Set<MustDefinition> mustConstraints = refineContainer.getConstraints().getMustConstraints();
92 assertTrue(mustConstraints.isEmpty());
93 assertEquals("description of port defined by refine", refineContainer.getDescription());
94 assertEquals("port reference added by refine", refineContainer.getReference());
95 assertFalse(refineContainer.isConfiguration());
96 assertTrue(refineContainer.isPresenceContainer());
99 assertNotNull(refineList);
100 assertEquals("description of addresses defined by refine", refineList.getDescription());
101 assertEquals("addresses reference added by refine", refineList.getReference());
102 assertFalse(refineList.isConfiguration());
103 assertEquals(2, (int) refineList.getConstraints().getMinElements());
104 assertEquals(12, (int) refineList.getConstraints().getMaxElements());
106 // grouping target-inner
107 assertNotNull(refineGrouping);
108 Set<DataSchemaNode> refineGroupingChildren = refineGrouping.getChildNodes();
109 assertEquals(1, refineGroupingChildren.size());
110 LeafSchemaNode refineGroupingLeaf = (LeafSchemaNode) refineGroupingChildren.iterator().next();
111 assertEquals("inner-grouping-id", refineGroupingLeaf.getQName().getLocalName());
112 assertEquals("new target-inner grouping description", refineGrouping.getDescription());
114 // typedef group-type
115 assertNotNull(typedef);
116 assertEquals("new group-type description", typedef.getDescription());
117 assertEquals("new group-type reference", typedef.getReference());
118 assertTrue(typedef.getBaseType() instanceof ExtendedType);
122 public void testGrouping() {
123 Module testModule = TestUtils.findModule(modules, "custom");
124 Set<GroupingDefinition> groupings = testModule.getGroupings();
125 assertEquals(1, groupings.size());
126 GroupingDefinition grouping = groupings.iterator().next();
127 Set<DataSchemaNode> children = grouping.getChildNodes();
128 assertEquals(5, children.size());
132 public void testUses() {
133 // suffix _u = added by uses
134 // suffix _g = defined in grouping
136 Module testModule = TestUtils.findModule(modules, "custom");
139 Set<GroupingDefinition> groupings = testModule.getGroupings();
140 assertEquals(1, groupings.size());
141 GroupingDefinition grouping = groupings.iterator().next();
143 testModule = TestUtils.findModule(modules, "nodes");
145 // get node containing uses
146 ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName("peer");
147 ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName("destination");
150 Set<UsesNode> uses = destination.getUses();
151 assertEquals(1, uses.size());
153 // check uses process
154 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
155 assertNotNull(data_u);
156 assertTrue(data_u.isAddedByUses());
158 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
159 assertNotNull(data_g);
160 assertFalse(data_g.isAddedByUses());
161 assertFalse(data_u.equals(data_g));
163 ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
164 assertNotNull(how_u);
165 assertTrue(how_u.isAddedByUses());
167 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
168 assertNotNull(how_g);
169 assertFalse(how_g.isAddedByUses());
170 assertFalse(how_u.equals(how_g));
172 LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
173 assertNotNull(address_u);
174 assertEquals("1.2.3.4", address_u.getDefault());
175 assertEquals("IP address of target node", address_u.getDescription());
176 assertEquals("address reference added by refine", address_u.getReference());
177 assertFalse(address_u.isConfiguration());
178 assertTrue(address_u.isAddedByUses());
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));
189 ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
190 assertNotNull(port_u);
191 assertTrue(port_u.isAddedByUses());
193 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
194 assertNotNull(port_g);
195 assertFalse(port_g.isAddedByUses());
196 assertFalse(port_u.equals(port_g));
198 ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
199 assertNotNull(addresses_u);
200 assertTrue(addresses_u.isAddedByUses());
202 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
203 assertNotNull(addresses_g);
204 assertFalse(addresses_g.isAddedByUses());
205 assertFalse(addresses_u.equals(addresses_g));
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 assertTrue(grouping_u.isAddedByUses());
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 assertFalse(grouping_g.isAddedByUses());
218 assertFalse(grouping_u.equals(grouping_g));
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());
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));
233 public void testUsesUnderModule() {
234 // suffix _u = added by uses
235 // suffix _g = defined in grouping
237 Module testModule = TestUtils.findModule(modules, "custom");
240 Set<GroupingDefinition> groupings = testModule.getGroupings();
241 assertEquals(1, groupings.size());
242 GroupingDefinition grouping = groupings.iterator().next();
244 // get node containing uses
245 Module destination = TestUtils.findModule(modules, "nodes");
248 Set<UsesNode> uses = destination.getUses();
249 assertEquals(1, uses.size());
251 // check uses process
252 AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName("data");
253 assertNotNull(data_u);
254 assertTrue(data_u.isAddedByUses());
256 AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName("data");
257 assertNotNull(data_g);
258 assertFalse(data_g.isAddedByUses());
259 assertFalse(data_u.equals(data_g));
261 ChoiceNode how_u = (ChoiceNode) destination.getDataChildByName("how");
262 assertNotNull(how_u);
263 assertTrue(how_u.isAddedByUses());
265 ChoiceNode how_g = (ChoiceNode) grouping.getDataChildByName("how");
266 assertNotNull(how_g);
267 assertFalse(how_g.isAddedByUses());
268 assertFalse(how_u.equals(how_g));
270 LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName("address");
271 assertNotNull(address_u);
272 assertNull(address_u.getDefault());
273 assertEquals("Target IP address", address_u.getDescription());
274 assertNull(address_u.getReference());
275 assertTrue(address_u.isConfiguration());
276 assertTrue(address_u.isAddedByUses());
278 LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName("address");
279 assertNotNull(address_g);
280 assertFalse(address_g.isAddedByUses());
281 assertNull(address_g.getDefault());
282 assertEquals("Target IP address", address_g.getDescription());
283 assertNull(address_g.getReference());
284 assertTrue(address_g.isConfiguration());
285 assertFalse(address_u.equals(address_g));
287 ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName("port");
288 assertNotNull(port_u);
289 assertTrue(port_u.isAddedByUses());
291 ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName("port");
292 assertNotNull(port_g);
293 assertFalse(port_g.isAddedByUses());
294 assertFalse(port_u.equals(port_g));
296 ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName("addresses");
297 assertNotNull(addresses_u);
298 assertTrue(addresses_u.isAddedByUses());
300 ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName("addresses");
301 assertNotNull(addresses_g);
302 assertFalse(addresses_g.isAddedByUses());
303 assertFalse(addresses_u.equals(addresses_g));
305 // grouping defined by 'uses'
306 Set<GroupingDefinition> groupings_u = destination.getGroupings();
307 assertEquals(1, groupings_u.size());
308 GroupingDefinition grouping_u = groupings_u.iterator().next();
309 assertTrue(grouping_u.isAddedByUses());
311 // grouping defined in 'grouping' node
312 Set<GroupingDefinition> groupings_g = grouping.getGroupings();
313 assertEquals(1, groupings_g.size());
314 GroupingDefinition grouping_g = groupings_g.iterator().next();
315 assertFalse(grouping_g.isAddedByUses());
316 assertFalse(grouping_u.equals(grouping_g));
318 List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
319 assertEquals(1, nodes_u.size());
320 UnknownSchemaNode node_u = nodes_u.get(0);
321 assertTrue(node_u.isAddedByUses());
323 List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
324 assertEquals(1, nodes_g.size());
325 UnknownSchemaNode node_g = nodes_g.get(0);
326 assertFalse(node_g.isAddedByUses());
327 assertFalse(node_u.equals(node_g));
329 UsesNode un = uses.iterator().next();
330 Set<AugmentationSchema> usesAugments = un.getAugmentations();
331 assertEquals(1, usesAugments.size());
332 AugmentationSchema augment = usesAugments.iterator().next();
333 assertEquals("inner augment", augment.getDescription());
334 Set<DataSchemaNode> children = augment.getChildNodes();
335 assertEquals(1, children.size());
336 DataSchemaNode leaf = children.iterator().next();
337 assertTrue(leaf instanceof LeafSchemaNode);
338 assertEquals("name", leaf.getQName().getLocalName());