restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/PostDataTransactionUtilTest.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.rests.utils;
   9
  10 import static org.hamcrest.CoreMatchers.containsString;
  11 import static org.hamcrest.MatcherAssert.assertThat;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertThrows;
  14 import static org.mockito.ArgumentMatchers.any;
  15 import static org.mockito.Mockito.doNothing;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.verify;
  18 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
  19 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
  20
  21 import com.google.common.util.concurrent.Futures;
  22 import java.net.URLDecoder;
  23 import java.nio.charset.StandardCharsets;
  24 import java.util.Collection;
  25 import java.util.Optional;
  26 import javax.ws.rs.core.Response;
  27 import javax.ws.rs.core.UriBuilder;
  28 import javax.ws.rs.core.UriInfo;
  29 import org.junit.Before;
  30 import org.junit.Test;
  31 import org.junit.runner.RunWith;
  32 import org.mockito.Mock;
  33 import org.mockito.junit.MockitoJUnitRunner;
  34 import org.opendaylight.mdsal.common.api.CommitInfo;
  35 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  36 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  37 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  38 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  39 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  40 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  41 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  42 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  43 import org.opendaylight.restconf.nb.rfc8040.WriteDataParams;
  44 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  45 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  46 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
  47 import org.opendaylight.yangtools.yang.common.QName;
  48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  51 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  52 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  56 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  57 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  58 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  59 import org.w3c.dom.DOMException;
  60
  61 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  62 public class PostDataTransactionUtilTest {
  63     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
  64
  65     @Mock
  66     private DOMDataTreeReadWriteTransaction readWrite;
  67     @Mock
  68     private UriInfo uriInfo;
  69     @Mock
  70     private DOMDataBroker mockDataBroker;
  71     @Mock
  72     private NetconfDataTreeService netconfService;
  73
  74     private ContainerNode buildBaseCont;
  75     private EffectiveModelContext schema;
  76     private YangInstanceIdentifier iid2;
  77     private YangInstanceIdentifier iidList;
  78     private MapNode buildList;
  79
  80     @Before
  81     public void setUp() throws Exception {
  82         schema =
  83                 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
  84
  85         final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
  86         final QName containerQname = QName.create(baseQName, "player");
  87         final QName leafQname = QName.create(baseQName, "gap");
  88         final QName listQname = QName.create(baseQName, "playlist");
  89         final QName listKeyQname = QName.create(baseQName, "name");
  90         final NodeIdentifierWithPredicates nodeWithKey = NodeIdentifierWithPredicates.of(listQname, listKeyQname,
  91             "name of band");
  92         iid2 = YangInstanceIdentifier.builder()
  93                 .node(baseQName)
  94                 .build();
  95         iidList = YangInstanceIdentifier.builder()
  96                 .node(baseQName)
  97                 .node(listQname)
  98                 .build();
  99
 100         final LeafNode<?> buildLeaf = Builders.leafBuilder()
 101                 .withNodeIdentifier(new NodeIdentifier(leafQname))
 102                 .withValue(0.2)
 103                 .build();
 104         final ContainerNode buildPlayerCont = Builders.containerBuilder()
 105                 .withNodeIdentifier(new NodeIdentifier(containerQname))
 106                 .withChild(buildLeaf)
 107                 .build();
 108         buildBaseCont = Builders.containerBuilder()
 109                 .withNodeIdentifier(new NodeIdentifier(baseQName))
 110                 .withChild(buildPlayerCont)
 111                 .build();
 112
 113         final LeafNode<Object> content = Builders.leafBuilder()
 114                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
 115                 .withValue("name of band")
 116                 .build();
 117         final LeafNode<Object> content2 = Builders.leafBuilder()
 118                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
 119                 .withValue("band description")
 120                 .build();
 121         final MapEntryNode mapEntryNode = Builders.mapEntryBuilder()
 122                 .withNodeIdentifier(nodeWithKey)
 123                 .withChild(content)
 124                 .withChild(content2)
 125                 .build();
 126         buildList = Builders.mapBuilder()
 127                 .withNodeIdentifier(new NodeIdentifier(listQname))
 128                 .withChild(mapEntryNode)
 129                 .build();
 130
 131         doReturn(UriBuilder.fromUri("http://localhost:8181/restconf/16/")).when(uriInfo).getBaseUriBuilder();
 132         doReturn(readWrite).when(mockDataBroker).newReadWriteTransaction();
 133
 134         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).lock();
 135         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
 136     }
 137
 138     @Test
 139     public void testPostContainerData() {
 140         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 141                 new InstanceIdentifierContext<>(iid2, null, null, schema);
 142         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
 143
 144         doReturn(immediateFalseFluentFuture()).when(readWrite).exists(LogicalDatastoreType.CONFIGURATION, iid2);
 145         final NodeIdentifier identifier =
 146                 ((ContainerNode) ((Collection<?>) payload.getData().body()).iterator().next()).getIdentifier();
 147         final YangInstanceIdentifier node = iid2.node(identifier);
 148         doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
 149         doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
 150         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 151         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 152             .create(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());
 153
 154         Response response = PostDataTransactionUtil.postData(uriInfo, payload,
 155             new MdsalRestconfStrategy(mockDataBroker), schema, WriteDataParams.empty());
 156         assertEquals(201, response.getStatus());
 157         verify(readWrite).exists(LogicalDatastoreType.CONFIGURATION, iid2);
 158         verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData());
 159
 160         response = PostDataTransactionUtil.postData(uriInfo, payload,
 161                 new NetconfRestconfStrategy(netconfService), schema, WriteDataParams.empty());
 162         assertEquals(201, response.getStatus());
 163         verify(netconfService).create(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());
 164     }
 165
 166     @Test
 167     public void testPostListData() {
 168         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 169                 new InstanceIdentifierContext<>(iidList, null, null, schema);
 170         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildList);
 171
 172         final MapNode data = (MapNode) payload.getData();
 173         final MapEntryNode entryNode = data.body().iterator().next();
 174         final NodeIdentifierWithPredicates identifier = entryNode.getIdentifier();
 175         final YangInstanceIdentifier node = iidList.node(identifier);
 176         doReturn(immediateFalseFluentFuture()).when(readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 177         doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
 178         doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
 179         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 180             .merge(any(), any(), any(), any());
 181         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 182         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).create(
 183             LogicalDatastoreType.CONFIGURATION, node, entryNode, Optional.empty());
 184
 185         Response response = PostDataTransactionUtil.postData(uriInfo, payload,
 186                         new MdsalRestconfStrategy(mockDataBroker), schema, WriteDataParams.empty());
 187         assertEquals(201, response.getStatus());
 188         assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
 189             containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
 190         verify(readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 191         verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
 192
 193         response = PostDataTransactionUtil.postData(uriInfo, payload,
 194                 new NetconfRestconfStrategy(netconfService), schema, WriteDataParams.empty());
 195         assertEquals(201, response.getStatus());
 196         assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
 197                 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
 198         verify(netconfService).create(LogicalDatastoreType.CONFIGURATION, node, entryNode,
 199                 Optional.empty());
 200     }
 201
 202     @Test
 203     public void testPostDataFail() {
 204         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 205                 new InstanceIdentifierContext<>(iid2, null, null, schema);
 206         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
 207
 208         doReturn(immediateFalseFluentFuture()).when(readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 209             iid2);
 210         final NodeIdentifier identifier =
 211                 ((ContainerNode) ((Collection<?>) payload.getData().body()).iterator().next()).getIdentifier();
 212         final YangInstanceIdentifier node = iid2.node(identifier);
 213         doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
 214         final DOMException domException = new DOMException((short) 414, "Post request failed");
 215         doReturn(immediateFailedFluentFuture(domException)).when(readWrite).commit();
 216         doReturn(immediateFailedFluentFuture(domException)).when(netconfService)
 217             .create(any(), any(), any(), any());
 218         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).discardChanges();
 219         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
 220
 221         RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
 222             () -> PostDataTransactionUtil.postData(uriInfo, payload, new MdsalRestconfStrategy(mockDataBroker), schema,
 223                 WriteDataParams.empty()));
 224         assertEquals(1, ex.getErrors().size());
 225         assertThat(ex.getErrors().get(0).getErrorInfo(), containsString(domException.getMessage()));
 226
 227         verify(readWrite).exists(LogicalDatastoreType.CONFIGURATION, iid2);
 228         verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData());
 229
 230         ex = assertThrows(RestconfDocumentedException.class, () -> PostDataTransactionUtil.postData(uriInfo, payload,
 231             new NetconfRestconfStrategy(netconfService), schema, WriteDataParams.empty()));
 232         assertEquals(1, ex.getErrors().size());
 233         assertThat(ex.getErrors().get(0).getErrorInfo(), containsString(domException.getMessage()));
 234
 235         verify(netconfService).create(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());
 236     }
 237 }