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