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