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.data.impl.schema;
10 import com.google.common.base.Function;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.Collections2;
13 import com.google.common.collect.Lists;
14 import com.google.common.collect.Sets;
15 import com.google.common.io.ByteSource;
16 import com.google.common.io.Resources;
17 import java.io.IOException;
19 import java.util.Collections;
20 import java.util.List;
21 import org.junit.Before;
22 import org.junit.Test;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
28 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeSchemaAwareBuilder;
37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeSchemaAwareBuilder;
38 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
39 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
42 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
45 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
46 import org.opendaylight.yangtools.yang.model.api.Module;
47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
48 import org.opendaylight.yangtools.yang.model.parser.api.YangSyntaxErrorException;
49 import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl;
51 public class NormalizedDataBuilderTest {
53 private ContainerSchemaNode containerNode;
54 private SchemaContext schema;
56 SchemaContext parseTestSchema(final String... yangPath) throws IOException, YangSyntaxErrorException {
57 YangParserImpl yangParserImpl = new YangParserImpl();
58 return yangParserImpl.parseSources(getTestYangs(yangPath));
61 List<ByteSource> getTestYangs(final String... yangPaths) {
63 return Lists.newArrayList(Collections2.transform(Lists.newArrayList(yangPaths),
64 new Function<String, ByteSource>() {
66 public ByteSource apply(final String input) {
67 ByteSource resourceAsStream = Resources.asByteSource(getClass().getResource(input));
68 Preconditions.checkNotNull(resourceAsStream, "File %s was null", resourceAsStream);
69 return resourceAsStream;
75 public void setUp() throws Exception {
76 schema = parseTestSchema("test.yang");
77 containerNode = (ContainerSchemaNode) getSchemaNode(schema, "test", "container");
81 public void testSchemaUnaware() throws Exception {
83 DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders
84 .containerBuilder().withNodeIdentifier(getNodeIdentifier("container"));
87 LeafNode<String> leafChild = Builders.<String> leafBuilder().withNodeIdentifier(getNodeIdentifier("leaf"))
88 .withValue("String").build();
89 builder.withChild(leafChild);
92 LeafSetNode<Integer> leafList = Builders
93 .<Integer> leafSetBuilder()
94 .withNodeIdentifier(getNodeIdentifier("leaf"))
97 Builders.<Integer> leafSetEntryBuilder()
98 .withNodeIdentifier(getNodeWithValueIdentifier("leaf", 3)).withValue(3).build())
100 builder.withChild(leafList);
103 MapEntryNode listChild1 = Builders
106 Builders.<Integer> leafBuilder().withNodeIdentifier(getNodeIdentifier("uint32InList"))
107 .withValue(1).build())
108 .withChild(Builders.containerBuilder().withNodeIdentifier(getNodeIdentifier("containerInList")).build())
110 new NodeIdentifierWithPredicates(getNodeIdentifier("list").getNodeType(),
111 Collections.singletonMap(getNodeIdentifier("uint32InList").getNodeType(), (Object) 1)))
114 MapNode list = Builders.mapBuilder().withChild(listChild1).withNodeIdentifier(getNodeIdentifier("list"))
116 builder.withChild(list);
118 AugmentationNode augmentation = Builders
119 .augmentationBuilder()
121 new AugmentationIdentifier(Sets.newHashSet(getQName("augmentUint32"))))
123 Builders.<Integer> leafBuilder().withNodeIdentifier(getNodeIdentifier("augmentUint32"))
124 .withValue(11).build()).build();
126 builder.withChild(augmentation);
128 // This works without schema (adding child from augment as a direct
130 builder.withChild(Builders.<Integer> leafBuilder().withNodeIdentifier(getNodeIdentifier("augmentUint32"))
131 .withValue(11).build());
135 public void testSchemaAware() throws Exception {
136 DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder = Builders
137 .containerBuilder(containerNode);
139 LeafSchemaNode schemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "uint32");
140 LeafNode<String> leafChild = Builders.<String> leafBuilder(schemaNode).withValue("String").build();
141 builder.withChild(leafChild);
143 LeafListSchemaNode leafListSchemaNode = (LeafListSchemaNode) getSchemaNode(schema, "test", "leafList");
144 LeafSetNode<Integer> leafList = Builders.<Integer> leafSetBuilder(leafListSchemaNode).withChildValue(1)
145 .withChild(Builders.<Integer> leafSetEntryBuilder(leafListSchemaNode).withValue(3).build()).build();
146 builder.withChild(leafList);
148 ListSchemaNode listSchema = (ListSchemaNode) getSchemaNode(schema, "test", "list");
149 LeafSchemaNode uint32InListSchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "uint32InList");
150 ContainerSchemaNode containerInListSchemaNode = (ContainerSchemaNode) getSchemaNode(schema, "test",
153 MapEntryNode listChild1 = Builders.mapEntryBuilder(listSchema)
154 .withChild(Builders.<Integer> leafBuilder(uint32InListSchemaNode).withValue(1).build())
155 .withChild(Builders.containerBuilder(containerInListSchemaNode).build()).build();
157 MapNode list = ImmutableMapNodeSchemaAwareBuilder.create(listSchema).withChild(listChild1).build();
158 builder.withChild(list);
160 LeafSchemaNode augmentUint32SchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "augmentUint32");
161 AugmentationSchema augmentationSchema = getAugmentationSchemaForChild(containerNode,
162 augmentUint32SchemaNode.getQName());
164 AugmentationNode augmentation = Builders.augmentationBuilder(augmentationSchema)
165 .withChild(Builders.<Integer>leafBuilder(augmentUint32SchemaNode).withValue(11).build()).build();
167 builder.withChild(augmentation);
169 // This should fail with schema, since the leaf comes from augmentation
170 // builder.withChild(ImmutableLeafNodeSchemaAwareBuilder.<Integer>get(augmentUint32SchemaNode).withValue(11).build());
172 LeafSchemaNode augumentString1SchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "augmentString1");
173 LeafSchemaNode augumentString2SchemaNode = (LeafSchemaNode) getSchemaNode(schema, "test", "augmentString2");
175 ChoiceSchemaNode choice1SchemaNode = (ChoiceSchemaNode) getSchemaNode(schema, "test", "choice");
176 ChoiceNode choice = ImmutableChoiceNodeSchemaAwareBuilder
177 .create(choice1SchemaNode)
178 .withChild(Builders.<String> leafBuilder(augumentString1SchemaNode).withValue("case1").build())
179 // This should fail, since child node belongs to different case
180 // .withChild(Builders.<String>leafBuilder(augumentString2SchemaNode).withValue("case2")
185 builder.withChild(choice);
187 // This should fail, child from case
188 // builder.withChild(Builders.<String>leafBuilder(augumentString1SchemaNode).withValue("case1")
192 private static AugmentationSchema getAugmentationSchemaForChild(final ContainerSchemaNode containerNode, final QName qName) {
193 for (AugmentationSchema augmentationSchema : containerNode.getAvailableAugmentations()) {
194 if (augmentationSchema.getDataChildByName(qName) != null) {
195 return augmentationSchema;
198 throw new IllegalStateException("Unable to find child augmentation in " + containerNode);
201 private static <T> NodeWithValue<T> getNodeWithValueIdentifier(final String localName, final T value) {
202 return new NodeWithValue<>(getQName(localName), value);
205 private static QName getQName(final String localName) {
206 String namespace = "namespace";
207 return new QName(URI.create(namespace), localName);
210 private static NodeIdentifier getNodeIdentifier(final String localName) {
211 return new NodeIdentifier(getQName(localName));
214 public static DataSchemaNode getSchemaNode(final SchemaContext context, final String moduleName, final String childNodeName) {
215 for (Module module : context.getModules()) {
216 if (module.getName().equals(moduleName)) {
217 DataSchemaNode found = findChildNode(module.getChildNodes(), childNodeName);
218 Preconditions.checkState(found != null, "Unable to find %s", childNodeName);
222 throw new IllegalStateException("Unable to find child node " + childNodeName);
225 private static DataSchemaNode findChildNode(final Iterable<DataSchemaNode> children, final String name) {
226 List<DataNodeContainer> containers = Lists.newArrayList();
228 for (DataSchemaNode dataSchemaNode : children) {
229 if (dataSchemaNode.getQName().getLocalName().equals(name)) {
230 return dataSchemaNode;
232 if (dataSchemaNode instanceof DataNodeContainer) {
233 containers.add((DataNodeContainer) dataSchemaNode);
234 } else if (dataSchemaNode instanceof ChoiceSchemaNode) {
235 containers.addAll(((ChoiceSchemaNode) dataSchemaNode).getCases());
239 for (DataNodeContainer container : containers) {
240 DataSchemaNode retVal = findChildNode(container.getChildNodes(), name);
241 if (retVal != null) {