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.verify;
13 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
15 import org.junit.Before;
16 import org.junit.Test;
17 import org.mockito.Mock;
18 import org.mockito.Mockito;
19 import org.mockito.MockitoAnnotations;
20 import org.opendaylight.mdsal.common.api.CommitInfo;
21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
22 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
23 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
24 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
25 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
26 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
27 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
28 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
29 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
30 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
31 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
32 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.TransactionVarsWrapper;
33 import org.opendaylight.yangtools.yang.common.QName;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
36 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
41 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
42 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
43 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
44 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
45 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
47 public class PutDataTransactionUtilTest {
49 private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
52 private DOMTransactionChain transactionChain;
54 private DOMDataTreeReadWriteTransaction readWrite;
56 private DOMDataTreeReadTransaction read;
58 private DOMDataTreeWriteTransaction write;
60 private DOMDataBroker mockDataBroker;
62 private TransactionChainHandler transactionChainHandler;
63 private LeafNode buildLeaf;
64 private ContainerNode buildBaseCont;
65 private ContainerNode buildBaseContWithList;
66 private MapEntryNode buildListEntry;
67 private EffectiveModelContext schema;
68 private DataSchemaNode schemaNode;
69 private YangInstanceIdentifier iid;
70 private DataSchemaNode schemaNode2;
71 private YangInstanceIdentifier iid2;
72 private DataSchemaNode schemaNode3;
73 private YangInstanceIdentifier iid3;
76 public void setUp() throws Exception {
77 MockitoAnnotations.initMocks(this);
79 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
81 final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
82 final QName containerQname = QName.create(baseQName, "player");
83 final QName leafQname = QName.create(baseQName, "gap");
84 final QName listQname = QName.create(baseQName, "playlist");
85 final QName listKeyQname = QName.create(baseQName, "name");
87 final NodeIdentifierWithPredicates nodeWithKey =
88 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band");
89 final NodeIdentifierWithPredicates nodeWithKey2 =
90 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band 2");
92 this.iid = YangInstanceIdentifier.builder()
97 this.schemaNode = DataSchemaContextTree.from(this.schema).getChild(this.iid).getDataSchemaNode();
99 this.iid2 = YangInstanceIdentifier.builder()
102 this.schemaNode2 = DataSchemaContextTree.from(this.schema).getChild(this.iid2).getDataSchemaNode();
104 this.iid3 = YangInstanceIdentifier.builder()
109 this.schemaNode3 = DataSchemaContextTree.from(this.schema).getChild(this.iid3).getDataSchemaNode();
111 this.buildLeaf = Builders.leafBuilder()
112 .withNodeIdentifier(new NodeIdentifier(leafQname))
115 final ContainerNode buildPlayerCont = Builders.containerBuilder()
116 .withNodeIdentifier(new NodeIdentifier(containerQname))
117 .withChild(this.buildLeaf)
119 this.buildBaseCont = Builders.containerBuilder()
120 .withNodeIdentifier(new NodeIdentifier(baseQName))
121 .withChild(buildPlayerCont)
123 final LeafNode<Object> content = Builders.leafBuilder()
124 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
125 .withValue("name of band")
127 final LeafNode<Object> content2 = Builders.leafBuilder()
128 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
129 .withValue("band description")
131 this.buildListEntry = Builders.mapEntryBuilder()
132 .withNodeIdentifier(nodeWithKey)
136 final LeafNode<Object> content3 = Builders.leafBuilder()
137 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
138 .withValue("name of band 2")
140 final LeafNode<Object> content4 = Builders.leafBuilder()
141 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
142 .withValue("band description 2")
144 final MapEntryNode buildListEntry2 = Builders.mapEntryBuilder()
145 .withNodeIdentifier(nodeWithKey2)
149 final MapNode buildList = Builders.mapBuilder()
150 .withNodeIdentifier(new NodeIdentifier(listQname))
151 .withChild(this.buildListEntry)
152 .withChild(buildListEntry2)
154 this.buildBaseContWithList = Builders.containerBuilder()
155 .withNodeIdentifier(new NodeIdentifier(baseQName))
156 .withChild(buildList)
159 Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
160 transactionChainHandler = new TransactionChainHandler(mockDataBroker);
164 public void testValidInputData() throws Exception {
165 final InstanceIdentifierContext<DataSchemaNode> iidContext =
166 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
167 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
168 PutDataTransactionUtil.validInputData(iidContext.getSchemaNode(), payload);
172 public void testValidTopLevelNodeName() throws Exception {
173 InstanceIdentifierContext<DataSchemaNode> iidContext =
174 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
175 NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
176 PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
178 iidContext = new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
179 payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
180 PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
183 @Test(expected = RestconfDocumentedException.class)
184 public void testValidTopLevelNodeNamePathEmpty() throws Exception {
185 final InstanceIdentifierContext<DataSchemaNode> iidContext =
186 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
187 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
188 PutDataTransactionUtil.validTopLevelNodeName(YangInstanceIdentifier.empty(), payload);
191 @Test(expected = RestconfDocumentedException.class)
192 public void testValidTopLevelNodeNameWrongTopIdentifier() throws Exception {
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(this.iid.getAncestor(1), payload);
200 public void testValidateListKeysEqualityInPayloadAndUri() throws Exception {
201 final InstanceIdentifierContext<DataSchemaNode> iidContext =
202 new InstanceIdentifierContext<>(this.iid3, this.schemaNode3, null, this.schema);
203 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildListEntry);
204 PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
208 public void testPutContainerData() throws Exception {
209 final InstanceIdentifierContext<DataSchemaNode> iidContext =
210 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
211 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
213 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
214 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
215 doReturn(this.write).when(this.transactionChain).newWriteOnlyTransaction();
216 doReturn(immediateFalseFluentFuture())
217 .when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
218 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
219 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
220 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
222 PutDataTransactionUtil.putData(payload, this.schema,
223 new TransactionVarsWrapper(payload.getInstanceIdentifierContext(), null, transactionChainHandler), null,
225 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
226 payload.getInstanceIdentifierContext().getInstanceIdentifier());
227 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
228 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
232 public void testPutleafData() throws Exception {
233 final InstanceIdentifierContext<DataSchemaNode> iidContext =
234 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
235 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
237 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
238 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
239 doReturn(this.write).when(this.transactionChain).newWriteOnlyTransaction();
240 doReturn(immediateFalseFluentFuture())
241 .when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid);
242 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
243 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
244 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
246 PutDataTransactionUtil.putData(payload, this.schema,
247 new TransactionVarsWrapper(payload.getInstanceIdentifierContext(), null, transactionChainHandler), null,
249 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
250 payload.getInstanceIdentifierContext().getInstanceIdentifier());
251 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
252 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
256 public void testPutListData() throws Exception {
257 final InstanceIdentifierContext<DataSchemaNode> iidContext =
258 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
259 final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
261 doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
262 doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
263 doReturn(this.write).when(this.transactionChain).newWriteOnlyTransaction();
264 doReturn(immediateFalseFluentFuture())
265 .when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
266 doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
267 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
268 doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
269 PutDataTransactionUtil.putData(payload, this.schema,
270 new TransactionVarsWrapper(payload.getInstanceIdentifierContext(), null, transactionChainHandler), null,
272 verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
273 verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, this.iid2, payload.getData());