restconf/restconf-nb-rfc8040/src/test/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/PostDataTransactionUtilTest.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.hamcrest.CoreMatchers.containsString;
  11 import static org.hamcrest.MatcherAssert.assertThat;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.junit.Assert.assertTrue;
  14 import static org.junit.Assert.fail;
  15 import static org.mockito.Mockito.doNothing;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.verify;
  18 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
  19 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFalseFluentFuture;
  20
  21 import java.io.UnsupportedEncodingException;
  22 import java.net.URLDecoder;
  23 import java.nio.charset.StandardCharsets;
  24 import java.util.Collection;
  25 import java.util.Optional;
  26 import javax.ws.rs.core.Response;
  27 import javax.ws.rs.core.UriBuilder;
  28 import javax.ws.rs.core.UriInfo;
  29 import org.junit.Before;
  30 import org.junit.Test;
  31 import org.junit.runner.RunWith;
  32 import org.mockito.Mock;
  33 import org.mockito.Mockito;
  34 import org.mockito.junit.MockitoJUnitRunner;
  35 import org.opendaylight.mdsal.common.api.CommitInfo;
  36 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  37 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  38 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  39 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  40 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  41 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  42 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  43 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  44 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  45 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  46 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
  47 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  48 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
  49 import org.opendaylight.yangtools.yang.common.QName;
  50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  58 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  59 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  60 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  61 import org.w3c.dom.DOMException;
  62
  63 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  64 public class PostDataTransactionUtilTest {
  65
  66     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
  67
  68     @Mock
  69     private DOMTransactionChain transactionChain;
  70     @Mock
  71     private DOMDataTreeReadWriteTransaction readWrite;
  72     @Mock
  73     private DOMDataTreeReadTransaction read;
  74     @Mock
  75     private UriInfo uriInfo;
  76     @Mock
  77     private DOMDataBroker mockDataBroker;
  78     @Mock
  79     private NetconfDataTreeService netconfService;
  80
  81     private TransactionChainHandler transactionChainHandler;
  82     private ContainerNode buildBaseCont;
  83     private EffectiveModelContext schema;
  84     private YangInstanceIdentifier iid2;
  85     private YangInstanceIdentifier iidList;
  86     private MapNode buildList;
  87
  88     @Before
  89     public void setUp() throws Exception {
  90         this.schema =
  91                 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
  92
  93         final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
  94         final QName containerQname = QName.create(baseQName, "player");
  95         final QName leafQname = QName.create(baseQName, "gap");
  96         final QName listQname = QName.create(baseQName, "playlist");
  97         final QName listKeyQname = QName.create(baseQName, "name");
  98         final NodeIdentifierWithPredicates nodeWithKey = NodeIdentifierWithPredicates.of(listQname, listKeyQname,
  99             "name of band");
 100         this.iid2 = YangInstanceIdentifier.builder()
 101                 .node(baseQName)
 102                 .build();
 103         this.iidList = YangInstanceIdentifier.builder()
 104                 .node(baseQName)
 105                 .node(listQname)
 106                 .build();
 107
 108         final LeafNode<?> buildLeaf = Builders.leafBuilder()
 109                 .withNodeIdentifier(new NodeIdentifier(leafQname))
 110                 .withValue(0.2)
 111                 .build();
 112         final ContainerNode buildPlayerCont = Builders.containerBuilder()
 113                 .withNodeIdentifier(new NodeIdentifier(containerQname))
 114                 .withChild(buildLeaf)
 115                 .build();
 116         this.buildBaseCont = Builders.containerBuilder()
 117                 .withNodeIdentifier(new NodeIdentifier(baseQName))
 118                 .withChild(buildPlayerCont)
 119                 .build();
 120
 121         final LeafNode<Object> content = Builders.leafBuilder()
 122                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
 123                 .withValue("name of band")
 124                 .build();
 125         final LeafNode<Object> content2 = Builders.leafBuilder()
 126                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
 127                 .withValue("band description")
 128                 .build();
 129         final MapEntryNode mapEntryNode = Builders.mapEntryBuilder()
 130                 .withNodeIdentifier(nodeWithKey)
 131                 .withChild(content)
 132                 .withChild(content2)
 133                 .build();
 134         this.buildList = Builders.mapBuilder()
 135                 .withNodeIdentifier(new NodeIdentifier(listQname))
 136                 .withChild(mapEntryNode)
 137                 .build();
 138
 139         doReturn(UriBuilder.fromUri("http://localhost:8181/restconf/16/")).when(this.uriInfo).getBaseUriBuilder();
 140         doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
 141
 142         Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
 143         transactionChainHandler = new TransactionChainHandler(mockDataBroker);
 144     }
 145
 146     @Test
 147     public void testPostContainerData() {
 148         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 149                 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
 150         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
 151
 152         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 153             this.iid2);
 154         final NodeIdentifier identifier =
 155                 ((ContainerNode) ((Collection<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
 156         final YangInstanceIdentifier node =
 157                 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
 158         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
 159         doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
 160         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 161
 162         Response response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 163                         new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 164         assertEquals(201, response.getStatus());
 165         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 166         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 167                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 168
 169         response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 170                 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 171         assertEquals(201, response.getStatus());
 172         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 173                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 174     }
 175
 176     @Test
 177     public void testPostListData() throws UnsupportedEncodingException {
 178         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 179                 new InstanceIdentifierContext<>(this.iidList, null, null, this.schema);
 180         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildList);
 181
 182         final MapNode data = (MapNode) payload.getData();
 183         final MapEntryNode entryNode = data.getValue().iterator().next();
 184         final NodeIdentifierWithPredicates identifier = entryNode.getIdentifier();
 185         final YangInstanceIdentifier node =
 186                 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
 187         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 188         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
 189         doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
 190         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 191
 192         Response response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 193                         new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 194         assertEquals(201, response.getStatus());
 195         assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
 196             containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
 197         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 198         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, entryNode);
 199
 200         response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 201                 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 202         assertEquals(201, response.getStatus());
 203         assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
 204                 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
 205         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION, node, entryNode,
 206                 Optional.empty());
 207     }
 208
 209     @Test
 210     public void testPostDataFail() {
 211         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 212                 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
 213         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
 214
 215         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 216             this.iid2);
 217         final NodeIdentifier identifier =
 218                 ((ContainerNode) ((Collection<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
 219         final YangInstanceIdentifier node =
 220                 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
 221         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
 222         final DOMException domException = new DOMException((short) 414, "Post request failed");
 223         doReturn(immediateFailedFluentFuture(domException)).when(this.readWrite).commit();
 224         doReturn(immediateFailedFluentFuture(domException)).when(this.netconfService).commit(Mockito.any());
 225
 226         try {
 227             PostDataTransactionUtil.postData(this.uriInfo, payload,
 228                     new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 229             fail("Expected RestconfDocumentedException");
 230         } catch (final RestconfDocumentedException e) {
 231             assertEquals(1, e.getErrors().size());
 232             assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
 233         }
 234
 235         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 236         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 237                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 238
 239         try {
 240             PostDataTransactionUtil.postData(this.uriInfo, payload,
 241                     new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 242             fail("Expected RestconfDocumentedException");
 243         } catch (final RestconfDocumentedException e) {
 244             assertEquals(1, e.getErrors().size());
 245             assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
 246         }
 247
 248         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 249                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 250     }
 251 }