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