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.mockito.Mockito.doNothing;
11 import static org.mockito.Mockito.doReturn;
12 import static org.mockito.Mockito.mock;
13 import static org.mockito.Mockito.verify;
14 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
15 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
17 import com.google.common.util.concurrent.Futures;
18 import java.util.Optional;
19 import org.junit.Before;
20 import org.junit.Test;
21 import org.junit.runner.RunWith;
22 import org.mockito.Mock;
23 import org.mockito.Mockito;
24 import org.mockito.junit.MockitoJUnitRunner;
25 import org.opendaylight.mdsal.common.api.CommitInfo;
26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
27 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
30 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
31 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
32 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
33 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
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.rests.transactions.MdsalRestconfStrategy;
40 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
41 import org.opendaylight.yangtools.yang.common.QName;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
45 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
48 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
49 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
50 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
51 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
52 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
53 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
54 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
56 @RunWith(MockitoJUnitRunner.StrictStubs.class)
57 public class PutDataTransactionUtilTest {
58 private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
60 private DOMTransactionChain transactionChain;
62 private DOMDataTreeReadWriteTransaction readWrite;
64 private DOMDataTreeReadTransaction read;
66 private DOMDataTreeWriteTransaction write;
68 private DOMDataBroker mockDataBroker;
70 private NetconfDataTreeService netconfService;
72 private TransactionChainHandler transactionChainHandler;
73 private LeafNode<?> buildLeaf;
74 private ContainerNode buildBaseCont;
75 private ContainerNode buildBaseContWithList;
76 private MapEntryNode buildListEntry;
77 private EffectiveModelContext schema;
78 private DataSchemaNode schemaNode;
79 private YangInstanceIdentifier iid;
80 private DataSchemaNode schemaNode2;
81 private YangInstanceIdentifier iid2;
82 private DataSchemaNode schemaNode3;
83 private YangInstanceIdentifier iid3;
86 public void setUp() throws Exception {
88 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
90 final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
91 final QName containerQname = QName.create(baseQName, "player");
92 final QName leafQname = QName.create(baseQName, "gap");
93 final QName listQname = QName.create(baseQName, "playlist");
94 final QName listKeyQname = QName.create(baseQName, "name");
96 final NodeIdentifierWithPredicates nodeWithKey =
97 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band");
98 final NodeIdentifierWithPredicates nodeWithKey2 =
99 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band 2");
101 final DataSchemaContextTree tree = DataSchemaContextTree.from(this.schema);
102 this.iid = YangInstanceIdentifier.builder()
104 .node(containerQname)
107 this.schemaNode = tree.findChild(this.iid).orElseThrow().getDataSchemaNode();
109 this.iid2 = YangInstanceIdentifier.builder()
112 this.schemaNode2 = tree.findChild(this.iid2).orElseThrow().getDataSchemaNode();
114 this.iid3 = YangInstanceIdentifier.builder()
119 this.schemaNode3 = tree.findChild(this.iid3).orElseThrow().getDataSchemaNode();
121 this.buildLeaf = Builders.leafBuilder()
122 .withNodeIdentifier(new NodeIdentifier(leafQname))
125 final ContainerNode buildPlayerCont = Builders.containerBuilder()
126 .withNodeIdentifier(new NodeIdentifier(containerQname))
127 .withChild(this.buildLeaf)
129 this.buildBaseCont = Builders.containerBuilder()
130 .withNodeIdentifier(new NodeIdentifier(baseQName))
131 .withChild(buildPlayerCont)
133 final LeafNode<Object> content = Builders.leafBuilder()
134 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
135 .withValue("name of band")
137 final LeafNode<Object> content2 = Builders.leafBuilder()
138 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
139 .withValue("band description")
141 this.buildListEntry = Builders.mapEntryBuilder()
142 .withNodeIdentifier(nodeWithKey)
146 final LeafNode<Object> content3 = Builders.leafBuilder()
147 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
148 .withValue("name of band 2")
150 final LeafNode<Object> content4 = Builders.leafBuilder()
151 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
152 .withValue("band description 2")
154 final MapEntryNode buildListEntry2 = Builders.mapEntryBuilder()
155 .withNodeIdentifier(nodeWithKey2)
159 final MapNode buildList = Builders.mapBuilder()
160 .withNodeIdentifier(new NodeIdentifier(listQname))
161 .withChild(this.buildListEntry)
162 .withChild(buildListEntry2)
164 this.buildBaseContWithList = Builders.containerBuilder()
165 .withNodeIdentifier(new NodeIdentifier(baseQName))
166 .withChild(buildList)
169 Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
170 transactionChainHandler = new TransactionChainHandler(mockDataBroker);
171 Mockito.doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).lock();
172 Mockito.doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).unlock();
176 public void testValidInputData() {
177 final InstanceIdentifierContext<DataSchemaNode> iidContext =
178 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
179 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
180 PutDataTransactionUtil.validInputData(iidContext.getSchemaNode(), payload);
184 public void testValidTopLevelNodeName() {
185 InstanceIdentifierContext<DataSchemaNode> iidContext =
186 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
187 NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
188 PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
190 iidContext = new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
191 payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
192 PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
195 @Test(expected = RestconfDocumentedException.class)
196 public void testValidTopLevelNodeNamePathEmpty() {
197 final InstanceIdentifierContext<DataSchemaNode> iidContext =
198 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
199 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
200 PutDataTransactionUtil.validTopLevelNodeName(YangInstanceIdentifier.empty(), payload);
203 @Test(expected = RestconfDocumentedException.class)
204 public void testValidTopLevelNodeNameWrongTopIdentifier() {
205 final InstanceIdentifierContext<DataSchemaNode> iidContext =
206 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
207 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
208 PutDataTransactionUtil.validTopLevelNodeName(this.iid.getAncestor(1), payload);
212 public void testValidateListKeysEqualityInPayloadAndUri() {
213 final InstanceIdentifierContext<DataSchemaNode> iidContext =
214 new InstanceIdentifierContext<>(this.iid3, this.schemaNode3, null, this.schema);
215 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildListEntry);
216 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
220 public void testPutContainerData() {
221 final InstanceIdentifierContext<DataSchemaNode> iidContext =
222 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
223 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
225 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
226 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
227 doReturn(immediateFalseFluentFuture())
228 .when(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
229 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
230 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
231 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
233 PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
235 verify(this.read).exists(LogicalDatastoreType.CONFIGURATION,
236 payload.getInstanceIdentifierContext().getInstanceIdentifier());
237 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
238 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
242 public void testPutCreateContainerData() {
243 final InstanceIdentifierContext<DataSchemaNode> iidContext =
244 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
245 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
247 doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid2);
248 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
249 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
250 .replace(LogicalDatastoreType.CONFIGURATION, payload.getInstanceIdentifierContext().getInstanceIdentifier(),
251 payload.getData(), Optional.empty());
253 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
255 verify(this.netconfService).lock();
256 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
257 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
258 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
262 public void testPutReplaceContainerData() {
263 final InstanceIdentifierContext<DataSchemaNode> iidContext =
264 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
265 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
267 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
268 .when(this.netconfService).getConfig(this.iid2);
269 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
270 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
271 .replace(LogicalDatastoreType.CONFIGURATION,
272 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
274 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
276 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
277 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
278 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
282 public void testPutLeafData() {
283 final InstanceIdentifierContext<DataSchemaNode> iidContext =
284 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
285 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
287 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
288 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
289 doReturn(immediateFalseFluentFuture())
290 .when(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid);
291 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
292 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
293 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
295 PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
297 verify(this.read).exists(LogicalDatastoreType.CONFIGURATION,
298 payload.getInstanceIdentifierContext().getInstanceIdentifier());
299 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
300 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
304 public void testPutCreateLeafData() {
305 final InstanceIdentifierContext<DataSchemaNode> iidContext =
306 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
307 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
309 doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid);
310 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
311 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
312 .replace(LogicalDatastoreType.CONFIGURATION,
313 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
315 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
317 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
318 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
319 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
323 public void testPutReplaceLeafData() {
324 final InstanceIdentifierContext<DataSchemaNode> iidContext =
325 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
326 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
328 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
329 .when(this.netconfService).getConfig(this.iid);
330 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
331 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
332 .replace(LogicalDatastoreType.CONFIGURATION,
333 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
335 PutDataTransactionUtil.putData(payload, this.schema,
336 new NetconfRestconfStrategy(netconfService), null, null);
337 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
338 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
339 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
343 public void testPutListData() {
344 final InstanceIdentifierContext<DataSchemaNode> iidContext =
345 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
346 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
348 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
349 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
350 doReturn(immediateFalseFluentFuture())
351 .when(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
352 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
353 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
354 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
355 PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
357 verify(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
358 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, this.iid2, payload.getData());
362 public void testPutCreateListData() {
363 final InstanceIdentifierContext<DataSchemaNode> iidContext =
364 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
365 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
367 doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService)
368 .getConfig(this.iid2);
369 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
370 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
371 .replace(LogicalDatastoreType.CONFIGURATION, this.iid2, payload.getData(), Optional.empty());
373 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
375 verify(this.netconfService).getConfig(this.iid2);
376 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION, this.iid2,
377 payload.getData(), Optional.empty());
381 public void testPutReplaceListData() {
382 final InstanceIdentifierContext<DataSchemaNode> iidContext =
383 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
384 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
386 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class)))).when(this.netconfService)
387 .getConfig(this.iid2);
388 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService).commit();
389 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(this.netconfService)
390 .replace(LogicalDatastoreType.CONFIGURATION,
391 this.iid2, payload.getData(), Optional.empty());
393 PutDataTransactionUtil.putData(payload, this.schema,
394 new NetconfRestconfStrategy(netconfService), null, null);
395 verify(this.netconfService).getConfig(this.iid2);
396 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION, this.iid2,
397 payload.getData(), Optional.empty());