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.netconf.sal.rest.impl;
11 import com.google.common.collect.Sets;
12 import java.util.Collection;
13 import java.util.Collections;
14 import java.util.Optional;
15 import org.junit.Before;
16 import org.junit.Ignore;
17 import org.junit.Test;
18 import org.mockito.InOrder;
19 import org.mockito.Mock;
20 import org.mockito.Mockito;
21 import org.mockito.MockitoAnnotations;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
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.stream.NormalizedNodeStreamWriter;
36 public class DepthAwareNormalizedNodeWriterTest {
39 private NormalizedNodeStreamWriter writer;
41 private ContainerNode containerNodeData;
43 private MapNode mapNodeData;
45 private MapEntryNode mapEntryNodeData;
47 private LeafSetNode<String> leafSetNodeData;
49 private LeafSetEntryNode<String> leafSetEntryNodeData;
51 private LeafNode<String> keyLeafNodeData;
53 private LeafNode<String> anotherLeafNodeData;
55 private NodeIdentifier containerNodeIdentifier;
56 private NodeIdentifier mapNodeIdentifier;
57 private NodeIdentifierWithPredicates mapEntryNodeIdentifier;
58 private NodeIdentifier leafSetNodeIdentifier;
59 private NodeWithValue<?> leafSetEntryNodeIdentifier;
60 private NodeIdentifier keyLeafNodeIdentifier;
61 private NodeIdentifier anotherLeafNodeIdentifier;
63 private Collection<DataContainerChild<?, ?>> containerNodeValue;
64 private Collection<MapEntryNode> mapNodeValue;
65 private Collection<DataContainerChild<?, ?>> mapEntryNodeValue;
66 private Collection<LeafSetEntryNode<String>> leafSetNodeValue;
67 private String leafSetEntryNodeValue;
68 private String keyLeafNodeValue;
69 private String anotherLeafNodeValue;
73 MockitoAnnotations.initMocks(this);
76 containerNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "container"));
77 Mockito.when(containerNodeData.getIdentifier()).thenReturn(containerNodeIdentifier);
79 mapNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "list"));
80 Mockito.when(mapNodeData.getIdentifier()).thenReturn(mapNodeIdentifier);
82 final QName leafSetEntryNodeQName = QName.create("namespace", "leaf-set-entry");
83 leafSetEntryNodeValue = "leaf-set-value";
84 leafSetEntryNodeIdentifier = new NodeWithValue<>(leafSetEntryNodeQName, leafSetEntryNodeValue);
85 Mockito.when(leafSetEntryNodeData.getIdentifier()).thenReturn(leafSetEntryNodeIdentifier);
86 Mockito.when(leafSetEntryNodeData.getNodeType()).thenReturn(leafSetEntryNodeQName);
88 leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
89 Mockito.when(leafSetNodeData.getIdentifier()).thenReturn(leafSetNodeIdentifier);
91 final QName mapEntryNodeKey = QName.create("namespace", "key-field");
92 keyLeafNodeIdentifier = NodeIdentifier.create(mapEntryNodeKey);
93 keyLeafNodeValue = "key-value";
95 mapEntryNodeIdentifier = new YangInstanceIdentifier.NodeIdentifierWithPredicates(
96 QName.create("namespace", "list-entry"), Collections.singletonMap(mapEntryNodeKey, keyLeafNodeValue));
97 Mockito.when(mapEntryNodeData.getIdentifier()).thenReturn(mapEntryNodeIdentifier);
98 Mockito.when(mapEntryNodeData.getChild(keyLeafNodeIdentifier)).thenReturn(Optional.of(keyLeafNodeData));
100 Mockito.when(keyLeafNodeData.getValue()).thenReturn(keyLeafNodeValue);
101 Mockito.when(keyLeafNodeData.getIdentifier()).thenReturn(keyLeafNodeIdentifier);
103 anotherLeafNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "another-field"));
104 anotherLeafNodeValue = "another-value";
106 Mockito.when(anotherLeafNodeData.getValue()).thenReturn(anotherLeafNodeValue);
107 Mockito.when(anotherLeafNodeData.getIdentifier()).thenReturn(anotherLeafNodeIdentifier);
110 Mockito.when(leafSetEntryNodeData.getValue()).thenReturn(leafSetEntryNodeValue);
112 leafSetNodeValue = Collections.singletonList(leafSetEntryNodeData);
113 Mockito.when(leafSetNodeData.getValue()).thenReturn(leafSetNodeValue);
115 containerNodeValue = Collections.singleton(leafSetNodeData);
116 Mockito.when(containerNodeData.getValue()).thenReturn(containerNodeValue);
118 mapEntryNodeValue = Sets.newHashSet(keyLeafNodeData, anotherLeafNodeData);
119 Mockito.when(mapEntryNodeData.getValue()).thenReturn(mapEntryNodeValue);
121 mapNodeValue = Collections.singleton(mapEntryNodeData);
122 Mockito.when(mapNodeData.getValue()).thenReturn(mapNodeValue);
126 * Test write {@link ContainerNode} with children but write data only to depth 1 (children will not be written).
129 public void writeContainerWithoutChildrenTest() throws Exception {
130 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(writer, 1);
132 depthWriter.write(containerNodeData);
134 final InOrder inOrder = Mockito.inOrder(writer);
135 inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
136 inOrder.verify(writer, Mockito.times(1)).endNode();
137 Mockito.verifyNoMoreInteractions(writer);
141 * Test write {@link ContainerNode} with children and write also all its children.
144 public void writeContainerWithChildrenTest() throws Exception {
145 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
146 writer, Integer.MAX_VALUE);
148 depthWriter.write(containerNodeData);
150 final InOrder inOrder = Mockito.inOrder(writer);
151 inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
152 inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
153 inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
154 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
155 inOrder.verify(writer, Mockito.times(2)).endNode();
156 Mockito.verifyNoMoreInteractions(writer);
160 * Test write with {@link MapNode} with children but write data only to depth 1 (children will not be written).
163 public void writeMapNodeWithoutChildrenTest() throws Exception {
164 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(writer, 1);
166 depthWriter.write(mapNodeData);
168 final InOrder inOrder = Mockito.inOrder(writer);
169 inOrder.verify(writer, Mockito.times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
170 inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
171 inOrder.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
172 inOrder.verify(writer, Mockito.times(2)).endNode();
173 Mockito.verifyNoMoreInteractions(writer);
177 * Test write {@link MapNode} with children and write also all its children.
179 * Although ordered writer is used leaves are not written in expected order.
184 public void writeMapNodeWithChildrenTest() throws Exception {
185 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
186 writer, Integer.MAX_VALUE);
188 depthWriter.write(mapNodeData);
190 final InOrder inOrder = Mockito.inOrder(writer);
191 inOrder.verify(writer, Mockito.times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
192 inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
193 inOrder.verify(writer, Mockito.times(2)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
194 // FIXME this assertion is not working because leaves are not written in expected order
195 inOrder.verify(writer, Mockito.times(1)).leafNode(anotherLeafNodeIdentifier, anotherLeafNodeValue);
196 inOrder.verify(writer, Mockito.times(2)).endNode();
197 Mockito.verifyNoMoreInteractions(writer);
201 * Test write with {@link LeafSetNode} with depth 1 (children will not be written).
204 public void writeLeafSetNodeWithoutChildrenTest() throws Exception {
205 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
208 depthWriter.write(leafSetNodeData);
210 final InOrder inOrder = Mockito.inOrder(writer);
211 inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
212 inOrder.verify(writer, Mockito.times(1)).endNode();
213 Mockito.verifyNoMoreInteractions(writer);
217 * Test write with {@link LeafSetNode} when all its children will be written.
220 public void writeLeafSetNodeWithChildrenTest() throws Exception {
221 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
222 writer, Integer.MAX_VALUE);
224 depthWriter.write(leafSetNodeData);
226 final InOrder inOrder = Mockito.inOrder(writer);
227 inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
228 inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
229 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
230 inOrder.verify(writer, Mockito.times(1)).endNode();
231 Mockito.verifyNoMoreInteractions(writer);
235 * Test write with {@link LeafSetEntryNode}.
238 public void writeLeafSetEntryNodeTest() throws Exception {
239 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
240 writer, Integer.MAX_VALUE);
242 depthWriter.write(leafSetEntryNodeData);
244 final InOrder inOrder = Mockito.inOrder(writer);
245 inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
246 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
247 Mockito.verifyNoMoreInteractions(writer);
251 * Test write with {@link MapEntryNode} unordered to depth 1 to write only keys.
254 public void writeMapEntryNodeUnorderedOnlyKeysTest() throws Exception {
255 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
258 depthWriter.write(mapEntryNodeData);
260 final InOrder inOrder = Mockito.inOrder(writer);
261 inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
262 // write only the key
263 inOrder.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
264 inOrder.verify(writer, Mockito.times(1)).endNode();
265 Mockito.verifyNoMoreInteractions(writer);
269 * Test write with {@link MapEntryNode} unordered with full depth.
272 public void writeMapEntryNodeUnorderedTest() throws Exception {
273 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
274 writer, false, Integer.MAX_VALUE);
276 depthWriter.write(mapEntryNodeData);
279 Mockito.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
280 Mockito.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
281 Mockito.verify(writer, Mockito.times(1)).leafNode(anotherLeafNodeIdentifier, anotherLeafNodeValue);
282 Mockito.verify(writer, Mockito.times(1)).endNode();
283 Mockito.verifyNoMoreInteractions(writer);
287 * Test write with {@link MapEntryNode} ordered with depth 1 (children will not be written).
290 public void writeMapEntryNodeOrderedWithoutChildrenTest() throws Exception {
291 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
294 depthWriter.write(mapEntryNodeData);
296 final InOrder inOrder = Mockito.inOrder(writer);
297 inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
298 inOrder.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
299 inOrder.verify(writer, Mockito.times(1)).endNode();
300 Mockito.verifyNoMoreInteractions(writer);
304 * Test write with {@link MapEntryNode} ordered and write also all its children.
306 * Although ordered writer is used leaves are not written in expected order.
311 public void writeMapEntryNodeOrderedTest() throws Exception {
312 final DepthAwareNormalizedNodeWriter depthWriter = DepthAwareNormalizedNodeWriter.forStreamWriter(
313 writer, true, Integer.MAX_VALUE);
315 depthWriter.write(mapEntryNodeData);
317 final InOrder inOrder = Mockito.inOrder(writer);
318 inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
319 inOrder.verify(writer, Mockito.times(2)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
320 // FIXME this assertion is not working because leaves are not written in expected order
321 inOrder.verify(writer, Mockito.times(1)).leafNode(anotherLeafNodeIdentifier, anotherLeafNodeValue);
322 inOrder.verify(writer, Mockito.times(1)).endNode();
323 Mockito.verifyNoMoreInteractions(writer);