restconf/restconf-nb-bierman02/src/test/java/org/opendaylight/restconf/jersey/providers/ParameterAwareNormalizedNodeWriterFieldsTest.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.ArrayList;
  14 import java.util.Collection;
  15 import java.util.Collections;
  16 import java.util.List;
  17 import java.util.Set;
  18 import org.junit.Before;
  19 import org.junit.Test;
  20 import org.mockito.InOrder;
  21 import org.mockito.Mock;
  22 import org.mockito.Mockito;
  23 import org.mockito.MockitoAnnotations;
  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.ContainerNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  30 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  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.api.schema.stream.NormalizedNodeStreamWriter;
  36
  37 /**
  38  * Unit test for {@link ParameterAwareNormalizedNodeWriter} used with fields parameter.
  39  */
  40 public class ParameterAwareNormalizedNodeWriterFieldsTest {
  41
  42     @Mock
  43     private NormalizedNodeStreamWriter writer;
  44     @Mock
  45     private ContainerNode containerNodeData;
  46     @Mock
  47     private MapNode mapNodeData;
  48     @Mock
  49     private MapEntryNode mapEntryNodeData;
  50     @Mock
  51     private LeafSetNode<String> leafSetNodeData;
  52     @Mock
  53     private LeafSetEntryNode<String> leafSetEntryNodeData;
  54     @Mock
  55     private LeafNode<String> keyLeafNodeData;
  56
  57     private NodeIdentifier containerNodeIdentifier;
  58     private NodeIdentifier mapNodeIdentifier;
  59     private NodeIdentifierWithPredicates mapEntryNodeIdentifier;
  60     private NodeIdentifier leafSetNodeIdentifier;
  61     private NodeWithValue<?> leafSetEntryNodeIdentifier;
  62     private NodeIdentifier keyLeafNodeIdentifier;
  63
  64     private Collection<DataContainerChild<?, ?>> containerNodeValue;
  65     private Collection<MapEntryNode> mapNodeValue;
  66     private Collection<DataContainerChild<?, ?>> mapEntryNodeValue;
  67     private Collection<LeafSetEntryNode<String>> leafSetNodeValue;
  68     private String leafSetEntryNodeValue;
  69     private String keyLeafNodeValue;
  70
  71     @Before
  72     public void setUp() {
  73         MockitoAnnotations.initMocks(this);
  74
  75         // identifiers
  76         containerNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "container"));
  77         Mockito.when(containerNodeData.getIdentifier()).thenReturn(containerNodeIdentifier);
  78         Mockito.when(containerNodeData.getNodeType()).thenReturn(containerNodeIdentifier.getNodeType());
  79
  80         mapNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "list"));
  81         Mockito.when(mapNodeData.getIdentifier()).thenReturn(mapNodeIdentifier);
  82         Mockito.when(mapNodeData.getNodeType()).thenReturn(mapNodeIdentifier.getNodeType());
  83
  84         final QName leafSetEntryNodeQName = QName.create("namespace", "leaf-set-entry");
  85         leafSetEntryNodeValue = "leaf-set-value";
  86         leafSetEntryNodeIdentifier = new NodeWithValue<>(leafSetEntryNodeQName, leafSetEntryNodeValue);
  87         Mockito.when(leafSetEntryNodeData.getIdentifier()).thenReturn(leafSetEntryNodeIdentifier);
  88         Mockito.when(leafSetEntryNodeData.getNodeType()).thenReturn(leafSetEntryNodeIdentifier.getNodeType());
  89         Mockito.when(leafSetEntryNodeData.getNodeType()).thenReturn(leafSetEntryNodeQName);
  90
  91         leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
  92         Mockito.when(leafSetNodeData.getIdentifier()).thenReturn(leafSetNodeIdentifier);
  93         Mockito.when(leafSetNodeData.getNodeType()).thenReturn(leafSetNodeIdentifier.getNodeType());
  94
  95         final QName mapEntryNodeKey = QName.create("namespace", "key-field");
  96         keyLeafNodeIdentifier = NodeIdentifier.create(mapEntryNodeKey);
  97         keyLeafNodeValue = "key-value";
  98
  99         mapEntryNodeIdentifier = new NodeIdentifierWithPredicates(
 100                 QName.create("namespace", "list-entry"), Collections.singletonMap(mapEntryNodeKey, keyLeafNodeValue));
 101         Mockito.when(mapEntryNodeData.getIdentifier()).thenReturn(mapEntryNodeIdentifier);
 102         Mockito.when(mapEntryNodeData.getNodeType()).thenReturn(mapEntryNodeIdentifier.getNodeType());
 103         Mockito.when(mapEntryNodeData.getChild(keyLeafNodeIdentifier)).thenReturn(Optional.of(keyLeafNodeData));
 104
 105         Mockito.when(keyLeafNodeData.getValue()).thenReturn(keyLeafNodeValue);
 106         Mockito.when(keyLeafNodeData.getIdentifier()).thenReturn(keyLeafNodeIdentifier);
 107         Mockito.when(keyLeafNodeData.getNodeType()).thenReturn(keyLeafNodeIdentifier.getNodeType());
 108
 109         // values
 110         Mockito.when(leafSetEntryNodeData.getValue()).thenReturn(leafSetEntryNodeValue);
 111
 112         leafSetNodeValue = Collections.singletonList(leafSetEntryNodeData);
 113         Mockito.when(leafSetNodeData.getValue()).thenReturn(leafSetNodeValue);
 114
 115         containerNodeValue = Collections.singleton(leafSetNodeData);
 116         Mockito.when(containerNodeData.getValue()).thenReturn(containerNodeValue);
 117
 118         mapEntryNodeValue = Sets.newHashSet(keyLeafNodeData);
 119         Mockito.when(mapEntryNodeData.getValue()).thenReturn(mapEntryNodeValue);
 120
 121         mapNodeValue = Collections.singleton(mapEntryNodeData);
 122         Mockito.when(mapNodeData.getValue()).thenReturn(mapNodeValue);
 123     }
 124
 125     /**
 126      * Test write {@link ContainerNode} when children which will be written are limited.
 127      * Fields parameter selects 0/1 of container children to be written.
 128      */
 129     @Test
 130     public void writeContainerWithLimitedFieldsTest() throws Exception {
 131         final List<Set<QName>> limitedFields = new ArrayList<>();
 132         limitedFields.add(Sets.newHashSet());
 133
 134         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 135                 writer, null, limitedFields);
 136
 137         parameterWriter.write(containerNodeData);
 138
 139         final InOrder inOrder = Mockito.inOrder(writer);
 140         inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 141         inOrder.verify(writer, Mockito.times(1)).endNode();
 142         Mockito.verifyNoMoreInteractions(writer);
 143     }
 144
 145     /**
 146      * Test write {@link ContainerNode} when all its children are selected to be written.
 147      * Fields parameter selects 1/1 of container children to be written.
 148      */
 149     @Test
 150     public void writeContainerAllFieldsTest() throws Exception {
 151         final List<Set<QName>> limitedFields = new ArrayList<>();
 152         limitedFields.add(Sets.newHashSet(leafSetNodeIdentifier.getNodeType()));
 153
 154         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 155                 writer, null, limitedFields);
 156
 157         parameterWriter.write(containerNodeData);
 158
 159         final InOrder inOrder = Mockito.inOrder(writer);
 160         inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 161         inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 162         inOrder.verify(writer, Mockito.times(1)).leafSetEntryNode(
 163                 leafSetEntryNodeIdentifier.getNodeType(), leafSetEntryNodeValue);
 164         inOrder.verify(writer, Mockito.times(2)).endNode();
 165         Mockito.verifyNoMoreInteractions(writer);
 166     }
 167
 168     /**
 169      * Test write {@link MapEntryNode} as child of {@link MapNode} when children which will be written are limited.
 170      * Fields parameter selects 0/1 of map entry node children to be written.
 171      */
 172     @Test
 173     public void writeMapEntryNodeWithLimitedFieldsTest() throws Exception {
 174         final List<Set<QName>> limitedFields = new ArrayList<>();
 175         limitedFields.add(Sets.newHashSet());
 176
 177         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 178                 writer, null, limitedFields);
 179
 180         parameterWriter.write(mapNodeData);
 181
 182         final InOrder inOrder = Mockito.inOrder(writer);
 183         inOrder.verify(writer, Mockito.times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
 184         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 185         inOrder.verify(writer, Mockito.times(2)).endNode();
 186         Mockito.verifyNoMoreInteractions(writer);
 187     }
 188
 189     /**
 190      * Test write {@link MapEntryNode} as child of {@link MapNode} when all its children will be written.
 191      * Fields parameter selects 1/1 of map entry node children to be written.
 192      */
 193     @Test
 194     public void writeMapNodeAllFieldsTest() throws Exception {
 195         final List<Set<QName>> limitedFields = new ArrayList<>();
 196         limitedFields.add(Sets.newHashSet(keyLeafNodeData.getNodeType()));
 197
 198         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 199                 writer, null, limitedFields);
 200
 201         parameterWriter.write(mapNodeData);
 202
 203         final InOrder inOrder = Mockito.inOrder(writer);
 204         inOrder.verify(writer, Mockito.times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
 205         inOrder.verify(writer, Mockito.times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 206         inOrder.verify(writer, Mockito.times(1)).leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
 207         inOrder.verify(writer, Mockito.times(2)).endNode();
 208         Mockito.verifyNoMoreInteractions(writer);
 209     }
 210 }