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