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
  14 import java.util.List;
  15 import java.util.Set;
  16 import org.junit.Test;
  17 import org.junit.runner.RunWith;
  18 import org.mockito.Mock;
  19 import org.mockito.junit.MockitoJUnitRunner;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  24 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  32 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  34
  35 /**
  36  * Unit test for {@link ParameterAwareNormalizedNodeWriter} used with fields parameter.
  37  */
  38 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  39 public class ParameterAwareNormalizedNodeWriterFieldsTest {
  40     private final String leafSetEntryNodeValue = "leaf-set-value";
  41     private final String keyLeafNodeValue = "key-value";
  42     private final NodeIdentifier containerNodeIdentifier =
  43         NodeIdentifier.create(QName.create("namespace", "container"));
  44     private final NodeIdentifier mapNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "list"));
  45     private final NodeIdentifier leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
  46     private final NodeWithValue<String> leafSetEntryNodeIdentifier =
  47         new NodeWithValue<>(QName.create("namespace", "leaf-set-entry"), leafSetEntryNodeValue);
  48     private final NodeIdentifier keyLeafNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "key-field"));
  49     private final NodeIdentifierWithPredicates mapEntryNodeIdentifier = NodeIdentifierWithPredicates.of(
  50         QName.create("namespace", "list-entry"), keyLeafNodeIdentifier.getNodeType(), keyLeafNodeValue);
  51
  52     private final LeafSetEntryNode<String> leafSetEntryNodeData = Builders.<String>leafSetEntryBuilder()
  53         .withNodeIdentifier(leafSetEntryNodeIdentifier)
  54         .withValue(leafSetEntryNodeValue)
  55         .build();
  56     private final SystemLeafSetNode<String> leafSetNodeData = Builders.<String>leafSetBuilder()
  57         .withNodeIdentifier(leafSetNodeIdentifier)
  58         .withChild(leafSetEntryNodeData)
  59         .build();
  60     private final ContainerNode containerNodeData = Builders.containerBuilder()
  61         .withNodeIdentifier(containerNodeIdentifier)
  62         .withChild(leafSetNodeData)
  63         .build();
  64     private final LeafNode<String> keyLeafNodeData = ImmutableNodes.leafNode(keyLeafNodeIdentifier, keyLeafNodeValue);
  65     private final MapEntryNode mapEntryNodeData = Builders.mapEntryBuilder()
  66         .withNodeIdentifier(mapEntryNodeIdentifier)
  67         .withChild(keyLeafNodeData)
  68         .build();
  69     private final SystemMapNode mapNodeData = Builders.mapBuilder()
  70         .withNodeIdentifier(mapNodeIdentifier)
  71         .withChild(mapEntryNodeData)
  72         .build();
  73
  74     @Mock
  75     private NormalizedNodeStreamWriter writer;
  76
  77     /**
  78      * Test write {@link ContainerNode} when children which will be written are limited.
  79      * Fields parameter selects 0/1 of container children to be written.
  80      */
  81     @Test
  82     public void writeContainerWithLimitedFieldsTest() throws Exception {
  83         final var parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(writer, null, List.of(Set.of()));
  84
  85         parameterWriter.write(containerNodeData);
  86
  87         final var inOrder = inOrder(writer);
  88         inOrder.verify(writer, times(1)).startContainerNode(containerNodeIdentifier, 1);
  89         inOrder.verify(writer, times(1)).endNode();
  90         verifyNoMoreInteractions(writer);
  91     }
  92
  93     /**
  94      * Test write {@link ContainerNode} when all its children are selected to be written.
  95      * Fields parameter selects 1/1 of container children to be written.
  96      */
  97     @Test
  98     public void writeContainerAllFieldsTest() throws Exception {
  99         final var parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 100                 writer, null, List.of(Set.of(leafSetNodeIdentifier.getNodeType())));
 101
 102         parameterWriter.write(containerNodeData);
 103
 104         final var inOrder = inOrder(writer);
 105         inOrder.verify(writer, times(1)).startContainerNode(containerNodeIdentifier, 1);
 106         inOrder.verify(writer, times(1)).startLeafSet(leafSetNodeIdentifier, 1);
 107         inOrder.verify(writer, times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
 108         inOrder.verify(writer, times(1)).scalarValue(leafSetEntryNodeValue);
 109         inOrder.verify(writer, times(3)).endNode();
 110         verifyNoMoreInteractions(writer);
 111     }
 112
 113     /**
 114      * Test write {@link MapEntryNode} as child of {@link MapNode} when children which will be written are limited.
 115      * Fields parameter selects 0/1 of map entry node children to be written.
 116      */
 117     @Test
 118     public void writeMapEntryNodeWithLimitedFieldsTest() throws Exception {
 119         final var parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(writer, null, List.of(Set.of()));
 120
 121         parameterWriter.write(mapNodeData);
 122
 123         final var inOrder = inOrder(writer);
 124         inOrder.verify(writer, times(1)).startMapNode(mapNodeIdentifier, 1);
 125         inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, 1);
 126         inOrder.verify(writer, times(2)).endNode();
 127         verifyNoMoreInteractions(writer);
 128     }
 129
 130     /**
 131      * Test write {@link MapEntryNode} as child of {@link MapNode} when all its children will be written.
 132      * Fields parameter selects 1/1 of map entry node children to be written.
 133      */
 134     @Test
 135     public void writeMapNodeAllFieldsTest() throws Exception {
 136         final var parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(writer, null,
 137             List.of(Set.of(keyLeafNodeData.name().getNodeType())));
 138
 139         parameterWriter.write(mapNodeData);
 140
 141         final var inOrder = inOrder(writer);
 142         inOrder.verify(writer, times(1)).startMapNode(mapNodeIdentifier, 1);
 143         inOrder.verify(writer, times(1)).startMapEntryNode(mapEntryNodeIdentifier, 1);
 144         inOrder.verify(writer, times(1)).startLeafNode(keyLeafNodeIdentifier);
 145         inOrder.verify(writer, times(1)).scalarValue(keyLeafNodeValue);
 146         inOrder.verify(writer, times(3)).endNode();
 147         verifyNoMoreInteractions(writer);
 148     }
 149 }