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.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;
  16
  17 import java.util.Optional;
  18 import org.junit.Before;
  19 import org.junit.Test;
  20 import org.mockito.Mock;
  21 import org.mockito.Mockito;
  22 import org.mockito.MockitoAnnotations;
  23 import org.opendaylight.mdsal.common.api.CommitInfo;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  25 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  26 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  27 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  28 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  29 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  30 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  31 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  32 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  33 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  34 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  35 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
  36 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  37 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  42 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  43 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  46 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  48 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  49 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  50 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  51 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  52
  53 public class PutDataTransactionUtilTest {
  54     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
  55     @Mock
  56     private DOMTransactionChain transactionChain;
  57     @Mock
  58     private DOMDataTreeReadWriteTransaction readWrite;
  59     @Mock
  60     private DOMDataTreeReadTransaction read;
  61     @Mock
  62     private DOMDataTreeWriteTransaction write;
  63     @Mock
  64     private DOMDataBroker mockDataBroker;
  65     @Mock
  66     private NetconfDataTreeService netconfService;
  67
  68     private TransactionChainHandler transactionChainHandler;
  69     private LeafNode<?> buildLeaf;
  70     private ContainerNode buildBaseCont;
  71     private ContainerNode buildBaseContWithList;
  72     private MapEntryNode buildListEntry;
  73     private EffectiveModelContext schema;
  74     private DataSchemaNode schemaNode;
  75     private YangInstanceIdentifier iid;
  76     private DataSchemaNode schemaNode2;
  77     private YangInstanceIdentifier iid2;
  78     private DataSchemaNode schemaNode3;
  79     private YangInstanceIdentifier iid3;
  80
  81     @Before
  82     public void setUp() throws Exception {
  83         MockitoAnnotations.initMocks(this);
  84         this.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(this.schema);
  99         this.iid = YangInstanceIdentifier.builder()
 100                 .node(baseQName)
 101                 .node(containerQname)
 102                 .node(leafQname)
 103                 .build();
 104         this.schemaNode = tree.findChild(this.iid).orElseThrow().getDataSchemaNode();
 105
 106         this.iid2 = YangInstanceIdentifier.builder()
 107                 .node(baseQName)
 108                 .build();
 109         this.schemaNode2 = tree.findChild(this.iid2).orElseThrow().getDataSchemaNode();
 110
 111         this.iid3 = YangInstanceIdentifier.builder()
 112                 .node(baseQName)
 113                 .node(listQname)
 114                 .node(nodeWithKey)
 115                 .build();
 116         this.schemaNode3 = tree.findChild(this.iid3).orElseThrow().getDataSchemaNode();
 117
 118         this.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(this.buildLeaf)
 125                 .build();
 126         this.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         this.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(this.buildListEntry)
 159                 .withChild(buildListEntry2)
 160                 .build();
 161         this.buildBaseContWithList = Builders.containerBuilder()
 162                 .withNodeIdentifier(new NodeIdentifier(baseQName))
 163                 .withChild(buildList)
 164                 .build();
 165
 166         Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
 167         transactionChainHandler = new TransactionChainHandler(mockDataBroker);
 168     }
 169
 170     @Test
 171     public void testValidInputData() {
 172         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 173                 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
 174         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
 175         PutDataTransactionUtil.validInputData(iidContext.getSchemaNode(), payload);
 176     }
 177
 178     @Test
 179     public void testValidTopLevelNodeName() {
 180         InstanceIdentifierContext<DataSchemaNode> iidContext =
 181                 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
 182         NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
 183         PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
 184
 185         iidContext = new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
 186         payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
 187         PutDataTransactionUtil.validTopLevelNodeName(iidContext.getInstanceIdentifier(), payload);
 188     }
 189
 190     @Test(expected = RestconfDocumentedException.class)
 191     public void testValidTopLevelNodeNamePathEmpty() {
 192         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 193                 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
 194         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
 195         PutDataTransactionUtil.validTopLevelNodeName(YangInstanceIdentifier.empty(), payload);
 196     }
 197
 198     @Test(expected = RestconfDocumentedException.class)
 199     public void testValidTopLevelNodeNameWrongTopIdentifier() {
 200         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 201                 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
 202         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
 203         PutDataTransactionUtil.validTopLevelNodeName(this.iid.getAncestor(1), payload);
 204     }
 205
 206     @Test
 207     public void testValidateListKeysEqualityInPayloadAndUri() {
 208         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 209                 new InstanceIdentifierContext<>(this.iid3, this.schemaNode3, null, this.schema);
 210         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildListEntry);
 211         PutDataTransactionUtil.validateListKeysEqualityInPayloadAndUri(payload);
 212     }
 213
 214     @Test
 215     public void testPutContainerData() {
 216         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 217                 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
 218         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
 219
 220         doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
 221         doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
 222         doReturn(this.write).when(this.transactionChain).newWriteOnlyTransaction();
 223         doReturn(immediateFalseFluentFuture())
 224                 .when(this.readWrite).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();
 228
 229         PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
 230                 null, null);
 231         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 232                 payload.getInstanceIdentifierContext().getInstanceIdentifier());
 233         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 234                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 235     }
 236
 237     @Test
 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);
 242
 243         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid2);
 244         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 245
 246         PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
 247                 null, null);
 248         verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 249         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 250                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 251     }
 252
 253     @Test
 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);
 258
 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());
 262
 263         PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
 264                 null, null);
 265         verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 266         verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
 267                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 268     }
 269
 270     @Test
 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);
 275
 276         doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
 277         doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
 278         doReturn(this.write).when(this.transactionChain).newWriteOnlyTransaction();
 279         doReturn(immediateFalseFluentFuture())
 280                 .when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid);
 281         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 282                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 283         doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
 284
 285         PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
 286                 null, null);
 287         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 288                 payload.getInstanceIdentifierContext().getInstanceIdentifier());
 289         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 290                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 291     }
 292
 293     @Test
 294     public void testPutCreateLeafData() {
 295         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 296                 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
 297         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
 298
 299         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid);
 300         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 301
 302         PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
 303                 null, null);
 304         verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 305         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 306                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 307     }
 308
 309     @Test
 310     public void testPutReplaceLeafData() {
 311         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 312                 new InstanceIdentifierContext<>(this.iid, this.schemaNode, null, this.schema);
 313         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildLeaf);
 314
 315         doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class))))
 316                 .when(this.netconfService).getConfig(this.iid);
 317         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 318
 319         PutDataTransactionUtil.putData(payload, this.schema,
 320                 new NetconfRestconfStrategy(netconfService), null, null);
 321         verify(this.netconfService).getConfig(payload.getInstanceIdentifierContext().getInstanceIdentifier());
 322         verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION,
 323                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 324     }
 325
 326     @Test
 327     public void testPutListData() {
 328         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 329                 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
 330         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
 331
 332         doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
 333         doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
 334         doReturn(this.write).when(this.transactionChain).newWriteOnlyTransaction();
 335         doReturn(immediateFalseFluentFuture())
 336                 .when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 337         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 338                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 339         doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
 340         PutDataTransactionUtil.putData(payload, this.schema, new MdsalRestconfStrategy(transactionChainHandler),
 341                 null, null);
 342         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 343         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, this.iid2, payload.getData());
 344     }
 345
 346     @Test
 347     public void testPutCreateListData() {
 348         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 349                 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
 350         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
 351
 352         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService)
 353                 .getConfig(this.iid2);
 354         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 355
 356         PutDataTransactionUtil.putData(payload, this.schema, new NetconfRestconfStrategy(netconfService),
 357                 null, null);
 358         verify(this.netconfService).getConfig(this.iid2);
 359         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION, this.iid2,
 360                 payload.getData(), Optional.empty());
 361     }
 362
 363     @Test
 364     public void testPutReplaceListData() {
 365         final InstanceIdentifierContext<DataSchemaNode> iidContext =
 366                 new InstanceIdentifierContext<>(this.iid2, this.schemaNode2, null, this.schema);
 367         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseContWithList);
 368
 369         doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class)))).when(this.netconfService)
 370                 .getConfig(this.iid2);
 371         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 372
 373         PutDataTransactionUtil.putData(payload, this.schema,
 374                 new NetconfRestconfStrategy(netconfService), null, null);
 375         verify(this.netconfService).getConfig(this.iid2);
 376         verify(this.netconfService).replace(LogicalDatastoreType.CONFIGURATION, this.iid2,
 377                 payload.getData(), Optional.empty());
 378     }
 379 }