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