restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/PutDataTransactionUtilTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.restconf.nb.rfc8040.rests.utils;
   9
  10 import static org.junit.Assert.assertThrows;
  11 import static org.mockito.Mockito.doNothing;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.verify;
  15 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
  16 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
  17
  18 import com.google.common.util.concurrent.Futures;
  19 import java.util.Optional;
  20 import org.junit.Before;
  21 import org.junit.Test;
  22 import org.junit.runner.RunWith;
  23 import org.mockito.Mock;
  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.spi.DefaultDOMRpcResult;
  32 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  33 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  34 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  35 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  36 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  37 import org.opendaylight.restconf.nb.rfc8040.rests.services.impl.RestconfDataServiceImpl;
  38 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  39 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
  40 import org.opendaylight.yangtools.yang.common.QName;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  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.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  50 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  51 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  52 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  53 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  54
  55 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  56 public class PutDataTransactionUtilTest {
  57     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
  58
  59     @Mock
  60     private DOMDataTreeReadWriteTransaction readWrite;
  61     @Mock
  62     private DOMDataTreeReadTransaction read;
  63     @Mock
  64     private DOMDataTreeWriteTransaction write;
  65     @Mock
  66     private DOMDataBroker mockDataBroker;
  67     @Mock
  68     private NetconfDataTreeService netconfService;
  69
  70     private LeafNode<?> buildLeaf;
  71     private ContainerNode buildBaseCont;
  72     private ContainerNode buildBaseContWithList;
  73     private MapEntryNode buildListEntry;
  74     private EffectiveModelContext schema;
  75     private DataSchemaNode schemaNode;
  76     private YangInstanceIdentifier iid;
  77     private DataSchemaNode schemaNode2;
  78     private YangInstanceIdentifier iid2;
  79     private DataSchemaNode schemaNode3;
  80     private YangInstanceIdentifier iid3;
  81
  82     @Before
  83     public void setUp() throws Exception {
  84         schema =
  85                 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
  86
  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
  93         final NodeIdentifierWithPredicates nodeWithKey =
  94                 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band");
  95         final NodeIdentifierWithPredicates nodeWithKey2 =
  96                 NodeIdentifierWithPredicates.of(listQname, listKeyQname, "name of band 2");
  97
  98         final DataSchemaContextTree tree = DataSchemaContextTree.from(schema);
  99         iid = YangInstanceIdentifier.builder()
 100                 .node(baseQName)
 101                 .node(containerQname)
 102                 .node(leafQname)
 103                 .build();
 104         schemaNode = tree.findChild(iid).orElseThrow().getDataSchemaNode();
 105
 106         iid2 = YangInstanceIdentifier.builder()
 107                 .node(baseQName)
 108                 .build();
 109         schemaNode2 = tree.findChild(iid2).orElseThrow().getDataSchemaNode();
 110
 111         iid3 = YangInstanceIdentifier.builder()
 112                 .node(baseQName)
 113                 .node(listQname)
 114                 .node(nodeWithKey)
 115                 .build();
 116         schemaNode3 = tree.findChild(iid3).orElseThrow().getDataSchemaNode();
 117
 118         buildLeaf = Builders.leafBuilder()
 119                 .withNodeIdentifier(new NodeIdentifier(leafQname))
 120                 .withValue(0.2)
 121                 .build();
 122         final ContainerNode buildPlayerCont = Builders.containerBuilder()
 123                 .withNodeIdentifier(new NodeIdentifier(containerQname))
 124                 .withChild(buildLeaf)
 125                 .build();
 126         buildBaseCont = Builders.containerBuilder()
 127                 .withNodeIdentifier(new NodeIdentifier(baseQName))
 128                 .withChild(buildPlayerCont)
 129                 .build();
 130         final LeafNode<Object> content = Builders.leafBuilder()
 131                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
 132                 .withValue("name of band")
 133                 .build();
 134         final LeafNode<Object> content2 = Builders.leafBuilder()
 135                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
 136                 .withValue("band description")
 137                 .build();
 138         buildListEntry = Builders.mapEntryBuilder()
 139                 .withNodeIdentifier(nodeWithKey)
 140                 .withChild(content)
 141                 .withChild(content2)
 142                 .build();
 143         final LeafNode<Object> content3 = Builders.leafBuilder()
 144                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
 145                 .withValue("name of band 2")
 146                 .build();
 147         final LeafNode<Object> content4 = Builders.leafBuilder()
 148                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
 149                 .withValue("band description 2")
 150                 .build();
 151         final MapEntryNode buildListEntry2 = Builders.mapEntryBuilder()
 152                 .withNodeIdentifier(nodeWithKey2)
 153                 .withChild(content3)
 154                 .withChild(content4)
 155                 .build();
 156         final MapNode buildList = Builders.mapBuilder()
 157                 .withNodeIdentifier(new NodeIdentifier(listQname))
 158                 .withChild(buildListEntry)
 159                 .withChild(buildListEntry2)
 160                 .build();
 161         buildBaseContWithList = Builders.containerBuilder()
 162                 .withNodeIdentifier(new NodeIdentifier(baseQName))
 163                 .withChild(buildList)
 164                 .build();
 165
 166         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).lock();
 167         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
 168     }
 169
 170     @Test
 171     public void testValidInputData() {
 172         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 173                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 174         RestconfDataServiceImpl.validInputData(iidContext.getSchemaNode(),
 175             NormalizedNodePayload.of(iidContext, buildLeaf));
 176     }
 177
 178     @Test
 179     public void testValidTopLevelNodeName() {
 180         InstanceIdentifierContext<DataSchemaNode> iidContext =
 181                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 182         NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildLeaf);
 183         RestconfDataServiceImpl.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
 184
 185         iidContext = new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 186         payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
 187         RestconfDataServiceImpl.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
 188     }
 189
 190     @Test
 191     public void testValidTopLevelNodeNamePathEmpty() {
 192         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 193                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 194         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildLeaf);
 195
 196         // FIXME: more asserts
 197         assertThrows(RestconfDocumentedException.class,
 198             () -> RestconfDataServiceImpl.validTopLevelNodeName(YangInstanceIdentifier.empty(), payload));
 199     }
 200
 201     @Test
 202     public void testValidTopLevelNodeNameWrongTopIdentifier() {
 203         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 204                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 205         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildLeaf);
 206
 207         // FIXME: more asserts
 208         assertThrows(RestconfDocumentedException.class,
 209             () -> RestconfDataServiceImpl.validTopLevelNodeName(iid.getAncestor(1), payload));
 210     }
 211
 212     @Test
 213     public void testValidateListKeysEqualityInPayloadAndUri() {
 214         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 215                 new InstanceIdentifierContext<>(iid3, schemaNode3, null, schema);
 216         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildListEntry);
 217         RestconfDataServiceImpl.validateListKeysEqualityInPayloadAndUri(payload);
 218     }
 219
 220     @Test
 221     public void testPutContainerData() {
 222         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 223                 new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 224         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
 225
 226         doReturn(readWrite).when(mockDataBroker).newReadWriteTransaction();
 227         doReturn(read).when(mockDataBroker).newReadOnlyTransaction();
 228         doReturn(immediateFalseFluentFuture())
 229                 .when(read).exists(LogicalDatastoreType.CONFIGURATION, iid2);
 230         doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION,
 231                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 232         doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
 233
 234         PutDataTransactionUtil.putData(payload, schema, new MdsalRestconfStrategy(mockDataBroker), null, null);
 235         verify(read).exists(LogicalDatastoreType.CONFIGURATION,
 236                 payload.getInstanceIdentifierContext().getInstanceIdentifier());
 237         verify(readWrite).put(LogicalDatastoreType.CONFIGURATION,
 238                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 239     }
 240
 241     @Test
 242     public void testPutCreateContainerData() {
 243         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 244                 new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 245         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
 246
 247         doReturn(immediateFluentFuture(Optional.empty())).when(netconfService).getConfig(iid2);
 248         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 249         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 250             .replace(LogicalDatastoreType.CONFIGURATION, payload.getInstanceIdentifierContext().getInstanceIdentifier(),
 251                 payload.getData(), Optional.empty());
 252
 253         PutDataTransactionUtil.putData(payload, schema, new NetconfRestconfStrategy(netconfService),
 254                 null, null);
 255         verify(netconfService).lock();
 256         verify(netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 257         verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION,
 258                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 259     }
 260
 261     @Test
 262     public void testPutReplaceContainerData() {
 263         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 264                 new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 265         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseCont);
 266
 267         doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
 268                 .when(netconfService).getConfig(iid2);
 269         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 270         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 271             .replace(LogicalDatastoreType.CONFIGURATION,
 272                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 273
 274         PutDataTransactionUtil.putData(payload, schema, new NetconfRestconfStrategy(netconfService),
 275                 null, null);
 276         verify(netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 277         verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION,
 278                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 279     }
 280
 281     @Test
 282     public void testPutLeafData() {
 283         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 284                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 285         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildLeaf);
 286
 287         doReturn(readWrite).when(mockDataBroker).newReadWriteTransaction();
 288         doReturn(read).when(mockDataBroker).newReadOnlyTransaction();
 289         doReturn(immediateFalseFluentFuture())
 290                 .when(read).exists(LogicalDatastoreType.CONFIGURATION, iid);
 291         doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION,
 292                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 293         doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
 294
 295         PutDataTransactionUtil.putData(payload, schema, new MdsalRestconfStrategy(mockDataBroker), null, null);
 296         verify(read).exists(LogicalDatastoreType.CONFIGURATION,
 297                 payload.getInstanceIdentifierContext().getInstanceIdentifier());
 298         verify(readWrite).put(LogicalDatastoreType.CONFIGURATION,
 299                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 300     }
 301
 302     @Test
 303     public void testPutCreateLeafData() {
 304         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 305                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 306         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildLeaf);
 307
 308         doReturn(immediateFluentFuture(Optional.empty())).when(netconfService).getConfig(iid);
 309         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 310         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 311             .replace(LogicalDatastoreType.CONFIGURATION,
 312                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 313
 314         PutDataTransactionUtil.putData(payload, schema, new NetconfRestconfStrategy(netconfService),
 315                 null, null);
 316         verify(netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 317         verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION,
 318                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 319     }
 320
 321     @Test
 322     public void testPutReplaceLeafData() {
 323         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 324                 new InstanceIdentifierContext<>(iid, schemaNode, null, schema);
 325         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildLeaf);
 326
 327         doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
 328                 .when(netconfService).getConfig(iid);
 329         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 330         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 331             .replace(LogicalDatastoreType.CONFIGURATION,
 332                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 333
 334         PutDataTransactionUtil.putData(payload, schema,
 335                 new NetconfRestconfStrategy(netconfService), null, null);
 336         verify(netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 337         verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION,
 338                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 339     }
 340
 341     @Test
 342     public void testPutListData() {
 343         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 344                 new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 345         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseContWithList);
 346
 347         doReturn(readWrite).when(mockDataBroker).newReadWriteTransaction();
 348         doReturn(read).when(mockDataBroker).newReadOnlyTransaction();
 349         doReturn(immediateFalseFluentFuture())
 350                 .when(read).exists(LogicalDatastoreType.CONFIGURATION, iid2);
 351         doNothing().when(readWrite).put(LogicalDatastoreType.CONFIGURATION,
 352                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 353         doReturn(CommitInfo.emptyFluentFuture()).when(readWrite).commit();
 354         PutDataTransactionUtil.putData(payload, schema, new MdsalRestconfStrategy(mockDataBroker), null, null);
 355         verify(read).exists(LogicalDatastoreType.CONFIGURATION, iid2);
 356         verify(readWrite).put(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData());
 357     }
 358
 359     @Test
 360     public void testPutCreateListData() {
 361         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 362                 new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 363         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseContWithList);
 364
 365         doReturn(immediateFluentFuture(Optional.empty())).when(netconfService)
 366                 .getConfig(iid2);
 367         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 368         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 369             .replace(LogicalDatastoreType.CONFIGURATION, iid2, payload.getData(), Optional.empty());
 370
 371         PutDataTransactionUtil.putData(payload, schema, new NetconfRestconfStrategy(netconfService),
 372                 null, null);
 373         verify(netconfService).getConfig(iid2);
 374         verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, iid2,
 375                 payload.getData(), Optional.empty());
 376     }
 377
 378     @Test
 379     public void testPutReplaceListData() {
 380         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 381                 new InstanceIdentifierContext<>(iid2, schemaNode2, null, schema);
 382         final NormalizedNodePayload payload = NormalizedNodePayload.of(iidContext, buildBaseContWithList);
 383
 384         doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class)))).when(netconfService)
 385                 .getConfig(iid2);
 386         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
 387         doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
 388             .replace(LogicalDatastoreType.CONFIGURATION,
 389                 iid2, payload.getData(), Optional.empty());
 390
 391         PutDataTransactionUtil.putData(payload, schema,
 392                 new NetconfRestconfStrategy(netconfService), null, null);
 393         verify(netconfService).getConfig(iid2);
 394         verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, iid2,
 395                 payload.getData(), Optional.empty());
 396     }
 397 }