git.opendaylight Code Review - netconf.git/blob

   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.junit.runner.RunWith;
  33 import org.mockito.Mock;
  34 import org.mockito.Mockito;
  35 import org.mockito.junit.MockitoJUnitRunner;
  36 import org.opendaylight.mdsal.common.api.CommitInfo;
  37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  38 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  39 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadTransaction;
  40 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  41 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  42 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  43 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
  44 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  45 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  46 import org.opendaylight.restconf.nb.rfc8040.TestRestconfUtils;
  47 import org.opendaylight.restconf.nb.rfc8040.handlers.TransactionChainHandler;
  48 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  49 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.NetconfRestconfStrategy;
  50 import org.opendaylight.yangtools.yang.common.QName;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  58 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  59 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  60 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  61 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  62 import org.w3c.dom.DOMException;
  63
  64 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  65 public class PostDataTransactionUtilTest {
  66
  67     private static final String PATH_FOR_NEW_SCHEMA_CONTEXT = "/jukebox";
  68
  69     @Mock
  70     private DOMTransactionChain transactionChain;
  71     @Mock
  72     private DOMDataTreeReadWriteTransaction readWrite;
  73     @Mock
  74     private DOMDataTreeReadTransaction read;
  75     @Mock
  76     private UriInfo uriInfo;
  77     @Mock
  78     private DOMDataBroker mockDataBroker;
  79     @Mock
  80     private NetconfDataTreeService netconfService;
  81
  82     private TransactionChainHandler transactionChainHandler;
  83     private ContainerNode buildBaseCont;
  84     private EffectiveModelContext schema;
  85     private YangInstanceIdentifier iid2;
  86     private YangInstanceIdentifier iidList;
  87     private MapNode buildList;
  88
  89     @Before
  90     public void setUp() throws Exception {
  91         this.schema =
  92                 YangParserTestUtils.parseYangFiles(TestRestconfUtils.loadFiles(PATH_FOR_NEW_SCHEMA_CONTEXT));
  93
  94         final QName baseQName = QName.create("http://example.com/ns/example-jukebox", "2015-04-04", "jukebox");
  95         final QName containerQname = QName.create(baseQName, "player");
  96         final QName leafQname = QName.create(baseQName, "gap");
  97         final QName listQname = QName.create(baseQName, "playlist");
  98         final QName listKeyQname = QName.create(baseQName, "name");
  99         final NodeIdentifierWithPredicates nodeWithKey = NodeIdentifierWithPredicates.of(listQname, listKeyQname,
 100             "name of band");
 101         this.iid2 = YangInstanceIdentifier.builder()
 102                 .node(baseQName)
 103                 .build();
 104         this.iidList = YangInstanceIdentifier.builder()
 105                 .node(baseQName)
 106                 .node(listQname)
 107                 .build();
 108
 109         final LeafNode<?> buildLeaf = Builders.leafBuilder()
 110                 .withNodeIdentifier(new NodeIdentifier(leafQname))
 111                 .withValue(0.2)
 112                 .build();
 113         final ContainerNode buildPlayerCont = Builders.containerBuilder()
 114                 .withNodeIdentifier(new NodeIdentifier(containerQname))
 115                 .withChild(buildLeaf)
 116                 .build();
 117         this.buildBaseCont = Builders.containerBuilder()
 118                 .withNodeIdentifier(new NodeIdentifier(baseQName))
 119                 .withChild(buildPlayerCont)
 120                 .build();
 121
 122         final LeafNode<Object> content = Builders.leafBuilder()
 123                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "name")))
 124                 .withValue("name of band")
 125                 .build();
 126         final LeafNode<Object> content2 = Builders.leafBuilder()
 127                 .withNodeIdentifier(new NodeIdentifier(QName.create(baseQName, "description")))
 128                 .withValue("band description")
 129                 .build();
 130         final MapEntryNode mapEntryNode = Builders.mapEntryBuilder()
 131                 .withNodeIdentifier(nodeWithKey)
 132                 .withChild(content)
 133                 .withChild(content2)
 134                 .build();
 135         this.buildList = Builders.mapBuilder()
 136                 .withNodeIdentifier(new NodeIdentifier(listQname))
 137                 .withChild(mapEntryNode)
 138                 .build();
 139
 140         doReturn(UriBuilder.fromUri("http://localhost:8181/restconf/16/")).when(this.uriInfo).getBaseUriBuilder();
 141         doReturn(this.readWrite).when(this.transactionChain).newReadWriteTransaction();
 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         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), 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 MapEntryNode entryNode = data.getValue().iterator().next();
 187         final NodeIdentifierWithPredicates identifier = entryNode.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, entryNode);
 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, entryNode);
 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, entryNode,
 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         doNothing().when(this.readWrite).put(LogicalDatastoreType.CONFIGURATION, node.getParent(), payload.getData());
 228         final DOMException domException = new DOMException((short) 414, "Post request failed");
 229         doReturn(immediateFailedFluentFuture(domException)).when(this.readWrite).commit();
 230         doReturn(immediateFailedFluentFuture(domException)).when(this.netconfService).commit(Mockito.any());
 231
 232         try {
 233             PostDataTransactionUtil.postData(this.uriInfo, payload,
 234                     new MdsalRestconfStrategy(transactionChainHandler), this.schema, null, null);
 235             fail("Expected RestconfDocumentedException");
 236         } catch (final RestconfDocumentedException e) {
 237             assertEquals(1, e.getErrors().size());
 238             assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
 239         }
 240
 241         verify(this.readWrite).exists(LogicalDatastoreType.CONFIGURATION, this.iid2);
 242         verify(this.readWrite).put(LogicalDatastoreType.CONFIGURATION,
 243                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData());
 244
 245         try {
 246             PostDataTransactionUtil.postData(this.uriInfo, payload,
 247                     new NetconfRestconfStrategy(netconfService), this.schema, null, null);
 248             fail("Expected RestconfDocumentedException");
 249         } catch (final RestconfDocumentedException e) {
 250             assertEquals(1, e.getErrors().size());
 251             assertTrue(e.getErrors().get(0).getErrorInfo().contains(domException.getMessage()));
 252         }
 253
 254         verify(this.netconfService).getConfig(this.iid2);
 255         verify(this.netconfService).create(LogicalDatastoreType.CONFIGURATION,
 256                 payload.getInstanceIdentifierContext().getInstanceIdentifier(), payload.getData(), Optional.empty());
 257     }
 258 }