restconf/sal-rest-connector/src/test/java/org/opendaylight/restconf/jersey/providers/ParameterAwareNormalizedNodeWriterDepthTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.restconf.jersey.providers;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.collect.Sets;
  13 import java.util.Collection;
  14 import java.util.Collections;
  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;
  35
  36 /**
  37  * Unit test for {@link ParameterAwareNormalizedNodeWriter} used with depth parameter.
  38  */
  39 public class ParameterAwareNormalizedNodeWriterDepthTest {
  40
  41     @Mock
  42     private NormalizedNodeStreamWriter writer;
  43     @Mock
  44     private ContainerNode containerNodeData;
  45     @Mock
  46     private MapNode mapNodeData;
  47     @Mock
  48     private MapEntryNode mapEntryNodeData;
  49     @Mock
  50     private LeafSetNode<String> leafSetNodeData;
  51     @Mock
  52     private LeafSetEntryNode<String> leafSetEntryNodeData;
  53     @Mock
  54     private LeafNode<String> keyLeafNodeData;
  55     @Mock
  56     private LeafNode<String> anotherLeafNodeData;
  57
  58     private NodeIdentifier containerNodeIdentifier;
  59     private NodeIdentifier mapNodeIdentifier;
  60     private NodeIdentifierWithPredicates mapEntryNodeIdentifier;
  61     private NodeIdentifier leafSetNodeIdentifier;
  62     private NodeWithValue<?> leafSetEntryNodeIdentifier;
  63     private NodeIdentifier keyLeafNodeIdentifier;
  64     private NodeIdentifier anotherLeafNodeIdentifier;
  65
  66     private Collection<DataContainerChild<?, ?>> containerNodeValue;
  67     private Collection<MapEntryNode> mapNodeValue;
  68     private Collection<DataContainerChild<?, ?>> mapEntryNodeValue;
  69     private Collection<LeafSetEntryNode<String>> leafSetNodeValue;
  70     private String leafSetEntryNodeValue;
  71     private String keyLeafNodeValue;
  72     private String anotherLeafNodeValue;
  73
  74     @Before
  75     public void setUp() {
  76         MockitoAnnotations.initMocks(this);
  77
  78         // identifiers
  79         containerNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "container"));
  80         Mockito.when(containerNodeData.getIdentifier()).thenReturn(containerNodeIdentifier);
  81         Mockito.when(containerNodeData.getNodeType()).thenReturn(containerNodeIdentifier.getNodeType());
  82
  83         mapNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "list"));
  84         Mockito.when(mapNodeData.getIdentifier()).thenReturn(mapNodeIdentifier);
  85
  86         final QName leafSetEntryNodeQName = QName.create("namespace", "leaf-set-entry");
  87         leafSetEntryNodeValue = "leaf-set-value";
  88         leafSetEntryNodeIdentifier = new NodeWithValue<>(leafSetEntryNodeQName, leafSetEntryNodeValue);
  89         Mockito.when(leafSetEntryNodeData.getIdentifier()).thenReturn(leafSetEntryNodeIdentifier);
  90         Mockito.when(leafSetEntryNodeData.getNodeType()).thenReturn(leafSetEntryNodeQName);
  91
  92         leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
  93         Mockito.when(leafSetNodeData.getIdentifier()).thenReturn(leafSetNodeIdentifier);
  94
  95         final QName mapEntryNodeKey = QName.create("namespace", "key-field");
  96         keyLeafNodeIdentifier = NodeIdentifier.create(mapEntryNodeKey);
  97         keyLeafNodeValue = "key-value";
  98
  99         mapEntryNodeIdentifier = new YangInstanceIdentifier.NodeIdentifierWithPredicates(
 100                 QName.create("namespace", "list-entry"), Collections.singletonMap(mapEntryNodeKey, keyLeafNodeValue));
 101         Mockito.when(mapEntryNodeData.getIdentifier()).thenReturn(mapEntryNodeIdentifier);
 102         Mockito.when(mapEntryNodeData.getChild(keyLeafNodeIdentifier)).thenReturn(Optional.of(keyLeafNodeData));
 103
 104         Mockito.when(keyLeafNodeData.getValue()).thenReturn(keyLeafNodeValue);
 105         Mockito.when(keyLeafNodeData.getIdentifier()).thenReturn(keyLeafNodeIdentifier);
 106
 107         anotherLeafNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "another-field"));
 108         anotherLeafNodeValue = "another-value";
 109
 110         Mockito.when(anotherLeafNodeData.getValue()).thenReturn(anotherLeafNodeValue);
 111         Mockito.when(anotherLeafNodeData.getIdentifier()).thenReturn(anotherLeafNodeIdentifier);
 112
 113         // values
 114         Mockito.when(leafSetEntryNodeData.getValue()).thenReturn(leafSetEntryNodeValue);
 115
 116         leafSetNodeValue = Collections.singletonList(leafSetEntryNodeData);
 117         Mockito.when(leafSetNodeData.getValue()).thenReturn(leafSetNodeValue);
 118
 119         containerNodeValue = Collections.singleton(leafSetNodeData);
 120         Mockito.when(containerNodeData.getValue()).thenReturn(containerNodeValue);
 121
 122         mapEntryNodeValue = Sets.newHashSet(keyLeafNodeData, anotherLeafNodeData);
 123         Mockito.when(mapEntryNodeData.getValue()).thenReturn(mapEntryNodeValue);
 124
 125         mapNodeValue = Collections.singleton(mapEntryNodeData);
 126         Mockito.when(mapNodeData.getValue()).thenReturn(mapNodeValue);
 127     }
 128
 129     /**
 130      * Test write {@link ContainerNode} with children but write data only to depth 1 (children will not be written).
 131      * Depth parameter is limited to 1.
 132      */
 133     @Test
 134     public void writeContainerWithoutChildrenDepthTest() throws Exception {
 135         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter
 136                 .forStreamWriter(writer, 1, null);
 137
 138         parameterWriter.write(containerNodeData);
 139
 140         final InOrder inOrder = Mockito.inOrder(writer);
 141         inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 142         inOrder.verify(writer, Mockito.times(1)).endNode();
 143         Mockito.verifyNoMoreInteractions(writer);
 144     }
 145
 146     /**
 147      * Test write {@link ContainerNode} with children and write also all its children.
 148      * Depth parameter has higher value than maximal children depth.
 149      */
 150     @Test
 151     public void writeContainerWithChildrenDepthTest() throws Exception {
 152         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 153                 writer, Integer.MAX_VALUE, null);
 154
 155         parameterWriter.write(containerNodeData);
 156
 157         final InOrder inOrder = Mockito.inOrder(writer);
 158         inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 159         inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 160         inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
 161                 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
 162         inOrder.verify(writer, Mockito.times(2)).endNode();
 163         Mockito.verifyNoMoreInteractions(writer);
 164     }
 165
 166     /**
 167      * Test write with {@link MapNode} with children but write data only to depth 1 (children will not be written).
 168      * Depth parameter limits depth to 1.
 169      */
 170     @Test
 171     public void writeMapNodeWithoutChildrenDepthTest() throws Exception {
 172         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter
 173                 .forStreamWriter(writer, 1, null);
 174
 175         parameterWriter.write(mapNodeData);
 176
 177         final InOrder inOrder = Mockito.inOrder(writer);
 178         inOrder.verify(writer, Mockito.times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
 179         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 180         inOrder.verify(writer, Mockito.times(2)).endNode();
 181         Mockito.verifyNoMoreInteractions(writer);
 182     }
 183
 184     /**
 185      * Test write {@link MapNode} with children and write also all its children.
 186      * Depth parameter has higher value than maximal children depth.
 187      *
 188      *
 189      * FIXME
 190      * Although ordered writer is used leaves are not written in expected order.
 191      *
 192      */
 193     @Ignore
 194     @Test
 195     public void writeMapNodeWithChildrenDepthTest() throws Exception {
 196         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 197                 writer, Integer.MAX_VALUE, null);
 198
 199         parameterWriter.write(mapNodeData);
 200
 201         final InOrder inOrder = Mockito.inOrder(writer);
 202         inOrder.verify(writer, Mockito.times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
 203         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 204         inOrder.verify(writer, Mockito.times(2)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
 205         // FIXME this assertion is not working because leaves are not written in expected order
 206         inOrder.verify(writer, Mockito.times(1)).leafNode(anotherLeafNodeIdentifier, anotherLeafNodeValue);
 207         inOrder.verify(writer, Mockito.times(2)).endNode();
 208         Mockito.verifyNoMoreInteractions(writer);
 209     }
 210
 211     /**
 212      * Test write with {@link LeafSetNode} with depth 1 (children will not be written).
 213      * Depth parameter limits depth to 1.
 214      */
 215     @Test
 216     public void writeLeafSetNodeWithoutChildrenDepthTest() throws Exception {
 217         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 218                 writer, 1, null);
 219
 220         parameterWriter.write(leafSetNodeData);
 221
 222         final InOrder inOrder = Mockito.inOrder(writer);
 223         inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 224         inOrder.verify(writer, Mockito.times(1)).endNode();
 225         Mockito.verifyNoMoreInteractions(writer);
 226     }
 227
 228     /**
 229      * Test write with {@link LeafSetNode} when all its children will be written.
 230      * Depth parameter has higher value than maximal children depth.
 231      */
 232     @Test
 233     public void writeLeafSetNodeWithChildrenDepthTest() throws Exception {
 234         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 235                 writer, Integer.MAX_VALUE, null);
 236
 237         parameterWriter.write(leafSetNodeData);
 238
 239         final InOrder inOrder = Mockito.inOrder(writer);
 240         inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 241         inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
 242                 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
 243         inOrder.verify(writer, Mockito.times(1)).endNode();
 244         Mockito.verifyNoMoreInteractions(writer);
 245     }
 246
 247     /**
 248      * Test write with {@link LeafSetEntryNode}.
 249      * Depth parameter has higher value than maximal children depth.
 250      */
 251     @Test
 252     public void writeLeafSetEntryNodeDepthTest() throws Exception {
 253         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 254                 writer, Integer.MAX_VALUE, null);
 255
 256         parameterWriter.write(leafSetEntryNodeData);
 257
 258         final InOrder inOrder = Mockito.inOrder(writer);
 259         inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
 260                 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
 261         Mockito.verifyNoMoreInteractions(writer);
 262     }
 263
 264     /**
 265      * Test write with {@link MapEntryNode} unordered to depth 1 to write only keys.
 266      * Depth parameter limits depth to 1.
 267      */
 268     @Test
 269     public void writeMapEntryNodeUnorderedOnlyKeysDepthTest() throws Exception {
 270         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 271                 writer, false, 1, null);
 272
 273         parameterWriter.write(mapEntryNodeData);
 274
 275         final InOrder inOrder = Mockito.inOrder(writer);
 276         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 277         // write only the key
 278         inOrder.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
 279         inOrder.verify(writer, Mockito.times(1)).endNode();
 280         Mockito.verifyNoMoreInteractions(writer);
 281     }
 282
 283     /**
 284      * Test write with {@link MapEntryNode} unordered with full depth.
 285      * Depth parameter has higher value than maximal children depth.
 286      */
 287     @Test
 288     public void writeMapEntryNodeUnorderedDepthTest() throws Exception {
 289         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 290                 writer, false, Integer.MAX_VALUE, null);
 291
 292         parameterWriter.write(mapEntryNodeData);
 293
 294         // unordered
 295         Mockito.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 296         Mockito.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
 297         Mockito.verify(writer, Mockito.times(1)).leafNode(anotherLeafNodeIdentifier, anotherLeafNodeValue);
 298         Mockito.verify(writer, Mockito.times(1)).endNode();
 299         Mockito.verifyNoMoreInteractions(writer);
 300     }
 301
 302     /**
 303      * Test write with {@link MapEntryNode} ordered with depth 1 (children will not be written).
 304      * Depth parameter limits depth to 1.
 305      */
 306     @Test
 307     public void writeMapEntryNodeOrderedWithoutChildrenTest() throws Exception {
 308         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 309                 writer, true, 1, null);
 310
 311         parameterWriter.write(mapEntryNodeData);
 312
 313         final InOrder inOrder = Mockito.inOrder(writer);
 314         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 315         inOrder.verify(writer, Mockito.times(1)).endNode();
 316         Mockito.verifyNoMoreInteractions(writer);
 317     }
 318
 319     /**
 320      * Test write with {@link MapEntryNode} ordered and write also all its children.
 321      * Depth parameter has higher value than maximal children depth.
 322      *
 323      * FIXME
 324      * Although ordered writer is used leaves are not written in expected order.
 325      *
 326      */
 327     @Ignore
 328     @Test
 329     public void writeMapEntryNodeOrderedTest() throws Exception {
 330         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 331                 writer, true, Integer.MAX_VALUE, null);
 332
 333         parameterWriter.write(mapEntryNodeData);
 334
 335         final InOrder inOrder = Mockito.inOrder(writer);
 336         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 337         inOrder.verify(writer, Mockito.times(2)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
 338         // FIXME this assertion is not working because leaves are not written in expected order
 339         inOrder.verify(writer, Mockito.times(1)).leafNode(anotherLeafNodeIdentifier, anotherLeafNodeValue);
 340         inOrder.verify(writer, Mockito.times(1)).endNode();
 341         Mockito.verifyNoMoreInteractions(writer);
 342     }
 343 }