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
9 package org.opendaylight.yangtools.yang.data.impl.schema;
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotNull;
13 import static org.mockito.Mockito.mock;
16 import java.io.FileNotFoundException;
17 import java.net.URISyntaxException;
18 import java.util.HashMap;
19 import java.util.LinkedList;
21 import org.junit.Before;
22 import org.junit.Test;
23 import org.opendaylight.yangtools.util.UnmodifiableCollection;
24 import org.opendaylight.yangtools.yang.common.QName;
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.ChoiceNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeSchemaAwareBuilder;
45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeBuilder;
46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetEntryNodeSchemaAwareBuilder;
47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeSchemaAwareBuilder;
49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
51 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeSchemaAwareBuilder;
52 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
53 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeSchemaAwareBuilder;
54 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
55 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeSchemaAwareBuilder;
56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
57 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
58 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
59 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
60 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
61 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
62 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
63 import org.opendaylight.yangtools.yang.model.api.Module;
64 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
65 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
66 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
67 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.ContainerEffectiveStatementImpl;
68 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
70 public class BuilderTest {
71 private static final QName ROOT_CONTAINER = QName.create("test.namespace.builder.test", "2016-01-01",
73 private static final QName LIST_MAIN = QName.create(ROOT_CONTAINER, "list-ordered-by-user-with-key");
74 private static final QName LEAF_LIST_MAIN = QName.create(ROOT_CONTAINER, "leaf-list-ordered-by-user");
75 private static final QName LIST_MAIN_CHILD_QNAME_1 = QName.create(ROOT_CONTAINER, "leaf-a");
76 private static final NodeIdentifier NODE_IDENTIFIER_LIST = NodeIdentifier.create(LIST_MAIN);
77 private static final NodeIdentifier NODE_IDENTIFIER_LEAF_LIST = NodeIdentifier.create(LEAF_LIST_MAIN);
78 private static final NodeIdentifier NODE_IDENTIFIER_LEAF = NodeIdentifier.create(LIST_MAIN_CHILD_QNAME_1);
79 private static final MapEntryNode LIST_MAIN_CHILD_1 = ImmutableNodes.mapEntry(LIST_MAIN, LIST_MAIN_CHILD_QNAME_1,
81 private static final MapEntryNode LIST_MAIN_CHILD_2 = ImmutableNodes.mapEntry(LIST_MAIN, LIST_MAIN_CHILD_QNAME_1,
83 private static final MapEntryNode LIST_MAIN_CHILD_3 = ImmutableNodes.mapEntry(LIST_MAIN, LIST_MAIN_CHILD_QNAME_1,
85 private static final int SIZE = 3;
86 private static final NodeWithValue<String> BAR_PATH = new NodeWithValue<>(LEAF_LIST_MAIN, "bar");
87 private static final LeafSetEntryNode LEAF_SET_ENTRY_NODE = ImmutableLeafSetEntryNodeBuilder.create()
88 .withNodeIdentifier(BAR_PATH)
91 private ListSchemaNode list;
92 private LeafListSchemaNode leafList;
95 public void setup() throws FileNotFoundException, ReactorException, URISyntaxException {
96 final File leafRefTestYang = new File(getClass().getResource("/builder-test/immutable-ordered-map-node.yang")
98 final SchemaContext schema = YangParserTestUtils.parseYangFiles(leafRefTestYang);
99 final Module module = schema.getModules().iterator().next();
100 final DataSchemaNode root = module.getDataChildByName(ROOT_CONTAINER);
101 list = (ListSchemaNode)((ContainerEffectiveStatementImpl) root).getDataChildByName(LIST_MAIN);
102 leafList = (LeafListSchemaNode)((ContainerEffectiveStatementImpl) root).getDataChildByName(LEAF_LIST_MAIN);
106 public void immutableOrderedMapBuilderTest() {
107 final LinkedList<MapEntryNode> mapEntryNodeColl = new LinkedList<>();
108 mapEntryNodeColl.add(LIST_MAIN_CHILD_3);
109 final Map<QName, Object> keys = new HashMap<>();
110 keys.put(LIST_MAIN_CHILD_QNAME_1, 1);
111 final NodeIdentifierWithPredicates mapEntryPath = new NodeIdentifierWithPredicates(LIST_MAIN, keys);
112 final OrderedMapNode orderedMapNodeCreateNull = ImmutableOrderedMapNodeBuilder.create()
113 .withNodeIdentifier(NODE_IDENTIFIER_LIST)
114 .withChild(LIST_MAIN_CHILD_1)
115 .addChild(LIST_MAIN_CHILD_2)
116 .withValue(mapEntryNodeColl)
118 final OrderedMapNode orderedMapNodeCreateSize = ImmutableOrderedMapNodeBuilder.create(SIZE)
119 .withNodeIdentifier(NODE_IDENTIFIER_LIST)
121 final OrderedMapNode orderedMapNodeCreateNode = ImmutableOrderedMapNodeBuilder.create(orderedMapNodeCreateNull)
122 .removeChild(mapEntryPath)
124 final OrderedMapNode orderedMapNodeSchemaAware = ImmutableOrderedMapNodeSchemaAwareBuilder.create(list)
125 .withChild(LIST_MAIN_CHILD_1)
127 final OrderedMapNode orderedMapNodeSchemaAwareMapNodeConst = ImmutableOrderedMapNodeSchemaAwareBuilder.create(
128 list, getImmutableOrderedMapNode())
131 assertNotNull(Builders.orderedMapBuilder(list));
132 assertEquals(SIZE, orderedMapNodeCreateNull.getSize());
133 assertEquals(orderedMapNodeCreateNode.getSize(), orderedMapNodeCreateNull.getSize() - 1);
134 assertEquals(NODE_IDENTIFIER_LIST, orderedMapNodeCreateSize.getIdentifier());
135 assertEquals(LIST_MAIN_CHILD_1, orderedMapNodeCreateNull.getChild(0));
136 assertEquals(SIZE, orderedMapNodeCreateNull.getValue().size());
137 assertEquals(orderedMapNodeSchemaAware.getChild(0), orderedMapNodeSchemaAwareMapNodeConst.getChild(0));
141 public void immutableOrderedLeafSetNodeBuilderTest() {
142 final NormalizedNode<?, ?> orderedLeafSet = ImmutableOrderedLeafSetNodeBuilder.create()
143 .withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST)
144 .withChild(LEAF_SET_ENTRY_NODE)
145 .withChildValue("baz")
146 .removeChild(BAR_PATH)
148 final LinkedList<LeafSetNode<?>> mapEntryNodeColl = new LinkedList<>();
149 mapEntryNodeColl.add((LeafSetNode<?>)orderedLeafSet);
150 final UnmodifiableCollection<?> leafSetCollection = (UnmodifiableCollection<?>)orderedLeafSet.getValue();
151 final NormalizedNode<?, ?> orderedMapNodeSchemaAware = ImmutableOrderedLeafSetNodeSchemaAwareBuilder.create(
152 leafList).withChildValue("baz").build();
153 final UnmodifiableCollection<?> SchemaAwareleafSetCollection =
154 (UnmodifiableCollection<?>)orderedMapNodeSchemaAware.getValue();
155 final NormalizedNode<?, ?> orderedLeafSetShemaAware = ImmutableOrderedLeafSetNodeSchemaAwareBuilder.create(
156 leafList,(LeafSetNode<?>)orderedLeafSet).build();
158 assertNotNull(Builders.orderedLeafSetBuilder(leafList));
159 assertNotNull(Builders.anyXmlBuilder());
160 assertNotNull(orderedLeafSetShemaAware);
161 assertEquals(1, ((OrderedLeafSetNode<?>)orderedLeafSet).getSize());
162 assertEquals("baz", ((OrderedLeafSetNode<?>)orderedLeafSet).getChild(0).getValue());
163 assertNotNull(((OrderedLeafSetNode<?>)orderedLeafSet).getChild(BAR_PATH));
164 assertEquals(1, leafSetCollection.size());
165 assertEquals(1, SchemaAwareleafSetCollection.size());
169 public void immutableMapNodeBuilderTest() {
170 final LinkedList<MapEntryNode> mapEntryNodeColl = new LinkedList<>();
171 mapEntryNodeColl.add(LIST_MAIN_CHILD_3);
172 final CollectionNodeBuilder<MapEntryNode, MapNode> collectionNodeBuilder = ImmutableMapNodeBuilder.create(1);
173 assertNotNull(collectionNodeBuilder);
174 collectionNodeBuilder.withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST);
175 collectionNodeBuilder.withValue(mapEntryNodeColl);
176 final MapNode mapNode = collectionNodeBuilder.build();
177 final MapNode mapNodeSchemaAware = ImmutableMapNodeSchemaAwareBuilder.create(list, getImmutableMapNode())
179 assertNotNull(mapNodeSchemaAware);
180 assertNotNull(Builders.mapBuilder(mapNode));
184 public void immutableUnkeyedListEntryNodeBuilderTest() {
185 final UnkeyedListEntryNode unkeyedListEntryNode = ImmutableUnkeyedListEntryNodeBuilder.create()
186 .withNodeIdentifier(NODE_IDENTIFIER_LIST)
188 final UnkeyedListEntryNode unkeyedListEntryNodeSize = ImmutableUnkeyedListEntryNodeBuilder.create(1)
189 .withNodeIdentifier(NODE_IDENTIFIER_LIST)
191 final UnkeyedListEntryNode unkeyedListEntryNodeNode = ImmutableUnkeyedListEntryNodeBuilder
192 .create(unkeyedListEntryNode).build();
193 assertEquals(unkeyedListEntryNode.getNodeType().getLocalName(), unkeyedListEntryNodeSize.getNodeType()
195 assertEquals(unkeyedListEntryNodeSize.getNodeType().getLocalName(), unkeyedListEntryNodeNode.getNodeType()
200 public void immutableUnkeyedListNodeBuilderTest() {
201 final UnkeyedListEntryNode unkeyedListEntryNode = ImmutableUnkeyedListEntryNodeBuilder.create()
202 .withNodeIdentifier(NODE_IDENTIFIER_LEAF)
204 final ImmutableUnkeyedListNodeBuilder immutableUnkeyedListNodeBuilder = (ImmutableUnkeyedListNodeBuilder)
205 ImmutableUnkeyedListNodeBuilder.create();
206 final UnkeyedListNode unkeyedListNode = immutableUnkeyedListNodeBuilder
207 .withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST)
208 .addChild(unkeyedListEntryNode)
210 final UnkeyedListNode unkeyedListNodeSize = ImmutableUnkeyedListNodeBuilder.create(1)
211 .withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST)
213 final UnkeyedListNode unkeyedListNodeCreated = ImmutableUnkeyedListNodeBuilder.create(unkeyedListNode)
216 unkeyedListNodeSize.getChild(1);
217 } catch (IndexOutOfBoundsException e) {
218 // Ignored on purpose
221 assertNotNull(unkeyedListNodeSize.getValue());
222 assertEquals(unkeyedListEntryNode, unkeyedListNodeCreated.getChild(0));
223 assertEquals(unkeyedListNode.getNodeType().getLocalName(), unkeyedListNodeSize.getNodeType()
225 assertNotNull(unkeyedListNodeCreated);
229 public void immutableChoiceNodeBuilderTest() {
230 final ChoiceNode choiceNode = ImmutableChoiceNodeBuilder.create(1).withNodeIdentifier(NODE_IDENTIFIER_LIST)
232 final ChoiceNode choiceNodeCreated = ImmutableChoiceNodeBuilder.create(choiceNode).build();
233 assertEquals(choiceNodeCreated.getIdentifier(), choiceNode.getIdentifier());
237 @Test(expected = NullPointerException.class)
238 public void immutableAugmentationNodeBuilderExceptionTest() {
239 ImmutableAugmentationNodeBuilder.create(1).build();
242 @Test(expected = NullPointerException.class)
243 public void immutableContainerNodeBuilderExceptionTest() {
244 final ContainerNode immutableContainerNode = ImmutableContainerNodeBuilder.create(1)
245 .withNodeIdentifier(NODE_IDENTIFIER_LIST)
247 assertNotNull(immutableContainerNode);
248 final ContainerSchemaNode containerSchemaNode = mock(ContainerSchemaNode.class);
249 ImmutableContainerNodeSchemaAwareBuilder.create(containerSchemaNode, immutableContainerNode)
250 .withNodeIdentifier(NODE_IDENTIFIER_LIST)
254 @Test(expected = NullPointerException.class)
255 public void immutableLeafSetNodeBuilderExceptionTest() {
256 final LeafSetNode<?> leafSetNode = ImmutableLeafSetNodeBuilder.create(1)
257 .withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST).build();
258 assertNotNull(leafSetNode);
259 ImmutableLeafSetNodeSchemaAwareBuilder.create(mock(LeafListSchemaNode.class), leafSetNode).build();
262 @Test(expected = UnsupportedOperationException.class)
263 public void immutableLeafSetEntryNodeSchemaAwareBuilderExceptionTest() {
264 final LeafListSchemaNode leafListSchemaNode = mock(LeafListSchemaNode.class);
265 ImmutableLeafSetEntryNodeSchemaAwareBuilder.create(leafListSchemaNode).withNodeIdentifier(BAR_PATH).build();
268 @Test(expected = NullPointerException.class)
269 public void immutableMapEntryNodeBuilderExceptionTest() {
270 ImmutableMapEntryNodeBuilder.create(1).build();
273 @Test(expected = NullPointerException.class)
274 public void immutableYangModeledAnyXmlNodeBuilderExceptionTest() {
275 ImmutableYangModeledAnyXmlNodeBuilder.create(mock(YangModeledAnyXmlSchemaNode.class), 1);
278 @Test(expected = UnsupportedOperationException.class)
279 public void immutableUnkeyedListNodeBuilderExceptionTest() {
280 ImmutableUnkeyedListNodeBuilder.create().withNodeIdentifier(NODE_IDENTIFIER_LEAF)
281 .removeChild(NODE_IDENTIFIER_LIST).build();
284 @Test(expected = UnsupportedOperationException.class)
285 public void immutableOrderedMapNotSchemaAwareExceptionTest1() {
286 ImmutableOrderedMapNodeBuilder.create(getImmutableMapNode()).build();
289 @Test(expected = UnsupportedOperationException.class)
290 public void immutableMapNodeSchemaAwareExceptionTest() {
291 ImmutableMapNodeSchemaAwareBuilder.create(list, getImmutableMapNode()).withNodeIdentifier(NODE_IDENTIFIER_LIST)
295 @Test(expected = UnsupportedOperationException.class)
296 public void immutableOrderedMapSchemaAwareExceptionTest1() {
297 ImmutableOrderedMapNodeSchemaAwareBuilder.create(list).withNodeIdentifier(NODE_IDENTIFIER_LIST).build();
300 @Test(expected = UnsupportedOperationException.class)
301 public void immutableOrderedMapSchemaAwareExceptionTest2() {
302 ImmutableOrderedMapNodeSchemaAwareBuilder.create(list, getImmutableMapNode()).build();
305 @Test(expected = UnsupportedOperationException.class)
306 public void immutableOrderedLeafSetNodeExceptionTest1() {
307 ImmutableOrderedLeafSetNodeBuilder.create(getImmutableLeafSetNode()).build();
310 @Test(expected = UnsupportedOperationException.class)
311 public void immutableOrderedLeafSetNodeSchemaAwareExceptionTest1() {
312 ImmutableOrderedLeafSetNodeSchemaAwareBuilder.create(leafList).withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST)
316 private static LeafSetNode<?> getImmutableLeafSetNode() {
317 final ListNodeBuilder<Object, LeafSetEntryNode<Object>> leafSetBuilder = Builders.leafSetBuilder();
318 leafSetBuilder.withNodeIdentifier(NODE_IDENTIFIER_LEAF_LIST);
319 leafSetBuilder.addChild(LEAF_SET_ENTRY_NODE);
320 return leafSetBuilder.build();
323 private static MapNode getImmutableMapNode() {
324 return ImmutableMapNodeBuilder.create().withNodeIdentifier(NODE_IDENTIFIER_LIST).withChild(LIST_MAIN_CHILD_1)
328 private static MapNode getImmutableOrderedMapNode() {
329 return ImmutableOrderedMapNodeBuilder.create().withNodeIdentifier(NODE_IDENTIFIER_LIST)
330 .withChild(LIST_MAIN_CHILD_1).build();