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