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