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 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
  21
  22 import java.io.UnsupportedEncodingException;
  23 import java.net.URLDecoder;
  24 import java.nio.charset.StandardCharsets;
  25 import java.util.Collection;
  26 import java.util.Optional;
  27 import javax.ws.rs.core.Response;
  28 import javax.ws.rs.core.UriBuilder;
  29 import javax.ws.rs.core.UriInfo;
  30 import org.junit.Before;
  31 import org.junit.Test;
  32 import org.mockito.Mock;
  33 import org.mockito.Mockito;
  34 import org.mockito.MockitoAnnotations;
  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 public class PostDataTransactionUtilTest {
  64
  65     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
  66
  67     @Mock
  68     private DOMTransactionChain transactionChain;
  69     @Mock
  70     private DOMDataTreeReadWriteTransaction readWrite;
  71     @Mock
  72     private DOMDataTreeReadTransaction read;
  73     @Mock
  74     private UriInfo uriInfo;
  75     @Mock
  76     private DOMDataBroker mockDataBroker;
  77     @Mock
  78     private NetconfDataTreeService netconfService;
  79
  80     private TransactionChainHandler transactionChainHandler;
  81     private ContainerNode buildBaseCont;
  82     private EffectiveModelContext schema;
  83     private YangInstanceIdentifier iid2;
  84     private YangInstanceIdentifier iidList;
  85     private MapNode buildList;
  86
  87     @Before
  88     public void setUp() throws Exception {
  89         MockitoAnnotations.initMocks(this);
  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         doReturn(this.read).when(this.transactionChain).newReadOnlyTransaction();
 142
 143         Mockito.doReturn(transactionChain).when(mockDataBroker).createTransactionChain(Mockito.any());
 144         transactionChainHandler = new TransactionChainHandler(mockDataBroker);
 145     }
 146
 147     @Test
 148     public void testPostContainerData() {
 149         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 150                 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
 151         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
 152
 153         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 154             this.iid2);
 155         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid2);
 156         final NodeIdentifier identifier =
 157                 ((ContainerNode) ((Collection<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
 158         final YangInstanceIdentifier node =
 159                 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
 160         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 161         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, payload.getData());
 162         doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
 163         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 164
 165         Response response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 166                         new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 167         assertEquals(201, response.getStatus());
 168         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 169         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 170                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 171
 172         response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 173                 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 174         assertEquals(201, response.getStatus());
 175         verify(this.netconfService).getConfig(this.iid2);
 176         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 177                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 178     }
 179
 180     @Test
 181     public void testPostListData() throws UnsupportedEncodingException {
 182         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 183                 new InstanceIdentifierContext<>(this.iidList, null, null, this.schema);
 184         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildList);
 185
 186         final MapNode data = (MapNode) payload.getData();
 187         final NodeIdentifierWithPredicates identifier = data.getValue().iterator().next().getIdentifier();
 188         final YangInstanceIdentifier node =
 189                 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
 190         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 191         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(node);
 192         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, payload.getData());
 193         doReturn(CommitInfo.emptyFluentFuture()).when(this.readWrite).commit();
 194         doReturn(CommitInfo.emptyFluentFuture()).when(this.netconfService).commit(Mockito.any());
 195
 196         Response response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 197                         new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 198         assertEquals(201, response.getStatus());
 199         assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
 200             containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
 201         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 202         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, data.getValue().iterator().next());
 203
 204         response = PostDataTransactionUtil.postData(this.uriInfo, payload,
 205                 new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 206         assertEquals(201, response.getStatus());
 207         assertThat(URLDecoder.decode(response.getLocation().toString(), StandardCharsets.UTF_8),
 208                 containsString(identifier.getValue(identifier.keySet().iterator().next()).toString()));
 209         verify(this.netconfService).getConfig(node);
 210         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION, node, data.getValue().iterator().next(),
 211                 Optional.empty());
 212     }
 213
 214     @Test
 215     public void testPostDataFail() {
 216         final InstanceIdentifierContext<? extends SchemaNode> iidContext =
 217                 new InstanceIdentifierContext<>(this.iid2, null, null, this.schema);
 218         final NormalizedNodeContext payload = new NormalizedNodeContext(iidContext, this.buildBaseCont);
 219
 220         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION,
 221             this.iid2);
 222         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(this.iid2);
 223         final NodeIdentifier identifier =
 224                 ((ContainerNode) ((Collection<?>) payload.getData().getValue()).iterator().next()).getIdentifier();
 225         final YangInstanceIdentifier node =
 226                 payload.getInstanceIdentifierContext().getInstanceIdentifier().node(identifier);
 227         doReturn(immediateFalseFluentFuture()).when(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, node);
 228         doReturn(immediateFluentFuture(Optional.empty())).when(this.netconfService).getConfig(node);
 229         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node, payload.getData());
 230         final DOMException domException = new DOMException((short) 414, "Post request failed");
 231         doReturn(immediateFailedFluentFuture(domException)).when(this.readWrite).commit();
 232         doReturn(immediateFailedFluentFuture(domException)).when(this.netconfService).commit(Mockito.any());
 233
 234         try {
 235             PostDataTransactionUtil.postData(this.uriInfo, payload,
 236                     new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 237             fail("Expected RestconfDocumentedException");
 238         } catch (final RestconfDocumentedException e) {
 239             assertEquals(1, e.getErrors().size());
 240             assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
 241         }
 242
 243         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 244         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 245                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 246
 247         try {
 248             PostDataTransactionUtil.postData(this.uriInfo, payload,
 249                     new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 250             fail("Expected RestconfDocumentedException");
 251         } catch (final RestconfDocumentedException e) {
 252             assertEquals(1, e.getErrors().size());
 253             assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
 254         }
 255
 256         verify(this.netconfService).getConfig(this.iid2);
 257         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 258                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 259     }
 260 }