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.junit.Assert.assertEquals;
11 import static org.junit.Assert.assertTrue;
12 import static org.junit.Assert.fail;
13 import static org.mockito.Mockito.doNothing;
14 import static org.mockito.Mockito.doReturn;
15 import static org.mockito.Mockito.verify;
16 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
17 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
19 import javax.ws.rs.core.Response;
20 import javax.ws.rs.core.UriBuilder;
21 import javax.ws.rs.core.UriInfo;
22 import org.junit.Before;
23 import org.junit.Test;
24 import org.mockito.Mock;
25 import org.mockito.Mockito;
26 import org.mockito.MockitoAnnotations;
27 import org.opendaylight.mdsal.common.api.CommitInfo;
28 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
29 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
30 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
31 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
32 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
33 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
34 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
35 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
36 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
37 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
38 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
39 import org.opendaylight.restconf.nb.rfc8040.references.SchemaContextRef;
40 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.TransactionVarsWrapper;
41 import org.opendaylight.yangtools.util.SingletonSet;
42 import org.opendaylight.yangtools.yang.common.QName;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
44 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
48 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
50 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
51 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
52 import org.w3c.dom.DOMException;
54 public class PostDataTransactionUtilTest {
56 private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
59 private DOMTransactionChain transactionChain;
61 private DOMDataTreeReadWriteTransaction readWrite;
63 private DOMDataTreeReadTransaction read;
65 private DOMDataTreeWriteTransaction write;
67 private UriInfo uriInfo;
69 private UriBuilder uriBuilder;
71 private DOMDataBroker mockDataBroker;
73 private TransactionChainHandler transactionChainHandler;
74 private SchemaContextRef refSchemaCtx;
75 private ContainerNode buildBaseCont;
76 private SchemaContext schema;
77 private YangInstanceIdentifier iid2;
78 private MapNode buildList;
81 public void setUp() throws Exception {
82 MockitoAnnotations.initMocks(this);
83 this.refSchemaCtx = new SchemaContextRef(
84 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT)));
85 this.schema = this.refSchemaCtx.get();
87 final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
88 final QName containerQname = QName.create(baseQName, "player");
89 final QName leafQname = QName.create(baseQName, "gap");
90 final QName listQname = QName.create(baseQName, "playlist");
91 final QName listKeyQname = QName.create(baseQName, "name");
92 final YangInstanceIdentifier.NodeIdentifierWithPredicates nodeWithKey =
93 new YangInstanceIdentifier.NodeIdentifierWithPredicates(listQname, listKeyQname, "name of band");
94 this.iid2 = YangInstanceIdentifier.builder()
98 final LeafNode<?> buildLeaf = Builders.leafBuilder()
99 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(leafQname))
102 final ContainerNode buildPlayerCont = Builders.containerBuilder()
103 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(containerQname))
104 .withChild(buildLeaf)
106 this.buildBaseCont = Builders.containerBuilder()
107 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(baseQName))
108 .withChild(buildPlayerCont)
111 final LeafNode<Object> content = Builders.leafBuilder()
112 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create(baseQName, "name")))
113 .withValue("name of band")
115 final LeafNode<Object> content2 = Builders.leafBuilder()
116 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(QName.create(baseQName, "description")))
117 .withValue("band description")
119 final MapEntryNode mapEntryNode = Builders.mapEntryBuilder()
120 .withNodeIdentifier(nodeWithKey)
124 this.buildList = Builders.mapBuilder()
125 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(listQname))
126 .withChild(mapEntryNode)
129 doReturn(UriBuilder.fromUri("http://localhost:8181/restconf/16/")).when(this.uriInfo).getBaseUriBuilder();
130 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
131 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
133 Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
134 transactionChainHandler = new TransactionChainHandler(mockDataBroker);
138 public void testPostContainerData() {
139 final InstanceIdentifierContext<? extends SchemaNode> iidContext =
140 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
141 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
143 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
145 final YangInstanceIdentifier.NodeIdentifier identifier =
146 ((ContainerNode) ((SingletonSet<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
147 final YangInstanceIdentifier node =
148 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
149 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
150 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, payload.getData());
151 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
152 final TransactionVarsWrapper wrapper =
153 new TransactionVarsWrapper(payload.getInstanceIdentifierContext(), null, transactionChainHandler);
154 final Response response =
155 PostDataTransactionUtil.postData(this.uriInfo, payload, wrapper, this.refSchemaCtx, null, null);
156 assertEquals(201, response.getStatus());
157 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
158 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
159 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
163 public void testPostListData() {
164 final InstanceIdentifierContext<? extends SchemaNode> iidContext =
165 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
166 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildList);
168 final MapNode data = (MapNode) payload.getData();
169 final YangInstanceIdentifier.NodeIdentifierWithPredicates identifier =
170 data.getValue().iterator().next().getIdentifier();
171 final YangInstanceIdentifier node =
172 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
173 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
174 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, payload.getData());
175 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
176 final TransactionVarsWrapper wrapper =
177 new TransactionVarsWrapper(payload.getInstanceIdentifierContext(), null, transactionChainHandler);
178 final Response response =
179 PostDataTransactionUtil.postData(this.uriInfo, payload, wrapper, this.refSchemaCtx, null, null);
180 assertEquals(201, response.getStatus());
181 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
182 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, data.getValue().iterator().next());
186 public void testPostDataFail() {
187 final InstanceIdentifierContext<? extends SchemaNode> iidContext =
188 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
189 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
191 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
193 final YangInstanceIdentifier.NodeIdentifier identifier =
194 ((ContainerNode) ((SingletonSet<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
195 final YangInstanceIdentifier node =
196 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
197 doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
198 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, payload.getData());
199 final DOMException domException = new DOMException((short) 414, "Post request failed");
200 doReturn(immediateFailedFluentFuture(domException)).when(this.readWrite).commit();
201 final TransactionVarsWrapper wrapper =
202 new TransactionVarsWrapper(payload.getInstanceIdentifierContext(), null, transactionChainHandler);
205 PostDataTransactionUtil.postData(this.uriInfo, payload, wrapper, this.refSchemaCtx, null, null);
206 fail("Expected RestconfDocumentedException");
207 } catch (final RestconfDocumentedException e) {
208 assertEquals(1, e.getErrors().size());
209 assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
212 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
213 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
214 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());