restconf/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestPutOperationTest.java

   1 /*
   2  * Copyright (c) 2014 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.controller.sal.restconf.impl.test;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.Matchers.any;
  12 import static org.mockito.Mockito.doReturn;
  13 import static org.mockito.Mockito.doThrow;
  14 import static org.mockito.Mockito.mock;
  15 import static org.mockito.Mockito.when;
  16 import com.google.common.base.Optional;
  17 import com.google.common.util.concurrent.CheckedFuture;
  18 import com.google.common.util.concurrent.Futures;
  19 import java.io.FileNotFoundException;
  20 import java.io.IOException;
  21 import java.io.InputStream;
  22 import java.io.UnsupportedEncodingException;
  23 import java.net.URISyntaxException;
  24 import javax.ws.rs.client.Entity;
  25 import javax.ws.rs.core.Application;
  26 import javax.ws.rs.core.MediaType;
  27 import javax.ws.rs.core.Response;
  28 import javax.ws.rs.core.Response.Status;
  29 import org.glassfish.jersey.server.ResourceConfig;
  30 import org.glassfish.jersey.test.JerseyTest;
  31 import org.junit.BeforeClass;
  32 import org.junit.Test;
  33 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
  34 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  35 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
  36 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
  37 import org.opendaylight.netconf.sal.rest.impl.JsonNormalizedNodeBodyReader;
  38 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeJsonBodyWriter;
  39 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeXmlBodyWriter;
  40 import org.opendaylight.netconf.sal.rest.impl.RestconfDocumentedExceptionMapper;
  41 import org.opendaylight.netconf.sal.rest.impl.XmlNormalizedNodeBodyReader;
  42 import org.opendaylight.netconf.sal.restconf.impl.BrokerFacade;
  43 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  44 import org.opendaylight.netconf.sal.restconf.impl.PutResult;
  45 import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
  46 import org.opendaylight.netconf.sal.restconf.impl.RestconfImpl;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  51
  52 public class RestPutOperationTest extends JerseyTest {
  53
  54     private static String xmlData;
  55     private static String xmlData2;
  56     private static String xmlData3;
  57
  58     private static BrokerFacade brokerFacade;
  59     private static RestconfImpl restconfImpl;
  60     private static SchemaContext schemaContextYangsIetf;
  61     private static SchemaContext schemaContextTestModule;
  62
  63     @BeforeClass
  64     public static void init() throws IOException, ReactorException {
  65         schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs");
  66         schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module");
  67         final ControllerContext controllerContext = ControllerContext.getInstance();
  68         controllerContext.setSchemas(schemaContextYangsIetf);
  69         brokerFacade = mock(BrokerFacade.class);
  70         restconfImpl = RestconfImpl.getInstance();
  71         restconfImpl.setBroker(brokerFacade);
  72         restconfImpl.setControllerContext(controllerContext);
  73         loadData();
  74     }
  75
  76     private static void loadData() throws IOException {
  77         final InputStream xmlStream = RestconfImplTest.class.getResourceAsStream("/parts/ietf-interfaces_interfaces.xml");
  78         xmlData = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream));
  79         final InputStream xmlStream2 = RestconfImplTest.class.getResourceAsStream("/full-versions/test-data2/data2.xml");
  80         xmlData2 = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream2));
  81         final InputStream xmlStream3 = RestconfImplTest.class.getResourceAsStream("/full-versions/test-data2/data7.xml");
  82         xmlData3 = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream3));
  83     }
  84
  85     @Override
  86     protected Application configure() {
  87         /* enable/disable Jersey logs to console */
  88         // enable(TestProperties.LOG_TRAFFIC);
  89         // enable(TestProperties.DUMP_ENTITY);
  90         // enable(TestProperties.RECORD_LOG_LEVEL);
  91         // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue());
  92         ResourceConfig resourceConfig = new ResourceConfig();
  93         resourceConfig = resourceConfig.registerInstances(restconfImpl,new XmlNormalizedNodeBodyReader(),
  94                 new NormalizedNodeXmlBodyWriter(), new JsonNormalizedNodeBodyReader(), new NormalizedNodeJsonBodyWriter());
  95         resourceConfig.registerClasses(RestconfDocumentedExceptionMapper.class);
  96         return resourceConfig;
  97     }
  98
  99     /**
 100      * Tests of status codes for "/config/{identifier}".
 101      */
 102     @Test
 103     public void putConfigStatusCodes() throws UnsupportedEncodingException {
 104         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 105         mockCommitConfigurationDataPutMethod(true);
 106         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 107
 108         mockCommitConfigurationDataPutMethod(false);
 109         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 110
 111         assertEquals(400, put(uri, MediaType.APPLICATION_JSON, ""));
 112     }
 113
 114     @Test
 115     public void putConfigStatusCodesEmptyBody() throws UnsupportedEncodingException {
 116         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 117         @SuppressWarnings("unused")
 118         final Response resp = target(uri).request(MediaType.APPLICATION_JSON).put(
 119                 Entity.entity("", MediaType.APPLICATION_JSON));
 120         assertEquals(400, put(uri, MediaType.APPLICATION_JSON, ""));
 121     }
 122
 123     @Test
 124     public void testRpcResultCommitedToStatusCodesWithMountPoint() throws UnsupportedEncodingException,
 125             FileNotFoundException, URISyntaxException {
 126         final CheckedFuture<Void, TransactionCommitFailedException> dummyFuture = Futures.immediateCheckedFuture(null);
 127         final PutResult result = mock(PutResult.class);
 128         when(
 129                 brokerFacade.commitMountPointDataPut(any(DOMMountPoint.class), any(YangInstanceIdentifier.class),
 130                         any(NormalizedNode.class))).thenReturn(result);
 131         when(result.getFutureOfPutData()).thenReturn(dummyFuture);
 132         when(result.getStatus()).thenReturn(Status.OK);
 133
 134         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 135         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 136         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 137         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 138
 139         ControllerContext.getInstance().setMountService(mockMountService);
 140
 141         String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont";
 142         assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData2));
 143
 144         uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont";
 145         assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData2));
 146     }
 147
 148     @Test
 149     public void putDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException {
 150         final CheckedFuture<Void, TransactionCommitFailedException> dummyFuture = Futures.immediateCheckedFuture(null);
 151         final PutResult result = mock(PutResult.class);
 152         doReturn(result).when(brokerFacade).commitMountPointDataPut(any(DOMMountPoint.class),
 153                 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 154         when(result.getFutureOfPutData()).thenReturn(dummyFuture);
 155         when(result.getStatus()).thenReturn(Status.OK);
 156
 157         final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
 158         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 159         final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
 160         when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
 161
 162         ControllerContext.getInstance().setMountService(mockMountService);
 163
 164         final String uri = "/config/ietf-interfaces:interfaces/yang-ext:mount";
 165         assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData3));
 166     }
 167
 168     @Test
 169     public void putWithOptimisticLockFailedException() throws UnsupportedEncodingException {
 170
 171         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 172
 173         doThrow(OptimisticLockFailedException.class).
 174             when(brokerFacade).commitConfigurationDataPut(
 175                         any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 176
 177         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 178
 179         doThrow(OptimisticLockFailedException.class).doReturn(mock(PutResult.class)).when(brokerFacade)
 180                 .commitConfigurationDataPut(any(SchemaContext.class), any(YangInstanceIdentifier.class),
 181                         any(NormalizedNode.class));
 182
 183         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 184     }
 185
 186     @Test
 187     public void putWithTransactionCommitFailedException() throws UnsupportedEncodingException {
 188
 189         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 190
 191         doThrow(TransactionCommitFailedException.class).
 192             when(brokerFacade).commitConfigurationDataPut(
 193                         any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 194
 195         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 196     }
 197
 198     private int put(final String uri, final String mediaType, final String data) throws UnsupportedEncodingException {
 199         return target(uri).request(mediaType).put(Entity.entity(data, mediaType)).getStatus();
 200     }
 201
 202     private void mockCommitConfigurationDataPutMethod(final boolean noErrors) {
 203         final PutResult putResMock = mock(PutResult.class);
 204         if (noErrors) {
 205             doReturn(putResMock).when(brokerFacade).commitConfigurationDataPut(
 206                     any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 207         } else {
 208             doThrow(RestconfDocumentedException.class).when(brokerFacade).commitConfigurationDataPut(
 209                     any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class));
 210         }
 211     }
 212
 213 }