2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040.rests.utils;
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;
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.test.util.YangParserTestUtils;
58 import org.w3c.dom.DOMException;
60 @RunWith(MockitoJUnitRunner.StrictStubs.class)
61 public class PostDataTransactionUtilTest {
62 private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
65 private DOMDataTreeReadWriteTransaction readWrite;
67 private UriInfo uriInfo;
69 private DOMDataBroker mockDataBroker;
71 private NetconfDataTreeService netconfService;
73 private ContainerNode buildBaseCont;
74 private EffectiveModelContext schema;
75 private YangInstanceIdentifier iid2;
76 private YangInstanceIdentifier iidList;
77 private MapNode buildList;
80 public void setUp() throws Exception {
82 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
84 final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
85 final QName containerQname = QName.create(baseQName, "player");
86 final QName leafQname = QName.create(baseQName, "gap");
87 final QName listQname = QName.create(baseQName, "playlist");
88 final QName listKeyQname = QName.create(baseQName, "name");
89 final NodeIdentifierWithPredicates nodeWithKey = NodeIdentifierWithPredicates.of(listQname, listKeyQname,
91 iid2 = YangInstanceIdentifier.builder()
94 iidList = YangInstanceIdentifier.builder()
99 final LeafNode<?> buildLeaf = Builders.leafBuilder()
100 .withNodeIdentifier(new NodeIdentifier(leafQname))
103 final ContainerNode buildPlayerCont = Builders.containerBuilder()
104 .withNodeIdentifier(new NodeIdentifier(containerQname))
105 .withChild(buildLeaf)
107 buildBaseCont = Builders.containerBuilder()
108 .withNodeIdentifier(new NodeIdentifier(baseQName))
109 .withChild(buildPlayerCont)
112 final LeafNode<Object> content = Builders.leafBuilder()
113 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
114 .withValue("name of band")
116 final LeafNode<Object> content2 = Builders.leafBuilder()
117 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
118 .withValue("band description")
120 final MapEntryNode mapEntryNode = Builders.mapEntryBuilder()
121 .withNodeIdentifier(nodeWithKey)
125 buildList = Builders.mapBuilder()
126 .withNodeIdentifier(new NodeIdentifier(listQname))
127 .withChild(mapEntryNode)
130 doReturn(UriBuilder.fromUri("http://localhost:8181/rests/")).when(uriInfo).getBaseUriBuilder();
131 doReturn(readWrite).when(mockDataBroker).newReadWriteTransaction();
133 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).lock();
134 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
138 public void testPostContainerData() {
139 final InstanceIdentifierContext iidContext = InstanceIdentifierContext.ofLocalPath(schema, iid2);
140 final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
142 doReturn(immediateFalseFluentFuture()).when(readWrite).exists(LogicalDatastoreType.CONFIGURATION, iid2);
143 final NodeIdentifier identifier =
144 ((ContainerNode) ((Collection<?>) payload.getData().body()).iterator().next()).getIdentifier();
145 final YangInstanceIdentifier node = iid2.node(identifier);
146 doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
147 doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
148 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
149 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
150 .create(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());
152 Response response = PostDataTransactionUtil.postData(uriInfo, payload,
153 new MdsalRestconfStrategy(mockDataBroker), schema, WriteDataParams.empty());
154 assertEquals(201, response.getStatus());
155 verify(readWrite).exists(LogicalDatastoreType.CONFIGURATION, iid2);
156 verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData());
158 response = PostDataTransactionUtil.postData(uriInfo, payload,
159 new NetconfRestconfStrategy(netconfService), schema, WriteDataParams.empty());
160 assertEquals(201, response.getStatus());
161 verify(netconfService).create(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());
165 public void testPostListData() {
166 final InstanceIdentifierContext iidContext = InstanceIdentifierContext.ofLocalPath(schema, iidList);
167 final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildList);
169 final MapNode data = (MapNode) payload.getData();
170 final MapEntryNode entryNode = data.body().iterator().next();
171 final NodeIdentifierWithPredicates identifier = entryNode.getIdentifier();
172 final YangInstanceIdentifier node = iidList.node(identifier);
173 doReturn(immediateFalseFluentFuture()).when(readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
174 doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
175 doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
176 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
177 .merge(any(), any(), any(), any());
178 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
179 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).create(
180 LogicalDatastoreType.CONFIGURATION, node, entryNode, Optional.empty());
182 Response response = PostDataTransactionUtil.postData(uriInfo, payload,
183 new MdsalRestconfStrategy(mockDataBroker), schema, WriteDataParams.empty());
184 assertEquals(201, response.getStatus());
185 assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
186 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
187 verify(readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
188 verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
190 response = PostDataTransactionUtil.postData(uriInfo, payload,
191 new NetconfRestconfStrategy(netconfService), schema, WriteDataParams.empty());
192 assertEquals(201, response.getStatus());
193 assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
194 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
195 verify(netconfService).create(LogicalDatastoreType.CONFIGURATION, node, entryNode,
200 public void testPostDataFail() {
201 final InstanceIdentifierContext iidContext = InstanceIdentifierContext.ofLocalPath(schema, iid2);
202 final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
204 doReturn(immediateFalseFluentFuture()).when(readWrite).exists(LogicalDatastoreType.CONFIGURATION,
206 final NodeIdentifier identifier =
207 ((ContainerNode) ((Collection<?>) payload.getData().body()).iterator().next()).getIdentifier();
208 final YangInstanceIdentifier node = iid2.node(identifier);
209 doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
210 final DOMException domException = new DOMException((short) 414, "Post request failed");
211 doReturn(immediateFailedFluentFuture(domException)).when(readWrite).commit();
212 doReturn(immediateFailedFluentFuture(domException)).when(netconfService)
213 .create(any(), any(), any(), any());
214 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).discardChanges();
215 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
217 RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
218 () -> PostDataTransactionUtil.postData(uriInfo, payload, new MdsalRestconfStrategy(mockDataBroker), schema,
219 WriteDataParams.empty()));
220 assertEquals(1, ex.getErrors().size());
221 assertThat(ex.getErrors().get(0).getErrorInfo(), containsString(domException.getMessage()));
223 verify(readWrite).exists(LogicalDatastoreType.CONFIGURATION, iid2);
224 verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData());
226 ex = assertThrows(RestconfDocumentedException.class, () -> PostDataTransactionUtil.postData(uriInfo, payload,
227 new NetconfRestconfStrategy(netconfService), schema, WriteDataParams.empty()));
228 assertEquals(1, ex.getErrors().size());
229 assertThat(ex.getErrors().get(0).getErrorInfo(), containsString(domException.getMessage()));
231 verify(netconfService).create(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());