restconf/restconf-nb/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 package org.opendaylight.restconf.nb.rfc8040.jersey.providers;
   9
  10 import static org.mockito.Mockito.inOrder;
  11 import static org.mockito.Mockito.times;
  12 import static org.mockito.Mockito.verifyNoMoreInteractions;
  13 import static org.mockito.Mockito.when;
  14
  15 import java.util.Collection;
  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.junit.MockitoJUnitRunner;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  31 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  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.SystemLeafSetNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
  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     @Mock
  45     private NormalizedNodeStreamWriter writer;
  46     @Mock
  47     private ContainerNode containerNodeData;
  48     @Mock
  49     private SystemMapNode mapNodeData;
  50     @Mock
  51     private MapEntryNode mapEntryNodeData;
  52     @Mock
  53     private SystemLeafSetNode<String> leafSetNodeData;
  54     @Mock
  55     private LeafSetEntryNode<String> leafSetEntryNodeData;
  56     @Mock
  57     private LeafNode<String> keyLeafNodeData;
  58
  59     private NodeIdentifier containerNodeIdentifier;
  60     private NodeIdentifier mapNodeIdentifier;
  61     private NodeIdentifierWithPredicates mapEntryNodeIdentifier;
  62     private NodeIdentifier leafSetNodeIdentifier;
  63     private NodeWithValue<String> leafSetEntryNodeIdentifier;
  64     private NodeIdentifier keyLeafNodeIdentifier;
  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
  73     @Before
  74     public void setUp() {
  75         // identifiers
  76         containerNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "container"));
  77         when(containerNodeData.getIdentifier()).thenReturn(containerNodeIdentifier);
  78
  79         mapNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "list"));
  80         when(mapNodeData.getIdentifier()).thenReturn(mapNodeIdentifier);
  81
  82         final QName leafSetEntryNodeQName = QName.create("namespace", "leaf-set-entry");
  83         leafSetEntryNodeValue = "leaf-set-value";
  84         leafSetEntryNodeIdentifier = new NodeWithValue<>(leafSetEntryNodeQName, leafSetEntryNodeValue);
  85         when(leafSetEntryNodeData.getIdentifier()).thenReturn(leafSetEntryNodeIdentifier);
  86
  87         leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
  88         when(leafSetNodeData.getIdentifier()).thenReturn(leafSetNodeIdentifier);
  89
  90         final QName mapEntryNodeKey = QName.create("namespace", "key-field");
  91         keyLeafNodeIdentifier = NodeIdentifier.create(mapEntryNodeKey);
  92         keyLeafNodeValue = "key-value";
  93
  94         mapEntryNodeIdentifier = NodeIdentifierWithPredicates.of(
  95                 QName.create("namespace", "list-entry"), mapEntryNodeKey, keyLeafNodeValue);
  96         when(mapEntryNodeData.getIdentifier()).thenReturn(mapEntryNodeIdentifier);
  97         when(mapEntryNodeData.findChildByArg(keyLeafNodeIdentifier)).thenReturn(Optional.of(keyLeafNodeData));
  98
  99         when(keyLeafNodeData.body()).thenReturn(keyLeafNodeValue);
 100         when(keyLeafNodeData.getIdentifier()).thenReturn(keyLeafNodeIdentifier);
 101
 102         // values
 103         when(leafSetEntryNodeData.body()).thenReturn(leafSetEntryNodeValue);
 104
 105         leafSetNodeValue = List.of(leafSetEntryNodeData);
 106         when(leafSetNodeData.body()).thenReturn(leafSetNodeValue);
 107
 108         containerNodeValue = Set.of(leafSetNodeData);
 109         when(containerNodeData.body()).thenReturn(containerNodeValue);
 110
 111         mapEntryNodeValue = Set.of(keyLeafNodeData);
 112         when(mapEntryNodeData.body()).thenReturn(mapEntryNodeValue);
 113
 114         mapNodeValue = Set.of(mapEntryNodeData);
 115         when(mapNodeData.body()).thenReturn(mapNodeValue);
 116     }
 117
 118     /**
 119      * Test write {@link ContainerNode} when children which will be written are limited.
 120      * Fields parameter selects 0/1 of container children to be written.
 121      */
 122     @Test
 123     public void writeContainerWithLimitedFieldsTest() throws Exception {
 124         final List<Set<QName>> limitedFields = List.of(Set.of());
 125
 126         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 127                 writer, null, limitedFields);
 128
 129         parameterWriter.write(containerNodeData);
 130
 131         final InOrder inOrder = inOrder(writer);
 132         inOrder.verify(writer, times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 133         inOrder.verify(writer, times(1)).endNode();
 134         verifyNoMoreInteractions(writer);
 135     }
 136
 137     /**
 138      * Test write {@link ContainerNode} when all its children are selected to be written.
 139      * Fields parameter selects 1/1 of container children to be written.
 140      */
 141     @Test
 142     public void writeContainerAllFieldsTest() throws Exception {
 143         final List<Set<QName>> limitedFields = List.of(Set.of(leafSetNodeIdentifier.getNodeType()));
 144
 145         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 146                 writer, null, limitedFields);
 147
 148         parameterWriter.write(containerNodeData);
 149
 150         final InOrder inOrder = inOrder(writer);
 151         inOrder.verify(writer, times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 152         inOrder.verify(writer, times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 153         inOrder.verify(writer, times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
 154         inOrder.verify(writer, times(1)).scalarValue(leafSetEntryNodeValue);
 155         inOrder.verify(writer, times(3)).endNode();
 156         verifyNoMoreInteractions(writer);
 157     }
 158
 159     /**
 160      * Test write {@link MapEntryNode} as child of {@link MapNode} when children which will be written are limited.
 161      * Fields parameter selects 0/1 of map entry node children to be written.
 162      */
 163     @Test
 164     public void writeMapEntryNodeWithLimitedFieldsTest() throws Exception {
 165         final List<Set<QName>> limitedFields = List.of(Set.of());
 166
 167         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 168                 writer, null, limitedFields);
 169
 170         parameterWriter.write(mapNodeData);
 171
 172         final InOrder inOrder = inOrder(writer);
 173         inOrder.verify(writer, times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
 174         inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 175         inOrder.verify(writer, times(2)).endNode();
 176         verifyNoMoreInteractions(writer);
 177     }
 178
 179     /**
 180      * Test write {@link MapEntryNode} as child of {@link MapNode} when all its children will be written.
 181      * Fields parameter selects 1/1 of map entry node children to be written.
 182      */
 183     @Test
 184     public void writeMapNodeAllFieldsTest() throws Exception {
 185         final List<Set<QName>> limitedFields = List.of(Set.of(keyLeafNodeData.getIdentifier().getNodeType()));
 186
 187         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 188                 writer, null, limitedFields);
 189
 190         parameterWriter.write(mapNodeData);
 191
 192         final InOrder inOrder = inOrder(writer);
 193         inOrder.verify(writer, times(1)).startMapNode(mapNodeIdentifier, mapNodeValue.size());
 194         inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, mapEntryNodeValue.size());
 195         inOrder.verify(writer, times(1)).startLeafNode(keyLeafNodeIdentifier);
 196         inOrder.verify(writer, times(1)).scalarValue(keyLeafNodeValue);
 197         inOrder.verify(writer, times(3)).endNode();
 198         verifyNoMoreInteractions(writer);
 199     }
 200 }