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