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.assertTrue;
14 import static org.junit.Assert.fail;
15 import static org.mockito.ArgumentMatchers.any;
16 import static org.mockito.Mockito.doNothing;
17 import static org.mockito.Mockito.doReturn;
18 import static org.mockito.Mockito.verify;
19 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
20 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
22 import com.google.common.util.concurrent.Futures;
23 import java.net.URLDecoder;
24 import java.nio.charset.StandardCharsets;
25 import java.util.Collection;
26 import java.util.Optional;
27 import javax.ws.rs.core.Response;
28 import javax.ws.rs.core.UriBuilder;
29 import javax.ws.rs.core.UriInfo;
30 import org.junit.Before;
31 import org.junit.Test;
32 import org.junit.runner.RunWith;
33 import org.mockito.Mock;
34 import org.mockito.junit.MockitoJUnitRunner;
35 import org.opendaylight.mdsal.common.api.CommitInfo;
36 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
37 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
38 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
39 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
40 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
41 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
42 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
43 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
44 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
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;
61 @RunWith(MockitoJUnitRunner.StrictStubs.class)
62 public class PostDataTransactionUtilTest {
63 private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
66 private DOMDataTreeReadWriteTransaction readWrite;
68 private UriInfo uriInfo;
70 private DOMDataBroker mockDataBroker;
72 private NetconfDataTreeService netconfService;
74 private ContainerNode buildBaseCont;
75 private EffectiveModelContext schema;
76 private YangInstanceIdentifier iid2;
77 private YangInstanceIdentifier iidList;
78 private MapNode buildList;
81 public void setUp() throws Exception {
83 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
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,
92 this.iid2 = YangInstanceIdentifier.builder()
95 this.iidList = YangInstanceIdentifier.builder()
100 final LeafNode<?> buildLeaf = Builders.leafBuilder()
101 .withNodeIdentifier(new NodeIdentifier(leafQname))
104 final ContainerNode buildPlayerCont = Builders.containerBuilder()
105 .withNodeIdentifier(new NodeIdentifier(containerQname))
106 .withChild(buildLeaf)
108 this.buildBaseCont = Builders.containerBuilder()
109 .withNodeIdentifier(new NodeIdentifier(baseQName))
110 .withChild(buildPlayerCont)
113 final LeafNode<Object> content = Builders.leafBuilder()
114 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
115 .withValue("name of band")
117 final LeafNode<Object> content2 = Builders.leafBuilder()
118 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
119 .withValue("band description")
121 final MapEntryNode mapEntryNode = Builders.mapEntryBuilder()
122 .withNodeIdentifier(nodeWithKey)
126 this.buildList = Builders.mapBuilder()
127 .withNodeIdentifier(new NodeIdentifier(listQname))
128 .withChild(mapEntryNode)
131 doReturn(UriBuilder.fromUri("http://localhost:8181/restconf/16/")).when(this.uriInfo).getBaseUriBuilder();
132 doReturn(this.readWrite).when(this.mockDataBroker).newReadWriteTransaction();
134 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).lock();
135 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).unlock();
139 public void testPostContainerData() {
140 final InstanceIdentifierContext<? extends SchemaNode> iidContext =
141 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
142 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
144 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
146 final NodeIdentifier identifier =
147 ((ContainerNode) ((Collection<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
148 final YangInstanceIdentifier node =
149 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
150 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
151 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
152 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
153 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
154 .create(LogicalDatastoreType.CONFIGURATION, payload.getInstanceIdentifierContext().getInstanceIdentifier(),
155 payload.getData(), Optional.empty());
157 Response response = PostDataTransactionUtil.postData(this.uriInfo, payload,
158 new MdsalRestconfStrategy(mockDataBroker), this.schema, null, null);
159 assertEquals(201, response.getStatus());
160 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
161 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
162 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
164 response = PostDataTransactionUtil.postData(this.uriInfo, payload,
165 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
166 assertEquals(201, response.getStatus());
167 verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
168 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
172 public void testPostListData() {
173 final InstanceIdentifierContext<? extends SchemaNode> iidContext =
174 new InstanceIdentifierContext<>(this.iidList, null, null, this.schema);
175 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildList);
177 final MapNode data = (MapNode) payload.getData();
178 final MapEntryNode entryNode = data.getValue().iterator().next();
179 final NodeIdentifierWithPredicates identifier = entryNode.getIdentifier();
180 final YangInstanceIdentifier node =
181 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
182 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
183 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
184 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
185 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
186 .merge(any(), any(), any(), any());
187 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
188 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).create(
189 LogicalDatastoreType.CONFIGURATION, node, entryNode, Optional.empty());
191 Response response = PostDataTransactionUtil.postData(this.uriInfo, payload,
192 new MdsalRestconfStrategy(mockDataBroker), this.schema, null, null);
193 assertEquals(201, response.getStatus());
194 assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
195 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
196 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
197 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
199 response = PostDataTransactionUtil.postData(this.uriInfo, payload,
200 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
201 assertEquals(201, response.getStatus());
202 assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
203 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
204 verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION, node, entryNode,
209 public void testPostDataFail() {
210 final InstanceIdentifierContext<? extends SchemaNode> iidContext =
211 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
212 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
214 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
216 final NodeIdentifier identifier =
217 ((ContainerNode) ((Collection<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
218 final YangInstanceIdentifier node =
219 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
220 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
221 final DOMException domException = new DOMException((short) 414, "Post request failed");
222 doReturn(immediateFailedFluentFuture(domException)).when(this.readWrite).commit();
223 doReturn(immediateFailedFluentFuture(domException)).when(this.netconfService)
224 .create(any(), any(), any(), any());
225 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).discardChanges();
226 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).unlock();
229 PostDataTransactionUtil.postData(this.uriInfo, payload,
230 new MdsalRestconfStrategy(mockDataBroker), this.schema, null, null);
231 fail("Expected RestconfDocumentedException");
232 } catch (final RestconfDocumentedException e) {
233 assertEquals(1, e.getErrors().size());
234 assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
237 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
238 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
239 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
242 PostDataTransactionUtil.postData(this.uriInfo, payload,
243 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
244 fail("Expected RestconfDocumentedException");
245 } catch (final RestconfDocumentedException e) {
246 assertEquals(1, e.getErrors().size());
247 assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
250 verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
251 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());