restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/jersey/providers/ParameterAwareNormalizedNodeWriterParametersTest.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.List;
  16 import java.util.Set;
  17 import org.junit.Before;
  18 import org.junit.Test;
  19 import org.junit.runner.RunWith;
  20 import org.mockito.InOrder;
  21 import org.mockito.Mock;
  22 import org.mockito.Mockito;
  23 import org.mockito.junit.MockitoJUnitRunner;
  24 import org.opendaylight.restconf.nb.rfc8040.DepthParam;
  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.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.LeafSetEntryNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  35
  36 /**
  37  * Unit test for {@link ParameterAwareNormalizedNodeWriter} used with all parameters.
  38  */
  39 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  40 public class ParameterAwareNormalizedNodeWriterParametersTest {
  41
  42     @Mock
  43     private NormalizedNodeStreamWriter writer;
  44     @Mock
  45     private ContainerNode containerNodeData;
  46     @Mock
  47     private LeafSetNode<String> leafSetNodeData;
  48     @Mock
  49     private LeafSetEntryNode<String> leafSetEntryNodeData;
  50     @Mock
  51     private ContainerNode rootDataContainerData;
  52
  53     private NodeIdentifier containerNodeIdentifier;
  54     private NodeIdentifier leafSetNodeIdentifier;
  55     private NodeWithValue<String> leafSetEntryNodeIdentifier;
  56
  57     private Collection<DataContainerChild> containerNodeValue;
  58     private Collection<LeafSetEntryNode<String>> leafSetNodeValue;
  59     private String leafSetEntryNodeValue;
  60     private Collection<DataContainerChild> rootDataContainerValue;
  61
  62     @Before
  63     public void setUp() {
  64         // identifiers
  65         containerNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "container"));
  66         Mockito.when(containerNodeData.getIdentifier()).thenReturn(containerNodeIdentifier);
  67
  68         final QName leafSetEntryNodeQName = QName.create("namespace", "leaf-set-entry");
  69         leafSetEntryNodeValue = "leaf-set-value";
  70         leafSetEntryNodeIdentifier = new NodeWithValue<>(leafSetEntryNodeQName, leafSetEntryNodeValue);
  71         Mockito.when(leafSetEntryNodeData.getIdentifier()).thenReturn(leafSetEntryNodeIdentifier);
  72
  73         leafSetNodeIdentifier = NodeIdentifier.create(QName.create("namespace", "leaf-set"));
  74         Mockito.when(leafSetNodeData.getIdentifier()).thenReturn(leafSetNodeIdentifier);
  75
  76         // values
  77         Mockito.when(leafSetEntryNodeData.body()).thenReturn(leafSetEntryNodeValue);
  78
  79         leafSetNodeValue = Collections.singletonList(leafSetEntryNodeData);
  80         Mockito.when(leafSetNodeData.body()).thenReturn(leafSetNodeValue);
  81
  82         containerNodeValue = Collections.singleton(leafSetNodeData);
  83         Mockito.when(containerNodeData.body()).thenReturn(containerNodeValue);
  84
  85         rootDataContainerValue = Collections.singleton(leafSetNodeData);
  86         Mockito.when(rootDataContainerData.getIdentifier()).thenReturn(NodeIdentifier.create(
  87             QName.create("urn:ietf:params:xml:ns:netconf:base:1.0", "data")));
  88         Mockito.when(rootDataContainerData.body()).thenReturn(rootDataContainerValue);
  89     }
  90
  91     /**
  92      * Test write {@link ContainerNode} when all its children are selected to be written by fields parameter.
  93      * Depth parameter is also used and limits output to depth 1.
  94      * Fields parameter has effect limiting depth parameter in the way that selected nodes and its ancestors are
  95      * written regardless of their depth (some of container children have depth > 1).
  96      * Fields parameter selects all container children to be written and also all children of those children.
  97      */
  98     @Test
  99     public void writeContainerParameterPrioritiesTest() throws Exception {
 100         final List<Set<QName>> limitedFields = new ArrayList<>();
 101         limitedFields.add(Sets.newHashSet(leafSetNodeIdentifier.getNodeType()));
 102         limitedFields.add(Sets.newHashSet(leafSetEntryNodeIdentifier.getNodeType()));
 103
 104         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 105                 writer, DepthParam.min(), limitedFields);
 106
 107         parameterWriter.write(containerNodeData);
 108
 109         final InOrder inOrder = Mockito.inOrder(writer);
 110         inOrder.verify(writer, Mockito.times(1)).startContainerNode(containerNodeIdentifier, containerNodeValue.size());
 111         inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 112         inOrder.verify(writer, Mockito.times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
 113         inOrder.verify(writer, Mockito.times(1)).scalarValue(leafSetEntryNodeValue);
 114         inOrder.verify(writer, Mockito.times(3)).endNode();
 115         Mockito.verifyNoMoreInteractions(writer);
 116     }
 117
 118     /**
 119      * Test write {@link ContainerNode} which represents data at restconf/data root.
 120      * No parameters are used.
 121      */
 122     @Test
 123     public void writeRootDataTest() throws Exception {
 124         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 125                 writer, null, null);
 126
 127         parameterWriter.write(rootDataContainerData);
 128
 129         final InOrder inOrder = Mockito.inOrder(writer);
 130         inOrder.verify(writer, Mockito.times(1)).startLeafSet(leafSetNodeIdentifier, leafSetNodeValue.size());
 131         inOrder.verify(writer, Mockito.times(1)).startLeafSetEntryNode(leafSetEntryNodeIdentifier);
 132         inOrder.verify(writer, Mockito.times(1)).scalarValue(leafSetEntryNodeValue);
 133         inOrder.verify(writer, Mockito.times(2)).endNode();
 134         Mockito.verifyNoMoreInteractions(writer);
 135     }
 136
 137     @Test
 138     public void writeEmptyRootContainerTest() throws Exception {
 139         final ParameterAwareNormalizedNodeWriter parameterWriter = ParameterAwareNormalizedNodeWriter.forStreamWriter(
 140                 writer, null, null);
 141
 142         parameterWriter.write(ImmutableContainerNodeBuilder.create()
 143                 .withNodeIdentifier(new NodeIdentifier(SchemaContext.NAME)).build());
 144     }
 145 }