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.restconf.nb.rfc8040.jersey.providers;
10 import static org.mockito.Mockito.inOrder;
11 import static org.mockito.Mockito.times;
12 import static org.mockito.Mockito.verify;
13 import static org.mockito.Mockito.verifyNoMoreInteractions;
14 import static org.mockito.Mockito.when;
16 import java.util.Collection;
17 import java.util.List;
18 import java.util.Optional;
20 import org.junit.Before;
21 import org.junit.Ignore;
22 import org.junit.Test;
23 import org.junit.runner.RunWith;
24 import org.mockito.InOrder;
25 import org.mockito.Mock;
26 import org.mockito.junit.MockitoJUnitRunner;
27 import org.opendaylight.restconf.nb.rfc8040.DepthParam;
28 import org.opendaylight.yangtools.yang.common.QName;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
31 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
32 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
34 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
44 * Unit test for {@link ParameterAwareNormalizedNodeWriter} used with depth parameter.
46 @RunWith(MockitoJUnitRunner.StrictStubs.class)
47 public class ParameterAwareNormalizedNodeWriterDepthTest {
49 private NormalizedNodeStreamWriter writer;
51 private ContainerNode containerNodeData;
53 private SystemMapNode mapNodeData;
55 private MapEntryNode mapEntryNodeData;
57 private SystemLeafSetNode<String> leafSetNodeData;
59 private LeafSetEntryNode<String> leafSetEntryNodeData;
61 private LeafNode<String> keyLeafNodeData;
63 private LeafNode<String> anotherLeafNodeData;
65 private NodeIdentifier containerNodeIdentifier;
66 private NodeIdentifier mapNodeIdentifier;
67 private NodeIdentifierWithPredicates mapEntryNodeIdentifier;
68 private NodeIdentifier leafSetNodeIdentifier;
69 private NodeWithValue<String> leafSetEntryNodeIdentifier;
70 private NodeIdentifier keyLeafNodeIdentifier;
71 private NodeIdentifier anotherLeafNodeIdentifier;
73 private Collection<DataContainerChild> containerNodeValue;
74 private Collection<MapEntryNode> mapNodeValue;
75 private Collection<DataContainerChild> mapEntryNodeValue;
76 private Collection<LeafSetEntryNode<String>> leafSetNodeValue;
77 private String leafSetEntryNodeValue;
78 private String keyLeafNodeValue;
79 private String anotherLeafNodeValue;
84 containerNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "container"));
85 when(containerNodeData.getIdentifier()).thenReturn(containerNodeIdentifier);
87 mapNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "list"));
88 when(mapNodeData.getIdentifier()).thenReturn(mapNodeIdentifier);
90 final QName leafSetEntryNodeQName = QName.create("namespace", "leaf-set-entry");
91 leafSetEntryNodeValue = "leaf-set-value";
92 leafSetEntryNodeIdentifier = new NodeWithValue<>(leafSetEntryNodeQName, leafSetEntryNodeValue);
93 when(leafSetEntryNodeData.getIdentifier()).thenReturn(leafSetEntryNodeIdentifier);
95 leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
96 when(leafSetNodeData.getIdentifier()).thenReturn(leafSetNodeIdentifier);
98 final QName mapEntryNodeKey = QName.create("namespace", "key-field");
99 keyLeafNodeIdentifier = NodeIdentifier.create(mapEntryNodeKey);
100 keyLeafNodeValue = "key-value";
102 mapEntryNodeIdentifier = NodeIdentifierWithPredicates.of(
103 QName.create("namespace", "list-entry"), mapEntryNodeKey, keyLeafNodeValue);
104 when(mapEntryNodeData.getIdentifier()).thenReturn(mapEntryNodeIdentifier);
105 when(mapEntryNodeData.findChildByArg(keyLeafNodeIdentifier)).thenReturn(Optional.of(keyLeafNodeData));
107 when(keyLeafNodeData.body()).thenReturn(keyLeafNodeValue);
108 when(keyLeafNodeData.getIdentifier()).thenReturn(keyLeafNodeIdentifier);
110 anotherLeafNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "another-field"));
111 anotherLeafNodeValue = "another-value";
113 when(anotherLeafNodeData.body()).thenReturn(anotherLeafNodeValue);
114 when(anotherLeafNodeData.getIdentifier()).thenReturn(anotherLeafNodeIdentifier);
117 when(leafSetEntryNodeData.body()).thenReturn(leafSetEntryNodeValue);
119 leafSetNodeValue = List.of(leafSetEntryNodeData);
120 when(leafSetNodeData.body()).thenReturn(leafSetNodeValue);
122 containerNodeValue = Set.of(leafSetNodeData);
123 when(containerNodeData.body()).thenReturn(containerNodeValue);
125 mapEntryNodeValue = Set.of(keyLeafNodeData, anotherLeafNodeData);
126 when(mapEntryNodeData.body()).thenReturn(mapEntryNodeValue);
128 mapNodeValue = Set.of(mapEntryNodeData);
129 when(mapNodeData.body()).thenReturn(mapNodeValue);
133 * Test write {@link ContainerNode} with children but write data only to depth 1 (children will not be written).
134 * Depth parameter is limited to 1.
137 public void writeContainerWithoutChildrenDepthTest() throws Exception {
138 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
139 writer, DepthParam.min(), null);
141 parameterWriter.write(containerNodeData);
143 final InOrder inOrder = inOrder(writer);
144 inOrder.verify(writer, times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
145 inOrder.verify(writer, times(1)).endNode();
146 verifyNoMoreInteractions(writer);
150 * Test write {@link ContainerNode} with children and write also all its children.
151 * Depth parameter has higher value than maximal children depth.
154 public void writeContainerWithChildrenDepthTest() throws Exception {
155 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
156 writer, DepthParam.max(), null);
158 parameterWriter.write(containerNodeData);
160 final InOrder inOrder = inOrder(writer);
161 inOrder.verify(writer, times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
162 inOrder.verify(writer, times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
163 inOrder.verify(writer, times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
164 inOrder.verify(writer, times(1)).scalarValue(leafSetEntryNodeValue);
165 inOrder.verify(writer, times(3)).endNode();
166 verifyNoMoreInteractions(writer);
170 * Test write with {@link MapNode} with children but write data only to depth 1 (children will not be written).
171 * Depth parameter limits depth to 1.
174 public void writeMapNodeWithoutChildrenDepthTest() throws Exception {
175 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
176 writer, DepthParam.min(), null);
178 parameterWriter.write(mapNodeData);
180 final InOrder inOrder = inOrder(writer);
181 inOrder.verify(writer, times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
182 inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
183 inOrder.verify(writer, times(2)).endNode();
184 verifyNoMoreInteractions(writer);
188 * Test write {@link MapNode} with children and write also all its children.
189 * Depth parameter has higher value than maximal children depth.
191 * Although ordered writer is used leaves are not written in expected order.
196 public void writeMapNodeWithChildrenDepthTest() throws Exception {
197 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
198 writer, DepthParam.max(), null);
200 parameterWriter.write(mapNodeData);
202 final InOrder inOrder = inOrder(writer);
203 inOrder.verify(writer, times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
204 inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
205 inOrder.verify(writer, times(2)).startLeafNode(keyLeafNodeIdentifier);
206 inOrder.verify(writer, times(1)).scalarValue(keyLeafNodeValue);
207 inOrder.verify(writer, times(1)).endNode();
208 inOrder.verify(writer, times(2)).startLeafNode(keyLeafNodeIdentifier);
209 inOrder.verify(writer, times(2)).scalarValue(keyLeafNodeValue);
210 inOrder.verify(writer, times(2)).endNode();
211 // FIXME this assertion is not working because leaves are not written in expected order
212 inOrder.verify(writer, times(1)).startLeafNode(anotherLeafNodeIdentifier);
213 inOrder.verify(writer, times(1)).scalarValue(anotherLeafNodeValue);
214 inOrder.verify(writer, times(3)).endNode();
215 verifyNoMoreInteractions(writer);
219 * Test write with {@link LeafSetNode} with depth 1 (children will not be written).
220 * Depth parameter limits depth to 1.
223 public void writeLeafSetNodeWithoutChildrenDepthTest() throws Exception {
224 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
225 writer, DepthParam.min(), null);
227 parameterWriter.write(leafSetNodeData);
229 final InOrder inOrder = inOrder(writer);
230 inOrder.verify(writer, times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
231 inOrder.verify(writer, times(1)).endNode();
232 verifyNoMoreInteractions(writer);
236 * Test write with {@link LeafSetNode} when all its children will be written.
237 * Depth parameter has higher value than maximal children depth.
240 public void writeLeafSetNodeWithChildrenDepthTest() throws Exception {
241 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
242 writer, DepthParam.max(), null);
244 parameterWriter.write(leafSetNodeData);
246 final InOrder inOrder = inOrder(writer);
247 inOrder.verify(writer, times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
248 inOrder.verify(writer, times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
249 inOrder.verify(writer, times(1)).scalarValue(leafSetEntryNodeValue);
250 inOrder.verify(writer, times(2)).endNode();
251 verifyNoMoreInteractions(writer);
255 * Test write with {@link LeafSetEntryNode}.
256 * Depth parameter has higher value than maximal children depth.
259 public void writeLeafSetEntryNodeDepthTest() throws Exception {
260 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
261 writer, DepthParam.max(), null);
263 parameterWriter.write(leafSetEntryNodeData);
265 final InOrder inOrder = inOrder(writer);
266 inOrder.verify(writer, times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
267 inOrder.verify(writer, times(1)).scalarValue(leafSetEntryNodeValue);
268 inOrder.verify(writer, times(1)).endNode();
269 verifyNoMoreInteractions(writer);
273 * Test write with {@link MapEntryNode} unordered to depth 1 to write only keys.
274 * Depth parameter limits depth to 1.
277 public void writeMapEntryNodeUnorderedOnlyKeysDepthTest() throws Exception {
278 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
279 writer, false, DepthParam.min(), null);
281 parameterWriter.write(mapEntryNodeData);
283 final InOrder inOrder = inOrder(writer);
284 inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
285 // write only the key
286 inOrder.verify(writer, times(1)).startLeafNode(keyLeafNodeIdentifier);
287 inOrder.verify(writer, times(1)).scalarValue(keyLeafNodeValue);
288 inOrder.verify(writer, times(2)).endNode();
289 verifyNoMoreInteractions(writer);
293 * Test write with {@link MapEntryNode} unordered with full depth.
294 * Depth parameter has higher value than maximal children depth.
297 public void writeMapEntryNodeUnorderedDepthTest() throws Exception {
298 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
299 writer, false, DepthParam.max(), null);
301 parameterWriter.write(mapEntryNodeData);
304 verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
305 verify(writer, times(1)).startLeafNode(keyLeafNodeIdentifier);
306 verify(writer, times(1)).scalarValue(keyLeafNodeValue);
307 verify(writer, times(1)).startLeafNode(anotherLeafNodeIdentifier);
308 verify(writer, times(1)).scalarValue(anotherLeafNodeValue);
309 verify(writer, times(3)).endNode();
310 verifyNoMoreInteractions(writer);
314 * Test write with {@link MapEntryNode} ordered with depth 1 (children will not be written).
315 * Depth parameter limits depth to 1.
318 public void writeMapEntryNodeOrderedWithoutChildrenTest() throws Exception {
319 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
320 writer, true, DepthParam.min(), null);
322 parameterWriter.write(mapEntryNodeData);
324 final InOrder inOrder = inOrder(writer);
325 inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
326 inOrder.verify(writer, times(1)).endNode();
327 verifyNoMoreInteractions(writer);
331 * Test write with {@link MapEntryNode} ordered and write also all its children.
332 * Depth parameter has higher value than maximal children depth.
334 * Although ordered writer is used leaves are not written in expected order.
339 public void writeMapEntryNodeOrderedTest() throws Exception {
340 final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
341 writer, true, DepthParam.max(), null);
343 parameterWriter.write(mapEntryNodeData);
345 final InOrder inOrder = inOrder(writer);
346 inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
347 inOrder.verify(writer, times(1)).startLeafNode(keyLeafNodeIdentifier);
348 inOrder.verify(writer, times(1)).scalarValue(keyLeafNodeValue);
349 inOrder.verify(writer, times(1)).endNode();
350 inOrder.verify(writer, times(1)).startLeafNode(keyLeafNodeIdentifier);
351 inOrder.verify(writer, times(1)).scalarValue(keyLeafNodeValue);
352 inOrder.verify(writer, times(1)).endNode();
353 // FIXME this assertion is not working because leaves are not written in expected order
354 inOrder.verify(writer, times(1)).startLeafNode(anotherLeafNodeIdentifier);
355 inOrder.verify(writer, times(1)).scalarValue(anotherLeafNodeValue);
356 inOrder.verify(writer, times(2)).endNode();
357 verifyNoMoreInteractions(writer);