2 * Copyright (c) 2016 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.stmt;
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.assertTrue;
14 import static org.opendaylight.yangtools.yang.stmt.StmtTestUtils.sourceForResource;
16 import com.google.common.collect.Iterables;
17 import com.google.common.collect.Range;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.List;
23 import java.util.Optional;
25 import org.junit.Test;
26 import org.opendaylight.yangtools.yang.common.QName;
27 import org.opendaylight.yangtools.yang.common.Revision;
28 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.DeviateKind;
33 import org.opendaylight.yangtools.yang.model.api.Deviation;
34 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
35 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
36 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.Module;
40 import org.opendaylight.yangtools.yang.model.api.MustDefinition;
41 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
42 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
44 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.UsesNode;
46 import org.opendaylight.yangtools.yang.model.api.type.Uint16TypeDefinition;
47 import org.opendaylight.yangtools.yang.model.api.type.Uint8TypeDefinition;
48 import org.opendaylight.yangtools.yang.parser.impl.DefaultReactors;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
50 import org.opendaylight.yangtools.yang.parser.spi.source.StatementStreamSource;
52 public class YangParserWithContextTest {
53 private static final URI T1_NS = URI.create("urn:simple.demo.test1");
54 private static final URI T2_NS = URI.create("urn:simple.demo.test2");
55 private static final URI T3_NS = URI.create("urn:simple.demo.test3");
56 private static final Revision REV = Revision.of("2013-06-18");
58 private static final StatementStreamSource BAR = sourceForResource("/model/bar.yang");
59 private static final StatementStreamSource BAZ = sourceForResource("/model/baz.yang");
60 private static final StatementStreamSource FOO = sourceForResource("/model/foo.yang");
61 private static final StatementStreamSource SUBFOO = sourceForResource("/model/subfoo.yang");
63 private static final StatementStreamSource[] IETF = new StatementStreamSource[] {
64 sourceForResource("/ietf/iana-afn-safi@2012-06-04.yang"),
65 sourceForResource("/ietf/iana-if-type@2012-06-05.yang"),
66 sourceForResource("/ietf/iana-timezones@2012-07-09.yang"),
67 sourceForResource("/ietf/ietf-inet-types@2010-09-24.yang"),
68 sourceForResource("/ietf/ietf-yang-types@2010-09-24.yang"),
69 sourceForResource("/ietf/network-topology@2013-07-12.yang"),
70 sourceForResource("/ietf/network-topology@2013-10-21.yang") };
73 public void testTypeFromContext() throws ReactorException {
74 final SchemaContext context = DefaultReactors.defaultReactor().newBuild()
76 .addSource(sourceForResource("/types/custom-types-test@2012-04-04.yang"))
77 .addSource(sourceForResource("/context-test/test1.yang"))
80 final Module module = context.findModule("test1", Revision.of("2013-06-18")).get();
81 final LeafSchemaNode leaf = (LeafSchemaNode) module.getDataChildByName(QName.create(module.getQNameModule(),
84 assertTrue(leaf.getType() instanceof Uint16TypeDefinition);
85 final Uint16TypeDefinition leafType = (Uint16TypeDefinition) leaf.getType();
86 QName qname = leafType.getQName();
87 assertEquals(URI.create("urn:simple.demo.test1"), qname.getNamespace());
88 assertEquals(Revision.ofNullable("2013-06-18"), qname.getRevision());
89 assertEquals("port-number", qname.getLocalName());
91 final Uint16TypeDefinition leafBaseType = leafType.getBaseType();
92 qname = leafBaseType.getQName();
93 assertEquals(URI.create("urn:ietf:params:xml:ns:yang:ietf-inet-types"), qname.getNamespace());
94 assertEquals(Revision.ofNullable("2010-09-24"), qname.getRevision());
95 assertEquals("port-number", qname.getLocalName());
97 final Uint8TypeDefinition dscpExt = (Uint8TypeDefinition) TestUtils.findTypedef(module.getTypeDefinitions(),
99 final Set<? extends Range<?>> ranges = dscpExt.getRangeConstraint().get().getAllowedRanges().asRanges();
100 assertEquals(1, ranges.size());
101 final Range<?> range = ranges.iterator().next();
102 assertEquals((short)0, range.lowerEndpoint());
103 assertEquals((short)63, range.upperEndpoint());
107 public void testUsesFromContext() throws ReactorException {
108 final SchemaContext context = DefaultReactors.defaultReactor().newBuild()
109 .addSources(BAZ, FOO, BAR, SUBFOO, sourceForResource("/context-test/test2.yang"))
112 final Module testModule = context.findModule("test2", Revision.of("2013-06-18")).get();
113 final Module contextModule = context.findModules(URI.create("urn:opendaylight.baz")).iterator().next();
114 assertNotNull(contextModule);
115 final Set<GroupingDefinition> groupings = contextModule.getGroupings();
116 assertEquals(1, groupings.size());
117 final GroupingDefinition grouping = groupings.iterator().next();
119 // get node containing uses
120 final ContainerSchemaNode peer = (ContainerSchemaNode) testModule.getDataChildByName(QName.create(
121 testModule.getQNameModule(), "peer"));
122 final ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName(QName.create(
123 testModule.getQNameModule(), "destination"));
126 final Set<UsesNode> uses = destination.getUses();
127 assertEquals(1, uses.size());
129 // check uses process
130 final AnyXmlSchemaNode data_u = (AnyXmlSchemaNode) destination.getDataChildByName(QName.create(
131 testModule.getQNameModule(), "data"));
132 assertNotNull(data_u);
133 assertTrue(data_u.isAddedByUses());
135 final AnyXmlSchemaNode data_g = (AnyXmlSchemaNode) grouping.getDataChildByName(QName.create(
136 contextModule.getQNameModule(), "data"));
137 assertNotNull(data_g);
138 assertFalse(data_g.isAddedByUses());
139 assertFalse(data_u.equals(data_g));
141 final ChoiceSchemaNode how_u = (ChoiceSchemaNode) destination.getDataChildByName(QName.create(
142 testModule.getQNameModule(), "how"));
143 assertNotNull(how_u);
144 assertTrue(how_u.isAddedByUses());
146 final ChoiceSchemaNode how_g = (ChoiceSchemaNode) grouping.getDataChildByName(QName.create(
147 contextModule.getQNameModule(), "how"));
148 assertNotNull(how_g);
149 assertFalse(how_g.isAddedByUses());
150 assertFalse(how_u.equals(how_g));
152 final LeafSchemaNode address_u = (LeafSchemaNode) destination.getDataChildByName(QName.create(
153 testModule.getQNameModule(), "address"));
154 assertNotNull(address_u);
155 assertTrue(address_u.isAddedByUses());
157 final LeafSchemaNode address_g = (LeafSchemaNode) grouping.getDataChildByName(QName.create(
158 contextModule.getQNameModule(), "address"));
159 assertNotNull(address_g);
160 assertFalse(address_g.isAddedByUses());
161 assertFalse(address_u.equals(address_g));
163 final ContainerSchemaNode port_u = (ContainerSchemaNode) destination.getDataChildByName(QName.create(
164 testModule.getQNameModule(), "port"));
165 assertNotNull(port_u);
166 assertTrue(port_u.isAddedByUses());
168 final ContainerSchemaNode port_g = (ContainerSchemaNode) grouping.getDataChildByName(QName.create(
169 contextModule.getQNameModule(), "port"));
170 assertNotNull(port_g);
171 assertFalse(port_g.isAddedByUses());
172 assertFalse(port_u.equals(port_g));
174 final ListSchemaNode addresses_u = (ListSchemaNode) destination.getDataChildByName(QName.create(
175 testModule.getQNameModule(), "addresses"));
176 assertNotNull(addresses_u);
177 assertTrue(addresses_u.isAddedByUses());
179 final ListSchemaNode addresses_g = (ListSchemaNode) grouping.getDataChildByName(QName.create(
180 contextModule.getQNameModule(), "addresses"));
181 assertNotNull(addresses_g);
182 assertFalse(addresses_g.isAddedByUses());
183 assertFalse(addresses_u.equals(addresses_g));
185 // grouping defined by 'uses'
186 final Set<GroupingDefinition> groupings_u = destination.getGroupings();
187 assertEquals(1, groupings_u.size());
188 final GroupingDefinition grouping_u = groupings_u.iterator().next();
189 assertTrue(grouping_u.isAddedByUses());
191 // grouping defined in 'grouping' node
192 final Set<GroupingDefinition> groupings_g = grouping.getGroupings();
193 assertEquals(1, groupings_g.size());
194 final GroupingDefinition grouping_g = groupings_g.iterator().next();
195 assertFalse(grouping_g.isAddedByUses());
196 assertFalse(grouping_u.equals(grouping_g));
198 final List<UnknownSchemaNode> nodes_u = destination.getUnknownSchemaNodes();
199 assertEquals(1, nodes_u.size());
200 final UnknownSchemaNode node_u = nodes_u.get(0);
201 assertTrue(node_u.isAddedByUses());
203 final List<UnknownSchemaNode> nodes_g = grouping.getUnknownSchemaNodes();
204 assertEquals(1, nodes_g.size());
205 final UnknownSchemaNode node_g = nodes_g.get(0);
206 assertFalse(node_g.isAddedByUses());
207 assertFalse(node_u.equals(node_g));
211 public void testUsesRefineFromContext() throws ReactorException {
212 final SchemaContext context = DefaultReactors.defaultReactor().newBuild()
213 .addSources(BAZ, FOO, BAR, SUBFOO, sourceForResource("/context-test/test2.yang"))
216 final Module module = context.findModule("test2", Revision.of("2013-06-18")).get();
217 final ContainerSchemaNode peer = (ContainerSchemaNode) module.getDataChildByName(QName.create(
218 module.getQNameModule(), "peer"));
219 final ContainerSchemaNode destination = (ContainerSchemaNode) peer.getDataChildByName(QName.create(
220 module.getQNameModule(), "destination"));
221 final Set<UsesNode> usesNodes = destination.getUses();
222 assertEquals(1, usesNodes.size());
223 final UsesNode usesNode = usesNodes.iterator().next();
225 // test grouping path
226 final List<QName> path = new ArrayList<>();
227 final QName qname = QName.create(URI.create("urn:opendaylight.baz"), Revision.of("2013-02-27"), "target");
229 final SchemaPath expectedPath = SchemaPath.create(path, true);
230 assertEquals(expectedPath, usesNode.getGroupingPath());
233 final Map<SchemaPath, SchemaNode> refines = usesNode.getRefines();
234 assertEquals(3, refines.size());
236 LeafSchemaNode refineLeaf = null;
237 ContainerSchemaNode refineContainer = null;
238 ListSchemaNode refineList = null;
239 for (final Map.Entry<SchemaPath, SchemaNode> entry : refines.entrySet()) {
240 final SchemaNode value = entry.getValue();
241 if (value instanceof LeafSchemaNode) {
242 refineLeaf = (LeafSchemaNode) value;
243 } else if (value instanceof ContainerSchemaNode) {
244 refineContainer = (ContainerSchemaNode) value;
245 } else if (value instanceof ListSchemaNode) {
246 refineList = (ListSchemaNode) value;
251 assertNotNull(refineLeaf);
252 assertEquals("address", refineLeaf.getQName().getLocalName());
253 assertEquals(Optional.of("description of address defined by refine"), refineLeaf.getDescription());
254 assertEquals(Optional.of("address reference added by refine"), refineLeaf.getReference());
255 assertFalse(refineLeaf.isConfiguration());
256 assertTrue(refineLeaf.isMandatory());
257 final Collection<MustDefinition> leafMustConstraints = refineLeaf.getMustConstraints();
258 assertEquals(1, leafMustConstraints.size());
259 final MustDefinition leafMust = leafMustConstraints.iterator().next();
260 assertEquals("ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)", leafMust.toString());
263 assertNotNull(refineContainer);
264 final Collection<MustDefinition> mustConstraints = refineContainer.getMustConstraints();
265 assertTrue(mustConstraints.isEmpty());
266 assertEquals(Optional.of("description of port defined by refine"), refineContainer.getDescription());
267 assertEquals(Optional.of("port reference added by refine"), refineContainer.getReference());
268 assertFalse(refineContainer.isConfiguration());
269 assertTrue(refineContainer.isPresenceContainer());
272 assertNotNull(refineList);
273 assertEquals(Optional.of("description of addresses defined by refine"), refineList.getDescription());
274 assertEquals(Optional.of("addresses reference added by refine"), refineList.getReference());
275 assertFalse(refineList.isConfiguration());
276 final ElementCountConstraint constraint = refineList.getElementCountConstraint().get();
277 assertEquals(2, constraint.getMinElements().intValue());
278 assertEquals(12, constraint.getMaxElements().intValue());
282 public void testIdentity() throws ReactorException {
283 final SchemaContext context = DefaultReactors.defaultReactor().newBuild()
285 .addSource(sourceForResource("/types/custom-types-test@2012-04-04.yang"))
286 .addSource(sourceForResource("/context-test/test3.yang"))
289 final Module module = context.findModule("test3", Revision.of("2013-06-18")).get();
290 final Set<IdentitySchemaNode> identities = module.getIdentities();
291 assertEquals(1, identities.size());
293 final IdentitySchemaNode identity = identities.iterator().next();
294 final QName idQName = identity.getQName();
295 assertEquals(URI.create("urn:simple.demo.test3"), idQName.getNamespace());
296 assertEquals(Revision.ofNullable("2013-06-18"), idQName.getRevision());
297 assertEquals("pt", idQName.getLocalName());
299 final IdentitySchemaNode baseIdentity = Iterables.getOnlyElement(identity.getBaseIdentities());
300 final QName idBaseQName = baseIdentity.getQName();
301 assertEquals(URI.create("urn:custom.types.demo"), idBaseQName.getNamespace());
302 assertEquals(Revision.ofNullable("2012-04-16"), idBaseQName.getRevision());
303 assertEquals("service-type", idBaseQName.getLocalName());
307 public void testUnknownNodes() throws ReactorException {
308 final SchemaContext context = DefaultReactors.defaultReactor().newBuild()
310 .addSource(sourceForResource("/types/custom-types-test@2012-04-04.yang"))
311 .addSource(sourceForResource("/context-test/test3.yang"))
314 final Module module = context.findModule("test3", Revision.of("2013-06-18")).get();
315 final ContainerSchemaNode network = (ContainerSchemaNode) module.getDataChildByName(QName.create(
316 module.getQNameModule(), "network"));
317 final List<UnknownSchemaNode> unknownNodes = network.getUnknownSchemaNodes();
318 assertEquals(1, unknownNodes.size());
320 final UnknownSchemaNode un = unknownNodes.get(0);
321 final QName unType = un.getNodeType();
322 assertEquals(URI.create("urn:custom.types.demo"), unType.getNamespace());
323 assertEquals(Revision.ofNullable("2012-04-16"), unType.getRevision());
324 assertEquals("mountpoint", unType.getLocalName());
325 assertEquals("point", un.getNodeParameter());
326 assertNotNull(un.getExtensionDefinition());
330 public void testAugment() throws ReactorException {
331 final StatementStreamSource resource = sourceForResource("/context-augment-test/test4.yang");
332 final StatementStreamSource test1 = sourceForResource("/context-augment-test/test1.yang");
333 final StatementStreamSource test2 = sourceForResource("/context-augment-test/test2.yang");
334 final StatementStreamSource test3 = sourceForResource("/context-augment-test/test3.yang");
336 final SchemaContext context = TestUtils.parseYangSources(resource, test1, test2, test3);
337 final Module t4 = TestUtils.findModule(context, "test4").get();
338 final ContainerSchemaNode interfaces = (ContainerSchemaNode) t4.getDataChildByName(QName.create(
339 t4.getQNameModule(), "interfaces"));
340 final ListSchemaNode ifEntry = (ListSchemaNode) interfaces.getDataChildByName(QName.create(t4.getQNameModule(),
343 // test augmentation process
344 final ContainerSchemaNode augmentHolder = (ContainerSchemaNode) ifEntry.getDataChildByName(QName.create(T3_NS,
345 REV, "augment-holder"));
346 assertNotNull(augmentHolder);
347 final DataSchemaNode ds0 = augmentHolder.getDataChildByName(QName.create(T2_NS, REV, "ds0ChannelNumber"));
349 final DataSchemaNode interfaceId = augmentHolder.getDataChildByName(QName.create(T2_NS, REV, "interface-id"));
350 assertNotNull(interfaceId);
351 final DataSchemaNode higherLayerIf = augmentHolder.getDataChildByName(QName.create(T2_NS, REV,
353 assertNotNull(higherLayerIf);
354 final ContainerSchemaNode schemas = (ContainerSchemaNode) augmentHolder.getDataChildByName(QName.create(T2_NS,
356 assertNotNull(schemas);
357 assertNotNull(schemas.getDataChildByName(QName.create(T1_NS, REV, "id")));
359 // test augment target after augmentation: check if it is same instance
360 final ListSchemaNode ifEntryAfterAugment = (ListSchemaNode) interfaces.getDataChildByName(QName.create(
361 t4.getQNameModule(), "ifEntry"));
362 assertTrue(ifEntry == ifEntryAfterAugment);
366 public void testDeviation() throws ReactorException {
367 final SchemaContext context = DefaultReactors.defaultReactor().newBuild()
368 .addSource(sourceForResource("/model/bar.yang"))
369 .addSource(sourceForResource("/context-test/deviation-test.yang"))
372 final Module testModule = context.findModule("deviation-test", Revision.of("2013-02-27")).get();
373 final Set<Deviation> deviations = testModule.getDeviations();
374 assertEquals(1, deviations.size());
375 final Deviation dev = deviations.iterator().next();
377 assertEquals(Optional.of("system/user ref"), dev.getReference());
379 final URI expectedNS = URI.create("urn:opendaylight.bar");
380 final Revision expectedRev = Revision.of("2013-07-03");
381 final List<QName> path = new ArrayList<>();
382 path.add(QName.create(expectedNS, expectedRev, "interfaces"));
383 path.add(QName.create(expectedNS, expectedRev, "ifEntry"));
384 final SchemaPath expectedPath = SchemaPath.create(path, true);
386 assertEquals(expectedPath, dev.getTargetPath());
387 assertEquals(DeviateKind.ADD, dev.getDeviates().iterator().next().getDeviateType());