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 java.util.Optional;
18 import org.junit.Before;
19 import org.junit.Test;
20 import org.junit.runner.RunWith;
21 import org.mockito.Mock;
22 import org.mockito.Mockito;
23 import org.mockito.junit.MockitoJUnitRunner;
24 import org.opendaylight.mdsal.common.api.CommitInfo;
25 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
26 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
27 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
28 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
29 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
30 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
31 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
32 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
33 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
34 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
35 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
36 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
37 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
38 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
39 import org.opendaylight.yangtools.yang.common.QName;
40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
43 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
44 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
45 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
46 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
47 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
48 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
49 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
50 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
52 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
54 @RunWith(MockitoJUnitRunner.StrictStubs.class)
55 public class PutDataTransactionUtilTest {
56 private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
58 private DOMTransactionChain transactionChain;
60 private DOMDataTreeReadWriteTransaction readWrite;
62 private DOMDataTreeReadTransaction read;
64 private DOMDataTreeWriteTransaction write;
66 private DOMDataBroker mockDataBroker;
68 private NetconfDataTreeService netconfService;
70 private TransactionChainHandler transactionChainHandler;
71 private LeafNode<?> buildLeaf;
72 private ContainerNode buildBaseCont;
73 private ContainerNode buildBaseContWithList;
74 private MapEntryNode buildListEntry;
75 private EffectiveModelContext schema;
76 private DataSchemaNode schemaNode;
77 private YangInstanceIdentifier iid;
78 private DataSchemaNode schemaNode2;
79 private YangInstanceIdentifier iid2;
80 private DataSchemaNode schemaNode3;
81 private YangInstanceIdentifier iid3;
84 public void setUp() throws Exception {
86 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
88 final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
89 final QName containerQname = QName.create(baseQName, "player");
90 final QName leafQname = QName.create(baseQName, "gap");
91 final QName listQname = QName.create(baseQName, "playlist");
92 final QName listKeyQname = QName.create(baseQName, "name");
94 final NodeIdentifierWithPredicates nodeWithKey =
95 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band");
96 final NodeIdentifierWithPredicates nodeWithKey2 =
97 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band 2");
99 final DataSchemaContextTree tree = DataSchemaContextTree.from(this.schema);
100 this.iid = YangInstanceIdentifier.builder()
102 .node(containerQname)
105 this.schemaNode = tree.findChild(this.iid).orElseThrow().getDataSchemaNode();
107 this.iid2 = YangInstanceIdentifier.builder()
110 this.schemaNode2 = tree.findChild(this.iid2).orElseThrow().getDataSchemaNode();
112 this.iid3 = YangInstanceIdentifier.builder()
117 this.schemaNode3 = tree.findChild(this.iid3).orElseThrow().getDataSchemaNode();
119 this.buildLeaf = Builders.leafBuilder()
120 .withNodeIdentifier(new NodeIdentifier(leafQname))
123 final ContainerNode buildPlayerCont = Builders.containerBuilder()
124 .withNodeIdentifier(new NodeIdentifier(containerQname))
125 .withChild(this.buildLeaf)
127 this.buildBaseCont = Builders.containerBuilder()
128 .withNodeIdentifier(new NodeIdentifier(baseQName))
129 .withChild(buildPlayerCont)
131 final LeafNode<Object> content = Builders.leafBuilder()
132 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
133 .withValue("name of band")
135 final LeafNode<Object> content2 = Builders.leafBuilder()
136 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
137 .withValue("band description")
139 this.buildListEntry = Builders.mapEntryBuilder()
140 .withNodeIdentifier(nodeWithKey)
144 final LeafNode<Object> content3 = Builders.leafBuilder()
145 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
146 .withValue("name of band 2")
148 final LeafNode<Object> content4 = Builders.leafBuilder()
149 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
150 .withValue("band description 2")
152 final MapEntryNode buildListEntry2 = Builders.mapEntryBuilder()
153 .withNodeIdentifier(nodeWithKey2)
157 final MapNode buildList = Builders.mapBuilder()
158 .withNodeIdentifier(new NodeIdentifier(listQname))
159 .withChild(this.buildListEntry)
160 .withChild(buildListEntry2)
162 this.buildBaseContWithList = Builders.containerBuilder()
163 .withNodeIdentifier(new NodeIdentifier(baseQName))
164 .withChild(buildList)
167 Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
168 transactionChainHandler = new TransactionChainHandler(mockDataBroker);
172 public void testValidInputData() {
173 final InstanceIdentifierContext<DataSchemaNode> iidContext =
174 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
175 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
176 PutDataTransactionUtil.validInputData(iidContext.getSchemaNode(), payload);
180 public void testValidTopLevelNodeName() {
181 InstanceIdentifierContext<DataSchemaNode> iidContext =
182 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
183 NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
184 PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
186 iidContext = new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
187 payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
188 PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
191 @Test(expected = RestconfDocumentedException.class)
192 public void testValidTopLevelNodeNamePathEmpty() {
193 final InstanceIdentifierContext<DataSchemaNode> iidContext =
194 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
195 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
196 PutDataTransactionUtil.validTopLevelNodeName(YangInstanceIdentifier.empty(), payload);
199 @Test(expected = RestconfDocumentedException.class)
200 public void testValidTopLevelNodeNameWrongTopIdentifier() {
201 final InstanceIdentifierContext<DataSchemaNode> iidContext =
202 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
203 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
204 PutDataTransactionUtil.validTopLevelNodeName(this.iid.getAncestor(1), payload);
208 public void testValidateListKeysEqualityInPayloadAndUri() {
209 final InstanceIdentifierContext<DataSchemaNode> iidContext =
210 new InstanceIdentifierContext<>(this.iid3, this.schemaNode3, null, this.schema);
211 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildListEntry);
212 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
216 public void testPutContainerData() {
217 final InstanceIdentifierContext<DataSchemaNode> iidContext =
218 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
219 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
221 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
222 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
223 doReturn(immediateFalseFluentFuture())
224 .when(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
225 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
226 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
227 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
229 PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
231 verify(this.read).exists(LogicalDatastoreType.CONFIGURATION,
232 payload.getInstanceIdentifierContext().getInstanceIdentifier());
233 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
234 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
238 public void testPutCreateContainerData() {
239 final InstanceIdentifierContext<DataSchemaNode> iidContext =
240 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
241 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
243 doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid2);
244 doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
246 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
248 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
249 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
250 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
254 public void testPutReplaceContainerData() {
255 final InstanceIdentifierContext<DataSchemaNode> iidContext =
256 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
257 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
259 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
260 .when(this.netconfService).getConfig(this.iid2);
261 doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
263 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
265 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
266 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
267 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
271 public void testPutLeafData() {
272 final InstanceIdentifierContext<DataSchemaNode> iidContext =
273 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
274 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
276 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
277 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
278 doReturn(immediateFalseFluentFuture())
279 .when(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid);
280 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
281 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
282 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
284 PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
286 verify(this.read).exists(LogicalDatastoreType.CONFIGURATION,
287 payload.getInstanceIdentifierContext().getInstanceIdentifier());
288 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
289 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
293 public void testPutCreateLeafData() {
294 final InstanceIdentifierContext<DataSchemaNode> iidContext =
295 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
296 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
298 doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid);
299 doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
301 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
303 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
304 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
305 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
309 public void testPutReplaceLeafData() {
310 final InstanceIdentifierContext<DataSchemaNode> iidContext =
311 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
312 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
314 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
315 .when(this.netconfService).getConfig(this.iid);
316 doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
318 PutDataTransactionUtil.putData(payload, this.schema,
319 new NetconfRestconfStrategy(netconfService), null, null);
320 verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
321 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
322 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
326 public void testPutListData() {
327 final InstanceIdentifierContext<DataSchemaNode> iidContext =
328 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
329 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
331 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
332 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
333 doReturn(immediateFalseFluentFuture())
334 .when(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
335 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
336 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
337 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
338 PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
340 verify(this.read).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
341 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, this.iid2, payload.getData());
345 public void testPutCreateListData() {
346 final InstanceIdentifierContext<DataSchemaNode> iidContext =
347 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
348 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
350 doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService)
351 .getConfig(this.iid2);
352 doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
354 PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
356 verify(this.netconfService).getConfig(this.iid2);
357 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION, this.iid2,
358 payload.getData(), Optional.empty());
362 public void testPutReplaceListData() {
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.of(mock(NormalizedNode.class)))).when(this.netconfService)
368 .getConfig(this.iid2);
369 doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
371 PutDataTransactionUtil.putData(payload, this.schema,
372 new NetconfRestconfStrategy(netconfService), null, null);
373 verify(this.netconfService).getConfig(this.iid2);
374 verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION, this.iid2,
375 payload.getData(), Optional.empty());